wmde / hamcrest-html-matchers

src/AttributeMatcher.php

Indentation +100 added lines, -100 removed lines

@@ -7,114 +7,114 @@
 
 class AttributeMatcher extends TagMatcher {
 
-	/**
-	 * @var Matcher|string
-	 */
-	private $attributeNameMatcher;
+    /**
+     * @var Matcher|string
+     */
+    private $attributeNameMatcher;
 
-	/**
-	 * @var Matcher|string|null
-	 */
-	private $valueMatcher;
+    /**
+     * @var Matcher|string|null
+     */
+    private $valueMatcher;
 
-	/**
-	 * @param Matcher|string $attributeName
-	 *
-	 * @return self
-	 */
-	public static function withAttribute( $attributeName ) {
-		return new static( $attributeName );
-	}
+    /**
+     * @param Matcher|string $attributeName
+     *
+     * @return self
+     */
+    public static function withAttribute( $attributeName ) {
+        return new static( $attributeName );
+    }
 
-	/**
-	 * @param Matcher|string $attributeNameMatcher
-	 */
-	public function __construct( $attributeNameMatcher ) {
-		parent::__construct();
+    /**
+     * @param Matcher|string $attributeNameMatcher
+     */
+    public function __construct( $attributeNameMatcher ) {
+        parent::__construct();
 
-		$this->attributeNameMatcher = $attributeNameMatcher;
-	}
+        $this->attributeNameMatcher = $attributeNameMatcher;
+    }
 
-	/**
-	 * @param Matcher|string $value
-	 *
-	 * @return AttributeMatcher
-	 */
-	public function havingValue( $value ) {
-		// TODO: Throw exception if value is set
-		$result = clone $this;
-		$result->valueMatcher = $value;
+    /**
+     * @param Matcher|string $value
+     *
+     * @return AttributeMatcher
+     */
+    public function havingValue( $value ) {
+        // TODO: Throw exception if value is set
+        $result = clone $this;
+        $result->valueMatcher = $value;
 
-		return $result;
-	}
+        return $result;
+    }
 
-	public function describeTo( Description $description ) {
-		$description->appendText( 'with attribute ' );
-		if ( $this->attributeNameMatcher instanceof Matcher ) {
-			$description->appendDescriptionOf( $this->attributeNameMatcher );
-		} else {
-			$description->appendValue( $this->attributeNameMatcher );
-		}
-		if ( $this->valueMatcher !== null ) {
-			$description->appendText( ' having value ' );
-			if ( $this->attributeNameMatcher instanceof Matcher ) {
-				$description->appendDescriptionOf( $this->valueMatcher );
-			} else {
-				$description->appendValue( $this->valueMatcher );
-			}
-		}
-	}
+    public function describeTo( Description $description ) {
+        $description->appendText( 'with attribute ' );
+        if ( $this->attributeNameMatcher instanceof Matcher ) {
+            $description->appendDescriptionOf( $this->attributeNameMatcher );
+        } else {
+            $description->appendValue( $this->attributeNameMatcher );
+        }
+        if ( $this->valueMatcher !== null ) {
+            $description->appendText( ' having value ' );
+            if ( $this->attributeNameMatcher instanceof Matcher ) {
+                $description->appendDescriptionOf( $this->valueMatcher );
+            } else {
+                $description->appendValue( $this->valueMatcher );
+            }
+        }
+    }
 
-	/**
-	 * @param \DOMElement $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		if ( $this->valueMatcher === null ) {
-			if ( $this->attributeNameMatcher instanceof Matcher ) {
-				/** @var \DOMAttr $attribute */
-				foreach ( $item->attributes as $attribute ) {
-					if ( $this->attributeNameMatcher->matches( $attribute->name ) ) {
-						return true;
-					}
-				}
-			} else {
-				return $item->hasAttribute( $this->attributeNameMatcher );
-			}
-		} else {
-			if ( $this->attributeNameMatcher instanceof Matcher ) {
-				if ( $this->valueMatcher instanceof Matcher ) {
-					/** @var \DOMAttr $attribute */
-					foreach ( $item->attributes as $attribute ) {
-						if ( $this->attributeNameMatcher->matches( $attribute->name )
-							&& $this->valueMatcher->matches( $attribute->value )
-						) {
-							return true;
-						}
-					}
-				} else {
-					/** @var \DOMAttr $attribute */
-					foreach ( $item->attributes as $attribute ) {
-						if ( $this->attributeNameMatcher->matches( $attribute->name )
-							&& $attribute->value === $this->valueMatcher
-						) {
-							return true;
-						}
-					}
-				}
-			} else {
-				if ( $this->valueMatcher instanceof Matcher ) {
-					return $item->hasAttribute( $this->attributeNameMatcher )
-						&& $this->valueMatcher->matches( $item->getAttribute( $this->attributeNameMatcher ) );
-				} else {
-					return $item->getAttribute( $this->attributeNameMatcher ) === $this->valueMatcher;
-				}
-			}
-		}
+    /**
+     * @param \DOMElement $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        if ( $this->valueMatcher === null ) {
+            if ( $this->attributeNameMatcher instanceof Matcher ) {
+                /** @var \DOMAttr $attribute */
+                foreach ( $item->attributes as $attribute ) {
+                    if ( $this->attributeNameMatcher->matches( $attribute->name ) ) {
+                        return true;
+                    }
+                }
+            } else {
+                return $item->hasAttribute( $this->attributeNameMatcher );
+            }
+        } else {
+            if ( $this->attributeNameMatcher instanceof Matcher ) {
+                if ( $this->valueMatcher instanceof Matcher ) {
+                    /** @var \DOMAttr $attribute */
+                    foreach ( $item->attributes as $attribute ) {
+                        if ( $this->attributeNameMatcher->matches( $attribute->name )
+                            && $this->valueMatcher->matches( $attribute->value )
+                        ) {
+                            return true;
+                        }
+                    }
+                } else {
+                    /** @var \DOMAttr $attribute */
+                    foreach ( $item->attributes as $attribute ) {
+                        if ( $this->attributeNameMatcher->matches( $attribute->name )
+                            && $attribute->value === $this->valueMatcher
+                        ) {
+                            return true;
+                        }
+                    }
+                }
+            } else {
+                if ( $this->valueMatcher instanceof Matcher ) {
+                    return $item->hasAttribute( $this->attributeNameMatcher )
+                        && $this->valueMatcher->matches( $item->getAttribute( $this->attributeNameMatcher ) );
+                } else {
+                    return $item->getAttribute( $this->attributeNameMatcher ) === $this->valueMatcher;
+                }
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

src/TextContentsMatcher.php

Indentation +44 added lines, -44 removed lines

@@ -7,49 +7,49 @@
 
 class TextContentsMatcher extends TagMatcher {
 
-	/**
-	 * @var Matcher|string
-	 */
-	private $matcher;
-
-	/**
-	 * @param Matcher|string $text
-	 *
-	 * @return self
-	 */
-	public static function havingTextContents( $text ) {
-		return new static( $text );
-	}
-
-	/**
-	 * @param Matcher|string $matcher
-	 */
-	public function __construct( $matcher ) {
-		parent::__construct();
-		$this->matcher = $matcher;
-	}
-
-	public function describeTo( Description $description ) {
-		$description->appendText( 'having text contents ' );
-		if ( $this->matcher instanceof Matcher ) {
-			$description->appendDescriptionOf( $this->matcher );
-		} else {
-			$description->appendValue( $this->matcher );
-		}
-	}
-
-	/**
-	 * @param \DOMElement $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		if ( $this->matcher instanceof Matcher ) {
-			return $this->matcher->matches( $item->textContent );
-		} else {
-			return $item->textContent === (string)$this->matcher;
-		}
-	}
+    /**
+     * @var Matcher|string
+     */
+    private $matcher;
+
+    /**
+     * @param Matcher|string $text
+     *
+     * @return self
+     */
+    public static function havingTextContents( $text ) {
+        return new static( $text );
+    }
+
+    /**
+     * @param Matcher|string $matcher
+     */
+    public function __construct( $matcher ) {
+        parent::__construct();
+        $this->matcher = $matcher;
+    }
+
+    public function describeTo( Description $description ) {
+        $description->appendText( 'having text contents ' );
+        if ( $this->matcher instanceof Matcher ) {
+            $description->appendDescriptionOf( $this->matcher );
+        } else {
+            $description->appendValue( $this->matcher );
+        }
+    }
+
+    /**
+     * @param \DOMElement $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        if ( $this->matcher instanceof Matcher ) {
+            return $this->matcher->matches( $item->textContent );
+        } else {
+            return $item->textContent === (string)$this->matcher;
+        }
+    }
 
 }

src/ChildElementMatcher.php

Indentation +62 added lines, -62 removed lines

@@ -8,75 +8,75 @@
 
 class ChildElementMatcher extends TypeSafeDiagnosingMatcher {
 
-	/**
-	 * @var Matcher|string|null
-	 */
-	private $matcher;
+    /**
+     * @var Matcher|string|null
+     */
+    private $matcher;
 
-	/**
-	 * @param Matcher|string|null $elementMatcher
-	 *
-	 * @return self
-	 */
-	public static function havingChild( $elementMatcher = null ) {
-		return new static( $elementMatcher );
-	}
+    /**
+     * @param Matcher|string|null $elementMatcher
+     *
+     * @return self
+     */
+    public static function havingChild( $elementMatcher = null ) {
+        return new static( $elementMatcher );
+    }
 
-	/**
-	 * @param Matcher|string|null $matcher
-	 */
-	public function __construct( $matcher = null ) {
-		parent::__construct( \DOMNode::class );
-		$this->matcher = $matcher;
-	}
+    /**
+     * @param Matcher|string|null $matcher
+     */
+    public function __construct( $matcher = null ) {
+        parent::__construct( \DOMNode::class );
+        $this->matcher = $matcher;
+    }
 
-	public function describeTo( Description $description ) {
-		$description->appendText( 'having child ' );
-		if ( $this->matcher ) {
-			if ( $this->matcher instanceof Matcher ) {
-				$description->appendDescriptionOf( $this->matcher );
-			} else {
-				$description->appendValue( $this->matcher );
-			}
-		}
-	}
+    public function describeTo( Description $description ) {
+        $description->appendText( 'having child ' );
+        if ( $this->matcher ) {
+            if ( $this->matcher instanceof Matcher ) {
+                $description->appendDescriptionOf( $this->matcher );
+            } else {
+                $description->appendValue( $this->matcher );
+            }
+        }
+    }
 
-	/**
-	 * @param \DOMDocument|\DOMNode $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		if ( $item instanceof \DOMDocument ) {
-			$item = $item->documentElement->childNodes->item( 0 );
-			/** @var \DOMElement $item */
-		}
-		$directChildren = $item->childNodes;
+    /**
+     * @param \DOMDocument|\DOMNode $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        if ( $item instanceof \DOMDocument ) {
+            $item = $item->documentElement->childNodes->item( 0 );
+            /** @var \DOMElement $item */
+        }
+        $directChildren = $item->childNodes;
 
-		if ( $directChildren->length === 0 ) {
-			$mismatchDescription->appendText( 'having no children' );
-			return false;
-		}
+        if ( $directChildren->length === 0 ) {
+            $mismatchDescription->appendText( 'having no children' );
+            return false;
+        }
 
-		if ( !$this->matcher ) {
-			return true;
-		}
+        if ( !$this->matcher ) {
+            return true;
+        }
 
-		if ( $this->matcher instanceof Matcher ) {
-			foreach ( new XmlNodeRecursiveIterator( $directChildren ) as $child ) {
-				if ( $this->matcher->matches( $child ) ) {
-					return true;
-				}
-			}
-		} else {
-			if ( $item->getElementsByTagName( $this->matcher )->length !== 0 ) {
-				return true;
-			}
-		}
+        if ( $this->matcher instanceof Matcher ) {
+            foreach ( new XmlNodeRecursiveIterator( $directChildren ) as $child ) {
+                if ( $this->matcher->matches( $child ) ) {
+                    return true;
+                }
+            }
+        } else {
+            if ( $item->getElementsByTagName( $this->matcher )->length !== 0 ) {
+                return true;
+            }
+        }
 
-		$mismatchDescription->appendText( 'having no children ' )->appendDescriptionOf( $this->matcher );
-		return false;
-	}
+        $mismatchDescription->appendText( 'having no children ' )->appendDescriptionOf( $this->matcher );
+        return false;
+    }
 
 }

