Changeset 10769 for sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php

Timestamp:

03/05/2021 12:21:47 AM (5 years ago)

Author:

coffee2code

Message:

Handbooks, Init & Handbook: Improve multi-handbook support and configuration handling

Init:

• Introduce 'handbooks_config' as filter for defining and configuring handbooks
• Deprecate 'handbook_post_types' as filter for defining handbooks
• Store handbook objects as an associative array with post types as keys
• Discontinue explicitly memoizing handbook post types
• Introduce get_handbooks_config() to retrieve config for a particular handbook or all handbooks

Handbook:

• Change constructor to accept config array as optional arg
• Introduce get_config() as a getter to return handbook's config
• Start with 'label' and 'slug' as a config options

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/phpunit/tests/init.php

@@ -15 +15 @@
 
         WPorg_Handbook_Init::reset( true );
+    }
+
+
+    //
+    //
+    // DATA PROVIDERS
+    //
+    //
+
+
+    public static function get_default_config() {
+        return [
+            [ 'label', '' ],
+            [ 'manifest', '' ],
+            [ 'slug', '' ],
+            [ 'with_front', '' ],
+        ];
     }
 
@@ -143 +160 @@
     }
 
+    /*
+     * get_handbooks_config()
+     */
+
+    /**
+     * @dataProvider get_default_config
+     */
+    public function test_get_handbooks_config_default( $key, $default ) {
+        $configs = WPorg_Handbook_Init::get_handbooks_config();
+        $this->assertArrayHasKey( 'handbook', $configs );
+        $this->assertEquals( 1, count( $configs ) );
+
+        $config = $configs['handbook'];
+
+        $this->assertArrayHasKey( $key, $config );
+        $value = $config[ $key ];
+
+        if ( 'slug' === $key ) {
+            $this->assertEquals( 'handbook', $value );
+        } elseif ( '' === $default ) {
+            $this->assertEmpty( $value );
+        } else {
+            $this->assertEquals( $default, $value );
+        }
+    }
+
+    public function test_get_handbooks_config_non_handbook() {
+        $this->assertEmpty( WPorg_Handbook_Init::get_handbooks_config( 'nonexistent-handbook' ) );
+    }
+
+    /**
+     * @dataProvider get_default_config
+     */
+    public function test_get_handbooks_config_specific_handbook_default( $key, $default ) {
+        $config = WPorg_Handbook_Init::get_handbooks_config( 'handbook' );
+
+        $this->assertArrayHasKey( $key, $config );
+        $value = $config[ $key ];
+
+        if ( 'slug' === $key ) {
+            $this->assertEquals( 'handbook', $value );
+        } elseif ( '' === $default ) {
+            $this->assertEmpty( $value );
+        } else {
+            $this->assertEquals( $default, $value );
+        }
+    }
+
+    /**
+     * @dataProvider get_default_config
+     */
+    public function test_get_handbooks_config_specific_custom_handbook( $key, $default ) {
+        reinit_handbooks( [ 'plugins' => [] ] );
+
+        $config = WPorg_Handbook_Init::get_handbooks_config( 'plugins-handbook' );
+
+        $this->assertArrayHasKey( $key, $config );
+        $value = $config[ $key ];
+
+        if ( 'slug' === $key ) {
+            $this->assertEquals( 'plugins', $value );
+        } elseif ( '' === $default ) {
+            $this->assertEmpty( $value );
+        } else {
+            $this->assertEquals( $default, $value );
+        }
+    }
+
 }