WordPress/create-block-theme
1
0
Fork 0
mirror of https://github.com/WordPress/create-block-theme.git synced 2025-10-03 16:11:13 +08:00
Code Issues Projects Packages Wiki Activity Actions

Sanitize DOS (Windows) new line style on readme.txt (#681)

Browse source 
* sanitize windows new lines

* add tests
This commit is contained in:
Matias Benedetto 2024-07-03 17:59:42 +04:00 • committed by GitHub
parent 29c8dbc136
commit 082be0b85d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 87 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

18
includes/create-theme/theme-readme.php
View file

@ -97,6 +97,9 @@ License URI: {$license_uri}
// Adds the Images section
$readme_content = self::add_or_update_section( 'Images', $image_credits, $readme_content );

// Sanitize the readme content
$readme_content = self::sanitize( $readme_content );

return $readme_content;
}

@ -229,6 +232,9 @@ GNU General Public License for more details.
// Update image credits section.
$readme_content = self::add_or_update_section( 'Images', $image_credits, $readme_content );

// Sanitize the readme content.
$readme_content = self::sanitize( $readme_content );

return $readme_content;
}

@ -339,4 +345,16 @@ GNU General Public License for more details.
return $sections;
}

/**
* Sanitize the readme content.
*
* @param string $readme_content The readme content.
* @return string The sanitized readme content.
*/
private static function sanitize( $readme_content ) {
// Replaces DOS line endings with Unix line endings
$readme_content = str_replace( "\r\n", '', $readme_content );
return $readme_content;
}

}

14
tests/CbtThemeReadme/base.php
View file

@ -61,4 +61,18 @@ abstract class CBT_Theme_Readme_UnitTestCase extends WP_UnitTestCase {
// Restore the original active theme.
switch_theme( $this->orig_active_theme_slug );
}

/**
* Removes the newlines from a string.
*
* This is useful to make it easier to search for strings in the readme content.
* Removes both DOS and Unix newlines.
*
* @param string $string
* @return string
*/
public function remove_newlines( $string ) {
return str_replace( array( "\r\n", "\n" ), '', $string );
}

}

38
tests/CbtThemeReadme/create.php
View file

@ -17,8 +17,11 @@ class CBT_ThemeReadme_Create extends CBT_Theme_Readme_UnitTestCase {
public function test_create( $data ) {
$readme = CBT_Theme_Readme::create( $data );

// Check sanitazion before altering the content.
$this->assertStringNotContainsString( "\r\n", $readme, 'The readme content contains DOS newlines.' );

// Removes the newlines from the readme content to make it easier to search for strings.
$readme_without_newlines = str_replace( "\n", '', $readme );
$readme_without_newlines = $this->remove_newlines( $readme );

$expected_name = '== ' . $data['name'] . ' ==';
$expected_description = '== Description ==' . $data['description'];
@ -30,10 +33,16 @@ class CBT_ThemeReadme_Create extends CBT_Theme_Readme_UnitTestCase {
$expected_license = 'License: ' . $data['license'];
$expected_license_uri = 'License URI: ' . $data['license_uri'];
$expected_font_credits = '== Fonts ==' .
( isset( $data['font_credits'] ) ? $data['font_credits'] : '' );
( isset( $data['font_credits'] )
? $this->remove_newlines( $data['font_credits'] )
: ''
);
$expected_image_credits = '== Images ==' .
( isset( $data['image_credits'] ) ? $data['image_credits'] : '' );
$expected_recommended_plugins = '== Recommended Plugins ==' . $data['recommended_plugins'];
( isset( $data['image_credits'] )
? $this->remove_newlines( $data['image_credits'] )
: ''
);
$expected_recommended_plugins = '== Recommended Plugins ==' . $this->remove_newlines( $data['recommended_plugins'] );

$this->assertStringContainsString( $expected_name, $readme_without_newlines, 'The expected name is missing.' );
$this->assertStringContainsString( $expected_author, $readme_without_newlines, 'The expected author is missing.' );
@ -161,6 +170,27 @@ class CBT_ThemeReadme_Create extends CBT_Theme_Readme_UnitTestCase {
'font_credits' => 'Font credit example text',
),
),
/*
* This string contains DOS newlines.
* It uses double quotes to make PHP interpret the newlines as newlines and not as string literals.
*/
'With DOS newlines' => array(
'data' => array(
'name' => 'My Theme',
'description' => 'New theme description',
'uri' => 'https://example.com',
'author' => 'New theme author',
'author_uri' => 'https://example.com/author',
'copyright_year' => '2077',
'wp_version' => '12.12',
'required_php_version' => '10.0',
'license' => 'GPLv2 or later',
'license_uri' => 'https://www.gnu.org/licenses/gpl-2.0.html',
'image_credits' => "New image credits \r\n New image credits 2",
'recommended_plugins' => "Plugin1 \r\n Plugin2 \r\n Plugin3",
'font_credits' => "Font1 \r\n Font2 \r\n Font3",
),
),
// TODO: Add more test cases.
);
}

