Changeset 50527 for trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php

Timestamp:

03/12/2021 01:33:21 PM (5 years ago)

Author:

gziolo

Message:

Editor: Make block type aware of variations

Currently block variations are only defined on the client. In some cases, creating block variations on the server can be very useful, especially when needed data is not exposed in the REST APIs.

Related to ​https://github.com/WordPress/gutenberg/pull/29095.

Props: gwwar, timothyblynjacobs.
Fixes: #52688.

File:

• trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php (modified) (6 diffs)

trunk/tests/phpunit/tests/rest-api/rest-block-type-controller.php

@@ -225 +225 @@
                         'render_callback'  => 'invalid_callback',
                         'textdomain'       => true,
+                        'variations'       => 'invalid_variations',
                 );
                 register_block_type( $block_type, $settings );
@@ -250 +251 @@
                 $this->assertNull( $data['textdomain'] );
                 $this->assertFalse( $data['is_dynamic'] );
+                $this->assertSameSets( array( array() ), $data['variations'] );
         }
 
@@ -276 +278 @@
                         'textdomain'       => false,
                         'example'          => false,
+                        'variations'       => false,
                 );
                 register_block_type( $block_type, $settings );
@@ -302 +305 @@
                 $this->assertNull( $data['textdomain'] );
                 $this->assertFalse( $data['is_dynamic'] );
+                $this->assertSameSets( array(), $data['variations'] );
+        }
+
+        public function test_get_variation() {
+                $block_type = 'fake/variations';
+                $settings   = array(
+                        'title'       => 'variations block test',
+                        'description' => 'a variations block test',
+                        'attributes'  => array( 'kind' => array( 'type' => 'string' ) ),
+                        'variations'  => array(
+                                array(
+                                        'name'        => 'variation',
+                                        'title'       => 'variation title',
+                                        'description' => 'variation description',
+                                        'category'    => 'media',
+                                        'icon'        => 'checkmark',
+                                        'attributes'  => array( 'kind' => 'foo' ),
+                                        'isDefault'   => true,
+                                        'example'     => array( 'attributes' => array( 'kind' => 'example' ) ),
+                                        'scope'       => array( 'inserter', 'block' ),
+                                        'keywords'    => array( 'dogs', 'cats', 'mice' ),
+                                        'innerBlocks' => array(
+                                                array(
+                                                        'name'       => 'fake/bar',
+                                                        'attributes' => array( 'label' => 'hi' ),
+                                                ),
+                                        ),
+                                ),
+                        ),
+                );
+                register_block_type( $block_type, $settings );
+                wp_set_current_user( self::$admin_id );
+                $request  = new WP_REST_Request( 'GET', '/wp/v2/block-types/' . $block_type );
+                $response = rest_get_server()->dispatch( $request );
+                $data     = $response->get_data();
+                $this->assertSame( $block_type, $data['name'] );
+                $this->assertArrayHasKey( 'variations', $data );
+                $this->assertSame( 1, count( $data['variations'] ) );
+                $variation = $data['variations'][0];
+                $this->assertSame( 'variation title', $variation['title'] );
+                $this->assertSame( 'variation description', $variation['description'] );
+                $this->assertSame( 'media', $variation['category'] );
+                $this->assertSame( 'checkmark', $variation['icon'] );
+                $this->assertSameSets( array( 'inserter', 'block' ), $variation['scope'] );
+                $this->assertSameSets( array( 'dogs', 'cats', 'mice' ), $variation['keywords'] );
+                $this->assertSameSets( array( 'attributes' => array( 'kind' => 'example' ) ), $variation['example'] );
+                $this->assertSameSets(
+                        array(
+                                array(
+                                        'name'       => 'fake/bar',
+                                        'attributes' => array( 'label' => 'hi' ),
+                                ),
+                        ),
+                        $variation['innerBlocks']
+                );
+                $this->assertSameSets(
+                        array( 'kind' => 'foo' ),
+                        $variation['attributes']
+                );
         }
 
@@ -313 +375 @@
                 $data       = $response->get_data();
                 $properties = $data['schema']['properties'];
-                $this->assertCount( 20, $properties );
+                $this->assertCount( 21, $properties );
                 $this->assertArrayHasKey( 'api_version', $properties );
                 $this->assertArrayHasKey( 'title', $properties );
@@ -334 +396 @@
                 $this->assertArrayHasKey( 'uses_context', $properties );
                 $this->assertArrayHasKey( 'provides_context', $properties );
+                $this->assertArrayHasKey( 'variations', $properties );
         }