wmde / hamcrest-html-matchers

src/AttributeMatcher.php

Indentation +66 added lines, -66 removed lines

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

src/TagMatcher.php

Indentation +3 added lines, -3 removed lines

@@ -7,8 +7,8 @@
 
 abstract class TagMatcher extends TypeSafeDiagnosingMatcher {
 
-	public function __construct() {
-		parent::__construct( self::TYPE_OBJECT, DOMElement::class );
-	}
+    public function __construct() {
+        parent::__construct( self::TYPE_OBJECT, DOMElement::class );
+    }
 
 }

src/ComplexTagMatcher.php

Indentation +216 added lines, -216 removed lines

@@ -12,221 +12,221 @@
 
 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
-	 */
-	private 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 );
-	}
-
-	/**
-	 * @param Description $description
-	 */
-	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(
-			new TagNameMatcher( IsEqual::equalTo( $targetTag->tagName ) ),
-			call_user_func_array( [ AllOf::class, 'allOf' ], $attributeMatchers ),
-			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, '/' );
-
-		return !preg_match( "/\b{$quotedName}\s*=/ui", $inputHtml );
-	}
-
-	/**
-	 * @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 );
-
-		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
-			);
-		}
-
-		// @phan-suppress-next-line PhanTypeMismatchReturnNullable
-		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 = new AttributeMatcher( IsEqual::equalTo( $attribute->name ) );
-			if ( !$this->isBooleanAttribute( $inputHtml, $attribute->name ) ) {
-				$attributeMatcher = $attributeMatcher->havingValue(
-					IsEqual::equalTo( $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[] = new ClassMatcher( IsEqual::equalTo( $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
+     */
+    private 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 );
+    }
+
+    /**
+     * @param Description $description
+     */
+    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(
+            new TagNameMatcher( IsEqual::equalTo( $targetTag->tagName ) ),
+            call_user_func_array( [ AllOf::class, 'allOf' ], $attributeMatchers ),
+            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, '/' );
+
+        return !preg_match( "/\b{$quotedName}\s*=/ui", $inputHtml );
+    }
+
+    /**
+     * @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 );
+
+        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
+            );
+        }
+
+        // @phan-suppress-next-line PhanTypeMismatchReturnNullable
+        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 = new AttributeMatcher( IsEqual::equalTo( $attribute->name ) );
+            if ( !$this->isBooleanAttribute( $inputHtml, $attribute->name ) ) {
+                $attributeMatcher = $attributeMatcher->havingValue(
+                    IsEqual::equalTo( $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[] = new ClassMatcher( IsEqual::equalTo( $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/DirectChildElementMatcher.php

Indentation +59 added lines, -59 removed lines

@@ -10,64 +10,64 @@
 
 class DirectChildElementMatcher extends TypeSafeDiagnosingMatcher {
 
-	/**
-	 * @var Matcher|null
-	 */
-	private $matcher;
-
-	public static function havingDirectChild( ?Matcher $elementMatcher = null ) {
-		return new static( $elementMatcher );
-	}
-
-	public function __construct( ?Matcher $matcher = null ) {
-		parent::__construct( DOMNode::class );
-		$this->matcher = $matcher;
-	}
-
-	public function describeTo( Description $description ) {
-		$description->appendText( 'having direct child ' );
-		if ( $this->matcher ) {
-			$description->appendDescriptionOf( $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 );
-		}
-		$directChildren = $item->childNodes;
-
-		if ( $directChildren->length === 0 ) {
-			$mismatchDescription->appendText( 'with no direct children' );
-			return false;
-		}
-
-		$childWord = $directChildren->length === 1 ? 'child' : 'children';
-
-		$mismatchDescription->appendText( "with direct {$childWord} " );
-
-		if ( !$this->matcher ) {
-			return $directChildren->length !== 0;
-		}
-
-		$child = null;
-		foreach ( $directChildren as $child ) {
-			if ( $this->matcher->matches( $child ) ) {
-				return true;
-			}
-		}
-
-		$this->matcher->describeMismatch( $child, $mismatchDescription );
-
-		return false;
-	}
+    /**
+     * @var Matcher|null
+     */
+    private $matcher;
+
+    public static function havingDirectChild( ?Matcher $elementMatcher = null ) {
+        return new static( $elementMatcher );
+    }
+
+    public function __construct( ?Matcher $matcher = null ) {
+        parent::__construct( DOMNode::class );
+        $this->matcher = $matcher;
+    }
+
+    public function describeTo( Description $description ) {
+        $description->appendText( 'having direct child ' );
+        if ( $this->matcher ) {
+            $description->appendDescriptionOf( $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 );
+        }
+        $directChildren = $item->childNodes;
+
+        if ( $directChildren->length === 0 ) {
+            $mismatchDescription->appendText( 'with no direct children' );
+            return false;
+        }
+
+        $childWord = $directChildren->length === 1 ? 'child' : 'children';
+
+        $mismatchDescription->appendText( "with direct {$childWord} " );
+
+        if ( !$this->matcher ) {
+            return $directChildren->length !== 0;
+        }
+
+        $child = null;
+        foreach ( $directChildren as $child ) {
+            if ( $this->matcher->matches( $child ) ) {
+                return true;
+            }
+        }
+
+        $this->matcher->describeMismatch( $child, $mismatchDescription );
+
+        return false;
+    }
 
 }