src/TagNameMatcher.php

Indentation +51 added lines, -51 removed lines

@@ -7,62 +7,62 @@
 
 class TagNameMatcher extends TagMatcher {
 
-	/**
-	 * @var Matcher|string
-	 */
-	private $tagNameMatcher;
+    /**
+     * @var Matcher|string
+     */
+    private $tagNameMatcher;
 
-	/**
-	 * @param Matcher|string $tagName
-	 *
-	 * @return self
-	 */
-	public static function withTagName( $tagName ) {
-		return new static( $tagName );
-	}
+    /**
+     * @param Matcher|string $tagName
+     *
+     * @return self
+     */
+    public static function withTagName( $tagName ) {
+        return new static( $tagName );
+    }
 
-	/**
-	 * @param Matcher|string $tagNameMatcher
-	 */
-	public function __construct( $tagNameMatcher ) {
-		parent::__construct();
-		$this->tagNameMatcher = $tagNameMatcher;
-	}
+    /**
+     * @param Matcher|string $tagNameMatcher
+     */
+    public function __construct( $tagNameMatcher ) {
+        parent::__construct();
+        $this->tagNameMatcher = $tagNameMatcher;
+    }
 
-	public function describeTo( Description $description ) {
-		$description->appendText( 'with tag name ' );
-		if ( $this->tagNameMatcher instanceof Matcher ) {
-			$description->appendDescriptionOf( $this->tagNameMatcher );
-		} else {
-			$description->appendValue( $this->tagNameMatcher );
-		}
-	}
+    public function describeTo( Description $description ) {
+        $description->appendText( 'with tag name ' );
+        if ( $this->tagNameMatcher instanceof Matcher ) {
+            $description->appendDescriptionOf( $this->tagNameMatcher );
+        } else {
+            $description->appendValue( $this->tagNameMatcher );
+        }
+    }
 
-	/**
-	 * @param \DOMElement $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		if ( $this->tagNameMatcher instanceof Matcher ) {
-			if ( $this->tagNameMatcher->matches( $item->tagName ) ) {
-				return true;
-			}
-		} else {
-			if ( $item->tagName === $this->tagNameMatcher ) {
-				return true;
-			}
-		}
+    /**
+     * @param \DOMElement $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        if ( $this->tagNameMatcher instanceof Matcher ) {
+            if ( $this->tagNameMatcher->matches( $item->tagName ) ) {
+                return true;
+            }
+        } else {
+            if ( $item->tagName === $this->tagNameMatcher ) {
+                return true;
+            }
+        }
 
-		$mismatchDescription->appendText( 'tag name ' );
-		if ( $this->tagNameMatcher instanceof Matcher ) {
-			$this->tagNameMatcher->describeMismatch( $item->tagName, $mismatchDescription );
-		} else {
-			$mismatchDescription->appendText( 'was ' )->appendValue( $item->tagName );
-		}
+        $mismatchDescription->appendText( 'tag name ' );
+        if ( $this->tagNameMatcher instanceof Matcher ) {
+            $this->tagNameMatcher->describeMismatch( $item->tagName, $mismatchDescription );
+        } else {
+            $mismatchDescription->appendText( 'was ' )->appendValue( $item->tagName );
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

src/ComplexTagMatcher.php

Indentation +214 added lines, -214 removed lines

@@ -9,219 +9,219 @@
 
 class ComplexTagMatcher extends TagMatcher {
 
-	/**
-	 * @link http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
-	 * @link https://github.com/Chronic-Dev/libxml2/blob/683f296a905710ff285c28b8644ef3a3d8be9486/include/libxml/xmlerror.h#L257
-	 */
-	const XML_UNKNOWN_TAG_ERROR_CODE = 801;
-
-	/**
-	 * @var string
-	 */
-	private $tagHtmlOutline;
-
-	/**
-	 * @var Matcher
-	 */
-	private $matcher;
-
-	/**
-	 * @param string $htmlOutline
-	 *
-	 * @return self
-	 */
-	public static function tagMatchingOutline( $htmlOutline ) {
-		return new self( $htmlOutline );
-	}
-
-	/**
-	 * @param string $tagHtmlRepresentation
-	 */
-	public function __construct( $tagHtmlRepresentation ) {
-		parent::__construct();
-
-		$this->tagHtmlOutline = $tagHtmlRepresentation;
-		$this->matcher = $this->createMatcherFromHtml( $tagHtmlRepresentation );
-	}
-
-	public function describeTo( Description $description ) {
-		$description->appendText( 'tag matching outline `' )
-			->appendText( $this->tagHtmlOutline )
-			->appendText( '` ' );
-	}
-
-	/**
-	 * @param \DOMElement $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		if ( $this->matcher->matches( $item ) ) {
-			return true;
-		}
-
-		$mismatchDescription->appendText( 'was `' )
-			->appendText( $this->elementToString( $item ) )
-			->appendText( '`' );
-		return false;
-	}
-
-	/**
-	 * @param string $htmlOutline
-	 *
-	 * @return Matcher
-	 */
-	private function createMatcherFromHtml( $htmlOutline ) {
-		$document = $this->parseHtml( $htmlOutline );
-		$targetTag = $this->getSingleTagFromThe( $document );
-
-		$this->assertTagDoesNotContainChildren( $targetTag );
-
-		$attributeMatchers = $this->createAttributeMatchers( $htmlOutline, $targetTag );
-		$classMatchers = $this->createClassMatchers( $targetTag );
-
-		return AllOf::allOf(
-			TagNameMatcher::withTagName( $targetTag->tagName ),
-			count( $attributeMatchers ) === 1
-				? $attributeMatchers[0]
-				: call_user_func_array( [ AllOf::class, 'allOf' ], $attributeMatchers ),
-			count( $classMatchers ) === 1
-				? $classMatchers[0]
-				: call_user_func_array( [ AllOf::class, 'allOf' ], $classMatchers )
-		);
-	}
-
-	/**
-	 * @param \LibXMLError $error
-	 *
-	 * @return bool
-	 */
-	private function isUnknownTagError( \LibXMLError $error ) {
-		return $error->code === self::XML_UNKNOWN_TAG_ERROR_CODE;
-	}
-
-	/**
-	 * @param string $inputHtml
-	 * @param string $attributeName
-	 *
-	 * @return bool
-	 */
-	private function isBooleanAttribute( $inputHtml, $attributeName ) {
-		$quotedName = preg_quote( $attributeName, '/' );
-
-		$attributeHasValueAssigned = preg_match( "/\b{$quotedName}\s*=/ui", $inputHtml );
-		return !$attributeHasValueAssigned;
-	}
-
-	/**
-	 * @param string $html
-	 *
-	 * @return \DOMDocument
-	 * @throws \InvalidArgumentException
-	 */
-	private function parseHtml( $html ) {
-		$internalErrors = libxml_use_internal_errors( true );
-		$document = new \DOMDocument();
-
-		// phpcs:ignore Generic.PHP.NoSilencedErrors
-		if ( !@$document->loadHTML( $html ) ) {
-			throw new \InvalidArgumentException( "There was some parsing error of `$html`" );
-		}
-
-		$errors = libxml_get_errors();
-		libxml_clear_errors();
-		libxml_use_internal_errors( $internalErrors );
-
-		/** @var \LibXMLError $error */
-		foreach ( $errors as $error ) {
-			if ( $this->isUnknownTagError( $error ) ) {
-				continue;
-			}
-
-			throw new \InvalidArgumentException(
-				'There was parsing error: ' . trim( $error->message ) . ' on line ' . $error->line
-			);
-		}
-
-		return $document;
-	}
-
-	/**
-	 * @param \DOMDocument $document
-	 *
-	 * @return \DOMElement
-	 * @throws \InvalidArgumentException
-	 */
-	private function getSingleTagFromThe( \DOMDocument $document ) {
-		$directChildren = $document->documentElement->childNodes->item( 0 )->childNodes;
-
-		if ( $directChildren->length !== 1 ) {
-			throw new InvalidArgumentException(
-				'Expected exactly 1 tag description, got ' . $directChildren->length
-			);
-		}
-
-		return $directChildren->item( 0 );
-	}
-
-	private function assertTagDoesNotContainChildren( \DOMElement $targetTag ) {
-		if ( $targetTag->childNodes->length > 0 ) {
-			throw new InvalidArgumentException( 'Nested elements are not allowed' );
-		}
-	}
-
-	/**
-	 * @param string $inputHtml
-	 * @param \DOMElement $targetTag
-	 *
-	 * @return AttributeMatcher[]
-	 */
-	private function createAttributeMatchers( $inputHtml, \DOMElement $targetTag ) {
-		$attributeMatchers = [];
-		/** @var \DOMAttr $attribute */
-		foreach ( $targetTag->attributes as $attribute ) {
-			if ( $attribute->name === 'class' ) {
-				continue;
-			}
-
-			$attributeMatcher = AttributeMatcher::withAttribute( $attribute->name );
-			if ( !$this->isBooleanAttribute( $inputHtml, $attribute->name ) ) {
-				$attributeMatcher = $attributeMatcher->havingValue( $attribute->value );
-			}
-
-			$attributeMatchers[] = $attributeMatcher;
-		}
-		return $attributeMatchers;
-	}
-
-	/**
-	 * @param \DOMElement $targetTag
-	 *
-	 * @return ClassMatcher[]
-	 */
-	private function createClassMatchers( \DOMElement $targetTag ) {
-		$classMatchers = [];
-		$classValue = $targetTag->getAttribute( 'class' );
-		foreach ( explode( ' ', $classValue ) as $expectedClass ) {
-			if ( $expectedClass === '' ) {
-				continue;
-			}
-			$classMatchers[] = ClassMatcher::withClass( $expectedClass );
-		}
-		return $classMatchers;
-	}
-
-	/**
-	 * @param \DOMElement $element
-	 *
-	 * @return string
-	 */
-	private function elementToString( \DOMElement $element ) {
-		$newDocument = new \DOMDocument();
-		$cloned = $element->cloneNode( true );
-		$newDocument->appendChild( $newDocument->importNode( $cloned, true ) );
-		return trim( $newDocument->saveHTML() );
-	}
+    /**
+     * @link http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
+     * @link https://github.com/Chronic-Dev/libxml2/blob/683f296a905710ff285c28b8644ef3a3d8be9486/include/libxml/xmlerror.h#L257
+     */
+    const XML_UNKNOWN_TAG_ERROR_CODE = 801;
+
+    /**
+     * @var string
+     */
+    private $tagHtmlOutline;
+
+    /**
+     * @var Matcher
+     */
+    private $matcher;
+
+    /**
+     * @param string $htmlOutline
+     *
+     * @return self
+     */
+    public static function tagMatchingOutline( $htmlOutline ) {
+        return new self( $htmlOutline );
+    }
+
+    /**
+     * @param string $tagHtmlRepresentation
+     */
+    public function __construct( $tagHtmlRepresentation ) {
+        parent::__construct();
+
+        $this->tagHtmlOutline = $tagHtmlRepresentation;
+        $this->matcher = $this->createMatcherFromHtml( $tagHtmlRepresentation );
+    }
+
+    public function describeTo( Description $description ) {
+        $description->appendText( 'tag matching outline `' )
+            ->appendText( $this->tagHtmlOutline )
+            ->appendText( '` ' );
+    }
+
+    /**
+     * @param \DOMElement $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        if ( $this->matcher->matches( $item ) ) {
+            return true;
+        }
+
+        $mismatchDescription->appendText( 'was `' )
+            ->appendText( $this->elementToString( $item ) )
+            ->appendText( '`' );
+        return false;
+    }
+
+    /**
+     * @param string $htmlOutline
+     *
+     * @return Matcher
+     */
+    private function createMatcherFromHtml( $htmlOutline ) {
+        $document = $this->parseHtml( $htmlOutline );
+        $targetTag = $this->getSingleTagFromThe( $document );
+
+        $this->assertTagDoesNotContainChildren( $targetTag );
+
+        $attributeMatchers = $this->createAttributeMatchers( $htmlOutline, $targetTag );
+        $classMatchers = $this->createClassMatchers( $targetTag );
+
+        return AllOf::allOf(
+            TagNameMatcher::withTagName( $targetTag->tagName ),
+            count( $attributeMatchers ) === 1
+                ? $attributeMatchers[0]
+                : call_user_func_array( [ AllOf::class, 'allOf' ], $attributeMatchers ),
+            count( $classMatchers ) === 1
+                ? $classMatchers[0]
+                : call_user_func_array( [ AllOf::class, 'allOf' ], $classMatchers )
+        );
+    }
+
+    /**
+     * @param \LibXMLError $error
+     *
+     * @return bool
+     */
+    private function isUnknownTagError( \LibXMLError $error ) {
+        return $error->code === self::XML_UNKNOWN_TAG_ERROR_CODE;
+    }
+
+    /**
+     * @param string $inputHtml
+     * @param string $attributeName
+     *
+     * @return bool
+     */
+    private function isBooleanAttribute( $inputHtml, $attributeName ) {
+        $quotedName = preg_quote( $attributeName, '/' );
+
+        $attributeHasValueAssigned = preg_match( "/\b{$quotedName}\s*=/ui", $inputHtml );
+        return !$attributeHasValueAssigned;
+    }
+
+    /**
+     * @param string $html
+     *
+     * @return \DOMDocument
+     * @throws \InvalidArgumentException
+     */
+    private function parseHtml( $html ) {
+        $internalErrors = libxml_use_internal_errors( true );
+        $document = new \DOMDocument();
+
+        // phpcs:ignore Generic.PHP.NoSilencedErrors
+        if ( !@$document->loadHTML( $html ) ) {
+            throw new \InvalidArgumentException( "There was some parsing error of `$html`" );
+        }
+
+        $errors = libxml_get_errors();
+        libxml_clear_errors();
+        libxml_use_internal_errors( $internalErrors );
+
+        /** @var \LibXMLError $error */
+        foreach ( $errors as $error ) {
+            if ( $this->isUnknownTagError( $error ) ) {
+                continue;
+            }
+
+            throw new \InvalidArgumentException(
+                'There was parsing error: ' . trim( $error->message ) . ' on line ' . $error->line
+            );
+        }
+
+        return $document;
+    }
+
+    /**
+     * @param \DOMDocument $document
+     *
+     * @return \DOMElement
+     * @throws \InvalidArgumentException
+     */
+    private function getSingleTagFromThe( \DOMDocument $document ) {
+        $directChildren = $document->documentElement->childNodes->item( 0 )->childNodes;
+
+        if ( $directChildren->length !== 1 ) {
+            throw new InvalidArgumentException(
+                'Expected exactly 1 tag description, got ' . $directChildren->length
+            );
+        }
+
+        return $directChildren->item( 0 );
+    }
+
+    private function assertTagDoesNotContainChildren( \DOMElement $targetTag ) {
+        if ( $targetTag->childNodes->length > 0 ) {
+            throw new InvalidArgumentException( 'Nested elements are not allowed' );
+        }
+    }
+
+    /**
+     * @param string $inputHtml
+     * @param \DOMElement $targetTag
+     *
+     * @return AttributeMatcher[]
+     */
+    private function createAttributeMatchers( $inputHtml, \DOMElement $targetTag ) {
+        $attributeMatchers = [];
+        /** @var \DOMAttr $attribute */
+        foreach ( $targetTag->attributes as $attribute ) {
+            if ( $attribute->name === 'class' ) {
+                continue;
+            }
+
+            $attributeMatcher = AttributeMatcher::withAttribute( $attribute->name );
+            if ( !$this->isBooleanAttribute( $inputHtml, $attribute->name ) ) {
+                $attributeMatcher = $attributeMatcher->havingValue( $attribute->value );
+            }
+
+            $attributeMatchers[] = $attributeMatcher;
+        }
+        return $attributeMatchers;
+    }
+
+    /**
+     * @param \DOMElement $targetTag
+     *
+     * @return ClassMatcher[]
+     */
+    private function createClassMatchers( \DOMElement $targetTag ) {
+        $classMatchers = [];
+        $classValue = $targetTag->getAttribute( 'class' );
+        foreach ( explode( ' ', $classValue ) as $expectedClass ) {
+            if ( $expectedClass === '' ) {
+                continue;
+            }
+            $classMatchers[] = ClassMatcher::withClass( $expectedClass );
+        }
+        return $classMatchers;
+    }
+
+    /**
+     * @param \DOMElement $element
+     *
+     * @return string
+     */
+    private function elementToString( \DOMElement $element ) {
+        $newDocument = new \DOMDocument();
+        $cloned = $element->cloneNode( true );
+        $newDocument->appendChild( $newDocument->importNode( $cloned, true ) );
+        return trim( $newDocument->saveHTML() );
+    }
 
 }

