nokodiff 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12bce0257af1ebff2c6de595dce5d68cefc73feb5ae4a419a98a81d9dbac212
-  data.tar.gz: 9479aa3c4ae7f3481a0a96baf002735fb02a4848530a9fc38565c72118e4a2eb
+  metadata.gz: 4804027f53e38322927f18d80b25a0c9cdfa659154e56090ba61e895dbde68f8
+  data.tar.gz: 855959815a1284325a50326d962127ff44feee8d16adfd74fd0e7af300b99ab9
 SHA512:
-  metadata.gz: 864f165ec8332dbcc0a61cffda45f6649ed00d5483e969ad7d55dc9af2e4acdbe202f54686424ff387f6f36ecd160b3834e89f4d1633a8bf311534b6c09eb0b3
-  data.tar.gz: f182809b76cf85e8ce23002575fb5c2708e527cd3659628d0ef248fdce79e1581ed6a551f99ca41a16dff7bacf9d67db87579185761052136e3f491d227f8bf6
+  metadata.gz: e9484c5b5682e6d8299d1c8d7ff9b38d6a9c53c85ffc15cbef6bdfd234d3bd81df05ba90423924511db20381e44fb70c078cbbef15fdfea631ad5d583647aede
+  data.tar.gz: 3563899d45760342ac2a70ad7977b35a8e7bfc5aeb058aba2a69ad567865a6a8de628a4240f687439e2f48e5ef3ddba1d82e0916d72910d89e2b149897fbe659

data/README.md

@@ -4,7 +4,7 @@ A Ruby Gem to highlight additions, deletions and character level changes while p
 
 It includes functionality to:
 * Compare two HTML fragments and output diffs with semantic HTML
-* Inline character differences highlighting using `<strong>` tagging
+* Inline character differences highlighting using `<span class="diff-marker">` tagging
 * Blocks of added or removed content wrapped in aria labelled `<ins>` and `<del>` tags
 * Optional CSS for styling the visual differences
 
@@ -48,7 +48,7 @@ In your application.scss file include:
 @import "nokodiff";
 ```
 
-This will include the styling for `<del>`, `<ins>` and `<strong>` 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`
 
@@ -139,10 +139,10 @@ Output:
   <div data-diff-key="ixn4"><p>First paragraph</p></div>
   <div data-diff-key="zm7q">
     <div class="diff">
-      <del aria-label="removed content"><p><strong>S</strong>e<strong>cond</strong> paragraph</p></del>
+      <del aria-label="removed content"><p><span class="diff-marker">S</span>e<span class="diff-marker">cond</span> paragraph</p></del>
     </div>
     <div class="diff">
-      <ins aria-label="added content"><p><strong>N</strong>e<strong>w</strong> paragraph</p></ins>
+      <ins aria-label="added content"><p><span class="diff-marker">N</span>e<span class="diff-marker">w</span> paragraph</p></ins>
     </div>
   </div>
 </div>

data/app/assets/stylesheets/nokodiff.scss

@@ -1,9 +1,9 @@
 // stylelint-disable selector-no-qualifying-type, max-nesting-depth
 // Diff of two editions
 $added-color: #e6fff3;
-$strong-added-color: #99ffcf;
+$diff-marker-added-color: #99ffcf;
 $removed-color: #fadede;
-$strong-removed-color: #f3aeac;
+$diff-marker-removed-color: #f3aeac;
 $text-colour: #0b0c0c;
 $light-grey: #f3f2f1;
 $black: #0b0c0c;
@@ -33,9 +33,9 @@ $black: #0b0c0c;
     background-color: $removed-color;
     padding-bottom: 2px;
 
-    strong {
+    span.diff-marker {
       font-weight: normal;
-      background-color: $strong-removed-color;
+      background-color: $diff-marker-removed-color;
       border-bottom: 2px dashed $black;
     }
   }
@@ -44,9 +44,9 @@ $black: #0b0c0c;
     background-color: $added-color;
     padding-bottom: 2px;
 
-    strong {
+    span.diff-marker {
       font-weight: normal;
-      background-color: $strong-added-color;
+      background-color: $diff-marker-added-color;
       border-bottom: 2px dashed $black;
     }
   }