src/HtmlMatcher.php

Indentation +101 added lines, -101 removed lines

@@ -10,106 +10,106 @@
 
 class HtmlMatcher extends DiagnosingMatcher {
 
-	/**
-	 * @link http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
-	 * @link https://github.com/Chronic-Dev/libxml2/blob/683f296a905710ff285c28b8644ef3a3d8be9486/include/libxml/xmlerror.h#L257
-	 */
-	private const XML_UNKNOWN_TAG_ERROR_CODE = 801;
-
-	/**
-	 * @var Matcher|null
-	 */
-	private $elementMatcher;
-
-	/**
-	 * @param Matcher|null $elementMatcher
-	 *
-	 * @return self
-	 */
-	public static function htmlPiece( ?Matcher $elementMatcher = null ) {
-		return new static( $elementMatcher );
-	}
-
-	private function __construct( ?Matcher $elementMatcher = null ) {
-		$this->elementMatcher = $elementMatcher;
-	}
-
-	public function describeTo( Description $description ) {
-		$description->appendText( 'valid html piece ' );
-		if ( $this->elementMatcher ) {
-			$description->appendDescriptionOf( $this->elementMatcher );
-		}
-	}
-
-	/**
-	 * @param string $html
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesWithDiagnosticDescription( $html, Description $mismatchDescription ) {
-		$internalErrors = libxml_use_internal_errors( true );
-		libxml_clear_errors();
-		$document = new DOMDocument();
-
-		$html = $this->escapeScriptTagContents( $html );
-
-		// phpcs:ignore Generic.PHP.NoSilencedErrors
-		if ( !@$document->loadHTML( mb_convert_encoding( $html, 'HTML-ENTITIES', 'UTF-8' ) ) ) {
-			$mismatchDescription->appendText( 'there was some parsing error' );
-			return false;
-		}
-
-		$errors = libxml_get_errors();
-		libxml_clear_errors();
-		libxml_use_internal_errors( $internalErrors );
-
-		$result = true;
-		foreach ( $errors as $error ) {
-			if ( $this->isUnknownTagError( $error ) ) {
-				continue;
-			}
-
-			$mismatchDescription->appendText( 'there was parsing error: ' )
-				->appendText( trim( $error->message ) )
-				->appendText( ' on line ' )
-				->appendText( (string)$error->line );
-			$result = false;
-		}
-
-		if ( !$result ) {
-			return false;
-		}
-		$mismatchDescription->appendText( 'valid html piece ' );
-
-		if ( $this->elementMatcher ) {
-			$result = $this->elementMatcher->matches( $document );
-			$this->elementMatcher->describeMismatch( $document, $mismatchDescription );
-		}
-
-		$mismatchDescription->appendText( "\nActual html:\n" )->appendText( $html );
-
-		return $result;
-	}
-
-	/**
-	 * @param LibXMLError $error
-	 *
-	 * @return bool
-	 */
-	private function isUnknownTagError( LibXMLError $error ) {
-		return $error->code === self::XML_UNKNOWN_TAG_ERROR_CODE;
-	}
-
-	/**
-	 * @param string $html
-	 *
-	 * @return string HTML
-	 */
-	private function escapeScriptTagContents( $html ) {
-		return preg_replace_callback( '#(<script.*>)(.*)(</script>)#isU', static function ( $matches ) {
-			return $matches[1] . str_replace( '</', '<\/', $matches[2] ) . $matches[3];
-		}, $html );
-	}
+    /**
+     * @link http://www.xmlsoft.org/html/libxml-xmlerror.html#xmlParserErrors
+     * @link https://github.com/Chronic-Dev/libxml2/blob/683f296a905710ff285c28b8644ef3a3d8be9486/include/libxml/xmlerror.h#L257
+     */
+    private const XML_UNKNOWN_TAG_ERROR_CODE = 801;
+
+    /**
+     * @var Matcher|null
+     */
+    private $elementMatcher;
+
+    /**
+     * @param Matcher|null $elementMatcher
+     *
+     * @return self
+     */
+    public static function htmlPiece( ?Matcher $elementMatcher = null ) {
+        return new static( $elementMatcher );
+    }
+
+    private function __construct( ?Matcher $elementMatcher = null ) {
+        $this->elementMatcher = $elementMatcher;
+    }
+
+    public function describeTo( Description $description ) {
+        $description->appendText( 'valid html piece ' );
+        if ( $this->elementMatcher ) {
+            $description->appendDescriptionOf( $this->elementMatcher );
+        }
+    }
+
+    /**
+     * @param string $html
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesWithDiagnosticDescription( $html, Description $mismatchDescription ) {
+        $internalErrors = libxml_use_internal_errors( true );
+        libxml_clear_errors();
+        $document = new DOMDocument();
+
+        $html = $this->escapeScriptTagContents( $html );
+
+        // phpcs:ignore Generic.PHP.NoSilencedErrors
+        if ( !@$document->loadHTML( mb_convert_encoding( $html, 'HTML-ENTITIES', 'UTF-8' ) ) ) {
+            $mismatchDescription->appendText( 'there was some parsing error' );
+            return false;
+        }
+
+        $errors = libxml_get_errors();
+        libxml_clear_errors();
+        libxml_use_internal_errors( $internalErrors );
+
+        $result = true;
+        foreach ( $errors as $error ) {
+            if ( $this->isUnknownTagError( $error ) ) {
+                continue;
+            }
+
+            $mismatchDescription->appendText( 'there was parsing error: ' )
+                ->appendText( trim( $error->message ) )
+                ->appendText( ' on line ' )
+                ->appendText( (string)$error->line );
+            $result = false;
+        }
+
+        if ( !$result ) {
+            return false;
+        }
+        $mismatchDescription->appendText( 'valid html piece ' );
+
+        if ( $this->elementMatcher ) {
+            $result = $this->elementMatcher->matches( $document );
+            $this->elementMatcher->describeMismatch( $document, $mismatchDescription );
+        }
+
+        $mismatchDescription->appendText( "\nActual html:\n" )->appendText( $html );
+
+        return $result;
+    }
+
+    /**
+     * @param LibXMLError $error
+     *
+     * @return bool
+     */
+    private function isUnknownTagError( LibXMLError $error ) {
+        return $error->code === self::XML_UNKNOWN_TAG_ERROR_CODE;
+    }
+
+    /**
+     * @param string $html
+     *
+     * @return string HTML
+     */
+    private function escapeScriptTagContents( $html ) {
+        return preg_replace_callback( '#(<script.*>)(.*)(</script>)#isU', static function ( $matches ) {
+            return $matches[1] . str_replace( '</', '<\/', $matches[2] ) . $matches[3];
+        }, $html );
+    }
 
 }

src/XmlNodeRecursiveIterator.php

Indentation +20 added lines, -20 removed lines

@@ -6,27 +6,27 @@
 
 class XmlNodeRecursiveIterator extends \ArrayIterator {
 
-	public function __construct( \DOMNodeList $nodeList ) {
-		$queue = $this->addElementsToQueue( [], $nodeList );
-		parent::__construct( $queue );
-	}
+    public function __construct( \DOMNodeList $nodeList ) {
+        $queue = $this->addElementsToQueue( [], $nodeList );
+        parent::__construct( $queue );
+    }
 
-	/**
-	 * @param DOMNode[] $queue
-	 * @param \DOMNodeList $nodeList
-	 *
-	 * @return DOMNode[] New queue
-	 */
-	private function addElementsToQueue( array $queue, \DOMNodeList $nodeList ) {
-		/** @var DOMNode $node */
-		foreach ( $nodeList as $node ) {
-			$queue[] = $node;
-			if ( $node->childNodes !== null ) {
-				$queue = $this->addElementsToQueue( $queue, $node->childNodes );
-			}
-		}
+    /**
+     * @param DOMNode[] $queue
+     * @param \DOMNodeList $nodeList
+     *
+     * @return DOMNode[] New queue
+     */
+    private function addElementsToQueue( array $queue, \DOMNodeList $nodeList ) {
+        /** @var DOMNode $node */
+        foreach ( $nodeList as $node ) {
+            $queue[] = $node;
+            if ( $node->childNodes !== null ) {
+                $queue = $this->addElementsToQueue( $queue, $node->childNodes );
+            }
+        }
 
-		return $queue;
-	}
+        return $queue;
+    }
 
 }

src/TagNameMatcher.php

Indentation +41 added lines, -41 removed lines

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

src/RootElementMatcher.php

Indentation +50 added lines, -50 removed lines

@@ -9,62 +9,62 @@
 
 class RootElementMatcher extends TypeSafeDiagnosingMatcher {
 
-	/**
-	 * @var Matcher|null
-	 */
-	private $tagMatcher;
+    /**
+     * @var Matcher|null
+     */
+    private $tagMatcher;
 
-	/**
-	 * @param Matcher|null $tagMatcher
-	 *
-	 * @return static
-	 */
-	public static function havingRootElement( ?Matcher $tagMatcher = null ) {
-		return new static( $tagMatcher );
-	}
+    /**
+     * @param Matcher|null $tagMatcher
+     *
+     * @return static
+     */
+    public static function havingRootElement( ?Matcher $tagMatcher = null ) {
+        return new static( $tagMatcher );
+    }
 
-	public function __construct( ?Matcher $tagMatcher = null ) {
-		parent::__construct( self::TYPE_OBJECT, DOMDocument::class );
-		$this->tagMatcher = $tagMatcher;
-	}
+    public function __construct( ?Matcher $tagMatcher = null ) {
+        parent::__construct( self::TYPE_OBJECT, DOMDocument::class );
+        $this->tagMatcher = $tagMatcher;
+    }
 
-	public function describeTo( Description $description ) {
-		$description->appendText( 'having root element ' );
-		if ( $this->tagMatcher ) {
-			$description->appendDescriptionOf( $this->tagMatcher );
-		}
-	}
+    public function describeTo( Description $description ) {
+        $description->appendText( 'having root element ' );
+        if ( $this->tagMatcher ) {
+            $description->appendDescriptionOf( $this->tagMatcher );
+        }
+    }
 
-	/**
-	 * @param DOMDocument $item
-	 * @param Description $mismatchDescription
-	 *
-	 * @return bool
-	 */
-	protected function matchesSafelyWithDiagnosticDescription(
-		$item, Description $mismatchDescription
-	) {
-		$DOMNodeList = $item->documentElement->childNodes->item( 0 )->childNodes;
-		if ( $DOMNodeList->length > 1 ) {
-			// TODO Test this description
-			$mismatchDescription->appendText( 'having ' . $DOMNodeList->length . ' root elements ' );
-			return false;
-		}
+    /**
+     * @param DOMDocument $item
+     * @param Description $mismatchDescription
+     *
+     * @return bool
+     */
+    protected function matchesSafelyWithDiagnosticDescription(
+        $item, Description $mismatchDescription
+    ) {
+        $DOMNodeList = $item->documentElement->childNodes->item( 0 )->childNodes;
+        if ( $DOMNodeList->length > 1 ) {
+            // TODO Test this description
+            $mismatchDescription->appendText( 'having ' . $DOMNodeList->length . ' root elements ' );
+            return false;
+        }
 
-		$target = $DOMNodeList->item( 0 );
-		if ( !$target ) {
-			// TODO Reproduce?
-			$mismatchDescription->appendText( 'having no root elements ' );
-			return false;
-		}
+        $target = $DOMNodeList->item( 0 );
+        if ( !$target ) {
+            // TODO Reproduce?
+            $mismatchDescription->appendText( 'having no root elements ' );
+            return false;
+        }
 
-		if ( $this->tagMatcher ) {
-			$mismatchDescription->appendText( 'root element ' );
-			$this->tagMatcher->describeMismatch( $target, $mismatchDescription );
-			return $this->tagMatcher->matches( $target );
-		}
+        if ( $this->tagMatcher ) {
+            $mismatchDescription->appendText( 'root element ' );
+            $this->tagMatcher->describeMismatch( $target, $mismatchDescription );
+            return $this->tagMatcher->matches( $target );
+        }
 
-		return true;
-	}
+        return true;
+    }
 
 }

src/functions.php

Indentation +58 added lines, -58 removed lines

