hyp_diff 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kristian Hanekamp
+
+MIT License
+
+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,50 @@
+# HypDiff
+
+HypDiff compares HTML snippets. It generates a diff between two input snippets. The diff is a new HTML snippet that highlights textual changes. The tag structure and formatting of the input snippets is preserved. The generated diff snippet is valid, well-formed HTML and suitable for presentation inside a WYSIWYG environment.
+
+## Usage
+
+    HypDiff.compare("<p>byebye world</p>", "<p>hello world</p>")
+    # '<p><del>byebye</del><ins>hello</ins> world</p> '
+
+For more examples, take a look at the [specs](spec/hyp_diff_spec.rb).
+
+## Why another diff tool?
+
+Many existing tools simply create a diff of the html source code. Unfortunately a diff of the source code can only be viewed as source code. It cannot be viewed in a browser. While that is fine for developers, it is not suitable for an audience that prefers not to be exposed to HTML source code, for example users of WYSIWYG editors.
+
+There are other tools that try to generate an HTML diff that is can be rendered by a browser. But many tools simply try to "work around" the HTML document structure by use of regular expressions. This simplistic approach only works for a small subset of HTML snippets. These tools often output incomprehensible diffs or even invalid HTML.
+
+## How is HypDiff different?
+
+HypDiff takes two HTML snippets and generates a comparison that is again a valid HTML snippet that can be viewed inside a browser.
+
+HypDiff does not rely on regular expressions, but actually parses the input snippets using Nokogiri. It extracts the textual content of the documents and compares them with a state-of-the-art diff algorithm provided by the diff-lcs gem. It then inserts `<ins>` and `<del>` tags into the HTML snippet to highlight changes, but leaves all other HTML tags intact.
+
+## Limitations
+
+HypDiff does not perform a comparison of the html source code or the DOM tree, but compares changes to visible text. It does not care about changes that do not involve visible text.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hyp_diff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyp_diff
+
+## Contributing
+
+1. Fork it ( http://github.com/krishan/hyp_diff/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Copyright 2014 Kristian Hanekamp

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hyp_diff.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hyp_diff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hyp_diff"
+  spec.version       = HypDiff::VERSION
+  spec.authors       = ["Kristian Hanekamp"]
+  spec.email         = ["kris.hanekamp@gmail.com"]
+  spec.summary       = %q{HypDiff compares html snippets}
+  spec.description   = %q{
+HypDiff compares HTML snippets. It generates a diff between two input snippets. The diff is a new HTML snippet that highlights textual changes. The tag structure and formatting of the input snippets is preserved. The generated diff snippet is valid, well-formed HTML and suitable for presentation inside a WYSIWYG environment.
+  }
+  spec.homepage      = "https://github.com/krishan/hyp_diff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri", "~> 1.5.6"
+  spec.add_dependency "diff-lcs", "~> 1.2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/lib/hyp_diff.rb

@@ -0,0 +1,163 @@
+require "nokogiri"
+require "diff-lcs"
+
+require "text_from_node"
+
+module HypDiff; class << self
+
+  def compare(before, after)
+    parsed_after = parse(after)
+    parsed_before = parse(before)
+
+    text_changes = Diff::LCS.sdiff(extract_text(parsed_before), extract_text(parsed_after))
+
+    NodeMap.for(text_changes).each do |node, changes|
+      node.replace(ChangeRenderer.render(changes))
+    end
+
+    parsed_after.to_html
+  end
+
+  private
+
+  class NodeMap
+    def self.for(changes)
+      new.build(changes).map
+    end
+
+    attr_reader :map
+
+    def initialize
+      @map = {}
+      @stashed = []
+    end
+
+    def build(changes)
+      changes.each do |change|
+        if change.new_element
+          node = change.new_element.node
+
+          if @stashed.length > 0
+            @stashed.each do |stashed_change|
+              append_to_node(node, stashed_change)
+            end
+            @stashed = []
+          end
+
+          append_to_node(node, change)
+
+          @last_processed_node = node
+        else
+          if @last_processed_node
+            append_to_node(@last_processed_node, change)
+          else
+            @stashed << change
+          end
+        end
+      end
+
+      self
+    end
+
+    def append_to_node(node, change)
+      list = (@map[node] ||= [])
+      list << change
+    end
+  end
+
+  class ChangeRenderer
+    def self.render(changes)
+      renderer = new.render(changes).rendered_text
+    end
+
+    def initialize
+      @new_text = []
+    end
+
+    def render(changes)
+      @insertions = []
+      @deletions = []
+
+      changes.each do |change|
+        case change.action
+        when "!" then
+          deletions << change.old_element.text
+          insertions << change.new_element.text
+        when "=" then
+          apply_insertions_and_deletions
+          new_text << change.new_element.text
+        when "+" then
+          insertions << change.new_element.text
+        when "-" then
+          deletions << change.old_element.text
+        else
+          raise "unexpected change.action #{change.action}"
+        end
+      end
+
+      apply_insertions_and_deletions
+
+      self
+    end
+
+    def rendered_text
+      new_text.join
+    end
+
+    private
+
+    attr_reader :insertions, :deletions, :new_text
+
+    def apply_insertions_and_deletions
+      if deletions.length > 0
+        @new_text << deletion_tag(deletions.join)
+      end
+      if insertions.length > 0
+        @new_text << insertion_tag(insertions.join)
+      end
+
+      @insertions = []
+      @deletions = []
+    end
+
+    def insertion_tag(text)
+      "<ins>#{text}</ins>"
+    end
+
+    def deletion_tag(text)
+      "<del>#{text}</del>"
+    end
+
+  end
+
+  def parse(text)
+    Nokogiri::HTML.fragment(text)
+  end
+
+  def extract_text(node)
+    filter_whitespace(text_fragments(node))
+  end
+
+  def text_fragments(node)
+    if node.is_a?(Nokogiri::XML::Text)
+      node.text.split(/(?=[.!, ])|\b/).map { |token| TextFromNode.new(token, node) }
+    else
+      node.children.map { |c| text_fragments(c) }.flatten
+    end
+  end
+
+  def filter_whitespace(node_list)
+    result = []
+    last_node_whitespace = false
+    node_list.each do |node|
+      node_whitespace = node.whitespace?
+      result << node unless last_node_whitespace && node_whitespace
+
+      last_node_whitespace = node_whitespace
+    end
+
+    result
+  end
+
+end; end
+

data/lib/hyp_diff/version.rb

@@ -0,0 +1,3 @@
+module HypDiff
+  VERSION = "0.0.1"
+end

data/lib/text_from_node.rb

@@ -0,0 +1,31 @@
+class TextFromNode
+  def initialize(raw_text, node)
+    @text = raw_text.strip == "" ? " " : raw_text
+    @node = node
+  end
+
+  def ==(other)
+    text == other.text
+  end
+
+  def eql?(other)
+    text == other.text
+  end
+
+  def hash
+    text.hash
+  end
+
+  def whitespace?
+    @text == " "
+  end
+
+  def text
+    @text
+  end
+
+  def node
+    @node
+  end
+end
+

data/spec/hyp_diff_spec.rb

@@ -0,0 +1,141 @@
+require "hyp_diff"
+
+describe HypDiff do
+
+  def expect_diff(old, new, expected)
+    HypDiff.compare(old, new).should == expected
+  end
+
+  it "diffs two texts, applying tags to indicate changes" do
+    expect_diff("byebye", "hello", '<del>byebye</del><ins>hello</ins>')
+  end
+
+  it "extracts text to diff from input markup, reapplying the (after-)markup to the diff" do
+    expect_diff(
+      "<b>byebye</b> world",
+      "<i>hello</i> world",
+      '<i><del>byebye</del><ins>hello</ins></i> world'
+    )
+  end
+
+  it "diffs word-by-word" do
+    expect_diff("byebye world", "hello world", '<del>byebye</del><ins>hello</ins> world')
+  end
+
+  it "handles pure additions" do
+    expect_diff("hello ", "hello world", 'hello <ins>world</ins>')
+  end
+
+  it "handles pure deletions" do
+    expect_diff("hello world", "hello ", 'hello <del>world</del>')
+  end
+
+  it "handles pure deletions at the beginning" do
+    expect_diff("hello world", " world", '<del>hello</del> world')
+  end
+
+  it "handles several pure deletions at the beginning" do
+    expect_diff("hello beautiful world", "world", '<del>hello beautiful </del>world')
+  end
+
+  it "merges consecutive additions into a single tag" do
+    expect_diff(
+      "hello world",
+      "why hello beautiful world",
+      "<ins>why </ins>hello<ins> beautiful</ins> world"
+    )
+  end
+
+  it "merges consecutive deletions into a single tag" do
+    expect_diff("hello beautiful world", "hello world", "hello <del>beautiful </del>world")
+  end
+
+  it "merge consecutive additions and edits into single tags" do
+    expect_diff(
+      "hello world",
+      "hello my beautiful",
+      "hello <del>world</del><ins>my beautiful</ins>"
+    )
+  end
+
+  it "merge consecutive deletions and edits into single tags" do
+    expect_diff(
+      "hello my beautiful",
+      "hello world",
+      "hello <del>my beautiful</del><ins>world</ins>"
+    )
+  end
+
+  describe "handling whitespace" do
+    it "treats consecutive whitespace as a single whitespace" do
+      expect_diff("hello  world", "hello world", "hello world")
+    end
+
+    it "treats consecutive whitespace as a single whitespace across tags" do
+      expect_diff(
+        "<span>hello </span> <span> world</span>",
+        "hello world",
+        "hello world"
+      )
+      expect_diff(
+        "<span>hello </span>world",
+        "hello<span> world</span>",
+        "hello<span> world</span>"
+      )
+    end
+
+    it "considers trailing and leading whitespace for insertions and deletions" do
+      expect_diff("hello", "hello world", "hello<ins> world</ins>")
+      expect_diff("hello world", "hello", "hello<del> world</del>")
+      expect_diff("world", "hello world", "<ins>hello </ins>world")
+      expect_diff("hello world", "world", "<del>hello </del>world")
+      expect_diff(" world", "hello world", "<ins>hello</ins> world")
+      expect_diff("hello world", " world", "<del>hello</del> world")
+      expect_diff("hello ", "hello world", "hello <ins>world</ins>")
+      expect_diff("hello world", "hello ", "hello <del>world</del>")
+    end
+
+    it "considers trailing and leading whitespace changes" do
+      expect_diff("hello ", "hello", "hello<del> </del>")
+      expect_diff("hello", "hello ", "hello<ins> </ins>")
+      expect_diff(" hello", "hello", "<del> </del>hello")
+      expect_diff("hello", " hello", "<ins> </ins>hello")
+    end
+
+    it "considers changes of text and whitespace" do
+      expect_diff("hello world ", "hello friend", "hello <del>world </del><ins>friend</ins>")
+      expect_diff(" bye world", "hello world", "<del> bye</del><ins>hello</ins> world")
+      expect_diff("hello friend", "hello world ", "hello <del>friend</del><ins>world </ins>")
+      expect_diff("hello world", " bye world", "<del>hello</del><ins> bye</ins> world")
+    end
+  end
+
+  it "diffs punctuation signs as single tokens when followed by whitespace" do
+    expect_diff("hello world", "hello, world", "hello<ins>,</ins> world")
+  end
+
+  it "diffs changes of punctuation to words" do
+    expect_diff(
+      "hello, world",
+      "hello beautiful world",
+      "hello<del>,</del><ins> beautiful</ins> world"
+    )
+    expect_diff(
+      "hello beautiful world",
+      "hello, world",
+      "hello<del> beautiful</del><ins>,</ins> world"
+    )
+  end
+
+  it "diffs changes of punctuation to leading and trailing spaces" do
+    expect_diff("hello.", "hello ", "hello<del>.</del><ins> </ins>")
+    expect_diff("hello ", "hello.", "hello<del> </del><ins>.</ins>")
+    expect_diff(" hello", ".hello", "<del> </del><ins>.</ins>hello")
+    expect_diff(".hello", " hello", "<del>.</del><ins> </ins>hello")
+  end
+
+  it "diffs punctuation signs as single tokens when at end of string" do
+    expect_diff("hello world", "hello world.", "hello world<ins>.</ins>")
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))

