diff-lcs 1.1.3 → 1.2.0

data/lib/diff/lcs/string.rb

@@ -1,18 +1,4 @@
-#! /usr/env/bin ruby
-#--
-# Copyright 2004 Austin Ziegler <diff-lcs@halostatue.ca>
-#   adapted from:
-#     Algorithm::Diff (Perl) by Ned Konz <perl@bike-nomad.com>
-#     Smalltalk by Mario I. Wolczko <mario@wolczko.com>
-#   implements McIlroy-Hunt diff algorithm
-#
-# This program is free software. It may be redistributed and/or modified under
-# the terms of the GPL version 2 (or later), the Perl Artistic licence, or the
-# Ruby licence.
-# 
-# $Id$
-#++
-# Includes Diff::LCS into String.
+# -*- ruby encoding: utf-8 -*-
 
 class String
   include Diff::LCS

data/spec/change_spec.rb

@@ -0,0 +1,65 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe Diff::LCS::Change do
+  describe "an add" do
+    subject { described_class.new('+', 0, 'element') }
+    it { should_not be_deleting   }
+    it { should     be_adding     }
+    it { should_not be_unchanged  }
+    it { should_not be_changed    }
+    it { should_not be_finished_a }
+    it { should_not be_finished_b }
+  end
+
+  describe "a delete" do
+    subject { described_class.new('-', 0, 'element') }
+    it { should     be_deleting   }
+    it { should_not be_adding     }
+    it { should_not be_unchanged  }
+    it { should_not be_changed    }
+    it { should_not be_finished_a }
+    it { should_not be_finished_b }
+  end
+
+  describe "an unchanged" do
+    subject { described_class.new('=', 0, 'element') }
+    it { should_not be_deleting   }
+    it { should_not be_adding     }
+    it { should     be_unchanged  }
+    it { should_not be_changed    }
+    it { should_not be_finished_a }
+    it { should_not be_finished_b }
+  end
+
+  describe "a changed" do
+    subject { described_class.new('!', 0, 'element') }
+    it { should_not be_deleting   }
+    it { should_not be_adding     }
+    it { should_not be_unchanged  }
+    it { should     be_changed    }
+    it { should_not be_finished_a }
+    it { should_not be_finished_b }
+  end
+
+  describe "a finished_a" do
+    subject { described_class.new('>', 0, 'element') }
+    it { should_not be_deleting   }
+    it { should_not be_adding     }
+    it { should_not be_unchanged  }
+    it { should_not be_changed    }
+    it { should     be_finished_a }
+    it { should_not be_finished_b }
+  end
+
+  describe "a finished_b" do
+    subject { described_class.new('<', 0, 'element') }
+    it { should_not be_deleting   }
+    it { should_not be_adding     }
+    it { should_not be_unchanged  }
+    it { should_not be_changed    }
+    it { should_not be_finished_a }
+    it { should     be_finished_b }
+  end
+end

data/spec/diff_spec.rb

@@ -30,6 +30,12 @@ describe "Diff::LCS.diff" do
     correct_diff.each { |hunk| hunk.each { |change| change[0] = '+' } }
     change_diff(correct_diff).should == diff
   end
-end
 
-# vim: ft=ruby
+  it "should return an empty diff with (hello, hello)" do
+    Diff::LCS.diff(hello, hello).should == []
+  end
+
+  it "should return an empty diff with (hello_ary, hello_ary)" do
+    Diff::LCS.diff(hello_ary, hello_ary).should == []
+  end
+end

data/spec/issues_spec.rb

@@ -0,0 +1,24 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'spec_helper'
+
+describe "Diff::LCS Issues" do
+  include Diff::LCS::SpecHelper::Matchers
+
+  it "should not fail to provide a simple patchset (issue 1)" do
+    s1, s2 = *%W(aX bXaX)
+    correct_forward_diff = [
+      [ [ '+', 0, 'b' ],
+        [ '+', 1, 'X' ] ],
+    ]
+
+    diff_s1_s2 = Diff::LCS.diff(s1, s2)
+    change_diff(correct_forward_diff).should == diff_s1_s2
+    expect do
+      Diff::LCS.patch(s1, diff_s1_s2).should == s2
+    end.to_not raise_error(RuntimeError, /provided patchset/)
+    expect do
+      Diff::LCS.patch(s2, diff_s1_s2).should == s1
+    end.to_not raise_error(RuntimeError, /provided patchset/)
+  end
+end

