Changeset 58466 for trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

Timestamp:

06/24/2024 08:49:52 AM (17 months ago)

Author:

oandregal

Message:

Section styles: improve performance and conceptual consistency.

These changes involve:

• Move shared variation definitions from styles.blocks.variations to styles.variations
• Remove blockTypes from styles.variations.
• Do not register shared variations from theme style variation or primary theme.json files.
• Move the merging of theme.json data into the WP_Theme_JSON_Resolver and WP_Theme_JSON classes.

These changes improve performance and are more future-proof API wise.
See conversation at ​https://github.com/WordPress/gutenberg/issues/62686

Props aaronrobertshaw, oandregal, andrewserong, joemcgill, talldanwp, andrewserong, ramonopoly, richtabor, youknowriad.

See #61312, #61451.

File:

• trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (1 diff)

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

@@ -1322 +1322 @@
         $this->assertSame( $expected_data, $actual );
     }
+
+    /**
+     * Tests that block style variations data gets merged in the following
+     * priority order, from highest priority to lowest.
+     *
+     * - `styles.blocks.blockType.variations` from theme.json
+     * - `styles.variations` from theme.json
+     * - variations from block style variation files under `/styles`
+     * - variations from `WP_Block_Styles_Registry`
+     *
+     * @ticket 61451
+     */
+    public function test_block_style_variation_merge_order() {
+        switch_theme( 'block-theme-child-with-block-style-variations' );
+
+        /*
+         * Register style for a block that isn't included in the block style variation's partial
+         * theme.json's blockTypes. The name must match though so we can ensure the partial's
+         * styles do not get applied to this block.
+         */
+        register_block_style(
+            'core/heading',
+            array(
+                'name'  => 'block-style-variation-b',
+                'label' => 'Heading only variation',
+            )
+        );
+
+        // Register variation for a block that will be partially overridden at all levels.
+        register_block_style(
+            'core/media-text',
+            array(
+                'name'       => 'block-style-variation-a',
+                'label'      => 'Block Style Variation A',
+                'style_data' => array(
+                    'color' => array(
+                        'background' => 'pink',
+                        'gradient'   => 'var(--custom)',
+                    ),
+                ),
+            )
+        );
+
+        $data         = WP_Theme_JSON_Resolver::get_theme_data()->get_raw_data();
+        $block_styles = $data['styles']['blocks'] ?? array();
+        $actual       = array_intersect_key(
+            $block_styles,
+            array_flip( array( 'core/button', 'core/media-text', 'core/heading' ) )
+        );
+        $expected     = array(
+            'core/button'     => array(
+                'variations' => array(
+                    'outline' => array(
+                        'color' => array(
+                            'background' => 'red',
+                            'text'       => 'white',
+                        ),
+                    ),
+                ),
+            ),
+            'core/media-text' => array(
+                'variations' => array(
+                    'block-style-variation-a' => array(
+                        'color'      => array(
+                            'background' => 'blue',
+                            'gradient'   => 'var(--custom)',
+                            'text'       => 'aliceblue',
+                        ),
+                        'typography' => array(
+                            'fontSize'   => '1.5em',
+                            'lineHeight' => '1.4em',
+                        ),
+                    ),
+                ),
+            ),
+            'core/heading'    => array(
+                'variations' => array(
+                    'block-style-variation-b' => array(
+                        'typography' => array(
+                            'fontSize' => '3em',
+                        ),
+                    ),
+                ),
+            ),
+        );
+
+        unregister_block_style( 'core/heading', 'block-style-variation-b' );
+        unregister_block_style( 'core/media-text', 'block-style-variation-a' );
+
+        $this->assertSameSetsWithIndex( $expected, $actual, 'Merged variation styles do not match.' );
+    }
 }