Reworked ListDiffLines to use DOMDocument

Right now TableDiff already uses DOMDocument but this component still used a third party library that extended the old SimpleXML extension from PHP.

I ported to the code to use DOMDocument, making the library absolete, and slightly improving performance.

Mostly this is preperation for moving the entire library to DOMDocument

Author: Sven Hagemann

lib/Caxy/HtmlDiff/ListDiffLines.php

@@ -4,7 +4,7 @@
 
 class Operation
 {
-    const ADDED = 'a';
+    const ADDED   = 'a';
     const DELETED = 'd';
     const CHANGED = 'c';
 
@@ -14,12 +14,12 @@ class Operation
     public $startInNew;
     public $endInNew;
 
-    public function __construct($action, $startInOld, $endInOld, $startInNew, $endInNew)
+    public function __construct(string $action, int $startInOld, int $endInOld, int $startInNew, int $endInNew)
     {
-        $this->action = $action;
+        $this->action     = $action;
         $this->startInOld = $startInOld;
-        $this->endInOld = $endInOld;
+        $this->endInOld   = $endInOld;
         $this->startInNew = $startInNew;
-        $this->endInNew = $endInNew;
+        $this->endInNew   = $endInNew;
     }
 }

lib/Caxy/HtmlDiff/Operation.php

