@createiq/htmldiff 1.0.3 → 1.0.4-beta.1

package/test/HtmlDiff.spec.ts

@@ -82,14 +82,16 @@ describe('HtmlDiff', () => {
       "<del class='diffmod'>one</del><ins class='diffmod'>two</ins> a<ins class='diffins'>&nbsp;nother</ins> word is somewhere",
       0.1,
     ],
-  ] as const)(
-    'should diff (%s, %s) -> %s with orphanMatchThreshold %d',
-    ([oldText, newText, expected, orphanMatchThreshold]) => {
-      const diff = new HtmlDiff(oldText, newText)
-      diff.orphanMatchThreshold = orphanMatchThreshold
-      expect(diff.build()).toEqual(expected)
-    }
-  )
+  ] as const)('should diff (%s, %s) -> %s with orphanMatchThreshold %d', ([
+    oldText,
+    newText,
+    expected,
+    orphanMatchThreshold,
+  ]) => {
+    const diff = new HtmlDiff(oldText, newText)
+    diff.orphanMatchThreshold = orphanMatchThreshold
+    expect(diff.build()).toEqual(expected)
+  })
 
   it.for([
     [
@@ -104,16 +106,18 @@ describe('HtmlDiff', () => {
       "This is a date <del class='diffmod'>1</del><ins class='diffmod'>22</ins> <del class='diffmod'>Jan</del><ins class='diffmod'>Feb</ins> <del class='diffmod'>2016</del><ins class='diffmod'>2017</ins> that <del class='diffmod'>will</del><ins class='diffmod'>won't</ins> change",
       null,
     ],
-  ] as const)(
-    'should diff (%s, %s) %s with grouping expression %s',
-    ([oldText, newText, expected, groupExpression]) => {
-      const diff = new HtmlDiff(oldText, newText)
-      if (groupExpression) {
-        diff.addBlockExpression(groupExpression)
-      }
-      expect(diff.build()).toEqual(expected)
+  ] as const)('should diff (%s, %s) %s with grouping expression %s', ([
+    oldText,
+    newText,
+    expected,
+    groupExpression,
+  ]) => {
+    const diff = new HtmlDiff(oldText, newText)
+    if (groupExpression) {
+      diff.addBlockExpression(groupExpression)
     }
-  )
+    expect(diff.build()).toEqual(expected)
+  })
 
   it('should throw ArgumentException with invalid overlapping groups', () => {
     const oldText = 'This is a date 1 Jan 2016 that will change'
@@ -250,15 +254,71 @@ describe('HtmlDiff', () => {
     expect(HtmlDiff.execute(oldText, newText)).toEqual(expected)
   })
 
-  it(
-    'should calculate a diff for a real-world example within 5s',
-    { timeout: process.env.CI ? 15_000 : 5_000 }, // CI is slower so give it more time
-    async () => {
-      const oldText = await fs.readFile('test/input1.html', 'utf-8')
-      const newText = await fs.readFile('test/input2.html', 'utf-8')
-      const expected = await fs.readFile('test/expected.html', 'utf-8')
+  it('should calculate a diff for a real-world example within 5s', {
+    // CI is slower so give it more time
+    timeout: process.env.CI ? 15_000 : 5_000,
+  }, async () => {
+    const oldText = await fs.readFile('test/input1.html', 'utf-8')
+    const newText = await fs.readFile('test/input2.html', 'utf-8')
+    const expected = await fs.readFile('test/expected.html', 'utf-8')
 
-      expect(HtmlDiff.execute(oldText, newText)).toEqual(expected)
-    }
-  )
+    expect(HtmlDiff.execute(oldText, newText)).toEqual(expected)
+  })
+
+  it('should appropriately calculate a partial diff for changes within a paragraph', () => {
+    const oldText = `<ol data-type="a">
+      <li>
+        <p class="justify" data-html="applicability_and_scope">The “<em><strong>Cross-Default</strong></em>” provisions of Section 5(a)(vi) will apply to Party A and will apply to Party B but shall exclude any default that results solely from wire transfer difficulties or an error or omission of an administrative or operational nature (so long as sufficient funds are available to the relevant party on the relevant date), but only if payment is made within three Local Business Days after such transfer difficulties have been corrected or the error or omission has been discovered.</p><p></p>
+      </li>
+    </ol>`
+    const newText = `<ol data-type="a">
+      <li>
+        <div class="justify" data-html="applicability_and_scope">
+          <p>The “<em><strong>Cross-Default</strong></em>” provisions of Section 5(a)(vi) will apply to Party A and will apply to Party B provided that the phrase "or becoming capable at such time of being declared" shall be deleted from clause (1) of such Section 5(a)(vi); but shall exclude any default that results solely from wire transfer difficulties or an error or omission of an administrative or operational nature (so long as sufficient funds are available to the relevant party on the relevant date), but only if payment is made within three Local Business Days after such transfer difficulties have been corrected or the error or omission has been discovered.</p>
+          <p></p>
+        </div>
+        <p></p>
+      </li>
+    </ol>`
+
+    const expected = `<ol data-type="a">
+      <li>
+        <p class="justify" data-html="applicability_and_scope">The “<em><strong>Cross-Default</strong></em>” provisions of Section 5(a)(vi) will apply to Party A and will apply to Party B<ins class='diffins'>&nbsp;provided that the phrase "or becoming capable at such time of being declared" shall be deleted from clause (1) of such Section 5(a)(vi);</ins> but shall exclude any default that results solely from wire transfer difficulties or an error or omission of an administrative or operational nature (so long as sufficient funds are available to the relevant party on the relevant date), but only if payment is made within three Local Business Days after such transfer difficulties have been corrected or the error or omission has been discovered.</p><p></p>
+      </li>
+    </ol>`
+
+    expect(HtmlDiff.execute(oldText, newText)).toEqual(expected)
+  })
+
+  it('should not strip structural wrappers when diffing against empty content', () => {
+    // When one side is empty and the other has content wrapped in structural tags,
+    // the wrapper tags should be preserved in the diff output (not stripped by normalization).
+    expect(HtmlDiff.execute('', '<div data-html="test"><strong>Hello World</strong></div>')).toEqual(
+      `<div data-html="test"><strong><ins class='diffins'>Hello World</ins></strong></div>`
+    )
+  })
+
+  it('should not strip structural wrappers when diffing empty content against wrapped content', () => {
+    expect(HtmlDiff.execute('<div data-html="test"><strong>Hello World</strong></div>', '')).toEqual(
+      `<div data-html="test"><strong><del class='diffdel'>Hello World</del></div>`
+    )
+  })
+
+  it('should preserve old wrapper structure when diffing a p against a div with same content', () => {
+    expect(
+      HtmlDiff.execute(
+        '<p class="justify">Same content here</p>',
+        '<div class="justify"><p>Same content here</p></div>'
+      )
+    ).toEqual('<p class="justify">Same content here</p>')
+  })
+
+  it('should preserve old wrapper structure and highlight content changes when wrappers differ', () => {
+    expect(
+      HtmlDiff.execute(
+        '<p class="justify" data-html="test">Some content here</p>',
+        '<div class="justify" data-html="test"><p>Some different content here</p></div>'
+      )
+    ).toEqual(`<p class="justify" data-html="test">Some<ins class='diffins'>&nbsp;different</ins> content here</p>`)
+  })
 })