tdiff 0.3.1 → 0.3.2

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.3.2 / 2010-11-28
+
+* Added {TDiff#tdiff_recursive} to only handle recursively traversing
+  and diffing the children nodes.
+* Added {TDiff::Unordered#tdiff_recursive_unordered} to only handle
+  recursively traversing and diffing the children nodes, without respecting
+  the order of the nodes.
+
 ### 0.3.1 / 2010-11-28
 
 * Fixed a typo in {TDiff::Unordered#tdiff_unordered}, which was causing

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: tdiff
-version: 0.3.1
+version: 0.3.2
 summary: Calculates the differences between two tree-like structures.
 description:
   Calculates the differences between two tree-like structures. Similar to

data/lib/tdiff/tdiff.rb

@@ -58,6 +58,32 @@ module TDiff
       return self
     end
 
+    yield ' ', self
+
+    tdiff_recursive(tree,&block)
+    return self
+  end
+
+  protected
+
+  #
+  # Recursively compares the differences between the children nodes.
+  #
+  # @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.
+  #
+  # @since 0.3.2
+  #
+  def tdiff_recursive(tree,&block)
     c = Hash.new { |hash,key| hash[key] = Hash.new(0) }
     x = enum_for(:tdiff_each_child,self)
     y = enum_for(:tdiff_each_child,tree)
@@ -122,9 +148,7 @@ module TDiff
     changes = nil
 
     # recurse down through unchanged nodes
-    unchanged.each { |x,y| x.tdiff(y,&block) }
+    unchanged.each { |x,y| x.tdiff_recursive(y,&block) }
     unchanged = nil
-
-    return self
   end
 end

data/lib/tdiff/unordered.rb

@@ -15,7 +15,7 @@ module TDiff
 
     #
     # Finds the differences between `self` and another tree, not respecting
-    # the ordering of children.
+    # the order of the nodes.
     #
     # @param [#tdiff_each_child] tree
     #   The other tree.
@@ -44,6 +44,33 @@ module TDiff
         return self
       end
 
+      yield ' ', self
+
+      tdiff_recursive_unordered(tree,&block)
+      return self
+    end
+
+    protected
+
+    #
+    # Recursively compares the differences between the children nodes,
+    # without respecting the order of the nodes.
+    #
+    # @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.
+    #
+    # @since 0.3.2
+    #
+    def tdiff_recursive_unordered(tree,&block)
       x = enum_for(:tdiff_each_child,self)
       y = enum_for(:tdiff_each_child,tree)
 
@@ -79,10 +106,11 @@ module TDiff
       changes = nil
 
       # recurse down the unchanged nodes
-      unchanged.each { |xi,yj| xi.tdiff_unordered(yj,&block) }
-      unchanged = nil
+      unchanged.each do |xi,yj|
+        xi.tdiff_recursive_unordered(yj,&block)
+      end
 
-      return self
+      unchanged = nil
     end
   end
 end

data/spec/tdiff_examples.rb

@@ -23,7 +23,7 @@ shared_examples_for 'TDiff' do |method|
   end
 
   it "should tell when sub-nodes are added" do
-    changes = @tree.tdiff(@added).select { |change,node| change == '+' }
+    changes = @tree.send(method,@added).select { |change,node| change == '+' }
 
     changes.length.should == 1
     changes[0][0].should == '+'
@@ -31,7 +31,7 @@ shared_examples_for 'TDiff' do |method|
   end
 
   it "should tell when sub-nodes are removed" do
-    changes = @tree.tdiff(@removed).select { |change,node| change == '-' }
+    changes = @tree.send(method,@removed).select { |change,node| change == '-' }
 
     changes.length.should == 1
     changes[0][0].should == '-'

data/spec/tdiff_spec.rb

@@ -11,20 +11,24 @@ describe TDiff do
   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.length.should == 6
 
-    changes[1][0].should == ' '
-    changes[1][1].should == @tree.children[1]
+    changes[0][0].should == ' '
+    changes[0][1].should == @tree
 
-    changes[2][0].should == '+'
-    changes[2][1].should == @changed_order.children[1]
+    changes[1][0].should == '-'
+    changes[1][1].should == @tree.children[0]
 
-    changes[3][0].should == ' '
-    changes[3][1].should == @tree.children[1].children[0]
+    changes[2][0].should == ' '
+    changes[2][1].should == @tree.children[1]
+
+    changes[3][0].should == '+'
+    changes[3][1].should == @changed_order.children[1]
 
     changes[4][0].should == ' '
-    changes[4][1].should == @tree.children[1].children[1]
+    changes[4][1].should == @tree.children[1].children[0]
+
+    changes[5][0].should == ' '
+    changes[5][1].should == @tree.children[1].children[1]
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Postmodern