tdiff 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "TDiff Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,8 @@
+### 0.1.0 / 2010-11-13
+
+* Initial release:
+  * Provides the {TDiff} mixin.
+  * Allows custom node equality and traversal logic by overriding the
+    {TDiff#tdiff_equal} and {TDiff#tdiff_each_child} methods.
+  * Implements the [Longest Common Subsequence (LCS)](http://en.wikipedia.org/wiki/Longest_common_subsequence_problem).
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Hal Brodigan
+
+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,74 @@
+# TDiff
+
+* [Source](http://github.com/postmodern/tdiff)
+* [Issues](http://github.com/postmodern/tdiff/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+Calculates the differences between two tree-like structures. Similar to
+Rubys built-in [TSort](http://rubydoc.info/docs/ruby-stdlib/1.9.2/TSort)
+module.
+
+## Features
+
+* Provides the {TDiff} mixin.
+* Allows custom node equality and traversal logic by overriding the
+  {TDiff#tdiff_equal} and {TDiff#tdiff_each_child} methods.
+* Implements the [Longest Common Subsequence (LCS)](http://en.wikipedia.org/wiki/Longest_common_subsequence_problem).
+
+## Examples
+
+Diff two HTML documents:
+
+    require 'nokogiri'
+    require 'tdiff'
+
+    class Nokogiri::XML::Node
+
+      include TDiff
+
+      def tdiff_each_child(node,&block)
+        node.children.each(&block)
+      end
+
+      def tdiff_equal(node1,node2)
+        if (node1.text? && node2.text?)
+          node1.text == node2.text
+        elsif (node1.respond_to?(:root) && node2.respond_to?(:root))
+          tdiff_equal(node1.root,node2.root)
+        elsif (node1.respond_to?(:name) && node2.respond_to?(:name))
+          node1.name == node2.name
+        else
+          false
+        end
+      end
+
+    end
+
+    doc1 = Nokogiri::HTML('<div><p>one</p> <p>three</p></div>')
+    doc2 = Nokogiri::HTML('<div><p>one</p> <p>two</p> <p>three</p></div>')
+
+    doc1.at('div').tdiff(doc2.at('div')) do |change,node|
+      puts "#{change} #{node.to_html}".ljust(30) + node.parent.path
+    end
+
+### Output
+
+    + <p>one</p>                  /html/body/div
+    +                             /html/body/div
+      <p>one</p>                  /html/body/div
+                                  /html/body/div
+      <p>three</p>                /html/body/div
+    - one                         /html/body/div/p[1]
+    + two                         /html/body/div/p[2]
+      three                       /html/body/div/p[2]
+
+## Install
+
+    $ gem install tdiff
+
+## Copyright
+
+See {file:LICENSE.txt} for details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.2.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.1.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,17 @@
+name: tdiff
+version: 0.1.0
+summary: Calculates the differences between two tree-like structures.
+description:
+  Calculates the differences between two tree-like structures. Similar to
+  Rubys built-in TSort module.
+ 
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/tdiff
+has_yard: true
+
+development_dependencies:
+  ore-tasks: ~> 0.2.0
+  rspec: ~> 2.1.0
+  yard: ~> 0.6.0

data/lib/tdiff.rb

@@ -0,0 +1,133 @@
+#
+# {TDiff} adds the ability to calculate the differences between two tree-like
+# objects. Simply include {TDiff} into the class which represents the tree
+# nodes and define the {#tdiff_each_child} and {#tdiff_equal} methods.
+#
+module TDiff
+  #
+  # Default method which will enumerate over every child of a parent node.
+  #
+  # @param [Object] node
+  #   The parent node.
+  #
+  # @yield [child]
+  #   The given block will be passed each child of the parent node.
+  #
+  def tdiff_each_child(node,&block)
+    node.each(&block) if node.kind_of?(Enumerable)
+  end
+
+  #
+  # Default method which compares two nodes.
+  #
+  # @param [Object] original_node
+  #   A node from the original tree.
+  #
+  # @param [Object] new_node
+  #   A node from the new tree.
+  #
+  # @return [Boolean]
+  #   Specifies whether the two nodes are equal.
+  #
+  def tdiff_equal(original_node,new_node)
+    original_node == new_node
+  end
+
+  #
+  # Finds the differences between `self` and another tree.
+  #
+  # @param [#tdiff_each_child] tree
+  #   The other tree.
+  #
+  # @yield [change, node]
+  #   The given block will be passed the added or removed nodes.
+  #
+  # @yieldparam [' ', '+', '-'] change
+  #   The state-change of the node.
+  #
+  # @yieldparam [Object] node
+  #   A node from one of the two trees.
+  #
+  # @return [Enumerator]
+  #   If no block is given, an Enumerator object will be returned.
+  #
+  def tdiff(tree,&block)
+    return enum_for(:tdiff,tree) unless block
+
+    # check if the nodes differ
+    unless tdiff_equal(self,tree)
+      yield '-', self
+      yield '+', tree
+      return self
+    end
+
+    c = Hash.new { |hash,key| hash[key] = Hash.new(0) }
+    x = enum_for(:tdiff_each_child,self)
+    y = enum_for(:tdiff_each_child,tree)
+
+    x.each_with_index do |xi,i|
+      y.each_with_index do |yi,j|
+        c[i][j] = if tdiff_equal(xi,yi)
+                    c[i-1][j-1] + 1
+                  else
+                    if c[i][j-1] > c[i-1][j]
+                      c[i][j-1]
+                    else
+                      c[i-1][j]
+                    end
+                  end
+      end
+    end
+
+    unchanged = []
+    changes = []
+
+    x_backtrack = x.each_with_index.reverse_each
+    y_backtrack = y.each_with_index.reverse_each
+
+    next_child = lambda { |children|
+      begin
+        children.next
+      rescue StopIteration
+        # end of iteration, return a -1 index
+        [nil, -1]
+      end
+    }
+
+    xi, i = next_child[x_backtrack]
+    yi, j = next_child[y_backtrack]
+
+    until (i == -1 && j == -1)
+      if (i != -1 && j != -1 && tdiff_equal(xi,yi))
+        changes.unshift [' ', xi]
+        unchanged.unshift [xi, yi]
+
+        xi, i = next_child[x_backtrack]
+        yi, j = next_child[y_backtrack]
+      else
+        if (j >= 0 && (i == -1 || c[i][j-1] >= c[i-1][j]))
+          changes.unshift ['+', yi]
+
+          yi, j = next_child[y_backtrack]
+        elsif (i >= 0 && (j == -1 || c[i][j-1] < c[i-1][j]))
+          changes.unshift ['-', xi]
+
+          xi, i = next_child[x_backtrack]
+        end
+      end
+    end
+
+    # explicitly discard the c matrix
+    c = nil
+
+    # sequentially iterate over the changed nodes
+    changes.each(&block)
+    changes = nil
+
+    # recurse down through unchanged nodes
+    unchanged.each { |x,y| x.tdiff(y,&block) }
+    unchanged = nil
+
+    return self
+  end
+end

data/spec/classes/node.rb

@@ -0,0 +1,15 @@
+require 'tdiff'
+
+class Node < Struct.new(:name, :children)
+
+  include TDiff
+
+  def tdiff_each_child(node,&block)
+    node.children.each(&block)
+  end
+
+  def tdiff_equal(node1,node2)
+    node1.name == node2.name
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+gem 'rspec', '~> 2.1.0'
+require 'rspec'

data/spec/tdiff_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+require 'classes/node'
+require 'tdiff'
+
+describe TDiff do
+  before(:all) do
+    @tree = Node.new('root', [
+      Node.new('leaf1', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ]),
+
+      Node.new('leaf2', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ])
+    ])
+
+    @different_root = Node.new('wrong', [])
+
+    @added = Node.new('root', [
+      Node.new('leaf1', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf3', []),
+        Node.new('subleaf2', [])
+      ]),
+
+      Node.new('leaf2', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ])
+    ])
+
+    @removed = Node.new('root', [
+      Node.new('leaf1', [
+        Node.new('subleaf1', [])
+      ]),
+
+      Node.new('leaf2', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ])
+    ])
+
+    @changed_order = Node.new('root', [
+      Node.new('leaf2', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ]),
+
+      Node.new('leaf1', [
+        Node.new('subleaf1', []),
+        Node.new('subleaf2', [])
+      ])
+    ])
+  end
+
+  it "should tell if two trees are identical" do
+    @tree.tdiff(@tree).all? { |change,node|
+      change == ' '
+    }.should == true
+  end
+
+  it "should stop if the root nodes have changed" do
+    changes = @tree.tdiff(@different_root).to_a
+
+    changes.length.should == 2
+
+    changes[0][0].should == '-'
+    changes[0][1].should == @tree
+
+    changes[1][0].should == '+'
+    changes[1][1].should == @different_root
+  end
+
+  it "should tell when sub-nodes are added" do
+    changes = @tree.tdiff(@added).select { |change,node| change == '+' }
+
+    changes.length.should == 1
+    changes[0][0].should == '+'
+    changes[0][1].should == @added.children[0].children[1]
+  end
+
+  it "should tell when sub-nodes are removed" do
+    changes = @tree.tdiff(@removed).select { |change,node| change == '-' }
+
+    changes.length.should == 1
+    changes[0][0].should == '-'
+    changes[0][1].should == @tree.children[0].children[1]
+  end
+
+  it "should detect when the order of children has changed" do
+    changes = @tree.tdiff(@changed_order).to_a
+
+    changes.length.should == 5
+    changes[0][0].should == '-'
+    changes[0][1].should == @tree.children[0]
+
+    changes[1][0].should == ' '
+    changes[1][1].should == @tree.children[1]
+
+    changes[2][0].should == '+'
+    changes[2][1].should == @changed_order.children[1]
+
+    changes[3][0].should == ' '
+    changes[3][1].should == @tree.children[1].children[0]
+
+    changes[4][0].should == ' '
+    changes[4][1].should == @tree.children[1].children[1]
+  end
+end

data/tdiff.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'tdiff.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore-core` to install Ore."
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: tdiff
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id003
+description: Calculates the differences between two tree-like structures. Similar to Rubys built-in TSort module.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/tdiff.rb
+- spec/classes/node.rb
+- spec/spec_helper.rb
+- spec/tdiff_spec.rb
+- tdiff.gemspec
+has_rdoc: yard
+homepage: http://github.com/postmodern/tdiff
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: tdiff
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Calculates the differences between two tree-like structures.
+test_files: 
+- spec/tdiff_spec.rb