26
tests/CbtThemeReadme/update.php
View file

@ -18,13 +18,16 @@ class CBT_ThemeReadme_Update extends CBT_Theme_Readme_UnitTestCase {
$readme_content = CBT_Theme_Readme::get_content();
$readme = CBT_Theme_Readme::update( $data, $readme_content );

// Check sanitazion before altering the content.
$this->assertStringNotContainsString( "\r\n", $readme, 'The readme content contains DOS newlines.' );

// Removes the newlines from the readme content to make it easier to search for strings.
$readme_without_newlines = str_replace( "\n", '', $readme );
$readme_without_newlines = $this->remove_newlines( $readme );

$expected_author = 'Contributors: ' . $data['author'];
$expected_wp_version = 'Tested up to: ' . $data['wp_version'] ?? CBT_Theme_Utils::get_current_wordpress_version();
$expected_image_credits = '== Images ==' . $data['image_credits'];
$expected_recommended_plugins = '== Recommended Plugins ==' . $data['recommended_plugins'];
$expected_image_credits = '== Images ==' . $this->remove_newlines( $data['image_credits'] );
$expected_recommended_plugins = '== Recommended Plugins ==' . $this->remove_newlines( $data['recommended_plugins'] );

$this->assertStringContainsString( $expected_author, $readme_without_newlines, 'The expected author is missing.' );
$this->assertStringContainsString( $expected_wp_version, $readme_without_newlines, 'The expected WP version is missing.' );
@ -33,7 +36,7 @@ class CBT_ThemeReadme_Update extends CBT_Theme_Readme_UnitTestCase {

// Assertion specific to font credits.
if ( isset( $data['font_credits'] ) ) {
$expected_font_credits = '== Fonts ==' . $data['font_credits'];
$expected_font_credits = '== Fonts ==' . $this->remove_newlines( $data['font_credits'] );
$this->assertStringContainsString( $expected_font_credits, $readme_without_newlines, 'The expected font credits are missing.' );
}
}
@ -59,7 +62,20 @@ class CBT_ThemeReadme_Update extends CBT_Theme_Readme_UnitTestCase {
'recommended_plugins' => 'New recommended plugins',
),
),
// TODO: Add more test cases.
/*
* This string contains DOS newlines.
* It uses double quotes to make PHP interpret the newlines as newlines and not as string literals.
*/
'Remove DOS newlines' => array(
'data' => array(
'description' => 'New theme description',
'author' => 'New theme author',
'wp_version' => '12.12',
'image_credits' => "New image credits \r\n New image credits 2",
'recommended_plugins' => "Plugin1 \r\n Plugin2 \r\n Plugin3",
'font_credits' => "Font1 \r\n Font2 \r\n Font3",
),
),
);
}
}