Skip to content
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

add support for __experimentalSkiSerialization to the shadow attribute #6279

Closed
wants to merge 4 commits into from
Closed

add support for __experimentalSkiSerialization to the shadow attribute #6279

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ddf515
add support for __experimentalSkiSerialization to the shadow attribute
colinduwe Mar 15, 2024
2d66dc9
add unit tests for shadow support
madhusudhand May 23, 2024
c7355fa
fix unit tests
madhusudhand May 25, 2024
a72ac72
Add @since to docblock
colinduwe Jun 3, 2024
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
5 changes: 4 additions & 1 deletion src/wp-includes/block-supports/shadow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,10 @@ function wp_register_shadow_support( $block_type ) {
function wp_apply_shadow_support( $block_type, $block_attributes ) {
$has_shadow_support = block_has_support( $block_type, 'shadow', false );

if ( ! $has_shadow_support ) {
if (
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to add a since note to the docblock above; something like

@since 6.6.0 Return early if __experimentalSkipSerialization is true.

(it should be added just below @since 6.3.0)

! $has_shadow_support ||
wp_should_skip_block_supports_serialization( $block_type, 'shadow' )
) {
return array();
}

Expand Down
103 changes: 62 additions & 41 deletions tests/phpunit/tests/block-supports/shadow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,15 @@ public function tear_down() {
}

/**
* @ticket 58590
* Registers a new block for testing shadow support.
*
* @param string $block_name Name for the test block.
* @param array $supports Array defining block support configuration.
*
* @return WP_Block_Type The block type for the newly registered test block.
*/
public function test_shadow_style_is_applied() {
$this->test_block_name = 'test/shadow-style-is-applied';
private function register_shadow_block_with_support( $block_name, $supports = array() ) {
$this->test_block_name = $block_name;
register_block_type(
$this->test_block_name,
array(
Expand All @@ -35,55 +40,71 @@ public function test_shadow_style_is_applied() {
'type' => 'object',
),
),
'supports' => array(
'shadow' => true,
),
'supports' => $supports,
)
);
$registry = WP_Block_Type_Registry::get_instance();
$block_type = $registry->get_registered( $this->test_block_name );
$block_atts = array(
'style' => array(
'shadow' => '60px -16px teal',
),
);
$registry = WP_Block_Type_Registry::get_instance();

$actual = wp_apply_shadow_support( $block_type, $block_atts );
$expected = array(
'style' => 'box-shadow:60px -16px teal;',
return $registry->get_registered( $this->test_block_name );
}

/**
* Tests the generation of shadow block support styles.
*
* @dataProvider data_generate_shadow_fixtures
*
* @param boolean|array $support Shadow block support configuration.
* @param string $value Shadow style value for style attribute object.
* @param array $expected Expected shadow block support styles.
*/
public function test_gutenberg_apply_shadow_support( $support, $value, $expected ) {
$block_type = self::register_shadow_block_with_support(
'test/shadow-block',
array( 'shadow' => $support )
);
$block_attrs = array( 'style' => array( 'shadow' => $value ) );
$actual = gutenberg_apply_shadow_support( $block_type, $block_attrs );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for bringing in the tests!

We have to rename the functions, since the gutenberg_ prefix is meant to be used within Gutenberg and not core (https://github.com/WordPress/wordpress-develop/pull/6279/files#diff-a903d994435db8240aed96e253cfb2097ecbe9705d6f88ecdfd441422ecf2da3R52)

Suggested change
public function test_gutenberg_apply_shadow_support( $support, $value, $expected ) {
$block_type = self::register_shadow_block_with_support(
'test/shadow-block',
array( 'shadow' => $support )
);
$block_attrs = array( 'style' => array( 'shadow' => $value ) );
$actual = gutenberg_apply_shadow_support( $block_type, $block_attrs );
public function test_wp_apply_shadow_support( $support, $value, $expected ) {
$block_type = self::register_shadow_block_with_support(
'test/shadow-block',
array( 'shadow' => $support )
);
$block_attrs = array( 'style' => array( 'shadow' => $value ) );
$actual = wp_apply_shadow_support( $block_type, $block_attrs );

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed here.

@colinduwe please pull and
git cherry-pick 5383012d66abb19d39388750fd3e1b46ec0d60b6

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


$this->assertSame( $expected, $actual );
}

/**
* @ticket 58590
* Data provider.
*
* @return array
*/
public function test_shadow_without_block_supports() {
$this->test_block_name = 'test/shadow-with-skipped-serialization-block-supports';
register_block_type(
$this->test_block_name,
array(
'api_version' => 2,
'attributes' => array(
'style' => array(
'type' => 'object',
),
),
'supports' => array(),
)
);
$registry = WP_Block_Type_Registry::get_instance();
$block_type = $registry->get_registered( $this->test_block_name );
$block_atts = array(
'style' => array(
'shadow' => '60px -16px teal',
public function data_generate_shadow_fixtures() {
return array(
'with no styles' => array(
'support' => true,
'value' => '',
'expected' => array(),
),
'without support' => array(
'support' => false,
'value' => '1px 1px 1px #000',
'expected' => array(),
),
'with single shadow' => array(
'support' => true,
'value' => '1px 1px 1px #000',
'expected' => array( 'style' => 'box-shadow:1px 1px 1px #000;' ),
),
'with comma separated shadows' => array(
'support' => true,
'value' => '1px 1px 1px #000, 2px 2px 2px #fff',
'expected' => array( 'style' => 'box-shadow:1px 1px 1px #000, 2px 2px 2px #fff;' ),
),
'with preset shadow' => array(
'support' => true,
'value' => 'var:preset|shadow|natural',
'expected' => array( 'style' => 'box-shadow:var(--wp--preset--shadow--natural);' ),
),
'with serialization skipped' => array(
'support' => array( '__experimentalSkipSerialization' => true ),
'value' => '1px 1px 1px #000',
'expected' => array(),
),
);

$actual = wp_apply_spacing_support( $block_type, $block_atts );
$expected = array();

$this->assertSame( $expected, $actual );
}
}
Loading