vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-07-08 11:10:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Editor: introduce dimensions.aspectRatio block support.

Browse Source 
Adds front end rendering logic for the `dimensions.aspectRatio` block support as well as the required logic in `WP_Theme_JSON` and the style engine.

Props andrewserong.
Fixes #60365.


git-svn-id: https://develop.svn.wordpress.org/trunk@57491 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Isabel Brison
2024-01-31 02:52:25 +00:00
parent 5a59dbed82
commit 5d3f66ac5b
6 changed files with 318 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
tests/phpunit/tests/block-supports/wpRenderDimensionsSupport.php Normal file
View File

@@ -0,0 +1,176 @@
<?php
/**
* @group block-supports
*
* @covers ::wp_render_dimensions_support
*/
class Tests_Block_Supports_WpRenderDimensionsSupport extends WP_UnitTestCase {
/**
* @var string|null
*/
private $test_block_name;
/**
* Theme root directory.
*
* @var string
*/
private $theme_root;
/**
* Original theme directory.
*
* @var string
*/
private $orig_theme_dir;
public function set_up() {
parent::set_up();
$this->test_block_name = null;
$this->theme_root = realpath( DIR_TESTDATA . '/themedir1' );
$this->orig_theme_dir = $GLOBALS['wp_theme_directories'];
// /themes is necessary as theme.php functions assume /themes is the root if there is only one root.
$GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', $this->theme_root );
add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
// Clear caches.
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
}
public function tear_down() {
$GLOBALS['wp_theme_directories'] = $this->orig_theme_dir;
// Clear up the filters to modify the theme root.
remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
wp_clean_themes_cache();
unset( $GLOBALS['wp_themes'] );
WP_Style_Engine_CSS_Rules_Store::remove_all_stores();
unregister_block_type( $this->test_block_name );
$this->test_block_name = null;
parent::tear_down();
}
public function filter_set_theme_root() {
return $this->theme_root;
}
/**
* Tests that dimensions block support works as expected.
*
* @ticket 60365
*
* @covers ::wp_render_dimensions_support
*
* @dataProvider data_dimensions_block_support
*
* @param string $theme_name The theme to switch to.
* @param string $block_name The test block name to register.
* @param mixed $dimensions_settings The dimensions block support settings.
* @param mixed $dimensions_style The dimensions styles within the block attributes.
* @param string $expected_wrapper Expected markup for the block wrapper.
* @param string $wrapper Existing markup for the block wrapper.
*/
public function test_dimensions_block_support( $theme_name, $block_name, $dimensions_settings, $dimensions_style, $expected_wrapper, $wrapper ) {
switch_theme( $theme_name );
$this->test_block_name = $block_name;
register_block_type(
$this->test_block_name,
array(
'api_version' => 2,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(
'dimensions' => $dimensions_settings,
),
)
);
$block = array(
'blockName' => $block_name,
'attrs' => array(
'style' => array(
'dimensions' => $dimensions_style,
),
),
);
$actual = wp_render_dimensions_support( $wrapper, $block );
$this->assertEquals(
$expected_wrapper,
$actual,
'Dimensions block wrapper markup should be correct'
);
}
/**
* Data provider.
*
* @return array
*/
public function data_dimensions_block_support() {
return array(
'aspect ratio style is applied, with min-height unset' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/dimensions-rules-are-output',
'dimensions_settings' => array(
'aspectRatio' => true,
),
'dimensions_style' => array(
'aspectRatio' => '16/9',
),
'expected_wrapper' => '<div class="has-aspect-ratio" style="aspect-ratio:16/9;min-height:unset;">Content</div>',
'wrapper' => '<div>Content</div>',
),
'dimensions style is appended if a style attribute already exists' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/dimensions-rules-are-output',
'dimensions_settings' => array(
'aspectRatio' => true,
),
'dimensions_style' => array(
'aspectRatio' => '16/9',
),
'expected_wrapper' => '<div class="wp-block-test has-aspect-ratio" style="color:red;aspect-ratio:16/9;min-height:unset;">Content</div>',
'wrapper' => '<div class="wp-block-test" style="color:red;">Content</div>',
),
'aspect ratio style is unset if block has min-height set' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/dimensions-rules-are-output',
'dimensions_settings' => array(
'aspectRatio' => true,
),
'dimensions_style' => array(
'minHeight' => '100px',
),
'expected_wrapper' => '<div style="min-height:100px;aspect-ratio:unset;">Content</div>',
'wrapper' => '<div style="min-height:100px">Content</div>',
),
'aspect ratio style is not applied if the block does not support aspect ratio' => array(
'theme_name' => 'block-theme-child-with-fluid-typography',
'block_name' => 'test/background-rules-are-not-output',
'dimensions_settings' => array(
'aspectRatio' => false,
),
'dimensions_style' => array(
'aspectRatio' => '16/9',
),
'expected_wrapper' => '<div>Content</div>',
'wrapper' => '<div>Content</div>',
),
);
}
}

