mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-06-28 22:30:04 +00:00
Editor: Backport Style Engine API functions, classes and tests.
This PR migrates the Style Engine PHP functions, classes and tests into Core for 6.1. It backports the original [WordPress/gutenberg#40260 PR #40260] from Gutenberg repository. Props ramonopoly, bernhard-reiter, costdev, azaozz, andrewserong, mukesh27, aristath. See #56467. git-svn-id: https://develop.svn.wordpress.org/trunk@54156 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
670
tests/phpunit/tests/style-engine/styleEngine.php
Normal file
670
tests/phpunit/tests/style-engine/styleEngine.php
Normal file
@@ -0,0 +1,670 @@
|
||||
<?php
|
||||
/**
|
||||
* Tests the Style Engine global functions that interact with the WP_Style_Engine class.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage StyleEngine
|
||||
* @since 6.1.0
|
||||
*
|
||||
* @group style-engine
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests for registering, storing and generating styles.
|
||||
*/
|
||||
class Tests_wpStyleEngine extends WP_UnitTestCase {
|
||||
/**
|
||||
* Cleans up stores after each test.
|
||||
*/
|
||||
public function tear_down() {
|
||||
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
|
||||
parent::tear_down();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests generating block styles and classnames based on various manifestations of the $block_styles argument.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_styles
|
||||
*
|
||||
* @dataProvider data_wp_style_engine_get_styles
|
||||
*
|
||||
* @param array $block_styles The incoming block styles object.
|
||||
* @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 ) {
|
||||
$generated_styles = wp_style_engine_get_styles( $block_styles, $options );
|
||||
|
||||
$this->assertSame( $expected_output, $generated_styles );
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_wp_style_engine_get_styles().
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function data_wp_style_engine_get_styles() {
|
||||
return array(
|
||||
'default_return_value' => array(
|
||||
'block_styles' => array(),
|
||||
'options' => null,
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'inline_invalid_block_styles_empty' => array(
|
||||
'block_styles' => 'hello world!',
|
||||
'options' => null,
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'inline_invalid_block_styles_unknown_style' => array(
|
||||
'block_styles' => array(
|
||||
'pageBreakAfter' => 'verso',
|
||||
),
|
||||
'options' => null,
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'inline_invalid_block_styles_unknown_definition' => array(
|
||||
'block_styles' => array(
|
||||
'pageBreakAfter' => 'verso',
|
||||
),
|
||||
'options' => null,
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'inline_invalid_block_styles_unknown_property' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'gap' => '1000vw',
|
||||
),
|
||||
),
|
||||
'options' => null,
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'valid_inline_css_and_classnames_as_default_context' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:preset|color|texas-flood',
|
||||
),
|
||||
'spacing' => array(
|
||||
'margin' => '111px',
|
||||
'padding' => '0',
|
||||
),
|
||||
'border' => array(
|
||||
'color' => 'var:preset|color|cool-caramel',
|
||||
'width' => '2rem',
|
||||
'style' => 'dotted',
|
||||
),
|
||||
),
|
||||
'options' => array( 'convert_vars_to_classnames' => true ),
|
||||
'expected_output' => array(
|
||||
'css' => 'border-style:dotted;border-width:2rem;padding:0;margin:111px;',
|
||||
'declarations' => array(
|
||||
'border-style' => 'dotted',
|
||||
'border-width' => '2rem',
|
||||
'padding' => '0',
|
||||
'margin' => '111px',
|
||||
),
|
||||
'classnames' => 'has-text-color has-texas-flood-color has-border-color has-cool-caramel-border-color',
|
||||
),
|
||||
),
|
||||
|
||||
'inline_valid_box_model_style' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'padding' => array(
|
||||
'top' => '42px',
|
||||
'left' => '2%',
|
||||
'bottom' => '44px',
|
||||
'right' => '5rem',
|
||||
),
|
||||
'margin' => array(
|
||||
'top' => '12rem',
|
||||
'left' => '2vh',
|
||||
'bottom' => '2px',
|
||||
'right' => '10em',
|
||||
),
|
||||
),
|
||||
'border' => array(
|
||||
'radius' => array(
|
||||
'topLeft' => '99px',
|
||||
'topRight' => '98px',
|
||||
'bottomLeft' => '97px',
|
||||
'bottomRight' => '96px',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => null,
|
||||
'expected_output' => array(
|
||||
'css' => 'border-top-left-radius:99px;border-top-right-radius:98px;border-bottom-left-radius:97px;border-bottom-right-radius:96px;padding-top:42px;padding-left:2%;padding-bottom:44px;padding-right:5rem;margin-top:12rem;margin-left:2vh;margin-bottom:2px;margin-right:10em;',
|
||||
'declarations' => array(
|
||||
'border-top-left-radius' => '99px',
|
||||
'border-top-right-radius' => '98px',
|
||||
'border-bottom-left-radius' => '97px',
|
||||
'border-bottom-right-radius' => '96px',
|
||||
'padding-top' => '42px',
|
||||
'padding-left' => '2%',
|
||||
'padding-bottom' => '44px',
|
||||
'padding-right' => '5rem',
|
||||
'margin-top' => '12rem',
|
||||
'margin-left' => '2vh',
|
||||
'margin-bottom' => '2px',
|
||||
'margin-right' => '10em',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'inline_valid_typography_style' => array(
|
||||
'block_styles' => array(
|
||||
'typography' => array(
|
||||
'fontSize' => 'clamp(2em, 2vw, 4em)',
|
||||
'fontFamily' => 'Roboto,Oxygen-Sans,Ubuntu,sans-serif',
|
||||
'fontStyle' => 'italic',
|
||||
'fontWeight' => '800',
|
||||
'lineHeight' => '1.3',
|
||||
'textDecoration' => 'underline',
|
||||
'textTransform' => 'uppercase',
|
||||
'letterSpacing' => '2',
|
||||
),
|
||||
),
|
||||
'options' => null,
|
||||
'expected_output' => array(
|
||||
'css' => 'font-size:clamp(2em, 2vw, 4em);font-family:Roboto,Oxygen-Sans,Ubuntu,sans-serif;font-style:italic;font-weight:800;line-height:1.3;text-decoration:underline;text-transform:uppercase;letter-spacing:2;',
|
||||
'declarations' => array(
|
||||
'font-size' => 'clamp(2em, 2vw, 4em)',
|
||||
'font-family' => 'Roboto,Oxygen-Sans,Ubuntu,sans-serif',
|
||||
'font-style' => 'italic',
|
||||
'font-weight' => '800',
|
||||
'line-height' => '1.3',
|
||||
'text-decoration' => 'underline',
|
||||
'text-transform' => 'uppercase',
|
||||
'letter-spacing' => '2',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'style_block_with_selector' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'padding' => array(
|
||||
'top' => '42px',
|
||||
'left' => '2%',
|
||||
'bottom' => '44px',
|
||||
'right' => '5rem',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array( 'selector' => '.wp-selector > p' ),
|
||||
'expected_output' => array(
|
||||
'css' => '.wp-selector > p{padding-top:42px;padding-left:2%;padding-bottom:44px;padding-right:5rem;}',
|
||||
'declarations' => array(
|
||||
'padding-top' => '42px',
|
||||
'padding-left' => '2%',
|
||||
'padding-bottom' => '44px',
|
||||
'padding-right' => '5rem',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'elements_with_css_var_value' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:preset|color|my-little-pony',
|
||||
),
|
||||
),
|
||||
'options' => array(
|
||||
'selector' => '.wp-selector',
|
||||
),
|
||||
'expected_output' => array(
|
||||
'css' => '.wp-selector{color:var(--wp--preset--color--my-little-pony);}',
|
||||
'declarations' => array(
|
||||
'color' => 'var(--wp--preset--color--my-little-pony)',
|
||||
),
|
||||
'classnames' => 'has-text-color has-my-little-pony-color',
|
||||
),
|
||||
),
|
||||
|
||||
'elements_with_invalid_preset_style_property' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:preset|invalid_property|my-little-pony',
|
||||
),
|
||||
),
|
||||
'options' => array( 'selector' => '.wp-selector' ),
|
||||
'expected_output' => array(
|
||||
'classnames' => 'has-text-color',
|
||||
),
|
||||
),
|
||||
|
||||
'valid_classnames_deduped' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:preset|color|copper-socks',
|
||||
'background' => 'var:preset|color|splendid-carrot',
|
||||
'gradient' => 'var:preset|gradient|like-wow-dude',
|
||||
),
|
||||
'typography' => array(
|
||||
'fontSize' => 'var:preset|font-size|fantastic',
|
||||
'fontFamily' => 'var:preset|font-family|totally-awesome',
|
||||
),
|
||||
),
|
||||
'options' => array( 'convert_vars_to_classnames' => true ),
|
||||
'expected_output' => array(
|
||||
'classnames' => 'has-text-color has-copper-socks-color has-background has-splendid-carrot-background-color has-like-wow-dude-gradient-background has-fantastic-font-size has-totally-awesome-font-family',
|
||||
),
|
||||
),
|
||||
|
||||
'valid_classnames_and_css_vars' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:preset|color|teal-independents',
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'color:var(--wp--preset--color--teal-independents);',
|
||||
'declarations' => array(
|
||||
'color' => 'var(--wp--preset--color--teal-independents)',
|
||||
),
|
||||
'classnames' => 'has-text-color has-teal-independents-color',
|
||||
),
|
||||
),
|
||||
|
||||
'valid_classnames_with_null_style_values' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => '#fff',
|
||||
'background' => null,
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'color:#fff;',
|
||||
'declarations' => array(
|
||||
'color' => '#fff',
|
||||
),
|
||||
'classnames' => 'has-text-color',
|
||||
),
|
||||
),
|
||||
|
||||
'invalid_classnames_preset_value' => array(
|
||||
'block_styles' => array(
|
||||
'color' => array(
|
||||
'text' => 'var:cheese|color|fantastic',
|
||||
'background' => 'var:preset|fromage|fantastic',
|
||||
),
|
||||
'spacing' => array(
|
||||
'margin' => 'var:cheese|spacing|margin',
|
||||
'padding' => 'var:preset|spacing|padding',
|
||||
),
|
||||
),
|
||||
'options' => array( 'convert_vars_to_classnames' => true ),
|
||||
'expected_output' => array(
|
||||
'classnames' => 'has-text-color has-background',
|
||||
),
|
||||
),
|
||||
|
||||
'valid_spacing_single_preset_values' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'margin' => 'var:preset|spacing|10',
|
||||
'padding' => 'var:preset|spacing|20',
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'padding:var(--wp--preset--spacing--20);margin:var(--wp--preset--spacing--10);',
|
||||
'declarations' => array(
|
||||
'padding' => 'var(--wp--preset--spacing--20)',
|
||||
'margin' => 'var(--wp--preset--spacing--10)',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'valid_spacing_multi_preset_values' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'margin' => array(
|
||||
'left' => 'var:preset|spacing|10',
|
||||
'right' => 'var:preset|spacing|20',
|
||||
'top' => '1rem',
|
||||
'bottom' => '1rem',
|
||||
),
|
||||
'padding' => array(
|
||||
'left' => 'var:preset|spacing|30',
|
||||
'right' => 'var:preset|spacing|40',
|
||||
'top' => '14px',
|
||||
'bottom' => '14px',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'padding-left:var(--wp--preset--spacing--30);padding-right:var(--wp--preset--spacing--40);padding-top:14px;padding-bottom:14px;margin-left:var(--wp--preset--spacing--10);margin-right:var(--wp--preset--spacing--20);margin-top:1rem;margin-bottom:1rem;',
|
||||
'declarations' => array(
|
||||
'padding-left' => 'var(--wp--preset--spacing--30)',
|
||||
'padding-right' => 'var(--wp--preset--spacing--40)',
|
||||
'padding-top' => '14px',
|
||||
'padding-bottom' => '14px',
|
||||
'margin-left' => 'var(--wp--preset--spacing--10)',
|
||||
'margin-right' => 'var(--wp--preset--spacing--20)',
|
||||
'margin-top' => '1rem',
|
||||
'margin-bottom' => '1rem',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'invalid_spacing_multi_preset_values' => array(
|
||||
'block_styles' => array(
|
||||
'spacing' => array(
|
||||
'margin' => array(
|
||||
'left' => 'var:preset|spaceman|10',
|
||||
'right' => 'var:preset|spaceman|20',
|
||||
'top' => '1rem',
|
||||
'bottom' => '0',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'margin-top:1rem;margin-bottom:0;',
|
||||
'declarations' => array(
|
||||
'margin-top' => '1rem',
|
||||
'margin-bottom' => '0',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'invalid_classnames_options' => array(
|
||||
'block_styles' => array(
|
||||
'typography' => array(
|
||||
'fontSize' => array(
|
||||
'tomodachi' => 'friends',
|
||||
),
|
||||
'fontFamily' => array(
|
||||
'oishii' => 'tasty',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(),
|
||||
),
|
||||
|
||||
'inline_valid_box_model_style_with_sides' => array(
|
||||
'block_styles' => array(
|
||||
'border' => array(
|
||||
'top' => array(
|
||||
'color' => '#fe1',
|
||||
'width' => '1.5rem',
|
||||
'style' => 'dashed',
|
||||
),
|
||||
'right' => array(
|
||||
'color' => '#fe2',
|
||||
'width' => '1.4rem',
|
||||
'style' => 'solid',
|
||||
),
|
||||
'bottom' => array(
|
||||
'color' => '#fe3',
|
||||
'width' => '1.3rem',
|
||||
),
|
||||
'left' => array(
|
||||
'color' => 'var:preset|color|swampy-yellow',
|
||||
'width' => '0.5rem',
|
||||
'style' => 'dotted',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'border-top-color:#fe1;border-top-width:1.5rem;border-top-style:dashed;border-right-color:#fe2;border-right-width:1.4rem;border-right-style:solid;border-bottom-color:#fe3;border-bottom-width:1.3rem;border-left-color:var(--wp--preset--color--swampy-yellow);border-left-width:0.5rem;border-left-style:dotted;',
|
||||
'declarations' => array(
|
||||
'border-top-color' => '#fe1',
|
||||
'border-top-width' => '1.5rem',
|
||||
'border-top-style' => 'dashed',
|
||||
'border-right-color' => '#fe2',
|
||||
'border-right-width' => '1.4rem',
|
||||
'border-right-style' => 'solid',
|
||||
'border-bottom-color' => '#fe3',
|
||||
'border-bottom-width' => '1.3rem',
|
||||
'border-left-color' => 'var(--wp--preset--color--swampy-yellow)',
|
||||
'border-left-width' => '0.5rem',
|
||||
'border-left-style' => 'dotted',
|
||||
),
|
||||
),
|
||||
),
|
||||
|
||||
'inline_invalid_box_model_style_with_sides' => array(
|
||||
'block_styles' => array(
|
||||
'border' => array(
|
||||
'top' => array(
|
||||
'top' => '#fe1',
|
||||
'right' => '1.5rem',
|
||||
'cheese' => 'dashed',
|
||||
),
|
||||
'right' => array(
|
||||
'right' => '#fe2',
|
||||
'top' => '1.4rem',
|
||||
'bacon' => 'solid',
|
||||
),
|
||||
'bottom' => array(
|
||||
'color' => 'var:preset|color|terrible-lizard',
|
||||
'bottom' => '1.3rem',
|
||||
),
|
||||
'left' => array(
|
||||
'left' => null,
|
||||
'width' => null,
|
||||
'top' => 'dotted',
|
||||
),
|
||||
),
|
||||
),
|
||||
'options' => array(),
|
||||
'expected_output' => array(
|
||||
'css' => 'border-bottom-color:var(--wp--preset--color--terrible-lizard);',
|
||||
'declarations' => array(
|
||||
'border-bottom-color' => 'var(--wp--preset--color--terrible-lizard)',
|
||||
),
|
||||
),
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding rules to a store and retrieving a generated stylesheet.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_styles
|
||||
*/
|
||||
public function test_should_store_block_styles_using_context() {
|
||||
$block_styles = array(
|
||||
'spacing' => array(
|
||||
'padding' => array(
|
||||
'top' => '42px',
|
||||
'left' => '2%',
|
||||
'bottom' => '44px',
|
||||
'right' => '5rem',
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$generated_styles = wp_style_engine_get_styles(
|
||||
$block_styles,
|
||||
array(
|
||||
'context' => 'block-supports',
|
||||
'selector' => 'article',
|
||||
)
|
||||
);
|
||||
$store = WP_Style_Engine::get_store( 'block-supports' );
|
||||
$rule = $store->get_all_rules()['article'];
|
||||
|
||||
$this->assertSame( $generated_styles['css'], $rule->get_css() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that passing no context does not store styles.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_styles
|
||||
*/
|
||||
public function test_should_not_store_block_styles_without_context() {
|
||||
$block_styles = array(
|
||||
'typography' => array(
|
||||
'fontSize' => '999px',
|
||||
),
|
||||
);
|
||||
|
||||
wp_style_engine_get_styles(
|
||||
$block_styles,
|
||||
array(
|
||||
'selector' => '#font-size-rulez',
|
||||
)
|
||||
);
|
||||
|
||||
$all_stores = WP_Style_Engine_CSS_Rules_Store::get_stores();
|
||||
|
||||
$this->assertEmpty( $all_stores );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding rules to a store and retrieving a generated stylesheet.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_stylesheet_from_context
|
||||
*/
|
||||
public function test_should_get_stored_stylesheet_from_context() {
|
||||
$css_rules = array(
|
||||
array(
|
||||
'selector' => '.frodo',
|
||||
'declarations' => array(
|
||||
'color' => 'brown',
|
||||
'height' => '10px',
|
||||
'width' => '30px',
|
||||
'border-style' => 'dotted',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.samwise',
|
||||
'declarations' => array(
|
||||
'color' => 'brown',
|
||||
'height' => '20px',
|
||||
'width' => '50px',
|
||||
'border-style' => 'solid',
|
||||
),
|
||||
),
|
||||
);
|
||||
$compiled_stylesheet = wp_style_engine_get_stylesheet_from_css_rules(
|
||||
$css_rules,
|
||||
array(
|
||||
'context' => 'test-store',
|
||||
)
|
||||
);
|
||||
|
||||
$this->assertSame( $compiled_stylesheet, wp_style_engine_get_stylesheet_from_context( 'test-store' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests returning a generated stylesheet from a set of rules.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_stylesheet_from_css_rules
|
||||
*/
|
||||
public function test_should_return_stylesheet_from_css_rules() {
|
||||
$css_rules = array(
|
||||
array(
|
||||
'selector' => '.saruman',
|
||||
'declarations' => array(
|
||||
'color' => 'white',
|
||||
'height' => '100px',
|
||||
'border-style' => 'solid',
|
||||
'align-self' => 'unset',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.gandalf',
|
||||
'declarations' => array(
|
||||
'color' => 'grey',
|
||||
'height' => '90px',
|
||||
'border-style' => 'dotted',
|
||||
'align-self' => 'safe center',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.radagast',
|
||||
'declarations' => array(
|
||||
'color' => 'brown',
|
||||
'height' => '60px',
|
||||
'border-style' => 'dashed',
|
||||
'align-self' => 'stretch',
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$compiled_stylesheet = wp_style_engine_get_stylesheet_from_css_rules( $css_rules, array( 'prettify' => false ) );
|
||||
|
||||
$this->assertSame( '.saruman{color:white;height:100px;border-style:solid;align-self:unset;}.gandalf{color:grey;height:90px;border-style:dotted;align-self:safe center;}.radagast{color:brown;height:60px;border-style:dashed;align-self:stretch;}', $compiled_stylesheet );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that incoming styles are deduped and merged.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::wp_style_engine_get_stylesheet_from_css_rules
|
||||
*/
|
||||
public function test_should_dedupe_and_merge_css_rules() {
|
||||
$css_rules = array(
|
||||
array(
|
||||
'selector' => '.gandalf',
|
||||
'declarations' => array(
|
||||
'color' => 'grey',
|
||||
'height' => '90px',
|
||||
'border-style' => 'dotted',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.gandalf',
|
||||
'declarations' => array(
|
||||
'color' => 'white',
|
||||
'height' => '190px',
|
||||
'padding' => '10px',
|
||||
'margin-bottom' => '100px',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.dumbledore',
|
||||
'declarations' => array(
|
||||
'color' => 'grey',
|
||||
'height' => '90px',
|
||||
'border-style' => 'dotted',
|
||||
),
|
||||
),
|
||||
array(
|
||||
'selector' => '.rincewind',
|
||||
'declarations' => array(
|
||||
'color' => 'grey',
|
||||
'height' => '90px',
|
||||
'border-style' => 'dotted',
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
$compiled_stylesheet = wp_style_engine_get_stylesheet_from_css_rules( $css_rules, array( 'prettify' => false ) );
|
||||
|
||||
$this->assertSame( '.gandalf{color:white;height:190px;border-style:dotted;padding:10px;margin-bottom:100px;}.dumbledore,.rincewind{color:grey;height:90px;border-style:dotted;}', $compiled_stylesheet );
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,293 @@
|
||||
<?php
|
||||
/**
|
||||
* Tests the Style Engine CSS declarations class.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage StyleEngine
|
||||
* @since 6.1.0
|
||||
*
|
||||
* @group style-engine
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests registering, storing and generating CSS declarations.
|
||||
*
|
||||
* @coversDefaultClass WP_Style_Engine_CSS_Declarations
|
||||
*/
|
||||
class Tests_Style_Engine_wpStyleEngineCSSDeclarations extends WP_UnitTestCase {
|
||||
/**
|
||||
* Tests setting declarations on instantiation.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::__construct
|
||||
*/
|
||||
public function test_should_set_declarations_on_instantiation() {
|
||||
$input_declarations = array(
|
||||
'margin-top' => '10px',
|
||||
'font-size' => '2rem',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
|
||||
$this->assertSame( $input_declarations, $css_declarations->get_declarations() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that declarations are added.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_declarations
|
||||
* @covers ::add_declaration
|
||||
*/
|
||||
public function test_should_add_declarations() {
|
||||
$input_declarations = array(
|
||||
'padding' => '20px',
|
||||
'color' => 'var(--wp--preset--elbow-patches)',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations();
|
||||
$css_declarations->add_declarations( $input_declarations );
|
||||
|
||||
$this->assertSame( $input_declarations, $css_declarations->get_declarations() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that new declarations are added to existing declarations.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_declarations
|
||||
* @covers ::add_declaration
|
||||
*/
|
||||
public function test_should_add_new_declarations_to_existing() {
|
||||
$input_declarations = array(
|
||||
'border-width' => '1%',
|
||||
'background-color' => 'var(--wp--preset--english-mustard)',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$extra_declaration = array(
|
||||
'letter-spacing' => '1.5px',
|
||||
);
|
||||
$css_declarations->add_declarations( $extra_declaration );
|
||||
|
||||
$this->assertSame( array_merge( $input_declarations, $extra_declaration ), $css_declarations->get_declarations() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that properties are sanitized before storing.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::sanitize_property
|
||||
*/
|
||||
public function test_should_sanitize_properties() {
|
||||
$input_declarations = array(
|
||||
'^--wp--style--sleepy-potato$' => '40px',
|
||||
'<background-//color>' => 'var(--wp--preset--english-mustard)',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
|
||||
$this->assertSame(
|
||||
array(
|
||||
'--wp--style--sleepy-potato' => '40px',
|
||||
'background-color' => 'var(--wp--preset--english-mustard)',
|
||||
),
|
||||
$css_declarations->get_declarations()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test that values with HTML tags are escaped, and CSS properties are run through safecss_filter_attr().
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_declarations_string
|
||||
* @covers ::filter_declaration
|
||||
*/
|
||||
public function test_should_strip_html_tags_and_remove_unsafe_css_properties() {
|
||||
$input_declarations = array(
|
||||
'font-size' => '<red/>',
|
||||
'padding' => '</style>',
|
||||
'potato' => 'uppercase',
|
||||
'cheese' => '10px',
|
||||
'margin-right' => '10em',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$safe_style_css_mock_action = new MockAction();
|
||||
|
||||
// filter_declaration() is called in get_declarations_string().
|
||||
add_filter( 'safe_style_css', array( $safe_style_css_mock_action, 'filter' ) );
|
||||
$css_declarations_string = $css_declarations->get_declarations_string();
|
||||
|
||||
$this->assertSame(
|
||||
3, // Values with HTML tags are removed first by wp_strip_all_tags().
|
||||
$safe_style_css_mock_action->get_call_count(),
|
||||
'"safe_style_css" filters were not applied to CSS declaration properties.'
|
||||
);
|
||||
|
||||
$this->assertSame(
|
||||
'margin-right:10em;',
|
||||
$css_declarations_string,
|
||||
'Unallowed CSS properties or values with HTML tags were not removed.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that calc, clamp, min, max, and minmax CSS functions are allowed.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_declarations_string
|
||||
* @covers ::filter_declaration
|
||||
*/
|
||||
public function test_should_allow_css_functions_and_strip_unsafe_css_values() {
|
||||
$input_declarations = array(
|
||||
'background' => 'var(--wp--preset--color--primary, 10px)', // Simple var().
|
||||
'font-size' => 'clamp(36.00rem, calc(32.00rem + 10.00vw), 40.00rem)', // Nested clamp().
|
||||
'width' => 'min(150vw, 100px)',
|
||||
'min-width' => 'max(150vw, 100px)',
|
||||
'max-width' => 'minmax(400px, 50%)',
|
||||
'padding' => 'calc(80px * -1)',
|
||||
'background-image' => 'url("https://wordpress.org")',
|
||||
'line-height' => 'url("https://wordpress.org")',
|
||||
'margin' => 'illegalfunction(30px)',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$safecss_filter_attr_allow_css_mock_action = new MockAction();
|
||||
|
||||
// filter_declaration() is called in get_declarations_string().
|
||||
add_filter( 'safecss_filter_attr_allow_css', array( $safecss_filter_attr_allow_css_mock_action, 'filter' ) );
|
||||
$css_declarations_string = $css_declarations->get_declarations_string();
|
||||
|
||||
$this->assertSame(
|
||||
9,
|
||||
$safecss_filter_attr_allow_css_mock_action->get_call_count(),
|
||||
'"safecss_filter_attr_allow_css" filters were not applied to CSS declaration values.'
|
||||
);
|
||||
|
||||
$this->assertSame(
|
||||
'background:var(--wp--preset--color--primary, 10px);font-size:clamp(36.00rem, calc(32.00rem + 10.00vw), 40.00rem);width:min(150vw, 100px);min-width:max(150vw, 100px);max-width:minmax(400px, 50%);padding:calc(80px * -1);background-image:url("https://wordpress.org");',
|
||||
$css_declarations_string,
|
||||
'Unsafe values were not removed'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that CSS declarations are compiled into a CSS declarations block string.
|
||||
*
|
||||
* @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_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(
|
||||
$expected,
|
||||
$css_declarations->get_declarations_string( $should_prettify, $indent_count )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_should_compile_css_declarations_to_css_declarations_string().
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
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,
|
||||
),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests removing a single declaration.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::remove_declaration
|
||||
*/
|
||||
public function test_should_remove_single_declaration() {
|
||||
$input_declarations = array(
|
||||
'color' => 'tomato',
|
||||
'margin' => '10em 10em 20em 1px',
|
||||
'font-family' => 'Happy Font serif',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
|
||||
$this->assertSame(
|
||||
'color:tomato;margin:10em 10em 20em 1px;font-family:Happy Font serif;',
|
||||
$css_declarations->get_declarations_string(),
|
||||
'CSS declarations string does not match the values of `$declarations` passed to the constructor.'
|
||||
);
|
||||
|
||||
$css_declarations->remove_declaration( 'color' );
|
||||
|
||||
$this->assertSame(
|
||||
'margin:10em 10em 20em 1px;font-family:Happy Font serif;',
|
||||
$css_declarations->get_declarations_string(),
|
||||
'Output after removing "color" declaration via `remove_declaration()` does not match expectations'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that multiple declarations are removed.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::remove_declarations
|
||||
*/
|
||||
public function test_should_remove_multiple_declarations() {
|
||||
$input_declarations = array(
|
||||
'color' => 'cucumber',
|
||||
'margin' => '10em 10em 20em 1px',
|
||||
'font-family' => 'Happy Font serif',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
|
||||
$this->assertSame(
|
||||
'color:cucumber;margin:10em 10em 20em 1px;font-family:Happy Font serif;',
|
||||
$css_declarations->get_declarations_string(),
|
||||
'CSS declarations string does not match the values of `$declarations` passed to the constructor.'
|
||||
);
|
||||
|
||||
$css_declarations->remove_declarations( array( 'color', 'margin' ) );
|
||||
|
||||
$this->assertSame(
|
||||
'font-family:Happy Font serif;',
|
||||
$css_declarations->get_declarations_string(),
|
||||
'Output after removing "color" and "margin" declarations via `remove_declarations()` does not match expectations'
|
||||
);
|
||||
}
|
||||
}
|
||||
161
tests/phpunit/tests/style-engine/wpStyleEngineCssRule.php
Normal file
161
tests/phpunit/tests/style-engine/wpStyleEngineCssRule.php
Normal file
@@ -0,0 +1,161 @@
|
||||
<?php
|
||||
/**
|
||||
* Tests the Style Engine CSS Rule class.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage StyleEngine
|
||||
* @since 6.1.0
|
||||
*
|
||||
* @group style-engine
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests for registering, storing and generating CSS rules.
|
||||
*
|
||||
* @coversDefaultClass WP_Style_Engine_CSS_Rule
|
||||
*/
|
||||
class Tests_Style_Engine_wpStyleEngineCSSRule extends WP_UnitTestCase {
|
||||
/**
|
||||
* Tests that declarations are set on instantiation.
|
||||
*
|
||||
* @ticket 56467
|
||||
* @covers ::__construct
|
||||
*/
|
||||
public function test_should_instantiate_with_selector_and_rules() {
|
||||
$selector = '.law-and-order';
|
||||
$input_declarations = array(
|
||||
'margin-top' => '10px',
|
||||
'font-size' => '2rem',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector, $css_declarations );
|
||||
|
||||
$this->assertSame( $selector, $css_rule->get_selector(), 'Return value of get_selector() does not match value passed to constructor.' );
|
||||
|
||||
$expected = "$selector{{$css_declarations->get_declarations_string()}}";
|
||||
|
||||
$this->assertSame( $expected, $css_rule->get_css(), 'Value returned by get_css() does not match expected declarations string.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that declaration properties are deduplicated.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_declarations
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_dedupe_properties_in_rules() {
|
||||
$selector = '.taggart';
|
||||
$first_declaration = array(
|
||||
'font-size' => '2rem',
|
||||
);
|
||||
$overwrite_first_declaration = array(
|
||||
'font-size' => '4px',
|
||||
);
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector, $first_declaration );
|
||||
$css_rule->add_declarations( new WP_Style_Engine_CSS_Declarations( $overwrite_first_declaration ) );
|
||||
|
||||
$expected = '.taggart{font-size:4px;}';
|
||||
|
||||
$this->assertSame( $expected, $css_rule->get_css() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that declarations can be added to existing rules.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_declarations
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_add_declarations_to_existing_rules() {
|
||||
// Declarations using a WP_Style_Engine_CSS_Declarations object.
|
||||
$some_css_declarations = new WP_Style_Engine_CSS_Declarations( array( 'margin-top' => '10px' ) );
|
||||
// Declarations using a property => value array.
|
||||
$some_more_css_declarations = array( 'font-size' => '1rem' );
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( '.hill-street-blues', $some_css_declarations );
|
||||
$css_rule->add_declarations( $some_more_css_declarations );
|
||||
|
||||
$expected = '.hill-street-blues{margin-top:10px;font-size:1rem;}';
|
||||
|
||||
$this->assertSame( $expected, $css_rule->get_css() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests setting a selector to a rule.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::set_selector
|
||||
*/
|
||||
public function test_should_set_selector() {
|
||||
$selector = '.taggart';
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector );
|
||||
|
||||
$this->assertSame( $selector, $css_rule->get_selector(), 'Return value of get_selector() does not match value passed to constructor.' );
|
||||
|
||||
$css_rule->set_selector( '.law-and-order' );
|
||||
|
||||
$this->assertSame( '.law-and-order', $css_rule->get_selector(), 'Return value of get_selector() does not match value passed to set_selector().' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests generating a CSS rule string.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_generate_css_rule_string() {
|
||||
$selector = '.chips';
|
||||
$input_declarations = array(
|
||||
'margin-top' => '10px',
|
||||
'font-size' => '2rem',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector, $css_declarations );
|
||||
$expected = "$selector{{$css_declarations->get_declarations_string()}}";
|
||||
|
||||
$this->assertSame( $expected, $css_rule->get_css() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that an empty string will be returned where there are no declarations in a CSS rule.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_return_empty_string_with_no_declarations() {
|
||||
$selector = '.holmes';
|
||||
$input_declarations = array();
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector, $css_declarations );
|
||||
|
||||
$this->assertSame( '', $css_rule->get_css() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that CSS rules are prettified.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_prettify_css_rule_output() {
|
||||
$selector = '.baptiste';
|
||||
$input_declarations = array(
|
||||
'margin-left' => '0',
|
||||
'font-family' => 'Detective Sans',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $input_declarations );
|
||||
$css_rule = new WP_Style_Engine_CSS_Rule( $selector, $css_declarations );
|
||||
$expected = '.baptiste {
|
||||
margin-left: 0;
|
||||
font-family: Detective Sans;
|
||||
}';
|
||||
|
||||
$this->assertSame( $expected, $css_rule->get_css( true ) );
|
||||
}
|
||||
}
|
||||
190
tests/phpunit/tests/style-engine/wpStyleEngineCssRulesStore.php
Normal file
190
tests/phpunit/tests/style-engine/wpStyleEngineCssRulesStore.php
Normal file
@@ -0,0 +1,190 @@
|
||||
<?php
|
||||
/**
|
||||
* Tests the Style Engine CSS Rules Store class.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage StyleEngine
|
||||
* @since 6.1.0
|
||||
*
|
||||
* @group style-engine
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests for registering, storing and retrieving a collection of CSS Rules (a store).
|
||||
*
|
||||
* @coversDefaultClass WP_Style_Engine_CSS_Rules_Store
|
||||
*/
|
||||
class Tests_Style_Engine_wpStyleEngineCSSRulesStore extends WP_UnitTestCase {
|
||||
/**
|
||||
* Cleans up stores after each test.
|
||||
*/
|
||||
public function tear_down() {
|
||||
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
|
||||
parent::tear_down();
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests creating a new store on instantiation.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::__construct
|
||||
*/
|
||||
public function test_should_create_new_store_on_instantiation() {
|
||||
$new_pancakes_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'pancakes-with-strawberries' );
|
||||
|
||||
$this->assertInstanceOf( 'WP_Style_Engine_CSS_Rules_Store', $new_pancakes_store );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that a `$store_name` argument is required and no store will be created without one.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_store
|
||||
*/
|
||||
public function test_should_not_create_store_without_a_store_name() {
|
||||
$not_a_store = WP_Style_Engine_CSS_Rules_Store::get_store( '' );
|
||||
|
||||
$this->assertEmpty( $not_a_store, 'get_store() did not return an empty value with empty string as argument.' );
|
||||
|
||||
$also_not_a_store = WP_Style_Engine_CSS_Rules_Store::get_store( 123 );
|
||||
|
||||
$this->assertEmpty( $also_not_a_store, 'get_store() did not return an empty value with number as argument.' );
|
||||
|
||||
$definitely_not_a_store = WP_Style_Engine_CSS_Rules_Store::get_store( null );
|
||||
|
||||
$this->assertEmpty( $definitely_not_a_store, 'get_store() did not return an empty value with `null` as argument.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests returning a previously created store when the same selector key is passed.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_store
|
||||
*/
|
||||
public function test_should_return_existing_store() {
|
||||
$new_fish_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'fish-n-chips' );
|
||||
$selector = '.haddock';
|
||||
|
||||
$new_fish_store->add_rule( $selector );
|
||||
|
||||
$this->assertSame( $selector, $new_fish_store->add_rule( $selector )->get_selector(), 'Selector string of store rule does not match expected value' );
|
||||
|
||||
$the_same_fish_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'fish-n-chips' );
|
||||
|
||||
$this->assertSame( $selector, $the_same_fish_store->add_rule( $selector )->get_selector(), 'Selector string of existing store rule does not match expected value' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests returning all previously created stores.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_stores
|
||||
*/
|
||||
public function test_should_get_all_existing_stores() {
|
||||
$burrito_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'burrito' );
|
||||
$quesadilla_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'quesadilla' );
|
||||
|
||||
$this->assertEquals(
|
||||
array(
|
||||
'burrito' => $burrito_store,
|
||||
'quesadilla' => $quesadilla_store,
|
||||
),
|
||||
WP_Style_Engine_CSS_Rules_Store::get_stores()
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that all previously created stores are deleted.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::remove_all_stores
|
||||
*/
|
||||
public function test_should_remove_all_stores() {
|
||||
$dolmades_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'dolmades' );
|
||||
$tzatziki_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'tzatziki' );
|
||||
|
||||
$this->assertEquals(
|
||||
array(
|
||||
'dolmades' => $dolmades_store,
|
||||
'tzatziki' => $tzatziki_store,
|
||||
),
|
||||
WP_Style_Engine_CSS_Rules_Store::get_stores(),
|
||||
'Return value of get_stores() does not match expectation'
|
||||
);
|
||||
|
||||
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
|
||||
|
||||
$this->assertEquals(
|
||||
array(),
|
||||
WP_Style_Engine_CSS_Rules_Store::get_stores(),
|
||||
'Return value of get_stores() is not an empty array after remove_all_stores() called.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding rules to an existing store.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_rule
|
||||
*/
|
||||
public function test_should_add_rule_to_existing_store() {
|
||||
$new_pie_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'meat-pie' );
|
||||
$selector = '.wp-block-sauce a:hover';
|
||||
$store_rule = $new_pie_store->add_rule( $selector );
|
||||
$expected = '';
|
||||
|
||||
$this->assertSame( $expected, $store_rule->get_css(), 'Return value of get_css() is not a empty string where a rule has no CSS declarations.' );
|
||||
|
||||
$pie_declarations = array(
|
||||
'color' => 'brown',
|
||||
'border-color' => 'yellow',
|
||||
'border-radius' => '10rem',
|
||||
);
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $pie_declarations );
|
||||
$store_rule->add_declarations( $css_declarations );
|
||||
$store_rule = $new_pie_store->add_rule( $selector );
|
||||
|
||||
$expected = "$selector{{$css_declarations->get_declarations_string()}}";
|
||||
|
||||
$this->assertSame( $expected, $store_rule->get_css(), 'Return value of get_css() does not match expected CSS from existing store rules.' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that all stored rule objects are returned.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_all_rules
|
||||
*/
|
||||
public function test_should_get_all_rule_objects_for_a_store() {
|
||||
$new_pizza_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'pizza-with-mozzarella' );
|
||||
$selector = '.wp-block-anchovies a:hover';
|
||||
$store_rule = $new_pizza_store->add_rule( $selector );
|
||||
$expected = array(
|
||||
$selector => $store_rule,
|
||||
);
|
||||
|
||||
$this->assertSame( $expected, $new_pizza_store->get_all_rules(), 'Return value for get_all_rules() does not match expectations.' );
|
||||
|
||||
$new_selector = '.wp-block-mushroom a:hover';
|
||||
$newer_pizza_declarations = array(
|
||||
'padding' => '100px',
|
||||
);
|
||||
$new_store_rule = $new_pizza_store->add_rule( $new_selector );
|
||||
$css_declarations = new WP_Style_Engine_CSS_Declarations( $newer_pizza_declarations );
|
||||
$new_store_rule->add_declarations( array( $css_declarations ) );
|
||||
|
||||
$expected = array(
|
||||
$selector => $store_rule,
|
||||
$new_selector => $new_store_rule,
|
||||
);
|
||||
|
||||
$this->assertSame( $expected, $new_pizza_store->get_all_rules(), 'Return value for get_all_rules() does not match expectations after adding new rules to store.' );
|
||||
}
|
||||
}
|
||||
315
tests/phpunit/tests/style-engine/wpStyleEngineProcessor.php
Normal file
315
tests/phpunit/tests/style-engine/wpStyleEngineProcessor.php
Normal file
@@ -0,0 +1,315 @@
|
||||
<?php
|
||||
/**
|
||||
* Tests the Style Engine Processor class.
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage StyleEngine
|
||||
* @since 6.1.0
|
||||
*
|
||||
* @group style-engine
|
||||
*/
|
||||
|
||||
/**
|
||||
* Tests for compiling and rendering styles from a store of CSS rules.
|
||||
*
|
||||
* @coversDefaultClass WP_Style_Engine_Processor
|
||||
*/
|
||||
class Tests_Style_Engine_wpStyleEngineProcessor extends WP_UnitTestCase {
|
||||
/**
|
||||
* Tests adding rules and returning compiled CSS rules.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_rules
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_return_rules_as_compiled_css() {
|
||||
$a_nice_css_rule = new WP_Style_Engine_CSS_Rule( '.a-nice-rule' );
|
||||
$a_nice_css_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--nice-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_nicer_css_rule = new WP_Style_Engine_CSS_Rule( '.a-nicer-rule' );
|
||||
$a_nicer_css_rule->add_declarations(
|
||||
array(
|
||||
'font-family' => 'Nice sans',
|
||||
'font-size' => '1em',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_nice_processor = new WP_Style_Engine_Processor();
|
||||
$a_nice_processor->add_rules( array( $a_nice_css_rule, $a_nicer_css_rule ) );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-nice-rule{color:var(--nice-color);background-color:purple;}.a-nicer-rule{font-family:Nice sans;font-size:1em;background-color:purple;}',
|
||||
$a_nice_processor->get_css( array( 'prettify' => false ) )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests compiling CSS rules and formatting them with new lines and indents.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_return_prettified_css_rules() {
|
||||
$a_wonderful_css_rule = new WP_Style_Engine_CSS_Rule( '.a-wonderful-rule' );
|
||||
$a_wonderful_css_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--wonderful-color)',
|
||||
'background-color' => 'orange',
|
||||
)
|
||||
);
|
||||
$a_very_wonderful_css_rule = new WP_Style_Engine_CSS_Rule( '.a-very_wonderful-rule' );
|
||||
$a_very_wonderful_css_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--wonderful-color)',
|
||||
'background-color' => 'orange',
|
||||
)
|
||||
);
|
||||
$a_more_wonderful_css_rule = new WP_Style_Engine_CSS_Rule( '.a-more-wonderful-rule' );
|
||||
$a_more_wonderful_css_rule->add_declarations(
|
||||
array(
|
||||
'font-family' => 'Wonderful sans',
|
||||
'font-size' => '1em',
|
||||
'background-color' => 'orange',
|
||||
)
|
||||
);
|
||||
$a_wonderful_processor = new WP_Style_Engine_Processor();
|
||||
$a_wonderful_processor->add_rules( array( $a_wonderful_css_rule, $a_very_wonderful_css_rule, $a_more_wonderful_css_rule ) );
|
||||
|
||||
$expected = '.a-more-wonderful-rule {
|
||||
font-family: Wonderful sans;
|
||||
font-size: 1em;
|
||||
background-color: orange;
|
||||
}
|
||||
.a-wonderful-rule,
|
||||
.a-very_wonderful-rule {
|
||||
color: var(--wonderful-color);
|
||||
background-color: orange;
|
||||
}
|
||||
';
|
||||
$this->assertSame(
|
||||
$expected,
|
||||
$a_wonderful_processor->get_css( array( 'prettify' => true ) )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests adding a store and compiling CSS rules from that store.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_store
|
||||
*/
|
||||
public function test_should_return_store_rules_as_css() {
|
||||
$a_nice_store = WP_Style_Engine_CSS_Rules_Store::get_store( 'nice' );
|
||||
$a_nice_store->add_rule( '.a-nice-rule' )->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--nice-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_nice_store->add_rule( '.a-nicer-rule' )->add_declarations(
|
||||
array(
|
||||
'font-family' => 'Nice sans',
|
||||
'font-size' => '1em',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_nice_renderer = new WP_Style_Engine_Processor();
|
||||
$a_nice_renderer->add_store( $a_nice_store );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-nice-rule{color:var(--nice-color);background-color:purple;}.a-nicer-rule{font-family:Nice sans;font-size:1em;background-color:purple;}',
|
||||
$a_nice_renderer->get_css( array( 'prettify' => false ) )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that CSS declarations are merged and deduped in the final CSS rules output.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_rules
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_dedupe_and_merge_css_declarations() {
|
||||
$an_excellent_rule = new WP_Style_Engine_CSS_Rule( '.an-excellent-rule' );
|
||||
$an_excellent_processor = new WP_Style_Engine_Processor();
|
||||
$an_excellent_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--excellent-color)',
|
||||
'border-style' => 'dotted',
|
||||
)
|
||||
);
|
||||
$an_excellent_processor->add_rules( $an_excellent_rule );
|
||||
|
||||
$another_excellent_rule = new WP_Style_Engine_CSS_Rule( '.an-excellent-rule' );
|
||||
$another_excellent_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--excellent-color)',
|
||||
'border-style' => 'dotted',
|
||||
'border-color' => 'brown',
|
||||
)
|
||||
);
|
||||
$an_excellent_processor->add_rules( $another_excellent_rule );
|
||||
|
||||
$this->assertSame(
|
||||
'.an-excellent-rule{color:var(--excellent-color);border-style:dotted;border-color:brown;}',
|
||||
$an_excellent_processor->get_css( array( 'prettify' => false ) ),
|
||||
'Return value of get_css() does not match expectations with new, deduped and merged declarations.'
|
||||
);
|
||||
|
||||
$yet_another_excellent_rule = new WP_Style_Engine_CSS_Rule( '.an-excellent-rule' );
|
||||
$yet_another_excellent_rule->add_declarations(
|
||||
array(
|
||||
'color' => 'var(--excellent-color)',
|
||||
'border-style' => 'dashed',
|
||||
'border-width' => '2px',
|
||||
)
|
||||
);
|
||||
$an_excellent_processor->add_rules( $yet_another_excellent_rule );
|
||||
|
||||
$this->assertSame(
|
||||
'.an-excellent-rule{color:var(--excellent-color);border-style:dashed;border-color:brown;border-width:2px;}',
|
||||
$an_excellent_processor->get_css( array( 'prettify' => false ) ),
|
||||
'Return value of get_css() does not match expectations with deduped and merged declarations.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests printing out 'unoptimized' CSS, that is, uncombined selectors and duplicate CSS rules.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_not_optimize_css_output() {
|
||||
$a_sweet_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-sweet-rule',
|
||||
array(
|
||||
'color' => 'var(--sweet-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
|
||||
$a_sweeter_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'#an-even-sweeter-rule > marquee',
|
||||
array(
|
||||
'color' => 'var(--sweet-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
|
||||
$the_sweetest_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.the-sweetest-rule-of-all a',
|
||||
array(
|
||||
'color' => 'var(--sweet-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
|
||||
$a_sweet_processor = new WP_Style_Engine_Processor();
|
||||
$a_sweet_processor->add_rules( array( $a_sweet_rule, $a_sweeter_rule, $the_sweetest_rule ) );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-sweet-rule{color:var(--sweet-color);background-color:purple;}#an-even-sweeter-rule > marquee{color:var(--sweet-color);background-color:purple;}.the-sweetest-rule-of-all a{color:var(--sweet-color);background-color:purple;}',
|
||||
$a_sweet_processor->get_css(
|
||||
array(
|
||||
'optimize' => false,
|
||||
'prettify' => false,
|
||||
)
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that 'optimized' CSS is output, that is, that duplicate CSS rules are combined under their corresponding selectors.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::get_css
|
||||
*/
|
||||
public function test_should_optimize_css_output_by_default() {
|
||||
$a_sweet_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-sweet-rule',
|
||||
array(
|
||||
'color' => 'var(--sweet-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
|
||||
$a_sweeter_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'#an-even-sweeter-rule > marquee',
|
||||
array(
|
||||
'color' => 'var(--sweet-color)',
|
||||
'background-color' => 'purple',
|
||||
)
|
||||
);
|
||||
|
||||
$a_sweet_processor = new WP_Style_Engine_Processor();
|
||||
$a_sweet_processor->add_rules( array( $a_sweet_rule, $a_sweeter_rule ) );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-sweet-rule,#an-even-sweeter-rule > marquee{color:var(--sweet-color);background-color:purple;}',
|
||||
$a_sweet_processor->get_css( array( 'prettify' => false ) )
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests that incoming CSS rules are merged with existing CSS rules.
|
||||
*
|
||||
* @ticket 56467
|
||||
*
|
||||
* @covers ::add_rules
|
||||
*/
|
||||
public function test_should_combine_previously_added_css_rules() {
|
||||
$a_lovely_processor = new WP_Style_Engine_Processor();
|
||||
$a_lovely_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-lovely-rule',
|
||||
array(
|
||||
'border-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_lovely_processor->add_rules( $a_lovely_rule );
|
||||
$a_lovelier_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-lovelier-rule',
|
||||
array(
|
||||
'border-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_lovely_processor->add_rules( $a_lovelier_rule );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-lovely-rule,.a-lovelier-rule{border-color:purple;}',
|
||||
$a_lovely_processor->get_css( array( 'prettify' => false ) ),
|
||||
'Return value of get_css() does not match expectations when combining 2 CSS rules'
|
||||
);
|
||||
|
||||
$a_most_lovely_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-most-lovely-rule',
|
||||
array(
|
||||
'border-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_lovely_processor->add_rules( $a_most_lovely_rule );
|
||||
|
||||
$a_perfectly_lovely_rule = new WP_Style_Engine_CSS_Rule(
|
||||
'.a-perfectly-lovely-rule',
|
||||
array(
|
||||
'border-color' => 'purple',
|
||||
)
|
||||
);
|
||||
$a_lovely_processor->add_rules( $a_perfectly_lovely_rule );
|
||||
|
||||
$this->assertSame(
|
||||
'.a-lovely-rule,.a-lovelier-rule,.a-most-lovely-rule,.a-perfectly-lovely-rule{border-color:purple;}',
|
||||
$a_lovely_processor->get_css( array( 'prettify' => false ) ),
|
||||
'Return value of get_css() does not match expectations when combining 4 CSS rules'
|
||||
);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user