hyp_diff 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f4edc59168406b4b1194beb77ecde74bd4e2645
+  data.tar.gz: e89d6a3a2a7c55250d3d9183c6f2b6fcdbb16a80
+SHA512:
+  metadata.gz: d0197e591ec496470791dd49b63bcb78f88fa44d9d86e42bca2ddf95633f9f6576094cb4173aa7d29c71088482e2544c16fbb4ab30e29009947a1f6330f6e2a5
+  data.tar.gz: ed945683196fe5997645ba09f38d16853c9d2acac68d72cf531d8590d8f42227ad3e8389c73d2e254b12ee58d9e6200e16aedd269f026d195323f51cf08cf07d

data/.yardopts

@@ -0,0 +1,2 @@
+--non-transitive-tag api
+--api public

data/Gemfile

@@ -3,3 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem "pry"
+gem "yard"
+gem "redcarpet"

data/README.md

@@ -4,10 +4,24 @@ HypDiff compares HTML snippets. It generates a diff between two input snippets.
 
 ## Usage
 
+    # compare using the defaults: <ins> and <del> tags are inserted into the markup
     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).
+    # => '<p><del>byebye</del><ins>hello</ins> world</p> '
+
+    # use custom markup by providing callbacks for rendering insertions and deletions
+    HypDiff.compare("<p>byebye world</p>", "<p>hello world</p>",
+      render_insertion: proc { |html| "<span data-diff='ins'>#{html}</span>" },
+      render_deletion: proc { |html| "<span data-diff='del'>#{html}</span>" }
+    )
+    # '<p><span data-diff='del'>byebye</span><span data-diff='ins'>hello</span> world</p> '
+
+    # choose which markup should be the basis for the results:
+    HypDiff.compare("<div>byebye world</div>", "<p>hello world</p>", markup_from: "before")
+    # => '<div><del>byebye</del><ins>hello</ins> world</div> '
+    HypDiff.compare("<div>byebye world</div>", "<p>hello world</p>", markup_from: "after")
+    # => '<p><del>byebye</del><ins>hello</ins> world</p> '
+
+For more examples, take a look at the [specs](https://github.com/krishan/hyp_diff/blob/master/spec/hyp_diff_spec.rb).
 
 ## Why another diff tool?
 

data/lib/{text_from_node.rb → hyp_diff/text_from_node.rb}

@@ -1,3 +1,5 @@
+module HypDiff
+
 class TextFromNode
   def initialize(raw_text, node)
     @text = raw_text.strip == "" ? " " : raw_text
@@ -29,3 +31,4 @@ class TextFromNode
   end
 end
 
+end

data/lib/hyp_diff/version.rb

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

data/lib/hyp_diff.rb

@@ -1,28 +1,49 @@
 require "nokogiri"
 require "diff-lcs"
 
-require "text_from_node"
+require "hyp_diff/text_from_node"
 
+# @api public
 module HypDiff; class << self
 
-  def compare(before, after)
+  # Compare two html snippets.
+  # @param before [String] the first html snippet
+  # @param after [String] the second html snippet
+  # @option options [Proc] :render_insertion provide a callback to render insertions. The callback will receive the inserted text as a html snippet. It should return a new html snippet that will be used in the output. If no callback is given, `<ins>`-Tags will be used to highlight insertions.
+  # @option options [Proc] :render_deletion provide a callback to render deletions. The callback will receive the deleted text as a html snippet. It should return a new html snippet that will be used in the output. If no callback is given, `<del>`-Tags will be used to highlight deletions.
+  # @option options [String] :markup_from specify if the markup from `before` or `after` should be used as the basis for the output. Possible values: "before" and "after". Default: "after"
+  # @return [String] a new html snippet that highlights changes between `before` and `after`
+  # @api public
+  def compare(before, after, options = {})
     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))
