wiki.techinc.nl/tests/parser/ParserTestResultNormalizer.php
thiemowmde 373f02e8f7 Improve type documentation in parser test runner classes
Mostly unspecific "array" type hints that can be made more specific.

Change-Id: I5ceb042d0a8740867ae7e5718dfed1f4b632596f
2024-01-20 20:24:35 +01:00

96 lines
2.6 KiB
PHP

<?php
/**
* @ingroup Testing
*/
class ParserTestResultNormalizer {
/** @var DOMDocument */
protected $doc;
/** @var DOMNode|null */
protected $body;
/** @var DOMXPath */
protected $xpath;
/** @var bool */
protected $invalid;
/**
* @param string $text
* @param string[] $funcs
* @return string
*/
public static function normalize( $text, $funcs ) {
$norm = new self( $text );
if ( $norm->invalid ) {
return $text;
}
foreach ( $funcs as $func ) {
$norm->$func();
}
return $norm->serialize();
}
protected function __construct( $text ) {
$this->doc = new DOMDocument( '1.0', 'utf-8' );
// Parsing a supposedly-XHTML document with an XML parser is not
// guaranteed to give accurate results. For example, it may introduce
// differences in the number of line breaks in <pre> tags.
if ( !@$this->doc->loadXML( '<html><body>' . $text . '</body></html>' ) ) {
$this->invalid = true;
}
$this->xpath = new DOMXPath( $this->doc );
$this->body = $this->xpath->query( '//body' )->item( 0 );
}
protected function removeTbody() {
foreach ( $this->xpath->query( '//tbody' ) as $tbody ) {
while ( $tbody->firstChild ) {
$child = $tbody->firstChild;
$tbody->removeChild( $child );
$tbody->parentNode->insertBefore( $child, $tbody );
}
$tbody->parentNode->removeChild( $tbody );
}
}
/**
* The point of this function is to produce a normalized DOM in which
* Tidy's output matches the output of RemexHtml. Tidy both trims
* and pretty-prints, so this requires fairly aggressive treatment.
*
* In particular, note that Tidy converts <pre>x</pre> to <pre>\nx\n</pre>,
* which theoretically affects display since the second line break is not
* ignored by compliant HTML parsers.
*
* This function also removes empty elements, as does Tidy.
*/
protected function trimWhitespace() {
foreach ( $this->xpath->query( '//text()' ) as $child ) {
if ( strtolower( $child->parentNode->nodeName ) === 'pre' ) {
// Just trim one line break from the start and end
if ( str_starts_with( $child->data, "\n" ) ) {
$child->data = substr( $child->data, 1 );
}
if ( str_ends_with( $child->data, "\n" ) ) {
$child->data = substr( $child->data, 0, -1 );
}
} else {
// Trim all whitespace
$child->data = trim( $child->data );
}
if ( $child->data === '' ) {
$child->parentNode->removeChild( $child );
}
}
}
/**
* Serialize the XML DOM for comparison purposes. This does not generate HTML.
* @return string
*/
protected function serialize() {
return strtr( $this->doc->saveXML( $this->body ),
[ '<body>' => '', '</body>' => '' ] );
}
}