Changeset 52376 for trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php

Timestamp:

12/14/2021 06:22:07 PM (5 years ago)

Author:

hellofromTonya

Message:

REST API: Add block theme support for valid non-alphanumeric characters in theme's directory name.

Themes whose wp-content/themes/<dirname> include valid non-alphanumeric (cross-platform) characters work for non-block themes, but did not previously resolve for block themes. For example, a block theme in wp-content/themes/twentytwentytwo-0.4.0/ directory resulted a 404 "No route was found matching the URL and request method" response when attempting to customize it in the Site Editor.

This commit adds support for the following characters in a theme's root directory: _, ., @, [, ], (, and ). Subdirectory themes and - are already supported.

Follow-up to [51003], [52051], [52275].

Props mkaz, costdev, hellofromTonya, jffng, justinahinon, peterwilsoncc, spacedmonkey, TimothyBlynJacobs.
Fixes #54596.

File:

• trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php (modified) (3 diffs)

trunk/tests/phpunit/tests/rest-api/rest-global-styles-controller.php

@@ -94 +94 @@
         /**
          * @covers WP_REST_Global_Styles_Controller::register_routes
+         * @ticket 54596
          */
         public function test_register_routes() {
                 $routes = rest_get_server()->get_routes();
-                $this->assertArrayHasKey( '/wp/v2/global-styles/(?P<id>[\/\w-]+)', $routes );
-                $this->assertCount( 2, $routes['/wp/v2/global-styles/(?P<id>[\/\w-]+)'] );
-                $this->assertArrayHasKey( '/wp/v2/global-styles/themes/(?P<stylesheet>[^.\/]+(?:\/[^.\/]+)?)', $routes );
-                $this->assertCount( 1, $routes['/wp/v2/global-styles/themes/(?P<stylesheet>[^.\/]+(?:\/[^.\/]+)?)'] );
+                $this->assertArrayHasKey(
+                        '/wp/v2/global-styles/(?P<id>[\/\s%\w\.\(\)\[\]\@_\-]+)',
+                        $routes,
+                        'Single global style based on the given ID route does not exist'
+                );
+                $this->assertCount(
+                        2,
+                        $routes['/wp/v2/global-styles/(?P<id>[\/\s%\w\.\(\)\[\]\@_\-]+)'],
+                        'Single global style based on the given ID route does not have exactly two elements'
+                );
+                $this->assertArrayHasKey(
+                        '/wp/v2/global-styles/themes/(?P<stylesheet>[\/\s%\w\.\(\)\[\]\@_\-]+)',
+                        $routes,
+                        'Theme global styles route does not exist'
+                );
+                $this->assertCount(
+                        1,
+                        $routes['/wp/v2/global-styles/themes/(?P<stylesheet>[\/\s%\w\.\(\)\[\]\@_\-]+)'],
+                        'Theme global styles route does not have exactly one element'
+                );
         }
 
@@ -133 +150 @@
         }
 
-
         /**
          * @covers WP_REST_Global_Styles_Controller::get_theme_item
@@ -146 +162 @@
 
         /**
-         * @covers WP_REST_Global_Styles_Controller::get_theme_item
-         */
-        public function test_get_theme_item() {
-                wp_set_current_user( self::$admin_id );
-                $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/themes/tt1-blocks' );
+         * @dataProvider data_get_theme_item_invalid_theme_dirname
+         * @covers WP_REST_Global_Styles_Controller::get_theme_item
+         * @ticket 54596
+         */
+        public function test_get_theme_item_invalid_theme_dirname( $theme_dirname ) {
+                wp_set_current_user( self::$admin_id );
+                switch_theme( $theme_dirname );
+
+                $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/themes/' . $theme_dirname );
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertErrorResponse( 'rest_no_route', $response, 404 );
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public function data_get_theme_item_invalid_theme_dirname() {
+                return array(
+                        'with |'                 => array( 'my|theme' ),
+                        'with +'                 => array( 'my+theme' ),
+                        'with {}'                => array( 'my{theme}' ),
+                        'with #'                 => array( 'my#theme' ),
+                        'with !'                 => array( 'my!theme' ),
+                        'multiple invalid chars' => array( 'mytheme-[_(+@)]#! v4.0' ),
+                );
+        }
+
+        /**
+         * @dataProvider data_get_theme_item
+         * @covers WP_REST_Global_Styles_Controller::get_theme_item
+         * @ticket 54596
+         */
+        public function test_get_theme_item( $theme ) {
+                wp_set_current_user( self::$admin_id );
+                switch_theme( $theme );
+
+                $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/themes/' . $theme );
                 $response = rest_get_server()->dispatch( $request );
                 $data     = $response->get_data();
                 $links    = $response->get_links();
-                $this->assertArrayHasKey( 'settings', $data );
-                $this->assertArrayHasKey( 'styles', $data );
-                $this->assertArrayHasKey( 'self', $links );
-                $this->assertStringContainsString( '/wp/v2/global-styles/themes/tt1-blocks', $links['self'][0]['href'] );
+                $this->assertArrayHasKey( 'settings', $data, 'Data does not have "settings" key' );
+                $this->assertArrayHasKey( 'styles', $data, 'Data does not have "styles" key' );
+                $this->assertArrayHasKey( 'self', $links, 'Links do not have a "self" key' );
+                $this->assertStringContainsString( '/wp/v2/global-styles/themes/' . $theme, $links['self'][0]['href'] );
+        }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public function data_get_theme_item() {
+                return array(
+                        'alphabetic chars'   => array( 'mytheme' ),
+                        'alphanumeric chars' => array( 'mythemev1' ),
+                        'space'              => array( 'my theme' ),
+                        '-'                  => array( 'my-theme' ),
+                        '_'                  => array( 'my_theme' ),
+                        '.'                  => array( 'mytheme0.1' ),
+                        '- and .'            => array( 'my-theme-0.1' ),
+                        'space and .'        => array( 'mytheme v0.1' ),
+                        'space, -, _, .'     => array( 'my-theme-v0.1' ),
+                        '[]'                 => array( 'my[theme]' ),
+                        '()'                 => array( 'my(theme)' ),
+                        '@'                  => array( 'my@theme' ),
+                );
         }