@@ -63,13 +63,13 @@ $black: #0b0c0c;
 
   del::before {
     color: $text-colour;
-    background-color: $strong-removed-color;
+    background-color: $diff-marker-removed-color;
     content: "−";
   }
 
   ins::before {
     color: $text-colour;
-    background-color: $strong-added-color;
+    background-color: $diff-marker-added-color;
     content: "+";
   }
-}
+}

data/lib/nokodiff/changes_in_fragments.rb

@@ -43,18 +43,18 @@ module Nokodiff
       append_accumulated_text(before_fragment, accumulated_before_text)
       append_accumulated_text(after_fragment, accumulated_after_text)
 
-      before_fragment.add_child(wrap_in_strong(change.old_element, before_fragment))
-      after_fragment.add_child(wrap_in_strong(change.new_element, after_fragment))
+      before_fragment.add_child(highlight_changes(change.old_element, before_fragment))
+      after_fragment.add_child(highlight_changes(change.new_element, after_fragment))
     end
 
     def emphasise_deletion(change)
       append_accumulated_text(before_fragment, accumulated_before_text)
-      before_fragment.add_child(wrap_in_strong(change.old_element, before_fragment))
+      before_fragment.add_child(highlight_changes(change.old_element, before_fragment))
     end
 
     def emphasise_addition(change)
       append_accumulated_text(after_fragment, accumulated_after_text)
-      after_fragment.add_child(wrap_in_strong(change.new_element, after_fragment))
+      after_fragment.add_child(highlight_changes(change.new_element, after_fragment))
     end
 
     def append_accumulated_text(fragment, accumulated_text)

data/lib/nokodiff/differ.rb

@@ -42,8 +42,8 @@ module Nokodiff
 
       before_fragment, after_fragment = Nokodiff::TextNodeDiffs.new(before_dup, after_dup).call
 
-      merge_adjacent_strong_tags(before_fragment)
-      merge_adjacent_strong_tags(after_fragment)
+      merge_adjacent_highlighted_changes(before_fragment)
+      merge_adjacent_highlighted_changes(after_fragment)
 
       [before_fragment.to_html, after_fragment.to_html]
     end
@@ -62,24 +62,28 @@ module Nokodiff
       end
     end
 
-    def merge_adjacent_strong_tags(node)
+    def merge_adjacent_highlighted_changes(node)
       return unless node.element?
 
       node.children.each do |child|
-        merge_adjacent_strong_tags(child) if child.element?
+        merge_adjacent_highlighted_changes(child) if child.element?
       end
 
       node.children.each_cons(2) do |left, right|
-        next unless left.name == "strong" && right.name == "strong"
+        next unless node_is_a_change?(left) && node_is_a_change?(right)
 
         left.content = left.content + right.content
         right.remove
 
-        merge_adjacent_strong_tags(node)
+        merge_adjacent_highlighted_changes(node)
         break
       end
     end
 
+    def node_is_a_change?(node)
+      node.name == "span" && node["class"] == "diff-marker"
+    end
+
     def unchanged_block(html)
       html.to_s
     end

data/lib/nokodiff/formatting_helpers.rb

@@ -1,11 +1,14 @@
 module Nokodiff
   module FormattingHelpers
-    def wrap_in_strong(char, fragment)
-      Nokogiri::XML::Node.new("strong", fragment.document).tap { |n| n.content = char }
+    def highlight_changes(char, fragment)
+      Nokogiri::XML::Node.new("span", fragment.document).tap do |n|
+        n.content = char
+        n["class"] = "diff-marker"
+      end
     end
 
-    def strong(text_node)
-      text_node.replace(wrap_in_strong(text_node.to_html, text_node.parent))
+    def highlighted_change(text_node)
+      text_node.replace(highlight_changes(text_node.to_html, text_node.parent))
     end
   end
 end

data/lib/nokodiff/text_node_diffs.rb

@@ -31,8 +31,8 @@ module Nokodiff
     end
 
     def diff_text_node_content(before_text_node, after_text_node)
-      return strong(before_text_node) if text_removed?(before_text_node, after_text_node)
-      return strong(after_text_node) if text_added?(before_text_node, after_text_node)
+      return highlighted_change(before_text_node) if text_removed?(before_text_node, after_text_node)
+      return highlighted_change(after_text_node) if text_added?(before_text_node, after_text_node)
 
       before_chars = before_text_node.text.chars
       after_chars = after_text_node.text.chars

data/lib/nokodiff/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nokodiff
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - GOV.UK Dev