src/ClassMatcher.php

Indentation +50 added lines, -50 removed lines

@@ -7,60 +7,60 @@
 
 class ClassMatcher extends TagMatcher {
 
-	/**
-	 * @var Matcher|string
-	 */
-	private $classMatcher;
+    /**
+     * @var Matcher|string
+     */
+    private $classMatcher;
 
-	/**
-	 * @param Matcher|string $class
-	 *
-	 * @return self
-	 */
-	public static function withClass( $class ) {
-		return new static( $class );
-	}
+    /**
+     * @param Matcher|string $class
+     *
+     * @return self
+     */
+    public static function withClass( $class ) {
+        return new static( $class );
+    }
 
-	/**
-	 * @param Matcher|string $class
-	 */
-	public function __construct( $class ) {
-		parent::__construct();
-		$this->classMatcher = $class;
-	}
+    /**
+     * @param Matcher|string $class
+     */
+    public function __construct( $class ) {
+        parent::__construct();
+        $this->classMatcher = $class;
+    }
 
-	public function describeTo( Description $description ) {
-		$description->appendText( 'with class ' );
-		if ( $this->classMatcher instanceof Matcher ) {
-			$description->appendDescriptionOf( $this->classMatcher );
-		} else {
-			$description->appendValue( $this->classMatcher );
-		}
-	}
+    public function describeTo( Description $description ) {
+        $description->appendText( 'with class ' );
+        if ( $this->classMatcher instanceof Matcher ) {
+            $description->appendDescriptionOf( $this->classMatcher );
+        } else {
+            $description->appendValue( $this->classMatcher );
+        }
+    }
 
-	/**
-	 * @param \DOMElement $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
-		$classAttribute = $item->getAttribute( 'class' );
+    /**
+     * @param \DOMElement $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
+        $classAttribute = $item->getAttribute( 'class' );
 
-		if ( $this->classMatcher instanceof Matcher ) {
-			$classes = preg_split( '/\s+/u', $classAttribute );
-			foreach ( $classes as $class ) {
-				if ( $this->classMatcher->matches( $class ) ) {
-					return true;
-				}
-			}
-			return false;
-		} else {
-			return (bool)preg_match(
-				'/(^|\s)' . preg_quote( $this->classMatcher, '/' ) . '(\s|$)/u',
-				$classAttribute
-			);
-		}
-	}
+        if ( $this->classMatcher instanceof Matcher ) {
+            $classes = preg_split( '/\s+/u', $classAttribute );
+            foreach ( $classes as $class ) {
+                if ( $this->classMatcher->matches( $class ) ) {
+                    return true;
+                }
+            }
+            return false;
+        } else {
+            return (bool)preg_match(
+                '/(^|\s)' . preg_quote( $this->classMatcher, '/' ) . '(\s|$)/u',
+                $classAttribute
+            );
+        }
+    }
 
 }