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

Timestamp:

03/21/2016 09:58:02 PM (9 years ago)

Author:

westonruter

Message:

Customize: Require opt-in for selective refresh of widgets.

• Introduces customize-selective-refresh-widgets theme support feature and adds to themes.
• Introduces customize_selective_refresh arg for WP_Widget::$widget_options and adds to all core widgets.
• Remove selective_refresh from being a component that can be removed via customize_loaded_components filter.
• Add WP_Customize_Widgets::get_selective_refreshable_widgets() and WP_Customize_Widgets::is_widget_selective_refreshable().
• Fix default selector for Partial instances.
• Implement and improve Masronry sidebar refresh logic in Twenty Thirteen and Twenty Fourteen, including preservation of initial widget position after refresh.
• Re-initialize ME.js when refreshing Twenty_Fourteen_Ephemera_Widget.

See #27355.
Fixes #35855.

File:

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

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

@@ -25 +25 @@
         require_once( ABSPATH . WPINC . '/class-wp-customize-manager.php' );
 
+        add_theme_support( 'customize-selective-refresh-widgets' );
         $user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
         wp_set_current_user( $user_id );
@@ -48 +49 @@
     }
 
+    function clean_up_global_scope() {
+        global $wp_widget_factory, $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
+
+        $wp_registered_sidebars = array();
+        $wp_registered_widgets = array();
+        $wp_registered_widget_controls = array();
+        $wp_registered_widget_updates = array();
+        $wp_widget_factory->widgets = array();
+
+        parent::clean_up_global_scope();
+    }
+
     function tearDown() {
         $this->manager = null;
@@ -76 +89 @@
         $this->assertInstanceOf( 'WP_Customize_Widgets', $this->manager->widgets );
         $this->assertEquals( $this->manager, $this->manager->widgets->manager );
+    }
+
+    /**
+     * Tests WP_Customize_Widgets::get_selective_refreshable_widgets().
+     *
+     * @see WP_Customize_Widgets::get_selective_refreshable_widgets()
+     */
+    function test_get_selective_refreshable_widgets_when_theme_supports() {
+        global $wp_widget_factory;
+        add_action( 'widgets_init', array( $this, 'override_search_widget_customize_selective_refresh' ), 90 );
+        add_theme_support( 'customize-selective-refresh-widgets' );
+        $this->do_customize_boot_actions();
+
+        $selective_refreshable_widgets = $this->manager->widgets->get_selective_refreshable_widgets();
+        $this->assertInternalType( 'array', $selective_refreshable_widgets );
+        $this->assertEquals( count( $wp_widget_factory->widgets ), count( $selective_refreshable_widgets ) );
+        $this->assertArrayHasKey( 'text', $selective_refreshable_widgets );
+        $this->assertTrue( $selective_refreshable_widgets['text'] );
+        $this->assertArrayHasKey( 'search', $selective_refreshable_widgets );
+        $this->assertFalse( $selective_refreshable_widgets['search'] );
+    }
+
+    /**
+     * Tests WP_Customize_Widgets::get_selective_refreshable_widgets().
+     *
+     * @see WP_Customize_Widgets::get_selective_refreshable_widgets()
+     */
+    function test_get_selective_refreshable_widgets_when_no_theme_supports() {
+        add_action( 'widgets_init', array( $this, 'override_search_widget_customize_selective_refresh' ), 90 );
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $this->do_customize_boot_actions();
+        $selective_refreshable_widgets = $this->manager->widgets->get_selective_refreshable_widgets();
+        $this->assertEmpty( $selective_refreshable_widgets );
+    }
+
+    /**
+     * Hook into widgets_init to override the search widget's customize_selective_refresh widget option.
+     *
+     * @see Tests_WP_Customize_Widgets::test_get_selective_refreshable_widgets_when_theme_supports()
+     * @see Tests_WP_Customize_Widgets::test_get_selective_refreshable_widgets_when_no_theme_supports()
+     */
+    function override_search_widget_customize_selective_refresh() {
+        global $wp_widget_factory;
+        $wp_widget_factory->widgets['WP_Widget_Search']->widget_options['customize_selective_refresh'] = false;
+    }
+
+    /**
+     * Tests WP_Customize_Widgets::is_widget_selective_refreshable().
+     *
+     * @see WP_Customize_Widgets::is_widget_selective_refreshable()
+     */
+    function test_is_widget_selective_refreshable() {
+        add_action( 'widgets_init', array( $this, 'override_search_widget_customize_selective_refresh' ), 90 );
+        add_theme_support( 'customize-selective-refresh-widgets' );
+        $this->do_customize_boot_actions();
+        $this->assertFalse( $this->manager->widgets->is_widget_selective_refreshable( 'search' ) );
+        $this->assertTrue( $this->manager->widgets->is_widget_selective_refreshable( 'text' ) );
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $this->assertFalse( $this->manager->widgets->is_widget_selective_refreshable( 'text' ) );
     }
 
