nokodiff 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463332f5f2d94367e447941e4d28e53b0f8b8f421ec04e7b1fae4975668655df
-  data.tar.gz: 9d8b69166e7669290aae29f75309f38a47a211d5e30f54927b2dd26c5276d6cf
+  metadata.gz: 8574d5f3cb682d4797c8d6cfa9c979e10ca2307a4c55997a0ddd6b3299801856
+  data.tar.gz: c3e4b13e2632ba3bf99de7c7a3ef5583618f68e6e94c03f877e5059b764c36e2
 SHA512:
-  metadata.gz: d3e110802143d03c8ff63763a21380f3f46016c0656447302552ccb5e95ad687fec50b6452c5e72ef43b9186eb2f1b5544c753919c7cc963631d91d50da1cdc1
-  data.tar.gz: 5c5299d0e0759559f95e9e85fd3cacf963cd710e630918817d5d187d2b19f8be6e30a41c02a4aed7e058873c208fdc0d93a5f1ec94fac67c95da408892523464
+  metadata.gz: b5a8d417f70b4d7fbc1cc2c4745dbd4494d3bf401ad7038e45c239cf9c69e1bca9af24cc0d7e2a078a5d29727d91d8acf29959a5d8e6d94c2d5ba600709f4e05
+  data.tar.gz: af1d8b59965819a131bf96d6dcfd9e64e2563196bc74be4bb1c75310d2cd1f4862b40c92691cae1845e4fdf5fe7030fe52ec128376fcfcd09b3dc48649d935b6

data/README.md

@@ -1,6 +1,6 @@
 # Nokodiff
 
-A Ruby Gem to highlight additions, deletions and character level changes while preserving original HTML.
+A Ruby Gem to highlight additions, deletions, and character level changes while preserving original HTML.
 
 It includes functionality to:
 * Compare two HTML fragments and output diffs with semantic HTML
@@ -24,31 +24,21 @@ gem "nokodiff"
 
 ## Local Development
 
-The gem includes a dummy Rails application located in `spec/dummy`. It can be used to preview `Nokodiff` in a real browser environment without needing to integrate with an external host app.
+The gem includes a dummy Rails application located in `spec/dummy`. It can be used to preview `Nokodiff` in a real 
+browser environment without needing to integrate with an external host app.
 
-To get the dummy app running you need to:
-
-### Install dependencies
+You can run the dummy app with the following command:
 
 ```bash
-bundle install
+bin/run-dummy-app
 ```
 
-### Navigate to the app and install dependencies
-
-```bash
-cd spec/dummy
-bundle install
-```
+This installs the dependencies, builds the assets, and starts the server.
 
-### Start the server
-
-```bash
-bin/rails server
-```
+The dummy app will now be running on `localhost:3000`.
 
-The dummy app will now be running on `localhost:3000`
-If you want to edit the content you are testing it is located in `spec/dummy/app/controllers/application_controller.rb`, alongside the code calling `Nokodiff.diff(@before, @after)`
+If you want to edit the content you are testing it is located in `spec/dummy/fixtures/before.html`, and
+`spec/dummy/fixtures/after.html`.
 
 ## Usage
 
