phpunit/style-engine/class-wp-style-engine-css-declarations-test.php - trunk - githubmirror/gutenberg

phpunit/style-engine/class-wp-style-engine-css-declarations-test.php
364 строки12 KB
Shail Mehta
Docs: Use `gutenberg` instead of `Gutenberg` in package name (#81051)
02 авг 2026, 09:05
02 авг 2026, 09:059594294
<?php
/**
 * Tests the Style Engine CSS declarations class.
 *
 * @package    gutenberg
 * @subpackage style-engine
 */

/**
 * Tests registering, storing and generating CSS declarations.
 *
 * @group style-engine
 * @coversDefaultClass WP_Style_Engine_CSS_Declarations_Gutenberg
 */
class WP_Style_Engine_CSS_Declarations_Test extends WP_UnitTestCase {
	/**
	 * Tests setting declarations on instantiation.
	 *
	 * @covers ::__construct
	 */
	public function test_should_instantiate_with_declarations() {
		$input_declarations = array(
			'margin-top' => '10px',
			'font-size'  => '2rem',
		);
		$css_declarations   = new WP_Style_Engine_CSS_Declarations_Gutenberg( $input_declarations );
		$this->assertSame( $input_declarations, $css_declarations->get_declarations() );
	}

	/**
	 * Tests that declarations are added.
	 *
	 * @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_Gutenberg();
		$css_declarations->add_declarations( $input_declarations );

		$this->assertSame( $input_declarations, $css_declarations->get_declarations() );
	}

	/**
	 * Tests that new declarations are added to existing declarations.
	 *
	 * @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_Gutenberg( $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.
	 *
	 * @covers ::filter_declaration
	 * @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_Gutenberg( $input_declarations );

		$this->assertSame(
			array(
				'--wp--style--sleepy-potato' => '40px',
				'background-color'           => 'var(--wp--preset--english-mustard)',
			),
			$css_declarations->get_declarations()
		);
	}

	/**
	 * Tests that values with HTML tags are escaped, and CSS properties are run through safecss_filter_attr().
	 *
	 * @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_Gutenberg( $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, minmax CSS functions and CSS custom properties are allowed.
	 *
	 * @covers ::get_declarations_string
	 * @covers ::filter_declaration
	 */
	public function test_should_allow_css_functions_and_custom_properties_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)',
			'--wp--style--unstable-gallery-gap' => '12em',
			'/::border-[<width>]'               => '2000.75em',
		);
		$css_declarations                          = new WP_Style_Engine_CSS_Declarations_Gutenberg( $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(
			11,
			$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");--wp--style--unstable-gallery-gap:12em;border-width:2000.75em;',
			$css_declarations_string,
			'Unsafe values were not removed'
		);
	}

	/**
	 * Tests that important declarations are added after CSS sanitization.
	 *
	 * @covers ::get_declarations_string
	 * @covers ::filter_declaration
	 */
	public function test_should_add_important_after_sanitizing_declarations() {
		$css_declarations = new WP_Style_Engine_CSS_Declarations_Gutenberg();
		$css_declarations->add_declaration(
			'background-image',
			'linear-gradient(135deg,rgb(119,255,112) 0%,rgb(253,254,215) 99%)',
			array(
				'important' => true,
			)
		);

		$this->assertSame(
			'background-image:linear-gradient(135deg,rgb(119,255,112) 0%,rgb(253,254,215) 99%) !important;',
			$css_declarations->get_declarations_string()
		);
	}

	/**
	 * Tests that declaration options are stored and cleared with their declarations.
	 *
	 * @covers ::add_declaration
	 * @covers ::remove_declaration
	 * @covers ::get_declaration_options
	 */
	public function test_should_store_declaration_options_by_property() {
		$css_declarations = new WP_Style_Engine_CSS_Declarations_Gutenberg();
		$css_declarations->add_declaration(
			'background-image',
			'linear-gradient(135deg,rgb(119,255,112) 0%,rgb(253,254,215) 99%)',
			array(
				'important' => true,
			)
		);

		$this->assertSame(
			array(
				'background-image' => array(
					'important' => true,
				),
			),
			$css_declarations->get_declaration_options()
		);

		$css_declarations->add_declaration( 'background-image', 'url("https://wordpress.org")' );
		$this->assertSame( array(), $css_declarations->get_declaration_options() );

		$css_declarations->add_declaration(
			'background-image',
			'linear-gradient(135deg,rgb(119,255,112) 0%,rgb(253,254,215) 99%)',
			array(
				'important' => true,
			)
		);
		$css_declarations->remove_declaration( 'background-image' );
		$this->assertSame( array(), $css_declarations->get_declaration_options() );
	}

	/**
	 * Tests that CSS declarations are compiled into a CSS declarations block string.
	 *
	 * @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_Gutenberg( $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 that non-string values are rejected without causing fatal errors.
	 *
	 * @covers ::add_declaration
	 */
	public function test_should_reject_non_string_values() {
		$css_declarations = new WP_Style_Engine_CSS_Declarations_Gutenberg();

		// Add valid string value first.
		$css_declarations->add_declaration( 'color', 'red' );

		// Try to add array value - should be silently rejected.
		$css_declarations->add_declaration( 'padding-margin', array( 'top' => '10px' ) );

		// Try to add other non-string values.
		$css_declarations->add_declaration( 'font-size', 123 );
		$css_declarations->add_declaration( 'margin', null );

		// Only the valid string value should be stored.
		$this->assertSame(
			array( 'color' => 'red' ),
			$css_declarations->get_declarations(),
			'Non-string values should be rejected without causing errors.'
		);
	}

	/**
	 * Tests removing a single declaration.
	 *
	 * @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_Gutenberg( $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.
	 *
	 * @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_Gutenberg( $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'
		);
	}
}