Chris@0: <?php
Chris@0: /*
Chris@14:  * This file is part of sebastian/comparator.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace SebastianBergmann\Comparator;
Chris@0: 
Chris@0: use DOMDocument;
Chris@0: use DOMNode;
Chris@0: 
Chris@0: /**
Chris@0:  * Compares DOMNode instances for equality.
Chris@0:  */
Chris@0: class DOMNodeComparator extends ObjectComparator
Chris@0: {
Chris@0:     /**
Chris@0:      * Returns whether the comparator can compare two values.
Chris@0:      *
Chris@14:      * @param mixed $expected The first value to compare
Chris@14:      * @param mixed $actual   The second value to compare
Chris@14:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function accepts($expected, $actual)
Chris@0:     {
Chris@0:         return $expected instanceof DOMNode && $actual instanceof DOMNode;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Asserts that two values are equal.
Chris@0:      *
Chris@0:      * @param mixed $expected     First value to compare
Chris@0:      * @param mixed $actual       Second value to compare
Chris@0:      * @param float $delta        Allowed numerical distance between two values to consider them equal
Chris@0:      * @param bool  $canonicalize Arrays are sorted before comparison when set to true
Chris@0:      * @param bool  $ignoreCase   Case is ignored when set to true
Chris@0:      * @param array $processed    List of already processed elements (used to prevent infinite recursion)
Chris@0:      *
Chris@0:      * @throws ComparisonFailure
Chris@0:      */
Chris@14:     public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = [])
Chris@0:     {
Chris@0:         $expectedAsString = $this->nodeToText($expected, true, $ignoreCase);
Chris@0:         $actualAsString   = $this->nodeToText($actual, true, $ignoreCase);
Chris@0: 
Chris@0:         if ($expectedAsString !== $actualAsString) {
Chris@14:             $type = $expected instanceof DOMDocument ? 'documents' : 'nodes';
Chris@0: 
Chris@0:             throw new ComparisonFailure(
Chris@0:                 $expected,
Chris@0:                 $actual,
Chris@0:                 $expectedAsString,
Chris@0:                 $actualAsString,
Chris@0:                 false,
Chris@14:                 \sprintf("Failed asserting that two DOM %s are equal.\n", $type)
Chris@0:             );
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns the normalized, whitespace-cleaned, and indented textual
Chris@0:      * representation of a DOMNode.
Chris@0:      */
Chris@14:     private function nodeToText(DOMNode $node, bool $canonicalize, bool $ignoreCase): string
Chris@0:     {
Chris@0:         if ($canonicalize) {
Chris@0:             $document = new DOMDocument;
Chris@14:             @$document->loadXML($node->C14N());
Chris@0: 
Chris@0:             $node = $document;
Chris@0:         }
Chris@0: 
Chris@14:         $document = $node instanceof DOMDocument ? $node : $node->ownerDocument;
Chris@0: 
Chris@0:         $document->formatOutput = true;
Chris@0:         $document->normalizeDocument();
Chris@0: 
Chris@14:         $text = $node instanceof DOMDocument ? $node->saveXML() : $document->saveXML($node);
Chris@0: 
Chris@14:         return $ignoreCase ? $text : \strtolower($text);
Chris@0:     }
Chris@0: }