@@ -12,87 +12,87 @@
 use WMDE\HamcrestHtml\TextContentsMatcher;
 
 if ( !function_exists( 'htmlPiece' ) ) {
-	/**
-	 * @param Matcher|null $elementMatcher
-	 *
-	 * @return HtmlMatcher
-	 */
-	function htmlPiece( ?Matcher $elementMatcher = null ) {
-		return HtmlMatcher::htmlPiece( $elementMatcher );
-	}
+    /**
+     * @param Matcher|null $elementMatcher
+     *
+     * @return HtmlMatcher
+     */
+    function htmlPiece( ?Matcher $elementMatcher = null ) {
+        return HtmlMatcher::htmlPiece( $elementMatcher );
+    }
 }
 
 if ( !function_exists( 'havingRootElement' ) ) {
-	function havingRootElement( ?Matcher $matcher = null ) {
-		return RootElementMatcher::havingRootElement( $matcher );
-	}
+    function havingRootElement( ?Matcher $matcher = null ) {
+        return RootElementMatcher::havingRootElement( $matcher );
+    }
 }
 
 if ( !function_exists( 'havingDirectChild' ) ) {
-	function havingDirectChild( ?Matcher $elementMatcher = null ) {
-		return DirectChildElementMatcher::havingDirectChild( $elementMatcher );
-	}
+    function havingDirectChild( ?Matcher $elementMatcher = null ) {
+        return DirectChildElementMatcher::havingDirectChild( $elementMatcher );
+    }
 }
 
 if ( !function_exists( 'havingChild' ) ) {
-	function havingChild( ?Matcher $elementMatcher = null ) {
-		return ChildElementMatcher::havingChild( $elementMatcher );
-	}
+    function havingChild( ?Matcher $elementMatcher = null ) {
+        return ChildElementMatcher::havingChild( $elementMatcher );
+    }
 }
 
 if ( !function_exists( 'withTagName' ) ) {
-	/**
-	 * @param Matcher|string $tagName
-	 *
-	 * @return TagNameMatcher
-	 */
-	function withTagName( $tagName ) {
-		return TagNameMatcher::withTagName( $tagName );
-	}
+    /**
+     * @param Matcher|string $tagName
+     *
+     * @return TagNameMatcher
+     */
+    function withTagName( $tagName ) {
+        return TagNameMatcher::withTagName( $tagName );
+    }
 }
 
 if ( !function_exists( 'withAttribute' ) ) {
-	/**
-	 * @param Matcher|string $attributeName
-	 *
-	 * @return AttributeMatcher
-	 */
-	function withAttribute( $attributeName ) {
-		return AttributeMatcher::withAttribute( $attributeName );
-	}
+    /**
+     * @param Matcher|string $attributeName
+     *
+     * @return AttributeMatcher
+     */
+    function withAttribute( $attributeName ) {
+        return AttributeMatcher::withAttribute( $attributeName );
+    }
 }
 
 if ( !function_exists( 'withClass' ) ) {
-	/**
-	 * @param Matcher|string $class
-	 *
-	 * @return ClassMatcher
-	 */
-	function withClass( $class ) {
-		// TODO don't allow to call with empty string
+    /**
+     * @param Matcher|string $class
+     *
+     * @return ClassMatcher
+     */
+    function withClass( $class ) {
+        // TODO don't allow to call with empty string
 
-		return ClassMatcher::withClass( $class );
-	}
+        return ClassMatcher::withClass( $class );
+    }
 }
 
 if ( !function_exists( 'havingTextContents' ) ) {
-	/**
-	 * @param Matcher|string $text
-	 *
-	 * @return TextContentsMatcher
-	 */
-	function havingTextContents( $text ) {
-		return TextContentsMatcher::havingTextContents( $text );
-	}
+    /**
+     * @param Matcher|string $text
+     *
+     * @return TextContentsMatcher
+     */
+    function havingTextContents( $text ) {
+        return TextContentsMatcher::havingTextContents( $text );
+    }
 }
 
 if ( !function_exists( 'tagMatchingOutline' ) ) {
-	/**
-	 * @param string $htmlOutline
-	 *
-	 * @return ComplexTagMatcher
-	 */
-	function tagMatchingOutline( $htmlOutline ) {
-		return ComplexTagMatcher::tagMatchingOutline( $htmlOutline );
-	}
+    /**
+     * @param string $htmlOutline
+     *
+     * @return ComplexTagMatcher
+     */
+    function tagMatchingOutline( $htmlOutline ) {
+        return ComplexTagMatcher::tagMatchingOutline( $htmlOutline );
+    }
 }