data/spec/text_from_node_spec.rb

@@ -0,0 +1,26 @@
+require "text_from_node"
+
+describe TextFromNode do
+
+  let(:node) { double }
+  let(:other_node) { double }
+
+  let(:subject) { TextFromNode.new("spam", node) }
+  let(:same_text_other_node) { TextFromNode.new("spam", other_node) }
+  let(:other_text_same_node) { TextFromNode.new("eggs", node) }
+
+  it "equals other instance when text is equal" do
+    subject.should == same_text_other_node
+    subject.should be_eql(same_text_other_node)
+
+    subject.should_not == other_text_same_node
+    subject.should_not be_eql(other_text_same_node)
+  end
+
+  it "provides a sane hash implementation" do
+    subject.hash.should == same_text_other_node.hash
+    subject.hash.should_not == other_text_same_node.hash
+  end
+
+end
+

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: hyp_diff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kristian Hanekamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: ! "\nHypDiff compares HTML snippets. It generates a diff between two
+  input snippets. The diff is a new HTML snippet that highlights textual changes.
+  The tag structure and formatting of the input snippets is preserved. The generated
+  diff snippet is valid, well-formed HTML and suitable for presentation inside a WYSIWYG
+  environment.\n  "
+email:
+- kris.hanekamp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hyp_diff.gemspec
+- lib/hyp_diff.rb
+- lib/hyp_diff/version.rb
+- lib/text_from_node.rb
+- spec/hyp_diff_spec.rb
+- spec/spec_helper.rb
+- spec/text_from_node_spec.rb
+homepage: https://github.com/krishan/hyp_diff
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4061769782701953502
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4061769782701953502
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: HypDiff compares html snippets
+test_files:
+- spec/hyp_diff_spec.rb
+- spec/spec_helper.rb
+- spec/text_from_node_spec.rb