+    markup_from_before = options[:markup_from] == "before"
+
+    change_node_tuples = text_changes.map do |change|
+      text_from_node = markup_from_before ? change.old_element : change.new_element
+      [change, text_from_node && text_from_node.node]
+    end
+
+    render_deletion = options[:render_deletion] || proc { |html| "<del>#{html}</del>" }
+    render_insertion = options[:render_insertion] || proc { |html| "<ins>#{html}</ins>" }
+
+    NodeMap.for(change_node_tuples).each do |node, changes|
+      node.replace(ChangeRenderer.render(changes, render_deletion, render_insertion))
     end
 
-    parsed_after.to_html
+    modified_fragment = markup_from_before ? parsed_before : parsed_after
+    modified_fragment.to_html
   end
 
   private
 
+  # @api private
   class NodeMap
-    def self.for(changes)
-      new.build(changes).map
+    def self.for(change_node_tuples, &block)
+      new.build(change_node_tuples).map
     end
 
     attr_reader :map
@@ -32,11 +53,9 @@ module HypDiff; class << self
       @stashed = []
     end
 
-    def build(changes)
-      changes.each do |change|
-        if change.new_element
-          node = change.new_element.node
-
+    def build(change_node_tuples)
+      change_node_tuples.each do |change, node|
+        if node
           if @stashed.length > 0
             @stashed.each do |stashed_change|
               append_to_node(node, stashed_change)
@@ -65,13 +84,16 @@ module HypDiff; class << self
     end
   end
 
+  # @api private
   class ChangeRenderer
-    def self.render(changes)
-      renderer = new.render(changes).rendered_text
+    def self.render(changes, render_deletion, render_insertion)
+      renderer = new(render_deletion, render_insertion).render(changes).rendered_text
     end
 
-    def initialize
+    def initialize(render_deletion, render_insertion)
       @new_text = []
+      @render_deletion = render_deletion
+      @render_insertion = render_insertion
     end
 
     def render(changes)
@@ -121,11 +143,11 @@ module HypDiff; class << self
     end
 
     def insertion_tag(text)
-      "<ins>#{text}</ins>"
+      @render_insertion.call(text)
     end
 
     def deletion_tag(text)
-      "<del>#{text}</del>"
+      @render_deletion.call(text)
     end
 
   end

data/spec/hyp_diff_spec.rb

@@ -66,6 +66,38 @@ describe HypDiff do
     )
   end
 
+  describe "with callbacks for custom markup" do
+    it "uses them to generate the insertions and deletions" do
+      HypDiff.compare(
+        "byebye world",
+        "hello world",
+        render_insertion: proc { |html| "<new>#{html}</new>" },
+        render_deletion: proc { |html| "<old>#{html}</old>" }
+      ).should ==
+        "<old>byebye</old><new>hello</new> world"
+    end
+  end
+
+  describe "choosing which markup to use" do
+    it "allows to choose 'after'" do
+      HypDiff.compare(
+        "<b>byebye world</b>",
+        "<i>hello world</i>",
+        markup_from: "after"
+      ).should ==
+        "<i><del>byebye</del><ins>hello</ins> world</i>"
+    end
+
+    it "allows to choose 'before'" do
+      HypDiff.compare(
+        "<b>byebye world</b>",
+        "<i>hello world</i>",
+        markup_from: "before"
+      ).should ==
+        "<b><del>byebye</del><ins>hello</ins> world</b>"
+    end
+  end
+
   describe "handling whitespace" do
     it "treats consecutive whitespace as a single whitespace" do
       expect_diff("hello  world", "hello world", "hello world")

data/spec/text_from_node_spec.rb

@@ -1,4 +1,6 @@
-require "text_from_node"
+require "hyp_diff/text_from_node"
+
+module HypDiff
 
 describe TextFromNode do
 
@@ -24,3 +26,4 @@ describe TextFromNode do
 
 end
 
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: hyp_diff
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Kristian Hanekamp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,15 +76,14 @@ dependencies:
   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
+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
@@ -103,49 +92,44 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - hyp_diff.gemspec
 - lib/hyp_diff.rb
+- lib/hyp_diff/text_from_node.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
+metadata: {}
 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
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HypDiff compares html snippets
 test_files:
 - spec/hyp_diff_spec.rb
 - spec/spec_helper.rb
 - spec/text_from_node_spec.rb
+has_rdoc: