Merge AMP_Widgets into AMP_Theme_Support

ampproject · Jan 23, 2018 · dc3f5b4 · dc3f5b4
1 parent da6cee6
commit dc3f5b4
Show file tree

Hide file tree

Showing 15 changed files with 122 additions and 323 deletions.
diff --git a/amp.php b/amp.php
@@ -71,7 +71,6 @@ function amp_after_setup_theme() {
 	}
 
 	add_action( 'init', 'amp_init' );
-	add_action( 'init', 'amp_add_widget_support' );
 	add_action( 'admin_init', 'AMP_Options_Manager::register_settings' );
 	add_filter( 'amp_post_template_analytics', 'amp_add_custom_analytics' );
 	add_action( 'wp_loaded', 'amp_post_meta_box' );

diff --git a/includes/admin/functions.php b/includes/admin/functions.php
@@ -136,18 +136,6 @@ function amp_add_custom_analytics( $analytics ) {
 	return $analytics;
 }
 
-/**
- * Bootstraps AMP widget support class, which registers AMP-compliant widgets.
- *
- * @since 0.7
- */
-function amp_add_widget_support() {
-	if ( is_amp_endpoint() ) {
-		$amp_widgets = new AMP_Widgets();
-		$amp_widgets->init();
-	}
-}
-
 /**
  * Bootstrap AMP post meta box.
  *

diff --git a/includes/class-amp-autoloader.php b/includes/class-amp-autoloader.php
@@ -86,7 +86,6 @@ class AMP_Autoloader {
 		'AMP_Widget_Media_Video'                      => 'includes/widgets/class-amp-widget-media-video',
 		'AMP_Widget_Recent_Comments'                  => 'includes/widgets/class-amp-widget-recent-comments',
 		'AMP_Widget_RSS'                              => 'includes/widgets/class-amp-widget-rss',
-		'AMP_Widgets'                                 => 'includes/widgets/class-amp-widgets',
 		'WPCOM_AMP_Polldaddy_Embed'                   => 'wpcom/class-amp-polldaddy-embed',
 		'AMP_Test_Stub_Sanitizer'                     => 'tests/stubs',
 		'AMP_Test_World_Sanitizer'                    => 'tests/stubs',

diff --git a/includes/class-amp-theme-support.php b/includes/class-amp-theme-support.php
@@ -154,6 +154,8 @@ public static function register_paired_hooks() {
 	 */
 	public static function register_hooks() {
 
+		add_action( 'widgets_init', array( __CLASS__, 'register_widgets' ) );
+
 		// Remove core actions which are invalid AMP.
 		remove_action( 'wp_head', 'locale_stylesheet' );
 		remove_action( 'wp_head', 'print_emoji_detection_script', 7 );
@@ -196,6 +198,29 @@ public static function register_hooks() {
 		// @todo Add character conversion.
 	}
 
+	/**
+	 * Register/override widgets.
+	 *
+	 * @global WP_Widget_Factory
+	 * @return void
+	 */
+	public static function register_widgets() {
+		global $wp_widget_factory;
+		foreach ( $wp_widget_factory->widgets as $registered_widget ) {
+			$registered_widget_class_name = get_class( $registered_widget );
+			if ( ! preg_match( '/^WP_Widget_(.+)$/', $registered_widget_class_name, $matches ) ) {
+				continue;
+			}
+			$amp_class_name = 'AMP_Widget_' . $matches[1];
+			if ( ! class_exists( $amp_class_name ) || is_a( $amp_class_name, $registered_widget_class_name ) ) {
+				continue;
+			}
+
+			unregister_widget( $registered_widget_class_name );
+			register_widget( $amp_class_name );
+		}
+	}
+
 	/**
 	 * Register content embed handlers.
 	 *

diff --git a/includes/widgets/class-amp-widgets.php b/includes/widgets/class-amp-widgets.php
diff --git a/tests/test-class-amp-theme-support.php b/tests/test-class-amp-theme-support.php
@@ -67,4 +67,21 @@ public function test_is_paired_available() {
 		$this->assertTrue( is_search() );
 		$this->assertFalse( AMP_Theme_Support::is_paired_available() );
 	}
+
+	/**
+	 * Test register_widgets().
+	 *
+	 * @covers AMP_Theme_Support::register_widgets()
+	 * @global WP_Widget_Factory $wp_widget_factory
+	 */
+	public function test_register_widgets() {
+		global $wp_widget_factory;
+		remove_all_actions( 'widgets_init' );
+		$wp_widget_factory->widgets = array();
+		wp_widgets_init();
+		AMP_Theme_Support::register_widgets();
+
+		$this->assertArrayNotHasKey( 'WP_Widget_Categories', $wp_widget_factory->widgets );
+		$this->assertArrayHasKey( 'AMP_Widget_Categories', $wp_widget_factory->widgets );
+	}
 }
