publishing_platform_nokodiff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a68f8c34108df7e8436c255154a6d224f9e664fe4cc66a7fd95421563802369
+  data.tar.gz: 22ad1fe022f37d8b6b4b16d706a4ea99de0c64fdc8129f8fb90b1c83de7a0ddc
+SHA512:
+  metadata.gz: d8bfc56f097ec67694f32314df01b9933c25b8f9d706dd7fde499d25ee3d02256713137491e8319e9dd99d724bce7b529af41d0bbcafb2329d5534adb26d3109
+  data.tar.gz: b3d6b296c69de8776b0344ad7dd9497ae1e417d068a26d778fc46043f1ca075bf870f3783b9a011f9726fb227db11272c7cabf3347c076baff4609274d3fab10

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2026 Publishing Platform
+Copyright (c) 2025 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Publishing Platform Nokodiff
+
+A Ruby Gem to highlight additions, deletions and character level changes while preserving original HTML.

data/app/assets/stylesheets/nokodiff.scss

@@ -0,0 +1,72 @@
+// stylelint-disable selector-no-qualifying-type, max-nesting-depth
+// Diff of two editions
+$added-color: #e6fff3;
+$diff-marker-added-color: #99ffcf;
+$removed-color: #fadede;
+$diff-marker-removed-color: #f3aeac;
+$text-colour: #0b0c0c;
+$light-grey: #f3f2f1;
+$black: #0b0c0c;
+
+.compare-editions {
+  position: relative;
+  border-left: 40px solid $light-grey;
+  padding: 15px;
+
+  .diff {
+    position: static;
+    margin-bottom: 10px;
+
+    del, ins {
+      position: static !important;
+      display: block;
+      text-decoration: none;
+      border-radius: 3px;
+    }
+
+    del {
+      background-color: $removed-color;
+      padding-bottom: 2px;
+
+      span.diff-marker {
+        font-weight: normal;
+        background-color: $diff-marker-removed-color;
+        border-bottom: 2px dashed $black;
+      }
+    }
+
+    ins {
+      background-color: $added-color;
+      padding-bottom: 2px;
+
+      span.diff-marker {
+        font-weight: normal;
+        background-color: $diff-marker-added-color;
+        border-bottom: 2px dashed $black;
+      }
+    }
+
+    del::before,
+    ins::before {
+      position: absolute;
+      left: -40px;
+      width: 40px;
+      height: 1.5em;
+      line-height: 1.5em;
+      text-align: center;
+      z-index: 10;
+    }
+  }
+
+  del::before {
+    color: $text-colour;
+    background-color: $diff-marker-removed-color;
+    content: "−";
+  }
+
+  ins::before {
+    color: $text-colour;
+    background-color: $diff-marker-added-color;
+    content: "+";
+  }
+}

data/lib/publishing_platform_nokodiff/changes_in_fragments.rb

@@ -0,0 +1,67 @@
+module PublishingPlatformNokodiff
+  class ChangesInFragments
+    include FormattingHelpers
+    def initialize(diff)
+      @diff = diff
+      @before_fragment = Nokogiri::HTML::DocumentFragment.parse("")
+      @after_fragment = Nokogiri::HTML::DocumentFragment.parse("")
+
+      @accumulated_before_text = ""
+      @accumulated_after_text = ""
+    end
+
+    def call
+      @diff.each do |change|
+        case change.action
+        when "="
+          no_change_emphasis(change)
+        when "!"
+          emphasise_change(change)
+        when "-"
+          emphasise_deletion(change)
+        when "+"
+          emphasise_addition(change)
+        end
+      end
+
+      append_accumulated_text(before_fragment, accumulated_before_text)
+      append_accumulated_text(after_fragment, accumulated_after_text)
+
+      [before_fragment, after_fragment]
+    end
+
+  private
+
+    attr_accessor :before_fragment, :after_fragment, :accumulated_before_text, :accumulated_after_text
+
+    def no_change_emphasis(change)
+      accumulated_before_text << change.old_element
+      accumulated_after_text << change.new_element
+    end
+
+    def emphasise_change(change)
+      append_accumulated_text(before_fragment, accumulated_before_text)
+      append_accumulated_text(after_fragment, accumulated_after_text)
+
+      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(highlight_changes(change.old_element, before_fragment))
+    end
+
+    def emphasise_addition(change)
+      append_accumulated_text(after_fragment, accumulated_after_text)
+      after_fragment.add_child(highlight_changes(change.new_element, after_fragment))
+    end
+
+    def append_accumulated_text(fragment, accumulated_text)
+      return if accumulated_text.empty?
+
+      fragment.add_child(Nokogiri::XML::Text.new(accumulated_text, fragment))
+      accumulated_text.clear
+    end
+  end
+end

data/lib/publishing_platform_nokodiff/differ.rb