data/spec/lcs_spec.rb

@@ -2,11 +2,11 @@
 
 require 'spec_helper'
 
-describe "Diff::LCS.LCS and Diff::LCS.__lcs" do
+describe "Diff::LCS::Internals.lcs" do
   include Diff::LCS::SpecHelper::Matchers
 
-  it "should return the correct raw values from Diff::LCS.__lcs" do
-    res = Diff::LCS.__lcs(seq1, seq2)
+  it "should return a meaningful LCS array with (seq1, seq2)" do
+    res = Diff::LCS::Internals.lcs(seq1, seq2)
     # The result of the LCS (less the +nil+ values) must be as long as the
     # correct result.
     res.compact.size.should == correct_lcs.size
@@ -20,6 +20,18 @@ describe "Diff::LCS.LCS and Diff::LCS.__lcs" do
     x_seq2.should == correct_lcs
   end
 
+  it "should return all indexes with (hello, hello)" do
+    Diff::LCS::Internals.lcs(hello, hello).should == (0...hello.size).to_a
+  end
+
+  it "should return all indexes with (hello_ary, hello_ary)" do
+    Diff::LCS::Internals.lcs(hello_ary, hello_ary).should == (0...hello_ary.size).to_a
+  end
+end
+
+describe "Diff::LCS.LCS" do
+  include Diff::LCS::SpecHelper::Matchers
+
   it "should return the correct compacted values from Diff::LCS.LCS" do
     res = Diff::LCS.LCS(seq1, seq2)
     res.should == correct_lcs
@@ -31,6 +43,12 @@ describe "Diff::LCS.LCS and Diff::LCS.__lcs" do
     res.should == correct_lcs
     res.compact.should == res
   end
-end
 