@@ -6,7 +6,7 @@
 
 abstract class AbstractTest extends TestCase
 {
-    protected function stripExtraWhitespaceAndNewLines($text)
+    protected function stripExtraWhitespaceAndNewLines(string $text)
     {
         return trim(
             preg_replace(

tests/Caxy/Tests/AbstractTest.php

@@ -20,7 +20,10 @@ public function testHtmlDiff($oldText, $newText, $expected)
         $diff = new HtmlDiff(trim($oldText), trim($newText), 'UTF-8', array());
         $output = $diff->build();
 
-        static::assertEquals($this->stripExtraWhitespaceAndNewLines($expected), $this->stripExtraWhitespaceAndNewLines($output));
+        static::assertEquals(
+            $this->stripExtraWhitespaceAndNewLines($expected),
+            $this->stripExtraWhitespaceAndNewLines($output)
+        );
     }
 
     public function diffContentProvider()

tests/Caxy/Tests/HtmlDiff/Functional/HtmlDiffFunctionalTest.php

@@ -7,23 +7,26 @@
 
 class PerformanceTest extends AbstractTest
 {
+    private const FIXTURE_PATH = __DIR__ . '/../../../../fixtures/Performance/';
+
     /**
      * @group performance
      */
     public function testParagraphPerformance()
     {
-        $fixturesPath = __DIR__ . '/../../../../fixtures/Performance/';
-
-        $expected = file_get_contents($fixturesPath . 'paragraphs_expected.html');
+        $expected = file_get_contents(self::FIXTURE_PATH . 'paragraphs_expected.html');
 
         $diff = new HtmlDiff(
-            file_get_contents($fixturesPath . 'paragraphs.html'),
-            file_get_contents($fixturesPath . 'paragraphs_changed.html'),
+            file_get_contents(self::FIXTURE_PATH . 'paragraphs.html'),
+            file_get_contents(self::FIXTURE_PATH . 'paragraphs_changed.html'),
             'UTF-8', array()
         );
 
         $output = $diff->build();
 
-        $this->assertSame($this->stripExtraWhitespaceAndNewLines($output), $this->stripExtraWhitespaceAndNewLines($expected));
+        self::assertSame(
+            $this->stripExtraWhitespaceAndNewLines($expected),
+            $this->stripExtraWhitespaceAndNewLines($output)
+        );
     }
 }

tests/Caxy/Tests/HtmlDiff/Performance/PerformanceTest.php

@@ -35,5 +35,5 @@
 </newText>
 
 <expected>
-<ol class="diff-list"><li class="removed"><del> Etiam feugiat lorem non metus. Nullam accumsan lorem in dui. </del></li><li class="removed"><del> Praesent ac sem eget est egestas volutpat. Nulla neque dolor, sagittis eget, iaculis quis, molestie non, velit. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Aenean massa. </del></li><li class="removed"><del> Vestibulum suscipit nulla quis orci. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. </del></li><li class="replacement"> Suspendisse non nisl sit amet velit hendrerit rutrum. Aenean massa. Curabitur ullamcorper ultricies nisi. Praesent vestibulum dapibus nibh. In dui magna, posuere eget, vestibulum et, tempor auctor, justo. </li><li class="normal new"><ins> Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. </ins></li><li class="normal new"><ins> Duis lobortis massa imperdiet quam. Donec sodales sagittis magna. Nam ipsum risus, rutrum vitae, vestibulum eu, molestie vel, lacus. Suspendisse eu ligula. Morbi nec metus. </ins></li></ol>
+    <ol class="diff-list"><li class="removed"><del> Etiam feugiat lorem non metus. Nullam accumsan lorem in dui. </del></li><li class="removed"><del> Praesent ac sem eget est egestas volutpat. Nulla neque dolor, sagittis eget, iaculis quis, molestie non, velit. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Aenean massa. </del></li><li class="removed"><del> Vestibulum suscipit nulla quis orci. Integer ante arcu, accumsan a, consectetuer eget, posuere ut, mauris. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. </del></li><li class="replacement">Suspendisse non nisl sit amet velit hendrerit rutrum. Aenean massa. Curabitur ullamcorper ultricies nisi. Praesent vestibulum dapibus nibh. In dui magna, posuere eget, vestibulum et, tempor auctor, justo.</li><li class="normal new"><ins> Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. </ins></li><li class="normal new"><ins> Duis lobortis massa imperdiet quam. Donec sodales sagittis magna. Nam ipsum risus, rutrum vitae, vestibulum eu, molestie vel, lacus. Suspendisse eu ligula. Morbi nec metus. </ins></li></ol>
 </expected>

tests/fixtures/HtmlDiff/first-and-last.html

@@ -27,5 +27,5 @@
 </newText>
 
 <expected>
-<p>In addition to the <em>means of egress</em> required by this chapter, <del class="diffmod">provisions </del><em class="diffmod"><ins class="diffmod">emergency escape and rescue openings </ins></em>shall be <del class="diffmod">made for </del><em class="diffmod"><del class="diffmod">emergency escape and rescue openings</del></em><ins class="diffmod">provided</ins> in<ins class="diffins"> the following occupancies:</ins></p><ins class="diffins"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffins">1.</ins> Group R<ins class="diffins">-1 and R-2</ins> occupancies.<del class="diffmod"> </del></div><ins class="diffmod"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffmod">2. Group R-1 and R-2 occupancies located on stories with one exit or access to one exit where permitted by Tables 1006.3.2(1) and 1006.3.2(2). </ins></div><ins class="diffmod"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffmod">3. Group R-3 occupancies.</ins></div><ins class="diffmod"> </ins><p class="diffmod"><br /><em>Basements</em> and sleeping rooms below the fourth story above <em>grade plane</em> shall have at least one exterior <em>emergency escape and rescue opening</em> in accordance with this section. Where <em>basements</em> contain one or more sleeping rooms, <em>emergency escape and rescue openings</em> shall be required in each sleeping room, but shall not be required in adjoining areas of the <em>basement</em>. Such openings shall open directly into a <em>public way</em> or to a <em>yard </em>or<em> court</em> that opens to a <em>public way</em>.</p> <ul class="exception diff-list"><li class="normal"><strong>Exceptions:</strong><br class="diffmod" /><ol class="diff-list"><li class="removed"><del><em>Groups R-1 and R-2 occupancies are not required to provide emergency and escape openings where they comply with all of the following:</em><ol><li><em>Each story has access to two or more means of egress.<br /></em></li> <li><em>The building is constructed of Type I, Type II, Type IIIA or Type IV construction.</em></li> <li><em>The building is equipped throughout with an approved automatic sprinkler system in accordance with Sections 903.3.1.1 or 903.3.3.2.</em></li> </ol></del></li><li class="removed"><del><em>The emergency escape and rescue opening is permitted to open onto a balcony within an atrium in accordance with the requirements of Section 404, provided the balcony provides access to an exit and the dwelling unit or sleeping unit has a means of egress that is not open to the atrium.</em></del></li><li class="replacement"><ins><em>Emergency escape and rescue opening</em> are not required from Group R-1 and R-2 occupancies where each story has access to at least two exits or access to exits and the building is equipped throughout with an automatic sprinkler system in accordance with Section 903.3.1.1.</ins></li><li class="normal"><em>Basements</em> with a ceiling height of less than 80 inches (2032 mm) shall not be required to have <em>emergency escape and rescue openings</em>.</li><li class="normal"><em>Emergency escape and rescue openings</em> are not required from <em>basements</em> or sleeping rooms that have an <em>exit</em> door or <em>exit access</em> door that opens directly into a <em>public way</em> or to a <em>yard</em>, <em>court</em> or exterior exit balcony that opens to a <em>public way</em>.</li><li class="normal"><em>Basements</em> without <em>habitable spaces</em> and having not more than 200 square feet (18.6 m<sup>2</sup>) in floor area shall not be required to have <em>emergency escape and rescue openings</em>.</li></ol></li></ul>
+<p>In addition to the <em>means of egress</em> required by this chapter, <del class="diffmod">provisions </del><em class="diffmod"><ins class="diffmod">emergency escape and rescue openings </ins></em>shall be <del class="diffmod">made for </del><em class="diffmod"><del class="diffmod">emergency escape and rescue openings</del></em><ins class="diffmod">provided</ins> in<ins class="diffins"> the following occupancies:</ins></p><ins class="diffins"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffins">1.</ins> Group R<ins class="diffins">-1 and R-2</ins> occupancies.<del class="diffmod"> </del></div><ins class="diffmod"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffmod">2. Group R-1 and R-2 occupancies located on stories with one exit or access to one exit where permitted by Tables 1006.3.2(1) and 1006.3.2(2). </ins></div><ins class="diffmod"> </ins><div style="padding-left:30px;" class="diffmod"><ins class="diffmod">3. Group R-3 occupancies.</ins></div><ins class="diffmod"> </ins><p class="diffmod"><br /><em>Basements</em> and sleeping rooms below the fourth story above <em>grade plane</em> shall have at least one exterior <em>emergency escape and rescue opening</em> in accordance with this section. Where <em>basements</em> contain one or more sleeping rooms, <em>emergency escape and rescue openings</em> shall be required in each sleeping room, but shall not be required in adjoining areas of the <em>basement</em>. Such openings shall open directly into a <em>public way</em> or to a <em>yard </em>or<em> court</em> that opens to a <em>public way</em>.</p> <ul class="exception diff-list"><li class="normal"><strong>Exceptions:</strong><br class="diffmod"><ol class="diff-list"><li class="removed"><del><em>Groups R-1 and R-2 occupancies are not required to provide emergency and escape openings where they comply with all of the following:</em><ol><li><em>Each story has access to two or more means of egress.<br></em></li> <li><em>The building is constructed of Type I, Type II, Type IIIA or Type IV construction.</em></li> <li><em>The building is equipped throughout with an approved automatic sprinkler system in accordance with Sections 903.3.1.1 or 903.3.3.2.</em></li> </ol></del></li><li class="removed"><del><em>The emergency escape and rescue opening is permitted to open onto a balcony within an atrium in accordance with the requirements of Section 404, provided the balcony provides access to an exit and the dwelling unit or sleeping unit has a means of egress that is not open to the atrium.</em></del></li><li class="replacement"><ins><em>Emergency escape and rescue opening</em> are not required from Group R-1 and R-2 occupancies where each story has access to at least two exits or access to exits and the building is equipped throughout with an automatic sprinkler system in accordance with Section 903.3.1.1.</ins></li><li class="normal"><em>Basements</em> with a ceiling height of less than 80 inches (2032 mm) shall not be required to have <em>emergency escape and rescue openings</em>.</li><li class="normal"><em>Emergency escape and rescue openings</em> are not required from <em>basements</em> or sleeping rooms that have an <em>exit</em> door or <em>exit access</em> door that opens directly into a <em>public way</em> or to a <em>yard</em>, <em>court</em> or exterior exit balcony that opens to a <em>public way</em>.</li><li class="normal"><em>Basements</em> without <em>habitable spaces</em> and having not more than 200 square feet (18.6 m<sup>2</sup>) in floor area shall not be required to have <em>emergency escape and rescue openings</em>.</li></ol></li></ul>
 </expected>

tests/fixtures/HtmlDiff/override-5.html

@@ -0,0 +1,50 @@
+<oldText>
+<ol>
+    <li>List item one</li>
+    <li>List item two with subitems:
+        <ul>
+            <li>Subitem 1</li>
+            <li>Subitem 2</li>
+            <li>
+                <p>
+                    Hi there<br />
+                <ul>
+                    <li>A</li>
+                    <li>B</li>
+                </ul>
+                </p>
+            </li>
+            <li>
+                <dl><li>Deleted list</li></dl>
+            </li>
+        </ul>
+    </li>
+    <li>Final list item</li>
+</ol>
+</oldText>
+
+<newText>
+    <ol>
+        <li>List item one</li>
+        <li>List item tw with subitems:
+            <ul>
+                <li>Subitem 1</li>
+                <li>Subitem 2</li>
+                <li>
+                    <p>
+                        *.* Hi there<br />
+                    <ul>
+                        <li>A</li>
+                        <li>C</li>
+                    </ul>
+                    </p>
+                </li>
+            </ul>
+        </li>
+        <li>Final list item</li>
+    </ol>
+</newText>
+
+<expected>
+    <ol class="diff-list"><li class="normal">List item one</li><li class="normal">List item <del class="diffmod">two</del><ins class="diffmod">tw</ins> with subitems: <ul class="diff-list"><li class="normal">Subitem 1</li><li class="normal">Subitem 2</li><li class="removed"><del><p> Hi there<br></p><ul><li>A</li><li>B</li></ul></del></li><li class="replacement"><p class="diffmod"><ins class="diffins"> *.* Hi there</ins><br class="diffmod"><ins class="diffins"></ins></p><ul><ins class="diffins"></ins><li class="diffmod"><ins class="diffins">A</ins></li><ins class="diffins"></ins><li class="diffmod"><ins class="diffins">C</ins></li><ins class="diffins"></ins></ul></li><li class="removed"><del>Deleted list</del></li></ul></li><li class="normal">Final list item</li></ol>
+</expected>