@@ -0,0 +1,198 @@
+module PublishingPlatformNokodiff
+  class Differ
+    def initialize(before, after)
+      @before = before
+      @after = after
+    end
+
+    def to_html
+      compared_blocks.map { |diff|
+        case diff[:status]
+        when :unchanged
+          unchanged_block(diff[:before])
+        when :changed
+          changed_block(diff[:before], diff[:after])
+        when :deleted
+          diff[:before].name == "li" ? deleted_li(diff[:before]) : deleted_block(diff[:before])
+        when :added
+          diff[:after].name == "li" ? added_li(diff[:after]) : added_block(diff[:after])
+        end
+      }.join("\n")
+    end
+
+  private
+
+    def compared_blocks
+      before_nodes = @before.children.to_a
+      after_nodes = @after.children.to_a
+
+      before_html_strings = before_nodes.map { |n| n.to_html.strip }
+      after_html_strings  = after_nodes.map { |n| n.to_html.strip }
+
+      Diff::LCS.sdiff(before_html_strings, after_html_strings).map do |change|
+        case change.action
+        when "="
+          {
+            status: :unchanged,
+            before: before_nodes[change.old_position],
+            after: after_nodes[change.new_position],
+          }
+        when "!"
+          {
+            status: :changed,
+            before: before_nodes[change.old_position],
+            after: after_nodes[change.new_position],
+          }
+        when "-"
+          {
+            status: :deleted,
+            before: before_nodes[change.old_position],
+            after: nil,
+          }
+        when "+"
+          {
+            status: :added,
+            before: nil,
+            after: after_nodes[change.new_position],
+          }
+        end
+      end
+    end
+
+    def changed_block(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)
+      else
+        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
+    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)
+      result = template_node.dup
+      result.inner_html = inner_html
+      result.to_html
+    end
+
+    def diff_raw_text(before_text, after_text)
+      diff = Diff::LCS.sdiff(before_text.text.chars, after_text.text.chars)
+      before_fragment, after_fragment = PublishingPlatformNokodiff::ChangesInFragments.new(diff).call
+      [merge_fragment_spans(before_fragment), merge_fragment_spans(after_fragment)]
+    end
+
+    def merge_fragment_spans(fragment)
+      doc = fragment.document
+      wrapper = Nokogiri::XML::Node.new("span", doc)
+      wrapper.inner_html = fragment.to_html
+      merge_adjacent_highlighted_changes(wrapper)
+      wrapper.inner_html
+    end
+
+    def diff_sub_elements(before_html, after_html)
+      before_dup = before_html.dup
+      after_dup = after_html.dup
+
+      before_fragment, after_fragment = PublishingPlatformNokodiff::TextNodeDiffs.new(before_dup, after_dup).call
+
+      merge_adjacent_highlighted_changes(before_fragment)
+      merge_adjacent_highlighted_changes(after_fragment)
+
+      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)
+      return unless node.element?
+
+      node.children.each do |child|
+        merge_adjacent_highlighted_changes(child) if child.element?
+      end
+
+      node.children.each_cons(2) do |left, right|
+        next unless node_is_a_change?(left) && node_is_a_change?(right)
+
+        left.content = left.content + right.content
+        right.remove
+
+        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(node)
+      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">
+           <del aria-label="removed content">#{html}</del>
+        </div>
+      )
+    end
+
+    def added_block(html)
+      %(
+        <div class="diff">
+           <ins aria-label="added content">#{html}</ins>
+        </div>
+      )
+    end
+
+    def added_li(html)
+      %(
+        <li>
+          <div class="diff">
+            <ins aria-label="added content">#{html}</ins>
+          </div>
+        </li>
+      )
+    end
+  end
+end

data/lib/publishing_platform_nokodiff/engine.rb

@@ -0,0 +1,7 @@
+return unless defined?(Rails)
+
+module PublishingPlatformNokodiff
+  class Engine < ::Rails::Engine
+    isolate_namespace PublishingPlatformNokodiff
+  end
+end

data/lib/publishing_platform_nokodiff/formatting_helpers.rb

@@ -0,0 +1,10 @@
+module PublishingPlatformNokodiff
+  module FormattingHelpers
+    def highlight_changes(char, fragment)
+      Nokogiri::XML::Node.new("span", fragment.document).tap do |n|
+        n.content = char
+        n["class"] = "diff-marker"
+      end
+    end
+  end
+end

data/lib/publishing_platform_nokodiff/html_fragment.rb

@@ -0,0 +1,40 @@
+require "forwardable"
+
+module PublishingPlatformNokodiff
+  class HTMLFragment
+    extend Forwardable
+
+    class InvalidHTMLError < StandardError; end
+
+    def initialize(html)
+      @fragment = Nokogiri::HTML.fragment(html)
+      validate!
+      remove_blank_nodes!
+      remove_comments!
+    end
+
+    def_delegators :@fragment, :children, :css, :at, :to_html
+
+  private
+
+    def validate!
+      invalid_text_nodes = @fragment.children.reject do |node|
+        node.element? || node.comment? || (node.text? && node.text.strip.empty?)
+      end
+
+      unless invalid_text_nodes.empty?
+        raise InvalidHTMLError, "Invalid HTML input: #{@fragment.to_html}"
+      end
+    end
+
+    def remove_blank_nodes!
+      @fragment.traverse do |node|
+        node.remove if node.blank?
+      end
+    end
+
+    def remove_comments!
+      @fragment.css("comment()").remove
+    end
+  end
+end

