Changeset 54269 for trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

Timestamp:

09/20/2022 09:19:10 PM (15 months ago)

Author:

hellofromTonya

Message:

Editor: Adds template types, is_wp_suggestion, and fallback template content.

This commit improves site editor templates by:

• Adds a post meta is_wp_suggestion to templates created from the site editor.

Why? To differentiate the templates created from the post editor in the Template panel in inspector controls and the templates suggested in site editor.

See ​Gutenberg PR 41387 for more details.

• Expands the template types that can be added to the site editor to include single custom post type and specific posts templates.

See ​Gutenberg PR 41189 for more details.

• Adds fallback template content on creation in site editor:
  • Introduces get_template_hierarchy() to get the template hierarchy for a given template slug to be created.
  • Adds a lookup route to WP_REST_Templates_Controller to get the fallback template content.

See ​Gutenberg PR 42520 for more details.

• Fixes a typo in default category template's description within get_default_block_template_types().

See ​Gutenberg PR 42586 for more details.

• Changes field checks from in_array() to rest_is_field_included() in WP_REST_Post_Types_Controller.
• Adds an icon field to WP_REST_Post_Types_Controller

Follow-up to [53129], [52331], [52275], [52062], [51962], [43087].

Props ntsekouras, spacedmonkey, mamaduka, mburridge, jameskoster, bernhard-reiter, mcsf, hellofromTonya.
See #56467.

File:

• trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php (modified) (3 diffs)

trunk/tests/phpunit/tests/rest-api/wpRestTemplatesController.php

@@ -57 +57 @@
      * @covers WP_REST_Templates_Controller::register_routes
      * @ticket 54596
+     * @ticket 56467
      */
     public function test_register_routes() {
@@ -69 +70 @@
             $routes,
             'Single template based on the given ID route does not exist'
+        );
+        $this->assertArrayHasKey(
+            '/wp/v2/templates/lookup',
+            $routes,
+            'Get template fallback content route does not exist'
         );
     }
@@ -679 +685 @@
     }
 
+    /**
+     * @dataProvider data_create_item_with_is_wp_suggestion
+     * @ticket 56467
+     * @covers WP_REST_Templates_Controller::create_item
+     *
+     * @param array $body_params Data set to test.
+     * @param array $expected    Expected results.
+     */
+    public function test_create_item_with_is_wp_suggestion( array $body_params, array $expected ) {
+        // Set up the user.
+        $body_params['author'] = self::$admin_id;
+        $expected['author']    = self::$admin_id;
+        wp_set_current_user( self::$admin_id );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/templates' );
+        $request->set_body_params( $body_params );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        unset( $data['_links'] );
+        unset( $data['wp_id'] );
+
+        $this->assertSame( $expected, $data );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_create_item_with_is_wp_suggestion() {
+        $expected = array(
+            'id'             => 'default//page-rigas',
+            'theme'          => 'default',
+            'content'        => array(
+                'raw' => 'Content',
+            ),
+            'slug'           => 'page-rigas',
+            'source'         => 'custom',
+            'origin'         => null,
+            'type'           => 'wp_template',
+            'description'    => 'Just a description',
+            'title'          => array(
+                'raw'      => 'My Template',
+                'rendered' => 'My Template',
+            ),
+            'status'         => 'publish',
+            'has_theme_file' => false,
+            'is_custom'      => false,
+            'author'         => null,
+        );
+
+        return array(
+            'is_wp_suggestion: true'  => array(
+                'body_params' => array(
+                    'slug'             => 'page-rigas',
+                    'description'      => 'Just a description',
+                    'title'            => 'My Template',
+                    'content'          => 'Content',
+                    'is_wp_suggestion' => true,
+                    'author'           => null,
+                ),
+                'expected'    => $expected,
+            ),
+            'is_wp_suggestion: false' => array(
+                'body_params' => array(
+                    'slug'             => 'page-hi',
+                    'description'      => 'Just a description',
+                    'title'            => 'My Template',
+                    'content'          => 'Content',
+                    'is_wp_suggestion' => false,
+                    'author'           => null,
+                ),
+                'expected'    => array_merge(
+                    $expected,
+                    array(
+                        'id'        => 'default//page-hi',
+                        'slug'      => 'page-hi',
+                        'is_custom' => true,
+                    )
+                ),
+            ),
+        );
+    }
+
+    /**
+     * @ticket 56467
+     * @covers WP_REST_Templates_Controller::get_template_fallback
+     */
+    public function test_get_template_fallback() {
+        wp_set_current_user( self::$admin_id );
+        switch_theme( 'block-theme' );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/templates/lookup' );
+        // Should fallback to `index.html`.
+        $request->set_param( 'slug', 'tag-status' );
+        $request->set_param( 'is_custom', false );
+        $request->set_param( 'template_prefix', 'tag' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 'index', $response->get_data()['slug'], 'Should fallback to `index.html`.' );
+        // Should fallback to `page.html`.
+        $request->set_param( 'slug', 'page-hello' );
+        $request->set_param( 'is_custom', false );
+        $request->set_param( 'template_prefix', 'page' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 'page', $response->get_data()['slug'], 'Should fallback to `page.html`.' );
+    }
 }