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

Timestamp:

05/31/2024 01:17:50 AM (12 months ago)

Author:

noisysocks

Message:

Block Themes: Add support for relative URLs in top-level theme.json styles

Allow using relative file: URLs in top-level theme.json properties such as
styles.background, and modify the REST API to provide clients with the
absolute URLs via a '​https://api.w.org/theme-file' attribute in the _links
array.

Props ramonopoly.
Fixes #61273.

File:

• trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (3 diffs)

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

@@ -104 +104 @@
         add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) );
         add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) );
+        add_filter( 'theme_file_uri', array( $this, 'filter_theme_file_uri' ) );
         $this->queries = array();
         // Clear caches.
@@ -114 +115 @@
         wp_clean_themes_cache();
         unset( $GLOBALS['wp_themes'] );
+        remove_filter( 'theme_file_uri', array( $this, 'filter_theme_file_uri' ) );
 
         // Reset data between tests.
         wp_clean_theme_json_cache();
         parent::tear_down();
+    }
+
+    /*
+     * This filter callback normalizes the return value from `get_theme_file_uri`
+     * to guard against changes in test environments.
+     * The test suite otherwise returns full system dir path, e.g.,
+     * /var/www/tests/phpunit/includes/../data/themedir1/block-theme/assets/sugarloaf-mountain.jpg
+     */
+    public function filter_theme_file_uri( $file ) {
+        $file_name = substr( strrchr( $file, '/' ), 1 );
+        return 'https://example.org/wp-content/themes/example-theme/assets/' . $file_name;
     }
 
@@ -1177 +1190 @@
         $this->assertTrue( $default_presets_for_block );
     }
+
+    /**
+     * Tests that relative paths are resolved and merged into the theme.json data.
+     *
+     * @covers WP_Theme_JSON_Resolver::resolve_theme_file_uris
+     * @ticket 61273
+     */
+    public function test_resolve_theme_file_uris() {
+        $theme_json = new WP_Theme_JSON(
+            array(
+                'version' => WP_Theme_JSON::LATEST_SCHEMA,
+                'styles'  => array(
+                    'background' => array(
+                        'backgroundImage' => array(
+                            'url' => 'file:./assets/image.png',
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        $expected_data = array(
+            'version' => WP_Theme_JSON::LATEST_SCHEMA,
+            'styles'  => array(
+                'background' => array(
+                    'backgroundImage' => array(
+                        'url' => 'https://example.org/wp-content/themes/example-theme/assets/image.png',
+                    ),
+                ),
+            ),
+        );
+
+        $actual = WP_Theme_JSON_Resolver::resolve_theme_file_uris( $theme_json );
+
+        $this->assertSame( $expected_data, $actual->get_raw_data() );
+    }
+
+    /**
+     * Tests that them uris are resolved and bundled with other metadata in an array.
+     *
+     * @covers WP_Theme_JSON_Resolver::get_resolved_theme_uris
+     * @ticket 61273
+     */
+    public function test_get_resolved_theme_uris() {
+        $theme_json = new WP_Theme_JSON(
+            array(
+                'version' => WP_Theme_JSON::LATEST_SCHEMA,
+                'styles'  => array(
+                    'background' => array(
+                        'backgroundImage' => array(
+                            'url' => 'file:./assets/image.png',
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        $expected_data = array(
+            array(
+                'name'   => 'file:./assets/image.png',
+                'href'   => 'https://example.org/wp-content/themes/example-theme/assets/image.png',
+                'target' => 'styles.background.backgroundImage.url',
+                'type'   => 'image/png',
+            ),
+        );
+
+        $actual = WP_Theme_JSON_Resolver::get_resolved_theme_uris( $theme_json );
+
+        $this->assertSame( $expected_data, $actual );
+    }
 }