data/lib/publishing_platform_nokodiff/text_node_diffs.rb

@@ -0,0 +1,51 @@
+module PublishingPlatformNokodiff
+  class TextNodeDiffs
+    include FormattingHelpers
+    def initialize(before_fragment, after_fragment)
+      @before_fragment = before_fragment
+      @after_fragment = after_fragment
+    end
+
+    def call
+      diff_text_nodes(before_fragment, after_fragment)
+      [before_fragment, after_fragment]
+    end
+
+  private
+
+    attr_accessor :before_fragment, :after_fragment
+
+    def diff_text_nodes(before_node, after_node)
+      if before_node&.text? || after_node&.text?
+        diff_text_node_content(before_node, after_node)
+      elsif before_node&.element? || after_node&.element?
+        before_children = before_node ? before_node.children.to_a : []
+        after_children = after_node ? after_node.children.to_a : []
+
+        max_child_count = [before_children.length, after_children.length].max
+
+        (0..max_child_count).each do |i|
+          diff_text_nodes(before_children[i], after_children[i])
+        end
+      end
+    end
+
+    def diff_text_node_content(before_text_node, after_text_node)
+      before_chars = get_chars(before_text_node)
+      after_chars = get_chars(after_text_node)
+
+      diff = Diff::LCS.sdiff(before_chars, after_chars)
+
+      before_fragment, after_fragment = PublishingPlatformNokodiff::ChangesInFragments.new(diff).call
+
+      before_text_node&.replace(before_fragment)
+      after_text_node&.replace(after_fragment)
+    end
+
+    def get_chars(text_node)
+      return [] if text_node.nil?
+
+      text_node.text.chars
+    end
+  end
+end

data/lib/publishing_platform_nokodiff/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PublishingPlatformNokodiff
+  VERSION = "0.1.0"
+end

data/lib/publishing_platform_nokodiff.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "nokogiri"
+require "diff-lcs"
+require "byebug"
+
+require_relative "publishing_platform_nokodiff/formatting_helpers"
+require_relative "publishing_platform_nokodiff/version"
+require_relative "publishing_platform_nokodiff/differ"
+require_relative "publishing_platform_nokodiff/engine"
+require_relative "publishing_platform_nokodiff/text_node_diffs"
+require_relative "publishing_platform_nokodiff/changes_in_fragments"
+require_relative "publishing_platform_nokodiff/html_fragment"
+
+module PublishingPlatformNokodiff
+  def self.diff(before_html, after_html)
+    before = PublishingPlatformNokodiff::HTMLFragment.new(before_html)
+    after = PublishingPlatformNokodiff::HTMLFragment.new(after_html)
+
+    before_nodes, after_nodes = nodes(before, after)
+    keys = (before_nodes.keys + after_nodes.keys).uniq
+
+    html = keys.any? ? diff_by_keys(after, keys, before_nodes, after_nodes) : Differ.new(before, after).to_html
+    safe_html(html)
+  end
+
+  def self.safe_html(html)
+    html.respond_to?(:html_safe) ? html.html_safe : html
+  end
+
+  private_class_method def self.nodes(before, after)
+    [
+      fetch_diff_nodes(before),
+      fetch_diff_nodes(after),
+    ]
+  end
+
+  private_class_method def self.fetch_diff_nodes(fragment)
+    fragment.css("[data-diff-key]").map { |node| [node["data-diff-key"], node] }.to_h
+  end
+
+  private_class_method def self.diff_by_keys(after, keys, before_nodes, after_nodes)
+    keys.each do |key|
+      diff = Differ.new(
+        before_nodes.fetch(key, Nokogiri::HTML.fragment("")),
+        after_nodes.fetch(key, Nokogiri::HTML.fragment("")),
+      ).to_html
+      after.at("[data-diff-key='#{key}']")&.inner_html = diff
+    end
+    after.to_html
+  end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: publishing_platform_nokodiff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Publishing Platform
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: publishing_platform_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 13.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.1.4
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.1.4
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- app/assets/stylesheets/nokodiff.scss
+- lib/publishing_platform_nokodiff.rb
+- lib/publishing_platform_nokodiff/changes_in_fragments.rb
+- lib/publishing_platform_nokodiff/differ.rb
+- lib/publishing_platform_nokodiff/engine.rb
+- lib/publishing_platform_nokodiff/formatting_helpers.rb
+- lib/publishing_platform_nokodiff/html_fragment.rb
+- lib/publishing_platform_nokodiff/text_node_diffs.rb
+- lib/publishing_platform_nokodiff/version.rb
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: A Ruby Gem to highlight additions, deletions and character level changes
+  while preserving original HTML
+test_files: []