diff --git a/tests/test-class-amp-widget-archives.php b/tests/test-class-amp-widget-archives.php
@@ -12,13 +12,6 @@
  */
 class Test_AMP_Widget_Archives extends WP_UnitTestCase {
 
-	/**
-	 * Instance of the widget.
-	 *
-	 * @var object
-	 */
-	public $instance;
-
 	/**
 	 * Setup.
 	 *
@@ -28,9 +21,6 @@ public function setUp() {
 		parent::setUp();
 		wp_maybe_load_widgets();
 		AMP_Theme_Support::init();
-		$amp_widgets = new AMP_Widgets();
-		$amp_widgets->register_widgets();
-		$this->instance = new AMP_Widget_Archives();
 	}
 
 	/**
@@ -39,14 +29,13 @@ public function setUp() {
 	 * @see AMP_Widget_Archives::__construct().
 	 */
 	public function test_construct() {
-		global $wp_widget_factory;
-		$amp_archives = $wp_widget_factory->widgets['AMP_Widget_Archives'];
-		$this->assertEquals( 'AMP_Widget_Archives', get_class( $amp_archives ) );
-		$this->assertEquals( 'archives', $amp_archives->id_base );
-		$this->assertEquals( 'Archives', $amp_archives->name );
-		$this->assertEquals( 'widget_archive', $amp_archives->widget_options['classname'] );
-		$this->assertEquals( true, $amp_archives->widget_options['customize_selective_refresh'] );
-		$this->assertEquals( 'A monthly archive of your site&#8217;s Posts.', $amp_archives->widget_options['description'] );
+		$widget = new AMP_Widget_Archives();
+		$this->assertEquals( 'AMP_Widget_Archives', get_class( $widget ) );
+		$this->assertEquals( 'archives', $widget->id_base );
+		$this->assertEquals( 'Archives', $widget->name );
+		$this->assertEquals( 'widget_archive', $widget->widget_options['classname'] );
+		$this->assertEquals( true, $widget->widget_options['customize_selective_refresh'] );
+		$this->assertEquals( 'A monthly archive of your site&#8217;s Posts.', $widget->widget_options['description'] );
 	}
 
 	/**
@@ -55,6 +44,7 @@ public function test_construct() {
 	 * @see AMP_Widget_Archives::widget().
 	 */
 	public function test_widget() {
+		$widget    = new AMP_Widget_Archives();
 		$arguments = array(
 			'before_widget' => '<div>',
 			'after_widget'  => '</div>',
@@ -66,10 +56,10 @@ public function test_widget() {
 			'dropdown' => 1,
 		);
 		ob_start();
-		$this->instance->widget( $arguments, $instance );
+		$widget->widget( $arguments, $instance );
 		$output = ob_get_clean();
 
-		$this->assertFalse( strpos( $output, 'onchange=' ) );
+		$this->assertNotContains( 'onchange=', $output );
 	}
 
 }
diff --git a/tests/test-class-amp-widget-categories.php b/tests/test-class-amp-widget-categories.php
@@ -12,13 +12,6 @@
  */
 class Test_AMP_Widget_Categories extends WP_UnitTestCase {
 
-	/**
-	 * Instance of the widget.
-	 *
-	 * @var object
-	 */
-	public $instance;
-
 	/**
 	 * Setup.
 	 *
@@ -28,9 +21,6 @@ public function setUp() {
 		parent::setUp();
 		wp_maybe_load_widgets();
 		AMP_Theme_Support::init();
-		$amp_widgets = new AMP_Widgets();
-		$amp_widgets->register_widgets();
-		$this->instance = new AMP_Widget_Categories();
 	}
 
 	/**
@@ -39,14 +29,13 @@ public function setUp() {
 	 * @see AMP_Widget_Categories::__construct().
 	 */
 	public function test_construct() {
-		global $wp_widget_factory;
-		$amp_categories = $wp_widget_factory->widgets['AMP_Widget_Categories'];
-		$this->assertEquals( 'AMP_Widget_Categories', get_class( $amp_categories ) );
-		$this->assertEquals( 'categories', $amp_categories->id_base );
-		$this->assertEquals( 'Categories', $amp_categories->name );
-		$this->assertEquals( 'widget_categories', $amp_categories->widget_options['classname'] );
-		$this->assertEquals( true, $amp_categories->widget_options['customize_selective_refresh'] );
-		$this->assertEquals( 'A list or dropdown of categories.', $amp_categories->widget_options['description'] );
+		$widget = new AMP_Widget_Categories();
+		$this->assertEquals( 'AMP_Widget_Categories', get_class( $widget ) );
+		$this->assertEquals( 'categories', $widget->id_base );
+		$this->assertEquals( 'Categories', $widget->name );
+		$this->assertEquals( 'widget_categories', $widget->widget_options['classname'] );
+		$this->assertEquals( true, $widget->widget_options['customize_selective_refresh'] );
+		$this->assertEquals( 'A list or dropdown of categories.', $widget->widget_options['description'] );
 	}
 
 	/**
@@ -55,12 +44,13 @@ public function test_construct() {
 	 * @see AMP_Widget_Categories::modify_select().
 	 */
 	public function test_modify_select() {
-		$categories             = wp_dropdown_categories( array(
+		$widget         = new AMP_Widget_Categories();
+		$categories     = wp_dropdown_categories( array(
 			'echo' => 0,
 		) );
-		$number                 = 3;
-		$this->instance->number = $number;
-		$this->assertContains( strval( $number ), $this->instance->modify_select( $categories ) );
+		$number         = 3;
+		$widget->number = $number;
+		$this->assertContains( strval( $number ), $widget->modify_select( $categories ) );
 	}
 
 	/**
@@ -69,6 +59,7 @@ public function test_modify_select() {
 	 * @see AMP_Widget_Categories::widget().
 	 */
 	public function test_widget() {
+		$widget    = new AMP_Widget_Categories();
 		$arguments = array(
 			'before_widget' => '<div>',
 			'after_widget'  => '</div>',
@@ -80,10 +71,10 @@ public function test_widget() {
 			'dropdown' => 1,
 		);
 		ob_start();
-		$this->instance->widget( $arguments, $instance );
+		$widget->widget( $arguments, $instance );
 		$output = ob_get_clean();
 
-		$this->assertFalse( strpos( $output, '<script type=' ) );
+		$this->assertNotContains( '<script type=', $output );
 	}
 
 }
diff --git a/tests/test-class-amp-widget-media-audio.php b/tests/test-class-amp-widget-media-audio.php
@@ -12,13 +12,6 @@
  */
 class Test_AMP_Widget_Media_Audio extends WP_UnitTestCase {
 
-	/**
-	 * Instance of the widget.
-	 *
-	 * @var object
-	 */
-	public $instance;
-
 	/**
 	 * Setup.
 	 *
@@ -32,9 +25,6 @@ public function setUp() {
 		parent::setUp();
 		wp_maybe_load_widgets();
 		AMP_Theme_Support::init();
-		$amp_widgets = new AMP_Widgets();
-		$amp_widgets->register_widgets();
-		$this->instance = new AMP_Widget_Media_Audio();
 	}
 
 	/**
@@ -43,14 +33,12 @@ public function setUp() {
 	 * @see AMP_Widget_Media_Audio::__construct().
 	 */
 	public function test_construct() {
-		global $wp_widget_factory;
-		$amp_widget = $wp_widget_factory->widgets['AMP_Widget_Media_Audio'];
-
-		$this->assertEquals( 'media_audio', $amp_widget->id_base );
-		$this->assertEquals( 'Audio', $amp_widget->name );
-		$this->assertEquals( 'widget_media_audio', $amp_widget->widget_options['classname'] );
-		$this->assertEquals( true, $amp_widget->widget_options['customize_selective_refresh'] );
-		$this->assertEquals( 'Displays an audio player.', $amp_widget->widget_options['description'] );
+		$widget = new AMP_Widget_Media_Audio();
+		$this->assertEquals( 'media_audio', $widget->id_base );
+		$this->assertEquals( 'Audio', $widget->name );
+		$this->assertEquals( 'widget_media_audio', $widget->widget_options['classname'] );
+		$this->assertEquals( true, $widget->widget_options['customize_selective_refresh'] );
+		$this->assertEquals( 'Displays an audio player.', $widget->widget_options['description'] );
 	}
 
 	/**
@@ -61,6 +49,7 @@ public function test_construct() {
 	 * @see AMP_Widget_Media_Audio::render_media().
 	 */
 	public function test_render_media() {
+		$widget = new AMP_Widget_Media_Audio();
 		$audio = '/tmp/small-audio.mp3';
 		copy( DIR_TESTDATA . '/uploads/small-audio.mp3', $audio );
 		$attachment_id = self::factory()->attachment->create_object( array(
@@ -77,10 +66,10 @@ public function test_render_media() {
 		);
 
 		ob_start();
-		$this->instance->render_media( $instance );
+		$widget->render_media( $instance );
 		$output = ob_get_clean();
 
-		$this->assertFalse( strpos( $output, '<audio' ) );
+		$this->assertNotContains( '<audio', $output );
 		$this->assertContains( '<amp-audio', $output );
 	}