@@ -117 +189 @@
      */
     function test_get_setting_args() {
+        add_theme_support( 'customize-selective-refresh-widgets' );
+        $this->do_customize_boot_actions();
 
         add_filter( 'widget_customizer_setting_args', array( $this, 'filter_widget_customizer_setting_args' ), 10, 2 );
+
+        $default_args = array(
+            'type' => 'option',
+            'capability' => 'edit_theme_options',
+            'transport' => 'refresh',
+            'default' => array(),
+            'sanitize_callback' => array( $this->manager->widgets, 'sanitize_widget_instance' ),
+            'sanitize_js_callback' => array( $this->manager->widgets, 'sanitize_widget_js_instance' ),
+        );
+        $args = $this->manager->widgets->get_setting_args( 'widget_foo[2]' );
+        foreach ( $default_args as $key => $default_value ) {
+            $this->assertEquals( $default_value, $args[ $key ] );
+        }
+        $this->assertEquals( 'WIDGET_FOO[2]', $args['uppercase_id_set_by_filter'] );
 
         $default_args = array(
@@ -128 +216 @@
             'sanitize_js_callback' => array( $this->manager->widgets, 'sanitize_widget_js_instance' ),
         );
-
-        $args = $this->manager->widgets->get_setting_args( 'widget_foo[2]' );
+        $args = $this->manager->widgets->get_setting_args( 'widget_search[2]' );
         foreach ( $default_args as $key => $default_value ) {
             $this->assertEquals( $default_value, $args[ $key ] );
         }
-        $this->assertEquals( 'WIDGET_FOO[2]', $args['uppercase_id_set_by_filter'] );
+
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $args = $this->manager->widgets->get_setting_args( 'widget_search[2]' );
+        $this->assertEquals( 'refresh', $args['transport'] );
+        add_theme_support( 'customize-selective-refresh-widgets' );
 
         $override_args = array(
@@ -369 +460 @@
         $this->assertTrue( $args['container_inclusive'] );
         $this->assertFalse( $args['fallback_refresh'] );
+
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $args = apply_filters( 'customize_dynamic_partial_args', false, 'widget[search-2]' );
+        $this->assertFalse( $args );
     }
 
@@ -376 +471 @@
      * @see WP_Customize_Widgets::selective_refresh_init()
      */
-    function test_selective_refresh_init() {
+    function test_selective_refresh_init_with_theme_support() {
+        add_theme_support( 'customize-selective-refresh-widgets' );
         $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' ) ) );
@@ -386 +481 @@
 
     /**
-     * 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();
+     * Test WP_Customize_Widgets::selective_refresh_init().
+     *
+     * @see WP_Customize_Widgets::selective_refresh_init()
+     */
+    function test_selective_refresh_init_without_theme_support() {
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $this->manager->widgets->selective_refresh_init();
+        $this->assertFalse( has_action( 'dynamic_sidebar_before', array( $this->manager->widgets, 'start_dynamic_sidebar' ) ) );
+        $this->assertFalse( has_action( 'dynamic_sidebar_after', array( $this->manager->widgets, 'end_dynamic_sidebar' ) ) );
+        $this->assertFalse( has_filter( 'dynamic_sidebar_params', array( $this->manager->widgets, 'filter_dynamic_sidebar_params' ) ) );
+        $this->assertFalse( has_filter( 'wp_kses_allowed_html', array( $this->manager->widgets, 'filter_wp_kses_allowed_data_attributes' ) ) );
+    }
+
+    /**
+     * Test WP_Customize_Widgets::customize_preview_enqueue().
+     *
+     * @see WP_Customize_Widgets::customize_preview_enqueue()
+     */
+    function test_customize_preview_enqueue() {
+        $this->manager->widgets->customize_preview_enqueue();
         $this->assertTrue( wp_script_is( 'customize-preview-widgets', 'enqueued' ) );
         $this->assertTrue( wp_style_is( 'customize-preview', 'enqueued' ) );
@@ -459 +568 @@
      */
     function test_render_widget_partial() {
+        add_theme_support( 'customize-selective-refresh-widgets' );
+        $this->do_customize_boot_actions();
         $this->manager->widgets->selective_refresh_init();