diff-lcs 1.2.1 → 1.2.2

data/.travis.yml

@@ -6,8 +6,9 @@ before_script:
 - rake travis:before -t
 language: ruby
 notifications:
-  email: false
+  email: true
 rvm:
+  - 2.0.0
   - 1.9.3
   - 1.9.2
   - ruby-head

data/Contributing.rdoc

@@ -61,3 +61,4 @@ Thanks to everyone else who has contributed to Diff::LCS:
 * Kenichi Kamiya
 * Michael Granger
 * Vít Ondruch
+* Jon Rowe

data/History.rdoc

@@ -1,3 +1,17 @@
+== 1.2.2 / 2013-03-30
+
+* Bugs Fixed:
+  * Diff::LCS::Hunk could not properly generate a difference for comparison
+    sets that are not US-ASCII-compatible because of the use of literal regular
+    expressions and strings. Jon Rowe (JonRowe) found this in
+    rspec/rspec-expectations#219 and provided a first pass implementation in
+    diff-lcs#15. I've reworked it because of test failures in Rubinius when
+    running in Ruby 1.9 mode. This coerces the added values to the encoding of
+    the old dataset (as determined by the first piece of the old dataset).
+    https://github.com/rspec/rspec-expectations/issues/219
+    https://github.com/halostatue/diff-lcs/pull/15
+* Adding Travis CI testing for Ruby 2.0.
+
 == 1.2.1 / 2013-02-09
 
 * Bugs Fixed:

data/Manifest.txt

@@ -29,6 +29,7 @@ lib/diff/lcs/ldiff.rb
 lib/diff/lcs/string.rb
 spec/change_spec.rb
 spec/diff_spec.rb
+spec/hunk_spec.rb
 spec/issues_spec.rb
 spec/lcs_spec.rb
 spec/patch_spec.rb

data/README.rdoc

@@ -11,9 +11,9 @@ Diff::LCS computes the difference between two Enumerable sequences using the
 McIlroy-Hunt longest common subsequence (LCS) algorithm. It includes utilities
 to create a simple HTML diff output format and a standard diff-like tool.
 
-This is release 1.2.1, restoring the public API to what existed in Diff::LCS
-1.1.x. Everyone is strongly encouraged to upgrade to this version as it fixes
-all known outstanding issues.
+This is release 1.2.2, fixing a bug that prevented comparison of values that
+are not US-ASCII-compatible. Thanks to Jon Rowe for finding and providing most
+of the work behind this issue. This is a recommended release.
 
 == Synopsis
 

data/lib/diff/lcs.rb

@@ -1,7 +1,7 @@
 # -*- ruby encoding: utf-8 -*-
 
 module Diff; end unless defined? Diff
-# = Diff::LCS 1.2.1
+# = Diff::LCS 1.2.2
 #
 # Computes "intelligent" differences between two sequenced Enumerables. This
 # is an implementation of the McIlroy-Hunt "diff" algorithm for Enumerable
@@ -129,7 +129,7 @@ module Diff; end unless defined? Diff
 # Common Subsequences</em>, CACM, vol.20, no.5, pp.350-353, May
 # 1977, with a few minor improvements to improve the speed."
 module Diff::LCS
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end
 
 require 'diff/lcs/callbacks'

data/lib/diff/lcs/hunk.rb

@@ -11,6 +11,9 @@ class Diff::LCS::Hunk
   def initialize(data_old, data_new, piece, flag_context, file_length_difference)
     # At first, a hunk will have just one Block in it
     @blocks = [ Diff::LCS::Block.new(piece) ]
+    if String.method_defined?(:encoding)
+      @preferred_data_encoding = data_old[0].encoding
+    end
     @data_old = data_old
     @data_new = data_new
 
@@ -120,19 +123,19 @@ class Diff::LCS::Hunk
     # Calculate item number range. Old diff range is just like a context
     # diff range, except the ranges are on one line with the action between
     # them.
-    s = "#{context_range(:old)}#{op_act[block.op]}#{context_range(:new)}\n"
+    s = encode("#{context_range(:old)}#{op_act[block.op]}#{context_range(:new)}\n")
     # If removing anything, just print out all the remove lines in the hunk
     # which is just all the remove lines in the block.
