diff-lcs 1.1.2 → 1.1.3

data/{ChangeLog → History.rdoc}

@@ -1,11 +1,19 @@
-Revision history for Ruby library Diff::LCS. Unless explicitly noted otherwise,
-all changes are produced by Austin Ziegler <diff-lcs@halostatue.ca>.
-
-== Diff::LCS 1.1.2
-* Fixed a problem reported by Mauricio Fernandez in htmldiff. Future versions
-  of Diff::LCS will be removing this program.
-
-== Diff::LCS 1.1.1
+== 1.1.3 / 2011-08-27
+* Converted to 'hoe' for release.
+* Converted tests to RSpec 2.
+* Extracted the body of htmldiff into a class available from
+  diff/lcs/htmldiff.
+* Migrated development and issue tracking to GitHub.
+* Bugs fixed:
+  - Eliminated the explicit use of RubyGems in both bin/htmldiff and bin/ldiff.
+    Resolves issue 4 (https://github.com/halostatue/diff-lcs/issues/4).
+  - Eliminated Ruby warnings. Resolves issue 3
+    (https://github.com/halostatue/diff-lcs/issues/3).
+
+== 1.1.2 / 2004-10-20
+* Fixed a problem reported by Mauricio Fernandez in htmldiff.
+
+== 1.1.1 / 2004-09-25
 * Fixed bug #891:
   http://rubyforge.org/tracker/?func=detail&atid=407&aid=891&group_id=84
 * Fixed a problem with callback initialisation code (it assumed that all
@@ -14,33 +22,33 @@ all changes are produced by Austin Ziegler <diff-lcs@halostatue.ca>.
 * Modified the non-initialisable callbacks to have a private #new method.
 * Moved ldiff core code to Diff::LCS::Ldiff (diff/lcs/ldiff.rb).
 
-== Diff::LCS 1.1.0
+== 1.1.0 / -
 * Eliminated the need for Diff::LCS::Event and removed it.
 * Added a contextual diff callback, Diff::LCS::ContextDiffCallback.
 * Implemented patching/unpatching for standard Diff callback output formats
   with both #diff and #sdiff.
 * Extensive documentation changes.
 
-== Diff::LCS 1.0.4
+== 1.0.4 / -
 * Fixed a problem with bin/ldiff output, especially for unified format.
   Newlines that should have been present weren't.
 * Changed the .tar.gz installer to generate Windows batch files if ones do not
   exist already. Removed the existing batch files as they didn't work.
 
-== Diff::LCS 1.0.3
+== 1.0.3 / -
 * Fixed a problem with #traverse_sequences where the first difference from the
   left sequence might not be appropriately captured.
 
-== Diff::LCS 1.0.2
+== 1.0.2 / -
 * Fixed an issue with ldiff not working because actions were changed from
   symbols to strings.
 
-== Diff::LCS 1.0.1
+== 1.0.1 / -
 * Minor modifications to the gemspec, the README.
 * Renamed the diff program to ldiff (as well as the companion batch file) so as
   to not collide with the standard diff program.
-* Fixed issues with RubyGEMs. Requires RubyGems > 0.6.1 or >= 0.6.1 with the
+* Fixed issues with RubyGems. Requires RubyGems > 0.6.1 or >= 0.6.1 with the
   latest CVS version.
 
-== Diff::LCS 1.0
+== 1.0 / -
 * Initial release based mostly on Perl's Algorithm::Diff.

data/License.rdoc

@@ -0,0 +1,38 @@
+== License
+
+This software is available under three licenses: the GNU GPL version 2 (or at
+your option, a later version), the Perl Artistic license, or the MIT license.
+Note that my preference for licensing is the MIT license, but Algorithm::Diff
+was dually originally licensed with the Perl Artistic and the GNU GPL ("the
+same terms as Perl itself") and that the Ruby implementation hews pretty
+closely to the Perl version, so I must maintain the additional licensing terms.
+
+* Copyright 2004–2011 Austin Ziegler.
+* Adapted from Algorithm::Diff (Perl) by Ned Konz and a Smalltalk versionby
+  Mario I. Wolczko <mario@wolczko.com>
+
+=== MIT License
+
+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.
+
+=== Perl Artistic License (version 2)
+See the file docs/artistic.txt in the main distribution.
+
+=== GNU GPL version 2
+See the file docs/COPYING.txt in the main distribution.

data/Manifest.txt

@@ -0,0 +1,27 @@
+History.rdoc
+License.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/htmldiff
+bin/ldiff
+diff-lcs.gemspec
+docs/COPYING.txt
+docs/artistic.html
+lib/diff-lcs.rb
+lib/diff/lcs.rb
+lib/diff/lcs/array.rb
+lib/diff/lcs/block.rb
+lib/diff/lcs/callbacks.rb
+lib/diff/lcs/change.rb
+lib/diff/lcs/htmldiff.rb
+lib/diff/lcs/hunk.rb
+lib/diff/lcs/ldiff.rb
+lib/diff/lcs/string.rb
+spec/diff_spec.rb
+spec/lcs_spec.rb
+spec/patch_spec.rb
+spec/sdiff_spec.rb
+spec/spec_helper.rb
+spec/traverse_balanced_spec.rb
+spec/traverse_sequences_spec.rb

data/README.rdoc

@@ -0,0 +1,72 @@
+= diff-lcs
+
+== Description
+Diff::LCS is a port of Perl's Algorithm::Diff that uses the McIlroy-Hunt
+longest common subsequence (LCS) algorithm to compute intelligent differences
+between two sequenced enumerable containers. The implementation is based on
+Mario I. Wolczko's {Smalltalk version 1.2}[ftp://st.cs.uiuc.edu/pub/Smalltalk/MANCHESTER/manchester/4.0/diff.st]
+(1993) and Ned Konz's Perl version
+{Algorithm::Diff 1.15}[http://search.cpan.org/~nedkonz/Algorithm-Diff-1.15/].
+
+This is release 1.1.3, fixing several small bugs found over the years. Version
+1.1.0 added new features, including the ability to #patch and #unpatch changes
+as well as a new contextual diff callback, Diff::LCS::ContextDiffCallbacks,
+that should improve the context sensitivity of patching.
+
+This library is called Diff::LCS because of an early version of Algorithm::Diff
+which was restrictively licensed. This version has seen a minor license change:
+instead of being under Ruby's license as an option, the third optional license
+is the MIT license.
+
+== Where
+
+* {GitHub}[https://github.com/halostatue/diff-lcs]
+
+This is the new home of Diff::LCS (diff-lcs). The Ruwiki page still refers to
+it, but development is not happening there any longer.
+
+== Synopsis
+
+Using this module is quite simple. By default, Diff::LCS does not extend
+objects with the Diff::LCS interface, but will be called as if it were a
+function:
+
+  require 'diff/lcs'
+
+  seq1 = %w(a b c e h j l m n p)
+  seq2 = %w(b c d e f j k l m r s t)
+
+  lcs = Diff::LCS.LCS(seq1, seq2)
+  diffs = Diff::LCS.diff(seq1, seq2)
+  sdiff = Diff::LCS.sdiff(seq1, seq2)
+  seq = Diff::LCS.traverse_sequences(seq1, seq2, callback_obj)
+  bal = Diff::LCS.traverse_balanced(seq1, seq2, callback_obj)
+  seq2 == Diff::LCS.patch!(seq1, diffs)
+  seq1 == Diff::LCS.unpatch!(seq2, diffs)
+  seq2 == Diff::LCS.patch!(seq1, sdiff)
+  seq1 == Diff::LCS.unpatch!(seq2, sdiff)
+
+Objects can be extended with Diff::LCS:
+
+  seq1.extend(Diff::LCS)
+  lcs = seq1.lcs(seq2)
+  diffs = seq1.diff(seq2)
+  sdiff = seq1.sdiff(seq2)
+  seq = seq1.traverse_sequences(seq2, callback_obj)
+  bal = seq1.traverse_balanced(seq2, callback_obj)
+  seq2 == seq1.patch!(diffs)
+  seq1 == seq2.unpatch!(diffs)
+  seq2 == seq1.patch!(sdiff)
+  seq1 == seq2.unpatch!(sdiff)
+
+By requiring 'diff/lcs/array' or 'diff/lcs/string', Array or String will be
+extended for use this way.
+
+Note that Diff::LCS requires a sequenced enumerable container, which means that
+the order of enumeration is both predictable and consistent for the same set of
+data. While it is theoretically possible to generate a diff for unordereded
+hash, it will only be meaningful if the enumeration of the hashes is
+consistent. In general, this will mean that containers that behave like String
+or Array will perform best.
+
+:include: License.rdoc

data/Rakefile

@@ -1,116 +1,26 @@
-#! /usr/bin/env rake
-$LOAD_PATH.unshift('lib')
+# -*- ruby encoding: utf-8 -*-
 
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
-require 'diff/lcs'
-require 'archive/tar/minitar'
-require 'zlib'
+require 'rspec'
+require 'hoe'
 
-DISTDIR = "diff-lcs-#{Diff::LCS::VERSION}"
-TARDIST = "../#{DISTDIR}.tar.gz"
+Hoe.plugin :doofus
+Hoe.plugin :gemspec
+Hoe.plugin :git
 
-DATE_RE = %r<(\d{4})[./-]?(\d{2})[./-]?(\d{2})(?:[\sT]?(\d{2})[:.]?(\d{2})[:.]?(\d{2})?)?>
+Hoe.spec 'diff-lcs' do
+  self.rubyforge_name = 'ruwiki'
 
-if ENV['RELEASE_DATE']
-  year, month, day, hour, minute, second = DATE_RE.match(ENV['RELEASE_DATE']).captures
-  year ||= 0
-  month ||= 0
-  day ||= 0
-  hour ||= 0
-  minute ||= 0
-  second ||= 0
-  ReleaseDate = Time.mktime(year, month, day, hour, minute, second)
-else
-  ReleaseDate = nil
-end
-
-task :test do |t|
-  require 'test/unit/testsuite'
-  require 'test/unit/ui/console/testrunner'
-
-  runner = Test::Unit::UI::Console::TestRunner
-
-  $LOAD_PATH.unshift('tests')
-  $stderr.puts "Checking for test cases:" if t.verbose
-  Dir['tests/*test*.rb'].each do |testcase|
-    $stderr.puts "\t#{testcase}" if t.verbose
-    load testcase
-  end
-
-  suite = Test::Unit::TestSuite.new
-
-  ObjectSpace.each_object(Class) do |testcase|
-    suite << testcase.suite if testcase < Test::Unit::TestCase
-  end
-
-  runner.run(suite)
-end
+  developer('Austin Ziegler', 'austin@rubyforge.org')
 
-spec = eval(File.read("diff-lcs.gemspec"))
-desc "Build the RubyGem for Diff::LCS."
-task :gem => [ :test ]
-Rake::GemPackageTask.new(spec) do |g|
-  g.need_tar    = false
-  g.need_zip    = false
-  g.package_dir = ".."
-end
-
-desc "Build an Diff::LCS .tar.gz distribution."
-task :tar => [ TARDIST ]
-file TARDIST => [ :test ] do |t|
-  current = File.basename(Dir.pwd)
-  Dir.chdir("..") do
-    begin
-      files = Dir["#{current}/**/*"].select { |dd| dd !~ %r{(?:/CVS/?|~$)} }
-      files.map! do |dd|
-        ddnew = dd.gsub(/^#{current}/, DISTDIR)
-        mtime = ReleaseDate || File.stat(dd).mtime
-        if File.directory?(dd)
-          { :name => ddnew, :mode => 0755, :dir => true, :mtime => mtime }
-        else
-          if dd =~ %r{bin/}
-            mode = 0755
-          else
-            mode = 0644
-          end
-          data = File.read(dd)
-          { :name => ddnew, :mode => mode, :data => data, :size => data.size,
-            :mtime => mtime }
-        end
-      end
-
-      ff = File.open(t.name.gsub(%r{^\.\./}o, ''), "wb")
-      gz = Zlib::GzipWriter.new(ff)
-      tw = Archive::Tar::Minitar::Writer.new(gz)
-
-      files.each do |entry|
-        if entry[:dir]
-          tw.mkdir(entry[:name], entry)
-        else
-          tw.add_file_simple(entry[:name], entry) { |os| os.write(entry[:data]) }
-        end
-      end
-    ensure
-      tw.close if tw
-      gz.close if gz
-    end
-  end
-end
-task TARDIST => [ :test ]
+  self.remote_rdoc_dir = 'diff-lcs/rdoc'
+  self.rsync_args << ' --exclude=statsvn/'
 
-def sign(file)
-  sh %("C:\\Program Files\\Windows Privacy Tools\\GnuPG\\Gpg.exe" -ba #{file}) rescue nil
-end
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+  self.extra_rdoc_files = FileList["*.rdoc"].to_a
 
-task :signtar => [ :tar ] do
-  sign TARDIST
-end
-task :signgem => [ :gem ] do
-  sign "../#{DISTDIR}.gem"
+  self.extra_dev_deps << ['rspec', '~> 2.0']
 end
 
-desc "Build everything."
-task :default => [ :signtar, :signgem ] do
-end
+# vim: syntax=ruby

data/bin/htmldiff

@@ -1,112 +1,32 @@
-#!/usr/bin/env 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: htmldiff,v 1.6 2004/10/17 19:33:21 austin Exp $
-#++
+#!ruby -w
+
+require 'diff/lcs'
+require 'diff/lcs/htmldiff'
 
 begin
-  require 'rubygems'
-  require_gem 'diff-lcs', "1.1.1"
-  require 'diff/lcs/string'
+  require 'text/format'
 rescue LoadError
-  require 'diff/lcs'
-  require 'diff/lcs/string'
+  Diff::LCS::HTMLDiff.can_expand_tabs = false
 end
 
-require 'text/format'
+if ARGV.size < 2 or ARGV.size > 3
+  $stderr.puts "usage: #{File.basename($0)} old new [output.html]"
+  $stderr.puts "       #{File.basename($0)} old new > output.html"
+  exit 127
+end
 
-class HTMLDiff #:nodoc:
-  attr_accessor :output
+left = IO.read(ARGV[0]).split($/)
+right = IO.read(ARGV[1]).split($/)
 
-  def initialize(output)
-    @output = output
-  end
+options = { :title => "diff #{ARGV[0]} #{ARGV[1]}" }
 
-    # This will be called with both lines are the same
-  def match(event)
-    @output << %Q|<pre class="match">#{event.old_element}</pre>\n|
-  end
+htmldiff = Diff::LCS::HTMLDiff.new(left, right, options)
 
-    # This will be called when there is a line in A that isn't in B
-  def discard_a(event)
-    @output << %Q|<pre class="only_a">#{event.old_element}</pre>\n|
+if ARGV[2]
+  File.open(ARGV[2], "w") do |f|
+    htmldiff.options[:output] = f
+    htmldiff.run
   end
-
-    # This will be called when there is a line in B that isn't in A
-  def discard_b(event)
-    @output << %Q|<pre class="only_b">#{event.new_element}</pre>\n|
-  end
-end
-
-if ARGV.size != 2
-  puts "usage: #{File.basename($0)} old new > output.html"
-  exit 255
+else
+  htmldiff.run
 end
-
-hd = HTMLDiff.new($stdout)
-tf = Text::Format.new
-tf.tabstop = 4
-
-preprocess = lambda { |line| tf.expand(line.chomp) }
-
-a = IO.readlines(ARGV[0]).map(&preprocess)
-b = IO.readlines(ARGV[1]).map(&preprocess)
-
-$stdout.write <<-START
-<html>
-  <head>
-    <title>diff #{ARGV[0]} #{ARGV[1]}</title>
-    <style>
-  body { margin: 0; }
-  .diff
-  {
-    border: 1px solid black;
-    margin: 1em 2em;
-  }
-  pre
-  {
-    padding-left: 1em;
-    margin: 0;
-    font-family: Lucida, Courier, monospaced;
-		white-space: pre;
-  }
-  .match { }
-  .only_a
-  {
-    background-color: #fdd;
-    color: red;
-    text-decoration: line-through;
-  }
-  .only_b
-  {
-    background-color: #ddf;
-    color: blue;
-    border-left: 3px solid blue
-  }
-  h1 { margin-left: 2em; }
-    </style>
-  </head>
-  <body>
-    <h1>diff&nbsp;
-        <span class="only_a">#{ARGV[0]}</span>&nbsp;
-        <span class="only_b">#{ARGV[1]}</span>
-    </h1>
-    <div class="diff">
-START
-
-Diff::LCS.traverse_sequences(a, b, hd)
-
-$stdout.write <<-END
-    </div>
-  </body>
-</html>
-END