Changeset 36586 for trunk/tests/phpunit/tests/customize/widgets.php

Timestamp:

02/19/2016 06:40:06 PM (9 years ago)

Author:

westonruter

Message:

Customize: Add selective refresh framework with implementation for widgets and re-implementation for nav menus.

See ​https://make.wordpress.org/core/2016/02/16/selective-refresh-in-the-customizer/.

Props westonruter, valendesigns, DrewAPicture, ocean90.
Fixes #27355.

File:

• trunk/tests/phpunit/tests/customize/widgets.php (modified) (4 diffs)

trunk/tests/phpunit/tests/customize/widgets.php

@@ -40 +40 @@
         remove_action( 'after_setup_theme', 'twentyfifteen_setup' );
         remove_action( 'after_setup_theme', 'twentysixteen_setup' );
+        remove_action( 'customize_register', 'twentysixteen_customize_register', 11 );
 
         $user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
@@ -122 +123 @@
             'type' => 'option',
             'capability' => 'edit_theme_options',
-            'transport' => 'refresh',
+            'transport' => 'postMessage',
             'default' => array(),
             'sanitize_callback' => array( $this->manager->widgets, 'sanitize_widget_instance' ),
@@ -151 +152 @@
             'type' => 'option',
             'capability' => 'edit_theme_options',
-            'transport' => 'refresh',
+            'transport' => 'postMessage',
             'default' => array(),
             'sanitize_callback' => array( $this->manager->widgets, 'sanitize_sidebar_widgets' ),
@@ -347 +348 @@
         $this->assertEquals( $post_value, $this->manager->widgets->sanitize_widget_js_instance( $instance ) );
     }