18
tests/phpunit/tests/style-engine/styleEngine.php
View File

@@ -184,6 +184,24 @@ class Tests_wpStyleEngine extends WP_UnitTestCase {
),
),
'inline_valid_aspect_ratio_style' => array(
'block_styles' => array(
'dimensions' => array(
'aspectRatio' => '4/3',
'minHeight' => 'unset',
),
),
'options' => null,
'expected_output' => array(
'css' => 'aspect-ratio:4/3;min-height:unset;',
'declarations' => array(
'aspect-ratio' => '4/3',
'min-height' => 'unset',
),
'classnames' => 'has-aspect-ratio',
),
),
'inline_valid_shadow_style' => array(
'block_styles' => array(
'shadow' => 'inset 5em 1em gold',

14
tests/phpunit/tests/theme/wpThemeJson.php
View File

@@ -279,7 +279,8 @@ class Tests_Theme_wpThemeJson extends WP_UnitTestCase {
'caption' => true,
),
'dimensions' => array(
'minHeight' => true,
'aspectRatio' => true,
'minHeight' => true,
),
'position' => array(
'sticky' => true,
@@ -316,7 +317,8 @@ class Tests_Theme_wpThemeJson extends WP_UnitTestCase {
'caption' => true,
),
'dimensions' => array(
'minHeight' => true,
'aspectRatio' => true,
'minHeight' => true,
),
'position' => array(
'sticky' => true,
@@ -495,6 +497,7 @@ class Tests_Theme_wpThemeJson extends WP_UnitTestCase {
* @ticket 56611
* @ticket 58549
* @ticket 58550
* @ticket 60365
*/
public function test_get_stylesheet() {
$theme_json = new WP_Theme_JSON(
@@ -567,6 +570,11 @@ class Tests_Theme_wpThemeJson extends WP_UnitTestCase {
),
),
'blocks' => array(
'core/cover' => array(
'dimensions' => array(
'aspectRatio' => '16/9',
),
),
'core/group' => array(
'color' => array(
'gradient' => 'var:preset|gradient|custom-gradient',
@@ -645,7 +653,7 @@ class Tests_Theme_wpThemeJson extends WP_UnitTestCase {
);
$variables = 'body{--wp--preset--color--grey: grey;--wp--preset--gradient--custom-gradient: linear-gradient(135deg,rgba(0,0,0) 0%,rgb(0,0,0) 100%);--wp--preset--font-family--small: 14px;--wp--preset--font-family--big: 41px;}.wp-block-group{--wp--custom--base-font: 16;--wp--custom--line-height--small: 1.2;--wp--custom--line-height--medium: 1.4;--wp--custom--line-height--large: 1.8;}';
$styles = 'body { margin: 0; }.wp-site-blocks > .alignleft { float: left; margin-right: 2em; }.wp-site-blocks > .alignright { float: right; margin-left: 2em; }.wp-site-blocks > .aligncenter { justify-content: center; margin-left: auto; margin-right: auto; }:where(.is-layout-flex){gap: 0.5em;}:where(.is-layout-grid){gap: 0.5em;}body .is-layout-flow > .alignleft{float: left;margin-inline-start: 0;margin-inline-end: 2em;}body .is-layout-flow > .alignright{float: right;margin-inline-start: 2em;margin-inline-end: 0;}body .is-layout-flow > .aligncenter{margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > .alignleft{float: left;margin-inline-start: 0;margin-inline-end: 2em;}body .is-layout-constrained > .alignright{float: right;margin-inline-start: 2em;margin-inline-end: 0;}body .is-layout-constrained > .aligncenter{margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > :where(:not(.alignleft):not(.alignright):not(.alignfull)){max-width: var(--wp--style--global--content-size);margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > .alignwide{max-width: var(--wp--style--global--wide-size);}body .is-layout-flex{display: flex;}body .is-layout-flex{flex-wrap: wrap;align-items: center;}body .is-layout-flex > *{margin: 0;}body .is-layout-grid{display: grid;}body .is-layout-grid > *{margin: 0;}body{color: var(--wp--preset--color--grey);}a:where(:not(.wp-element-button)){background-color: #333;color: #111;}.wp-element-button, .wp-block-button__link{box-shadow: 10px 10px 5px 0px rgba(0,0,0,0.66);}.wp-block-group{background: var(--wp--preset--gradient--custom-gradient);border-radius: 10px;padding: 24px;}.wp-block-group a:where(:not(.wp-element-button)){color: #111;}.wp-block-heading{color: #123456;}.wp-block-heading a:where(:not(.wp-element-button)){background-color: #333;color: #111;font-size: 60px;}.wp-block-post-date{color: #123456;}.wp-block-post-date a:where(:not(.wp-element-button)){background-color: #777;color: #555;}.wp-block-post-excerpt{column-count: 2;}.wp-block-image{margin-bottom: 30px;}.wp-block-image img, .wp-block-image .wp-block-image__crop-area, .wp-block-image .components-placeholder{border-top-left-radius: 10px;border-bottom-right-radius: 1em;}.wp-block-image img, .wp-block-image .components-placeholder{filter: var(--wp--preset--duotone--custom-duotone);}';
$styles = 'body { margin: 0; }.wp-site-blocks > .alignleft { float: left; margin-right: 2em; }.wp-site-blocks > .alignright { float: right; margin-left: 2em; }.wp-site-blocks > .aligncenter { justify-content: center; margin-left: auto; margin-right: auto; }:where(.is-layout-flex){gap: 0.5em;}:where(.is-layout-grid){gap: 0.5em;}body .is-layout-flow > .alignleft{float: left;margin-inline-start: 0;margin-inline-end: 2em;}body .is-layout-flow > .alignright{float: right;margin-inline-start: 2em;margin-inline-end: 0;}body .is-layout-flow > .aligncenter{margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > .alignleft{float: left;margin-inline-start: 0;margin-inline-end: 2em;}body .is-layout-constrained > .alignright{float: right;margin-inline-start: 2em;margin-inline-end: 0;}body .is-layout-constrained > .aligncenter{margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > :where(:not(.alignleft):not(.alignright):not(.alignfull)){max-width: var(--wp--style--global--content-size);margin-left: auto !important;margin-right: auto !important;}body .is-layout-constrained > .alignwide{max-width: var(--wp--style--global--wide-size);}body .is-layout-flex{display: flex;}body .is-layout-flex{flex-wrap: wrap;align-items: center;}body .is-layout-flex > *{margin: 0;}body .is-layout-grid{display: grid;}body .is-layout-grid > *{margin: 0;}body{color: var(--wp--preset--color--grey);}a:where(:not(.wp-element-button)){background-color: #333;color: #111;}.wp-element-button, .wp-block-button__link{box-shadow: 10px 10px 5px 0px rgba(0,0,0,0.66);}.wp-block-cover{min-height: unset;aspect-ratio: 16/9;}.wp-block-group{background: var(--wp--preset--gradient--custom-gradient);border-radius: 10px;padding: 24px;}.wp-block-group a:where(:not(.wp-element-button)){color: #111;}.wp-block-heading{color: #123456;}.wp-block-heading a:where(:not(.wp-element-button)){background-color: #333;color: #111;font-size: 60px;}.wp-block-post-date{color: #123456;}.wp-block-post-date a:where(:not(.wp-element-button)){background-color: #777;color: #555;}.wp-block-post-excerpt{column-count: 2;}.wp-block-image{margin-bottom: 30px;}.wp-block-image img, .wp-block-image .wp-block-image__crop-area, .wp-block-image .components-placeholder{border-top-left-radius: 10px;border-bottom-right-radius: 1em;}.wp-block-image img, .wp-block-image .components-placeholder{filter: var(--wp--preset--duotone--custom-duotone);}';
$presets = '.has-grey-color{color: var(--wp--preset--color--grey) !important;}.has-grey-background-color{background-color: var(--wp--preset--color--grey) !important;}.has-grey-border-color{border-color: var(--wp--preset--color--grey) !important;}.has-custom-gradient-gradient-background{background: var(--wp--preset--gradient--custom-gradient) !important;}.has-small-font-family{font-family: var(--wp--preset--font-family--small) !important;}.has-big-font-family{font-family: var(--wp--preset--font-family--big) !important;}';
$all = $variables . $styles . $presets;
$this->assertSame( $all, $theme_json->get_stylesheet() );