Merge pull request #4289 from ampproject/fix/4175-code-coverage

Improve code coverage

Author: westonruter

includes/admin/class-amp-customizer.php

@@ -325,6 +325,7 @@ public function print_controls_templates() {
 	/**
 	 * Whether the Customizer is AMP. This is always true since the AMP Customizer has been merged with the main Customizer.
 	 *
+	 * @codeCoverageIgnore
 	 * @deprecated 0.6
 	 * @return bool
 	 */

includes/amp-frontend-actions.php

@@ -2,6 +2,7 @@
 /**
  * Callbacks for adding AMP-related things to the main theme.
  *
+ * @codeCoverageIgnore
  * @deprecated Function in this file has been moved to amp-helper-functions.php.
  * @package AMP
  */

includes/class-amp-comment-walker.php

@@ -2,6 +2,7 @@
 /**
  * Class AMP_Comment_Walker
  *
+ * @codeCoverageIgnore
  * @deprecated 1.1.0 This functionality was moved to AMP_Comments_Sanitizer
  * @package AMP
  */

includes/class-amp-post-type-support.php

@@ -22,6 +22,7 @@ class AMP_Post_Type_Support {
 	 * Get post types that plugin supports out of the box (which cannot be disabled).
 	 *
 	 * @deprecated
+	 * @codeCoverageIgnore
 	 * @return string[] Post types.
 	 */
 	public static function get_builtin_supported_post_types() {

includes/class-amp-theme-support.php

@@ -216,6 +216,7 @@ static function () {
 	 * @since 1.0
 	 * @see AMP_Theme_Support::read_theme_support()
 	 * @see AMP_Theme_Support::get_support_mode()
+	 * @codeCoverageIgnore
 	 * @deprecated Use AMP_Theme_Support::get_support_mode_added_via_option().
 	 *
 	 * @return bool Support added via option.
@@ -1233,6 +1234,7 @@ public static function register_content_embed_handlers() {
 	/**
 	 * Add the comments template placeholder marker
 	 *
+	 * @codeCoverageIgnore
 	 * @deprecated 1.1.0 This functionality was moved to AMP_Comments_Sanitizer
 	 *
 	 * @param array $args the args for the comments list.

includes/deprecated.php

@@ -9,6 +9,7 @@
  * Load classes.
  *
  * @since 0.2
+ * @codeCoverageIgnore
  * @deprecated As of 0.6 since autoloading is now employed.
  */
 function amp_load_classes() {
@@ -21,6 +22,7 @@ function amp_load_classes() {
  * If the request is for an AMP page and this is in 'canonical mode,' redirect to the non-AMP page.
  * It won't need this plugin's template system, nor the frontend actions like the 'rel' link.
  *
+ * @codeCoverageIgnore
  * @deprecated This function is not used when 'amp' theme support is added.
  * @global WP_Query $wp_query
  * @since 0.2
@@ -85,6 +87,7 @@ function amp_maybe_add_actions() {
  * Add post template actions.
  *
  * @since 0.2
+ * @codeCoverageIgnore
  * @deprecated This function is not used when 'amp' theme support is added.
  */
 function amp_add_post_template_actions() {
@@ -98,6 +101,7 @@ function amp_add_post_template_actions() {
  *
  * @since 0.2
  * @since 1.0 The amp_render() function is called at template_redirect action priority 11 instead of priority 10.
+ * @codeCoverageIgnore
  * @deprecated This function is not used when 'amp' theme support is added.
  */
 function amp_prepare_render() {
@@ -109,6 +113,7 @@ function amp_prepare_render() {
  * Render AMP for queried post.
  *
  * @since 0.1
+ * @codeCoverageIgnore
  * @deprecated This function is not used when 'amp' theme support is added.
  */
 function amp_render() {
@@ -126,6 +131,7 @@ function amp_render() {
  * Render AMP post template.
  *
  * @since 0.5
+ * @codeCoverageIgnore
  * @deprecated Rendering a post is now handled by AMP_Theme_Support.
  *
  * @param WP_Post|int $post Post.
@@ -181,6 +187,7 @@ function amp_render_post( $post ) {
 /**
  * Print scripts.
  *
+ * @codeCoverageIgnore
  * @deprecated Scripts are now automatically added.
  * @see amp_register_default_scripts()
  * @see amp_filter_script_loader_tag()
@@ -203,6 +210,7 @@ function amp_post_template_add_scripts( $amp_template ) {
 /**
  * Print boilerplate CSS.
  *
+ * @codeCoverageIgnore
  * @deprecated Boilerplate is now automatically added.
  * @since 0.3
  * @see amp_get_boilerplate_code()
@@ -215,6 +223,7 @@ function amp_post_template_add_boilerplate_css() {
 /**
  * Print Schema.org metadata.
  *
+ * @codeCoverageIgnore
  * @deprecated Since 0.7
  */
 function amp_post_template_add_schemaorg_metadata() {
@@ -228,6 +237,7 @@ function amp_post_template_add_schemaorg_metadata() {
  * This function must be invoked only once through the 'wp_loaded' action.
  *
  * @since 0.6
+ * @codeCoverageIgnore
  * @deprecated Since 1.5.0, as admin class bootstrapping is moved to amp_bootstrap_admin().
  */
 function amp_post_meta_box() {
@@ -238,6 +248,7 @@ function amp_post_meta_box() {
  * Bootstrap the AMP admin pointer class.
  *
  * @since 1.0
+ * @codeCoverageIgnore
  * @deprecated Since 1.5.0, as admin class bootstrapping is moved to amp_bootstrap_admin().
  */
 function amp_admin_pointer() {

includes/embeds/class-amp-soundcloud-embed.php

@@ -38,6 +38,7 @@ public function unregister_embed() {
 	 *
 	 * @see \WP_Embed::shortcode()
 	 *
+	 * @codeCoverageIgnore
 	 * @deprecated Core's oEmbed handler is now used instead, with embed_oembed_html filter used to convert to AMP.
 	 * @param array  $matches URL pattern matches.
 	 * @param array  $attr    Shortcode attributes.

includes/sanitizers/class-amp-base-sanitizer.php

@@ -174,6 +174,7 @@ public function get_scripts() {
 	 * Return array of values that would be valid as an HTML `style` attribute.
 	 *
 	 * @since 0.4
+	 * @codeCoverageIgnore
 	 * @deprecated As of 1.0, use get_stylesheets().
 	 *
 	 * @return array[][] Mapping of CSS selectors to arrays of properties.
@@ -203,6 +204,7 @@ public function get_stylesheets() {
 	/**
 	 * Get HTML body as DOMElement from Dom\Document received by the constructor.
 	 *
+	 * @codeCoverageIgnore
 	 * @deprecated Use $this->dom->body instead.
 	 * @return DOMElement The body element.
 	 */

includes/sanitizers/class-amp-blacklist-sanitizer.php

@@ -12,6 +12,7 @@
  *     https://github.com/ampproject/amphtml/blob/master/spec/amp-html-format.md#html-tags
  *
  * @since 0.5 This has been replaced by AMP_Tag_And_Attribute_Sanitizer but is kept around for back-compat.
+ * @codeCoverageIgnore
  * @deprecated
  */
 class AMP_Blacklist_Sanitizer extends AMP_Base_Sanitizer {

includes/sanitizers/class-amp-core-theme-sanitizer.php

@@ -48,6 +48,23 @@ class AMP_Core_Theme_Sanitizer extends AMP_Base_Sanitizer {
 		'twentyten',
 	];
 
+	/**
+	 * Known modal roles.
+	 *
+	 * @var array
+	 */
+	protected static $modal_roles = [
+		'navigation',
+		'menu',
+		'search',
+		'alert',
+		'figure',
+		'form',
+		'img',
+		'toolbar',
+		'tooltip',
+	];
+
 	/**
 	 * Retrieve the config for features needed by a theme.
 	 *
@@ -401,6 +418,7 @@ protected static function get_theme_support_args( $theme ) {
 	 * Get theme config.
 	 *
 	 * @since 1.0
+	 * @codeCoverageIgnore
 	 * @deprecated 1.1
 	 *
 	 * @param string $theme Theme slug.
@@ -1909,10 +1927,10 @@ protected function guess_modal_role( DOMElement $modal ) {
 			return 'dialog';
 		}
 
-		$classes = $modal->getAttribute( 'class' );
+		$classes = preg_split( '/\s+/', trim( $modal->getAttribute( 'class' ) ) );
 
-		foreach ( [ 'navigation', 'menu', 'search', 'alert', 'figure', 'form', 'img', 'toolbar', 'tooltip' ] as $role ) {
-			if ( false !== strpos( $classes, $role ) ) {
+		foreach ( self::$modal_roles as $role ) {
+			if ( in_array( $role, $classes, true ) ) {
 				return $role;
 			}
 		}