-# vim: ft=ruby
+  it "should return %W(h e l l o) with (hello, hello)" do
+    Diff::LCS.LCS(hello, hello).should == hello.split(//)
+  end
+
+  it "should return hello_ary with (hello_ary, hello_ary)" do
+    Diff::LCS.LCS(hello_ary, hello_ary).should == hello_ary
+  end
+end

data/spec/patch_spec.rb

@@ -26,6 +26,16 @@ describe "Diff::LCS.patch" do
   end
 
   describe "using a Diff::LCS.diff patchset" do
+    describe "an empty patchset returns the source" do
+      it "works on a string (hello)" do
+        Diff::LCS::patch(hello, Diff::LCS.diff(hello, hello)).should == hello
+      end
+
+      it "works on an array %W(h e l l o)" do
+        Diff::LCS::patch(hello_ary, Diff::LCS.diff(hello_ary, hello_ary)).should == hello_ary
+      end
+    end
+
     describe "with default diff callbacks (DiffCallbacks)" do
       describe "forward (s1 -> s2)" do
         it_has_behavior "patch sequences correctly" do
@@ -90,6 +100,16 @@ describe "Diff::LCS.patch" do
   end
 
   describe "using a Diff::LCS.sdiff patchset" do
+    describe "an empty patchset returns the source" do
+      it "works on a string (hello)" do
+        Diff::LCS::patch(hello, Diff::LCS.sdiff(hello, hello)).should == hello
+      end
+
+      it "works on an array %W(h e l l o)" do
+        Diff::LCS::patch(hello_ary, Diff::LCS.sdiff(hello_ary, hello_ary)).should == hello_ary
+      end
+    end
+
     describe "with default diff callbacks (DiffCallbacks)" do
       describe "forward (s1 -> s2)" do
         it_has_behavior "patch sequences correctly" do
@@ -169,15 +189,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.diff(@s2, @s1)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -206,15 +227,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.diff(@s2, @s1, Diff::LCS::ContextDiffCallbacks)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -243,15 +265,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.diff(@s2, @s1, Diff::LCS::SDiffCallbacks)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -280,15 +303,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.sdiff(@s2, @s1)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -296,7 +320,7 @@ describe "Diff::LCS.patch" do
         Diff::LCS.patch(@s2, @patch_set_s1_s2).should == @s1
       end
 
-      it "should correctly patch left-to-right (explicit patch)" do
+      it "should correctly patch left-to-right (explicit patch)", :only => true do
         Diff::LCS.patch(@s1, @patch_set_s1_s2, :patch).should == @s2
         Diff::LCS.patch(@s2, @patch_set_s2_s1, :patch).should == @s1
         Diff::LCS.patch!(@s1, @patch_set_s1_s2).should == @s2
@@ -317,15 +341,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.sdiff(@s2, @s1, Diff::LCS::ContextDiffCallbacks)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -354,15 +379,16 @@ describe "Diff::LCS.patch" do
         @patch_set_s2_s1 = Diff::LCS.sdiff(@s2, @s1, Diff::LCS::DiffCallbacks)
       end
 
-      it "does not autodiscover s1 to s2 patches" do
-        # It should, but it doesn't.
+      it "should autodiscover s1 to s2 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s1_s2).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
+      end
 
+      it "should autodiscover s2 to s1 patches" do
         expect do
           Diff::LCS.patch(@s1, @patch_set_s2_s1).should == @s2
-        end.to raise_error(RuntimeError, /provided patchset/)
+        end.to_not raise_error(RuntimeError, /provided patchset/)
       end
 
       it "should autodiscover s2 to s1 the left-to-right patches" do
@@ -386,5 +412,3 @@ describe "Diff::LCS.patch" do
     end
   end
 end
-
-# vim: ft=ruby

data/spec/sdiff_spec.rb

@@ -200,5 +200,3 @@ describe "Diff::LCS.sdiff" do
     it_has_behavior "compare sequences correctly"
   end
 end
-
-# vim: ft=ruby

data/spec/spec_helper.rb

@@ -12,6 +12,14 @@ $:.unshift parent.join('lib')
 require 'diff-lcs'
 
 module Diff::LCS::SpecHelper
+  def hello
+    "hello"
+  end
+
+  def hello_ary
+    %W(h e l l o)
+  end
+
   def seq1
     %w(a b c e h j l m n p)
   end
@@ -159,7 +167,6 @@ module Diff::LCS::SpecHelper
     new_result
   end
 
-
   def simple_callback
     callbacks = Object.new
     class << callbacks
@@ -279,6 +286,5 @@ end
 RSpec.configure do |conf|
   conf.include Diff::LCS::SpecHelper
   conf.alias_it_should_behave_like_to :it_has_behavior, 'has behavior:'
+  conf.filter_run_excluding :broken => true
 end
-
-# vim: ft=ruby

data/spec/traverse_balanced_spec.rb

@@ -29,6 +29,32 @@ describe "Diff::LCS.traverse_balanced" do
     end
   end
 
+  describe "identical string sequences ('abc')" do
+    s1 = s2 = "abc"
+
+    result = [
+      [ '=', 0, 0 ],
+      [ '=', 1, 1 ],
+      [ '=', 2, 2 ]
+    ]
+
+    it_has_behavior "with a #change callback", s1, s2, result
+    it_has_behavior "without a #change callback", s1, s2, result
+  end
+
+  describe "identical array sequences %w(a b c)" do
+    s1 = s2 = %w(a b c)
+
+    result = [
+      [ '=', 0, 0 ],
+      [ '=', 1, 1 ],
+      [ '=', 2, 2 ]
+    ]
+
+    it_has_behavior "with a #change callback", s1, s2, result
+    it_has_behavior "without a #change callback", s1, s2, result
+  end
+
   describe "sequences %w(a b c) & %w(a x c)" do
     s1 = %w(a b c)
     s2 = %w(a x c)
@@ -282,5 +308,3 @@ describe "Diff::LCS.traverse_balanced" do
     it_has_behavior "without a #change callback", s1, s2, result
   end
 end
-
-# vim: ft=ruby

data/spec/traverse_sequences_spec.rb

@@ -4,39 +4,97 @@ require 'spec_helper'
 
 describe "Diff::LCS.traverse_sequences" do
   describe "callback with no finishers" do
-    before(:each) do
-      @callback_s1_s2 = simple_callback_no_finishers
-      Diff::LCS.traverse_sequences(seq1, seq2, @callback_s1_s2)
-
-      @callback_s2_s1 = simple_callback_no_finishers
-      Diff::LCS.traverse_sequences(seq2, seq1, @callback_s2_s1)
+    describe "over (seq1, seq2)" do
+      before(:each) do
+        @callback_s1_s2 = simple_callback_no_finishers
+        Diff::LCS.traverse_sequences(seq1, seq2, @callback_s1_s2)
+
+        @callback_s2_s1 = simple_callback_no_finishers
+        Diff::LCS.traverse_sequences(seq2, seq1, @callback_s2_s1)
+      end
+
+      it "should have the correct LCS result on left-matches" do
+        @callback_s1_s2.matched_a.should == correct_lcs
+        @callback_s2_s1.matched_a.should == correct_lcs
+      end
+
+      it "should have the correct LCS result on right-matches" do
+        @callback_s1_s2.matched_b.should == correct_lcs
+        @callback_s2_s1.matched_b.should == correct_lcs
+      end
+
+      it "should have the correct skipped sequences with the left sequence" do
+        @callback_s1_s2.discards_a.should == skipped_seq1
+        @callback_s2_s1.discards_a.should == skipped_seq2
+      end
+
+      it "should have the correct skipped sequences with the right sequence" do
+        @callback_s1_s2.discards_b.should == skipped_seq2
+        @callback_s2_s1.discards_b.should == skipped_seq1
+      end
+
+      it "should not have anything done markers from the left or right sequences" do
+        @callback_s1_s2.done_a.should be_empty
+        @callback_s1_s2.done_b.should be_empty
+        @callback_s2_s1.done_a.should be_empty
+        @callback_s2_s1.done_b.should be_empty
+      end
     end
 
-    it "should have the correct LCS result on left-matches" do
-      @callback_s1_s2.matched_a.should == correct_lcs
-      @callback_s2_s1.matched_a.should == correct_lcs
-    end
+    describe "over (hello, hello)" do
+      before(:each) do
+        @callback = simple_callback_no_finishers
+        Diff::LCS.traverse_sequences(hello, hello, @callback)
+      end
 
-    it "should have the correct LCS result on right-matches" do
-      @callback_s1_s2.matched_b.should == correct_lcs
-      @callback_s2_s1.matched_b.should == correct_lcs
-    end
+      it "should have the correct LCS result on left-matches" do
+        @callback.matched_a.should == hello.split(//)
+      end
 
-    it "should have the correct skipped sequences for the left sequence" do
-      @callback_s1_s2.discards_a.should == skipped_seq1
-      @callback_s2_s1.discards_a.should == skipped_seq2
-    end
+      it "should have the correct LCS result on right-matches" do
+        @callback.matched_b.should == hello.split(//)
+      end
 
-    it "should have the correct skipped sequences for the right sequence" do
-      @callback_s1_s2.discards_b.should == skipped_seq2
-      @callback_s2_s1.discards_b.should == skipped_seq1
+      it "should have the correct skipped sequences with the left sequence", :only => true do
+        @callback.discards_a.should be_empty
+      end
+
+      it "should have the correct skipped sequences with the right sequence" do
+        @callback.discards_b.should be_empty
+      end
+
+      it "should not have anything done markers from the left or right sequences" do
+        @callback.done_a.should be_empty
+        @callback.done_b.should be_empty
+      end
     end
 
-    it "should not have anything done markers from the left or right sequences" do
-      @callback_s1_s2.done_a.should be_empty
-      @callback_s1_s2.done_b.should be_empty
-      @callback_s2_s1.done_a.should be_empty
-      @callback_s2_s1.done_b.should be_empty
+    describe "over (hello_ary, hello_ary)" do
+      before(:each) do
+        @callback = simple_callback_no_finishers
+        Diff::LCS.traverse_sequences(hello_ary, hello_ary, @callback)
+      end
+
+      it "should have the correct LCS result on left-matches" do
+        @callback.matched_a.should == hello_ary
+      end
+
+      it "should have the correct LCS result on right-matches" do
+        @callback.matched_b.should == hello_ary
+      end
+
+      it "should have the correct skipped sequences with the left sequence" do
+        @callback.discards_a.should be_empty
+      end
+
+      it "should have the correct skipped sequences with the right sequence" do
+        @callback.discards_b.should be_empty
+      end
+
+      it "should not have anything done markers from the left or right sequences" do
+        @callback.done_a.should be_empty
+        @callback.done_b.should be_empty
+      end
     end
   end
 
@@ -79,5 +137,3 @@ describe "Diff::LCS.traverse_sequences" do
     end
   end
 end
-
-# vim: ft=ruby