wmde / hamcrest-html-matchers

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/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 );
+    }
 }

src/ChildElementMatcher.php

Indentation +46 added lines, -46 removed lines

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