wmde / hamcrest-html-matchers

src/ComplexTagMatcher.php

Indentation +210 added lines, -210 removed lines

@@ -10,215 +10,215 @@
 
 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(
-			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, '/' );
-
-		$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 = 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
+     */
+    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(
+            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, '/' );
+
+        $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 = 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/StringContainsIgnoringWhiteSpace.php

Indentation +32 added lines, -32 removed lines

@@ -6,37 +6,37 @@
 
 class StringContainsIgnoringWhiteSpace extends SubstringMatcher {
 
-	/**
-	 * Matches if value is a string that contains $substring consider all whitespace as single space
-	 *
-	 * @param string $substring
-	 *
-	 * @return self
-	 */
-	public static function containsStringIgnoringWhiteSpace( $substring ) {
-		return new self( $substring );
-	}
-
-	/**
-	 * @param string $item
-	 *
-	 * @return bool
-	 */
-	protected function evalSubstringOf( $item ) {
-		return strpos( $this->stripSpace( $item ), $this->stripSpace( $this->_substring ) ) !== false;
-	}
-
-	protected function relationship() {
-		return 'containing ignoring whitespace';
-	}
-
-	/**
-	 * @param string $string
-	 *
-	 * @return string
-	 */
-	private function stripSpace( $string ) {
-		return trim( preg_replace( '/\s+/', ' ', $string ) );
-	}
+    /**
+     * Matches if value is a string that contains $substring consider all whitespace as single space
+     *
+     * @param string $substring
+     *
+     * @return self
+     */
+    public static function containsStringIgnoringWhiteSpace( $substring ) {
+        return new self( $substring );
+    }
+
+    /**
+     * @param string $item
+     *
+     * @return bool
+     */
+    protected function evalSubstringOf( $item ) {
+        return strpos( $this->stripSpace( $item ), $this->stripSpace( $this->_substring ) ) !== false;
+    }
+
+    protected function relationship() {
+        return 'containing ignoring whitespace';
+    }
+
+    /**
+     * @param string $string
+     *
+     * @return string
+     */
+    private function stripSpace( $string ) {
+        return trim( preg_replace( '/\s+/', ' ', $string ) );
+    }
 
 }

src/functions.php

Indentation +68 added lines, -68 removed lines

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