@@ -76,7 +66,7 @@ In your application.scss file include:
 @import "nokodiff";
 ```
 
-This will include the styling for `<del>`, `<ins>` and `<span>` tags to allow colour coding, highlighting and underlining of changes.
+This will include the styling for `<del>`, `<ins>` and `<span>` tags to allow colour coding, highlighting, and underlining of changes.
 
 ### More complex diffing with `data-diff-key`
 

data/app/assets/stylesheets/nokodiff.scss

@@ -17,7 +17,7 @@ $black: #0b0c0c;
     position: static;
     margin-bottom: 10px;
 
-    del, ins, ul, li {
+    del, ins {
       position: static !important;
       display: block;
       text-decoration: none;

data/lib/nokodiff/differ.rb

@@ -13,9 +13,9 @@ module Nokodiff
         when :changed
           changed_block(diff[:before], diff[:after])
         when :deleted
-          deleted_block(diff[:before])
+          diff[:before].name == "li" ? deleted_li(diff[:before]) : deleted_block(diff[:before])
         when :added
-          added_block(diff[:after])
+          diff[:after].name == "li" ? added_li(diff[:after]) : added_block(diff[:after])
         end
       }.join("\n")
     end
@@ -60,23 +60,41 @@ module Nokodiff
     end
 
     def changed_block(before_node, after_node)
-      if structurally_similar?(before_node, after_node)
+      if structurally_similar?(before_node, after_node) && should_not_be_treated_as_single_change?(before_node)
         inner_diff = Differ.new(before_node, after_node).to_html
         rebuild_element(after_node, inner_diff)
-      elsif before_node.text? && after_node.text?
-        before_diff, after_diff = diff_raw_text(before_node, after_node)
-        deleted_block(before_diff) + added_block(after_diff)
       else
-        before_diff, after_diff = diff_sub_elements(before_node, after_node)
-        deleted_block(before_diff) + added_block(after_diff)
+        before_diff, after_diff = if both_text_nodes?(before_node, after_node)
+                                    diff_raw_text(before_node, after_node)
+                                  else
+                                    diff_sub_elements(before_node, after_node)
+                                  end
+
+        if before_node.name == "li"
+          deleted_li(before_diff) + added_li(after_diff)
+        else
+          deleted_block(before_diff) + added_block(after_diff)
+        end
       end
     end
 
+    def both_text_nodes?(before_node, after_node)
+      before_node.text? && after_node.text?
+    end
+
     def structurally_similar?(before_node, after_node)
       before_node.element? &&
         after_node.element? &&
-        before_node.name == after_node.name &&
-        before_node.name != "p"
+        before_node.name == after_node.name
+    end
+
+    # We want all changes within a paragraph, heading, or list item to be treated as a single change, even if they are
+    # structurally different, to avoid overwhelming the user with changes, and ensure any nested elements are included
+    # within the diff, rather than being treated as added or removed content on their own.
+    def should_not_be_treated_as_single_change?(before_node)
+      before_node.name != "p" &&
+        !before_node.name.match(/^h[1-6]$/) &&
+        before_node.name != "li"
     end
 
     def rebuild_element(template_node, inner_html)
@@ -108,7 +126,11 @@ module Nokodiff
       merge_adjacent_highlighted_changes(before_fragment)
       merge_adjacent_highlighted_changes(after_fragment)
 
-      [before_fragment.to_html, after_fragment.to_html]
+      if before_html.name == "li"
+        [before_fragment.inner_html, after_fragment.inner_html]
+      else
+        [before_fragment.to_html, after_fragment.to_html]
+      end
     end
 
     def merge_adjacent_highlighted_changes(node)
@@ -137,6 +159,16 @@ module Nokodiff
       node.to_html
     end
 
+    def deleted_li(html)
+      %(
+        <li>
+          <div class="diff">
+            <del aria-label="removed content">#{html}</del>
+          </div>
+        </li>
+      )
+    end
+
     def deleted_block(html)
       %(
         <div class="diff">
@@ -152,5 +184,15 @@ module Nokodiff
         </div>
       )
     end
+
+    def added_li(html)
+      %(
+        <li>
+          <div class="diff">
+            <ins aria-label="added content">#{html}</ins>
+          </div>
+        </li>
+      )
+    end
   end
 end

data/lib/nokodiff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nokodiff
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nokodiff
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -102,7 +102,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.1.3
+        version: 8.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.1.3
+        version: 8.1.4
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +184,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.1.3
+        version: 8.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -194,7 +194,7 @@ dependencies:
         version: '6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: 8.1.3
+        version: 8.1.4
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A Ruby Gem to highlight additions, deletions and character level changes
   while preserving original HTML