Skip to content

Style engine: migrate functions, classes and tests #3199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ramonjd wants to merge 16 commits into from
Closed

Style engine: migrate functions, classes and tests #3199

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
11a9aac
Initial commit:
ramonjd Sep 6, 2022
8d87cd1
Adding @covers annotations
ramonjd Sep 6, 2022
05b1903
Changes from https://github.com/WordPress/gutenberg/pull/43886
ramonjd Sep 6, 2022
d4fa390
Formatting PHP doc comments and params that describe associative arrays
ramonjd Sep 8, 2022
5543539
formatting
ramonjd Sep 8, 2022
f044bf4
Combining tests for get_declarations_string
ramonjd Sep 8, 2022
73288d1
Adding message parameter to assertions where more than one assertion …
ramonjd Sep 8, 2022
aa291de
Updating PHP docs
ramonjd Sep 8, 2022
cfcc425
Refactoring sanitization tests for CSS declarations
ramonjd Sep 8, 2022
4b2128e
Formatting styleEngine tests
ramonjd Sep 8, 2022
5da7cf4
My blod is typo
ramonjd Sep 8, 2022
d0de610
Imperative < active voice
ramonjd Sep 8, 2022
3d2f156
Remove Gutenberg suffix
ramonjd Sep 8, 2022
26cd739
renaming test group suite to kebab case
ramonjd Sep 9, 2022
57d81bc
Grammar, formatting, removing class_exists checks
ramonjd Sep 9, 2022
8e3266d
Removing @access private from Style Engine utility classes
ramonjd Sep 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Combining tests for get_declarations_string 
Updating php doc params
  • Loading branch information
@ramonjd
ramonjd committed Sep 9, 2022
commit f044bf428e8135a470a194e59e76f96d2773a147
16 changes: 12 additions & 4 deletions tests/phpunit/tests/style-engine/styleEngine.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,18 @@ public function tear_down() {
* @ticket 56467
* @covers ::wp_style_engine_get_styles
*
* @dataProvider data_get_styles_fixtures
* @dataProvider data_wp_style_engine_get_styles
*
* @param array $block_styles The incoming block styles object.
* @param array $options Style engine options.
* @param array $options {
* An array of options to pass to `wp_style_engine_get_styles()`.
*
* @type string|null $context An identifier describing the origin of the style object, e.g., 'block-supports' or 'global-styles'. Default is `null`.
* When set, the style engine will attempt to store the CSS rules, where a selector is also passed.
* @type bool $convert_vars_to_classnames Whether to skip converting incoming CSS var patterns, e.g., `var:preset|<PRESET_TYPE>|<PRESET_SLUG>`, to var( --wp--preset--* ) values. Default `false`.
* @type string $selector Optional. When a selector is passed, the value of `$css` in the return value will comprise a full CSS rule `$selector { ...$css_declarations }`,
* otherwise, the value will be a concatenated string of CSS declarations.
* }
* @param string $expected_output The expected output.
*/
public function test_wp_style_engine_get_styles( $block_styles, $options, $expected_output ) {
Expand All @@ -39,11 +47,11 @@ public function test_wp_style_engine_get_styles( $block_styles, $options, $expec
}

/**
* Data provider for test_generate_get_styles().
* Data provider for test_wp_style_engine_get_styles().
*
* @return array
*/
public function data_get_styles_fixtures() {
public function data_wp_style_engine_get_styles() {
return array(
'default_return_value' => array(
'block_styles' => array(),
Expand Down
96 changes: 35 additions & 61 deletions tests/phpunit/tests/style-engine/wpStyleEngineCssDeclarations.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,86 +113,60 @@ public function test_should_remove_unsafe_properties_and_values() {
}

/**
* Tests that css declarations are compiled into a css declarations block string.
* Tests that CSS declarations are compiled into a CSS declarations block string.
*
* @ticket 56467
* @covers ::get_declarations_string
*/
public function test_should_generate_css_declarations_string() {
$input_declarations = array(
'color' => 'red',
'border-top-left-radius' => '99px',
'text-decoration' => 'underline',
);
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );

$this->assertSame(
'color:red;border-top-left-radius:99px;text-decoration:underline;',
$css_declarations->get_declarations_string()
);
}

/**
* Tests that inline css declarations are compiled into a prettified css declarations block string.
*
* @ticket 56467
* @covers ::get_declarations_string
*/
public function test_should_generate_prettified_css_declarations_string() {
$input_declarations = array(
'color' => 'red',
'border-top-left-radius' => '99px',
'text-decoration' => 'underline',
);
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );

$this->assertSame(
'color: red; border-top-left-radius: 99px; text-decoration: underline;',
$css_declarations->get_declarations_string( true )
);
}

/**
* Tests that inline css declarations are compiled into a prettified css declarations block string with new lines and indents.
*
* @ticket 56467
* @covers ::get_declarations_string
* @dataProvider data_should_compile_css_declarations_to_css_declarations_string
*
* @param string $expected The expected declarations block string.
* @param bool $should_prettify Optional. Whether to pretty the string. Default false.
* @param int $indent_count Optional. The number of tab indents. Default false.
*/
public function test_should_generate_prettified_css_declarations_string_with_new_lines_and_indents() {
public function test_should_compile_css_declarations_to_css_declarations_string( $expected, $should_prettify = false, $indent_count = 0 ) {
$input_declarations = array(
'color' => 'red',
'border-top-left-radius' => '99px',
'text-decoration' => 'underline',
);
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );

$this->assertSame(
' color: red;
border-top-left-radius: 99px;
text-decoration: underline;',
$css_declarations->get_declarations_string( true, 1 )
$expected,
$css_declarations->get_declarations_string( $should_prettify, $indent_count )
);
}

/**
* Tests that inline css declarations are compiled into a prettified css declarations block string with extra indents.
* Data provider for test_should_compile_css_declarations_to_css_declarations_string().
*
* @ticket 56467
* @covers ::get_declarations_string
* @return array
*/
public function test_should_generate_prettified_with_extra_indents_css_declarations_string() {
$input_declarations = array(
'color' => 'red',
'border-top-left-radius' => '99px',
'text-decoration' => 'underline',
);
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );

$this->assertSame(
' color: red;
border-top-left-radius: 99px;
text-decoration: underline;',
$css_declarations->get_declarations_string( true, 2 )
public function data_should_compile_css_declarations_to_css_declarations_string() {
return array(
'unprettified, no indent' => array(
'expected' => 'color:red;border-top-left-radius:99px;text-decoration:underline;',
),
'unprettified, one indent' => array(
'expected' => 'color:red;border-top-left-radius:99px;text-decoration:underline;',
'should_prettify' => false,
'indent_count' => 1,
),
'prettified, no indent' => array(
'expected' => 'color: red; border-top-left-radius: 99px; text-decoration: underline;',
'should_prettify' => true,
),
'prettified, one indent' => array(
'expected' => "\tcolor: red;\n\tborder-top-left-radius: 99px;\n\ttext-decoration: underline;",
'should_prettify' => true,
'indent_count' => 1,
),
'prettified, two indents' => array(
'expected' => "\t\tcolor: red;\n\t\tborder-top-left-radius: 99px;\n\t\ttext-decoration: underline;",
'should_prettify' => true,
'indent_count' => 2,
),
);
}

Expand Down