-    @data_old[@start_old .. @end_old].each { |e| s << "< #{e}\n" } unless block.remove.empty?
-    s << "---\n" if block.op == "!"
-    @data_new[@start_new .. @end_new].each { |e| s << "> #{e}\n" } unless block.insert.empty?
+    @data_old[@start_old .. @end_old].each { |e| s << encode("< ") + e + encode("\n") } unless block.remove.empty?
+    s << encode("---\n") if block.op == "!"
+    @data_new[@start_new .. @end_new].each { |e| s << encode("> ") + e + encode("\n") } unless block.insert.empty?
     s
   end
   private :old_diff
 
   def unified_diff
     # Calculate item number range.
-    s = "@@ -#{unified_range(:old)} +#{unified_range(:new)} @@\n"
+    s = encode("@@ -#{unified_range(:old)} +#{unified_range(:new)} @@\n")
 
     # Outlist starts containing the hunk of the old file. Removing an item
     # just means putting a '-' in front of it. Inserting an item requires
@@ -145,30 +148,30 @@ class Diff::LCS::Hunk
     # file -- don't take removed items into account.
     lo, hi, num_added, num_removed = @start_old, @end_old, 0, 0
 
-    outlist = @data_old[lo .. hi].collect { |e| e.gsub(/^/, ' ') }
+    outlist = @data_old[lo .. hi].map { |e| e.insert(0, encode(' ')) }
 
     @blocks.each do |block|
       block.remove.each do |item|
-        op = item.action.to_s # -
+        op     = item.action.to_s # -
         offset = item.position - lo + num_added
-        outlist[offset].gsub!(/^ /, op.to_s)
+        outlist[offset][0, 1] = encode(op)
         num_removed += 1
       end
       block.insert.each do |item|
-        op = item.action.to_s # +
+        op     = item.action.to_s # +
         offset = item.position - @start_new + num_removed
-        outlist[offset, 0] = "#{op}#{@data_new[item.position]}"
+        outlist[offset, 0] = encode(op) + @data_new[item.position]
         num_added += 1
       end
     end
 
-    s << outlist.join("\n")
+    s << outlist.join(encode("\n"))
   end
   private :unified_diff
 
   def context_diff
-    s = "***************\n"
-    s << "*** #{context_range(:old)} ****\n"
+    s = encode("***************\n")
+    s << encode("*** #{context_range(:old)} ****\n")
     r = context_range(:new)
 
     # Print out file 1 part for each block in context diff format if there
@@ -176,23 +179,24 @@ class Diff::LCS::Hunk
     lo, hi = @start_old, @end_old
     removes = @blocks.select { |e| not e.remove.empty? }
     if removes
-      outlist = @data_old[lo .. hi].collect { |e| e.gsub(/^/, '  ') }
+      outlist = @data_old[lo .. hi].map { |e| e.insert(0, encode(' ')) }
+
       removes.each do |block|
         block.remove.each do |item|
-          outlist[item.position - lo].gsub!(/^ /) { block.op } # - or !
+          outlist[item.position - lo][0, 1] = encode(block.op) # - or !
         end
       end
       s << outlist.join("\n")
     end
 
-    s << "\n--- #{r} ----\n"
+    s << encode("\n--- #{r} ----\n")
     lo, hi = @start_new, @end_new
     inserts = @blocks.select { |e| not e.insert.empty? }
     if inserts
-      outlist = @data_new[lo .. hi].collect { |e| e.gsub(/^/, '  ') }
+      outlist = @data_new[lo .. hi].collect { |e| e.insert(0, encode(' ')) }
       inserts.each do |block|
         block.insert.each do |item|
-          outlist[item.position - lo].gsub!(/^ /) { block.op } # + or !
+          outlist[item.position - lo][0, 1] = encode(block.op) # + or !
         end
       end
       s << outlist.join("\n")
@@ -206,14 +210,14 @@ class Diff::LCS::Hunk
     warn "Expecting only one block in an old diff hunk!" if @blocks.size > 1
 
     if format == :reverse_ed
-      s = "#{op_act[@blocks[0].op]}#{context_range(:old)}\n"
+      s = encode("#{op_act[@blocks[0].op]}#{context_range(:old)}\n")
     else
-      s = "#{context_range(:old).gsub(/,/, ' ')}#{op_act[@blocks[0].op]}\n"
+      s = encode("#{context_range(:old, ' ')}#{op_act[@blocks[0].op]}\n")
     end
 
     unless @blocks[0].insert.empty?
-      @data_new[@start_new .. @end_new].each { |e| s << "#{e}\n" }
-      s << ".\n"
+      @data_new[@start_new .. @end_new].each { |e| s << e + encode("\n") }
+      s << encode(".\n")
     end
     s
   end