+
+    /**
+     * Test WP_Customize_Widgets::customize_dynamic_partial_args().
+     *
+     * @see WP_Customize_Widgets::customize_dynamic_partial_args()
+     */
+    function test_customize_dynamic_partial_args() {
+        do_action( 'customize_register', $this->manager );
+
+        $args = apply_filters( 'customize_dynamic_partial_args', false, 'widget[search-2]' );
+        $this->assertInternalType( 'array', $args );
+        $this->assertEquals( 'widget', $args['type'] );
+        $this->assertEquals( array( $this->manager->widgets, 'render_widget_partial' ), $args['render_callback'] );
+        $this->assertTrue( $args['container_inclusive'] );
+
+        $args = apply_filters( 'customize_dynamic_partial_args', array( 'fallback_refresh' => false ), 'widget[search-2]' );
+        $this->assertInternalType( 'array', $args );
+        $this->assertEquals( 'widget', $args['type'] );
+        $this->assertEquals( array( $this->manager->widgets, 'render_widget_partial' ), $args['render_callback'] );
+        $this->assertTrue( $args['container_inclusive'] );
+        $this->assertFalse( $args['fallback_refresh'] );
+    }
+
+    /**
+     * Test WP_Customize_Widgets::selective_refresh_init().
+     *
+     * @see WP_Customize_Widgets::selective_refresh_init()
+     */
+    function test_selective_refresh_init() {
+        $this->manager->widgets->selective_refresh_init();
+        $this->assertEquals( 10, has_action( 'wp_enqueue_scripts', array( $this->manager->widgets, 'customize_preview_enqueue_deps' ) ) );
+        $this->assertEquals( 10, has_action( 'dynamic_sidebar_before', array( $this->manager->widgets, 'start_dynamic_sidebar' ) ) );
+        $this->assertEquals( 10, has_action( 'dynamic_sidebar_after', array( $this->manager->widgets, 'end_dynamic_sidebar' ) ) );
+        $this->assertEquals( 10, has_filter( 'dynamic_sidebar_params', array( $this->manager->widgets, 'filter_dynamic_sidebar_params' ) ) );
+        $this->assertEquals( 10, has_filter( 'wp_kses_allowed_html', array( $this->manager->widgets, 'filter_wp_kses_allowed_data_attributes' ) ) );
+    }
+
+    /**
+     * Test WP_Customize_Widgets::customize_preview_enqueue_deps().
+     *
+     * @see WP_Customize_Widgets::customize_preview_enqueue_deps()
+     */
+    function test_customize_preview_enqueue_deps() {
+        $this->manager->widgets->customize_preview_enqueue_deps();
+        $this->assertTrue( wp_script_is( 'customize-preview-widgets', 'enqueued' ) );
+        $this->assertTrue( wp_style_is( 'customize-preview', 'enqueued' ) );
+        $script = wp_scripts()->registered['customize-preview-widgets'];
+        $this->assertContains( 'customize-selective-refresh', $script->deps );
+    }
+
+    /**
+     * Test extensions to dynamic_sidebar().
+     *
+     * @see WP_Customize_Widgets::filter_dynamic_sidebar_params()
+     * @see WP_Customize_Widgets::start_dynamic_sidebar()
+     * @see WP_Customize_Widgets::end_dynamic_sidebar()
+     */
+    function test_filter_dynamic_sidebar_params() {
+        global $wp_registered_sidebars;
+        register_sidebar( array(
+            'id' => 'foo',
+        ) );
+
+        $this->manager->widgets->selective_refresh_init();
+
+        $params = array(
+            array_merge(
+                $wp_registered_sidebars['foo'],
+                array(
+                    'widget_id' => 'search-2',
+                )
+            ),
+            array(),
+        );
+        $this->assertEquals( $params, $this->manager->widgets->filter_dynamic_sidebar_params( $params ), 'Expected short-circuit if not called after dynamic_sidebar_before.' );
+
+        ob_start();
+        do_action( 'dynamic_sidebar_before', 'foo' );
+        $output = ob_get_clean();
+        $this->assertEquals( '<!--dynamic_sidebar_before:foo:1-->', trim( $output ) );
+
+        $bad_params = $params;
+        unset( $bad_params[0]['id'] );
+        $this->assertEquals( $bad_params, $this->manager->widgets->filter_dynamic_sidebar_params( $bad_params ) );
+
+        $bad_params = $params;
+        $bad_params[0]['id'] = 'non-existing';
+        $this->assertEquals( $bad_params, $this->manager->widgets->filter_dynamic_sidebar_params( $bad_params ) );
+
+        $bad_params = $params;
+        $bad_params[0]['before_widget'] = '   <oops>';
+        $this->assertEquals( $bad_params, $this->manager->widgets->filter_dynamic_sidebar_params( $bad_params ) );
+
+        $filtered_params = $this->manager->widgets->filter_dynamic_sidebar_params( $params );
+        $this->assertNotEquals( $params, $filtered_params );
+        ob_start();
+        do_action( 'dynamic_sidebar_after', 'foo' );
+        $output = ob_get_clean();
+        $this->assertEquals( '<!--dynamic_sidebar_after:foo:1-->', trim( $output ) );
+
+        $output = wp_kses_post( $filtered_params[0]['before_widget'] );
+        $this->assertContains( 'data-customize-partial-id="widget[search-2]"', $output );
+        $this->assertContains( 'data-customize-partial-type="widget"', $output );
+    }
+
+    /**
+     * Test WP_Customize_Widgets::render_widget_partial() method.
+     *
+     * @see WP_Customize_Widgets::render_widget_partial()
+     */
+    function test_render_widget_partial() {
+        $this->manager->widgets->selective_refresh_init();
+
+        $partial_id = 'widget[search-2]';
+        $partials = $this->manager->selective_refresh->add_dynamic_partials( array( $partial_id ) );
+        $this->assertNotEmpty( $partials );
+        $partial = array_shift( $partials );
+        $this->assertEquals( $partial_id, $partial->id );
+
+        $this->assertFalse( $this->manager->widgets->render_widget_partial( $partial, array() ) );
+        $this->assertFalse( $this->manager->widgets->render_widget_partial( $partial, array( 'sidebar_id' => 'non-existing' ) ) );
+
+        $output = $this->manager->widgets->render_widget_partial( $partial, array( 'sidebar_id' => 'sidebar-1' ) );
+
+        $this->assertEquals( 1, substr_count( $output, 'data-customize-partial-id' ) );
+        $this->assertEquals( 1, substr_count( $output, 'data-customize-partial-type="widget"' ) );
+        $this->assertContains( ' id="search-2"', $output );
+    }
+
+    /**
+     * Test deprecated methods.
+     */
+    public function test_deprecated_methods() {
+        $this->setExpectedDeprecated( 'WP_Customize_Widgets::setup_widget_addition_previews' );
+        $this->setExpectedDeprecated( 'WP_Customize_Widgets::prepreview_added_sidebars_widgets' );
+        $this->setExpectedDeprecated( 'WP_Customize_Widgets::prepreview_added_widget_instance' );
+        $this->setExpectedDeprecated( 'WP_Customize_Widgets::remove_prepreview_filters' );
+        $this->manager->widgets->setup_widget_addition_previews();
+        $this->manager->widgets->prepreview_added_sidebars_widgets();
+        $this->manager->widgets->prepreview_added_widget_instance();
+        $this->manager->widgets->remove_prepreview_filters();
+    }
 }