@@ -221,7 +225,7 @@ class Diff::LCS::Hunk
 
   # Generate a range of item numbers to print. Only print 1 number if the
   # range has only one item in it. Otherwise, it's 'start,end'
-  def context_range(mode)
+  def context_range(mode, op = ',')
     case mode
     when :old
       s, e = (@start_old + 1), (@end_old + 1)
@@ -229,7 +233,7 @@ class Diff::LCS::Hunk
       s, e = (@start_new + 1), (@end_new + 1)
     end
 
-    (s < e) ? "#{s},#{e}" : "#{e}"
+    (s < e) ? "#{s}#{op}#{e}" : "#{e}"
   end
   private :context_range
 
@@ -249,4 +253,24 @@ class Diff::LCS::Hunk
     (length == 1) ? "#{first}" : "#{first},#{length}"
   end
   private :unified_range
+
+  if String.method_defined?(:encoding)
+    def encode(literal, target_encoding = @preferred_data_encoding)
+      literal.encode target_encoding
+    end
+
+    def encode_as(string, *args)
+      args.map { |arg| arg.encode(string.encoding) }
+    end
+  else
+    def encode(literal, target_encoding = nil)
+      literal
+    end
+    def encode_as(string, *args)
+      args
+    end
+  end
+
+  private :encode
+  private :encode_as
 end

data/spec/hunk_spec.rb

@@ -0,0 +1,63 @@
+# -*- ruby encoding: utf-8 -*-
+
+require 'spec_helper'
+
+def h(v)
+  v.to_s.bytes.to_a.map { |e| "%02x" % e }.join
+end
+
+describe "Diff::LCS::Hunk" do
+  if String.method_defined?(:encoding)
+
+    let(:old_data) { ["Tu avec carté {count} itém has".encode('UTF-16LE')] }
+    let(:new_data) { ["Tu avec carte {count} item has".encode('UTF-16LE')] }
+    let(:pieces)   { Diff::LCS.diff old_data, new_data }
+    let(:hunk)     { Diff::LCS::Hunk.new(old_data, new_data, pieces[0], 3, 0) }
+
+    it 'should be able to produce a unified diff from the two pieces' do
+      expected =
+(<<-EOD.encode('UTF-16LE').chomp)
+@@ -1,2 +1,2 @@
+-Tu avec carté {count} itém has
++Tu avec carte {count} item has
+EOD
+      expect(hunk.diff(:unified).to_s == expected).to eql true
+    end
+
+    it 'should be able to produce a context diff from the two pieces' do
+      expected =
+(<<-EOD.encode('UTF-16LE').chomp)
+***************
+*** 1,2 ****
+!Tu avec carté {count} itém has
+--- 1,2 ----
+!Tu avec carte {count} item has
+EOD
+
+      expect(hunk.diff(:context).to_s == expected).to eql true
+    end
+
+    it 'should be able to produce an old diff from the two pieces' do
+      expected =
+(<<-EOD.encode('UTF-16LE').chomp)
+1,2c1,2
+< Tu avec carté {count} itém has
+---
+> Tu avec carte {count} item has
+
+EOD
+      expect(hunk.diff(:old).to_s == expected).to eql true
+    end
+
+    it 'should be able to produce a reverse ed diff from the two pieces' do
+      expected =
+(<<-EOD.encode('UTF-16LE').chomp)
+c1,2
+Tu avec carte {count} item has
+.
+
+EOD
+      expect(hunk.diff(:reverse_ed).to_s == expected).to eql true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diff-lcs
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2013-02-09 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyforge
@@ -236,11 +236,11 @@ description: ! 'Diff::LCS computes the difference between two Enumerable sequenc
   to create a simple HTML diff output format and a standard diff-like tool.
 
 
-  This is release 1.2.1, restoring the public API to what existed in Diff::LCS
+  This is release 1.2.2, fixing a bug that prevented comparison of values that
 
-  1.1.x. Everyone is strongly encouraged to upgrade to this version as it fixes
+  are not US-ASCII-compatible. Thanks to Jon Rowe for finding and providing most
 
-  all known outstanding issues.'
+  of the work behind this issue. This is a recommended release.'
 email:
 - austin@rubyforge.org
 executables:
@@ -287,6 +287,7 @@ files:
 - lib/diff/lcs/string.rb
 - spec/change_spec.rb
 - spec/diff_spec.rb
+- spec/hunk_spec.rb
 - spec/issues_spec.rb
 - spec/lcs_spec.rb
 - spec/patch_spec.rb