diff-lcs 1.3 → 1.5.1

data/Manifest.txt

@@ -6,7 +6,6 @@ License.md
 Manifest.txt
 README.rdoc
 Rakefile
-autotest/discover.rb
 bin/htmldiff
 bin/ldiff
 docs/COPYING.txt
@@ -14,6 +13,7 @@ docs/artistic.txt
 lib/diff-lcs.rb
 lib/diff/lcs.rb
 lib/diff/lcs/array.rb
+lib/diff/lcs/backports.rb
 lib/diff/lcs/block.rb
 lib/diff/lcs/callbacks.rb
 lib/diff/lcs/change.rb
@@ -24,8 +24,30 @@ lib/diff/lcs/ldiff.rb
 lib/diff/lcs/string.rb
 spec/change_spec.rb
 spec/diff_spec.rb
+spec/fixtures/aX
+spec/fixtures/bXaX
 spec/fixtures/ds1.csv
 spec/fixtures/ds2.csv
+spec/fixtures/ldiff/output.diff
+spec/fixtures/ldiff/output.diff-c
+spec/fixtures/ldiff/output.diff-e
+spec/fixtures/ldiff/output.diff-f
+spec/fixtures/ldiff/output.diff-u
+spec/fixtures/ldiff/output.diff.chef
+spec/fixtures/ldiff/output.diff.chef-c
+spec/fixtures/ldiff/output.diff.chef-e
+spec/fixtures/ldiff/output.diff.chef-f
+spec/fixtures/ldiff/output.diff.chef-u
+spec/fixtures/ldiff/output.diff.chef2
+spec/fixtures/ldiff/output.diff.chef2-c
+spec/fixtures/ldiff/output.diff.chef2-d
+spec/fixtures/ldiff/output.diff.chef2-e
+spec/fixtures/ldiff/output.diff.chef2-f
+spec/fixtures/ldiff/output.diff.chef2-u
+spec/fixtures/new-chef
+spec/fixtures/new-chef2
+spec/fixtures/old-chef
+spec/fixtures/old-chef2
 spec/hunk_spec.rb
 spec/issues_spec.rb
 spec/lcs_spec.rb

data/README.rdoc

@@ -4,8 +4,7 @@ home :: https://github.com/halostatue/diff-lcs
 code :: https://github.com/halostatue/diff-lcs
 bugs :: https://github.com/halostatue/diff-lcs/issues
 rdoc :: http://rubydoc.info/github/halostatue/diff-lcs
-continuous integration :: {<img src="https://travis-ci.org/halostatue/diff-lcs.svg" />}[https://travis-ci.org/halostatue/diff-lcs]
-test coverage :: {<img src="https://coveralls.io/repos/halostatue/diff-lcs/badge.svg" alt="Coverage Status" />}[https://coveralls.io/r/halostatue/diff-lcs]
+continuous integration :: {<img src="https://github.com/halostatue/diff-lcs/workflows/CI/badge.svg" />}[https://github.com/halostatue/diff-lcs/actions]
 
 == Description
 
@@ -13,10 +12,15 @@ 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.3, providing a tentative fix to a long-standing issue related
-to incorrect detection of a patch direction. Also modernizes the gem
-infrastructure, testing infrastructure, and provides a warning-free experience
-to Ruby 2.4 users.
+This is release 1.4.3, providing a simple extension that allows for
+Diff::LCS::Change objects to be treated implicitly as arrays and fixes a
+number of formatting issues.
+
+Ruby versions below 2.5 are soft-deprecated, which means that older versions
+are no longer part of the CI test suite. If any changes have been introduced
+that break those versions, bug reports and patches will be accepted, but it
+will be up to the reporter to verify any fixes prior to release. The next
+major release will completely break compatibility.
 
 == Synopsis
 
@@ -78,7 +82,3 @@ The algorithm is described in <em>A Fast Algorithm for Computing Longest Common
 Subsequences</em>, CACM, vol.20, no.5, pp.350-353, May 1977, with a few minor
 improvements to improve the speed. A simplified description of the algorithm,
 originally written for the Perl version, was written by Mark-Jason Dominus.
-
-:include: Contributing.rdoc
-
-:include: License.rdoc

data/Rakefile

@@ -1,57 +1,130 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'rspec'
-require 'hoe'
+require "rubygems"
+require "rspec"
+require "rspec/core/rake_task"
+require "hoe"
+
+# This is required until https://github.com/seattlerb/hoe/issues/112 is fixed
+class Hoe
+  def with_config
+    config = Hoe::DEFAULT_CONFIG
+
+    rc = File.expand_path("~/.hoerc")
+    homeconfig = load_config(rc)
+    config = config.merge(homeconfig)
+
+    localconfig = load_config(File.expand_path(File.join(Dir.pwd, ".hoerc")))
+    config = config.merge(localconfig)
+
+    yield config, rc
+  end
+
+  def load_config(name)
+    File.exist?(name) ? safe_load_yaml(name) : {}
+  end
+
+  def safe_load_yaml(name)
+    return safe_load_yaml_file(name) if YAML.respond_to?(:safe_load_file)
+
+    data = IO.binread(name)
+    YAML.safe_load(data, permitted_classes: [Regexp])
+  rescue
+    YAML.safe_load(data, [Regexp])
+  end
+
+  def safe_load_yaml_file(name)
+    YAML.safe_load_file(name, permitted_classes: [Regexp])
+  rescue
+    YAML.safe_load_file(name, [Regexp])
+  end
+end
 
 Hoe.plugin :bundler
 Hoe.plugin :doofus
-Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
 Hoe.plugin :gemspec2
 Hoe.plugin :git
-Hoe.plugin :travis
 
-spec = Hoe.spec 'diff-lcs' do
-  developer('Austin Ziegler', 'halostatue@gmail.com')
+if RUBY_VERSION < "1.9"
+  class Array # :nodoc:
+    def to_h
+      Hash[*flatten(1)]
+    end
+  end
+
+  class Gem::Specification # :nodoc:
+    def metadata=(*)
+    end
+
+    def default_value(*)
+    end
+  end
+
+  class Object # :nodoc:
+    def caller_locations(*)
+      []
+    end
+  end
+end
+
+_spec = Hoe.spec "diff-lcs" do
+  developer("Austin Ziegler", "halostatue@gmail.com")
+
+  require_ruby_version ">= 1.8"
 
-  require_ruby_version '>= 1.8'
+  self.history_file = "History.md"
+  self.readme_file = "README.rdoc"
+  self.licenses = ["MIT", "Artistic-2.0", "GPL-2.0-or-later"]
 
-  self.history_file = 'History.md'
-  self.readme_file = 'README.rdoc'
-  self.licenses = [ 'MIT', 'Artistic-2.0', 'GPL-2.0+' ]
+  spec_extras[:metadata] = ->(val) { val["rubygems_mfa_required"] = "true" }
 
-  extra_dev_deps << ['hoe-doofus', '~> 1.0']
-  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
-  extra_dev_deps << ['hoe-git', '~> 1.6']
-  extra_dev_deps << ['hoe-rubygems', '~> 1.0']
-  extra_dev_deps << ['hoe-travis', '~> 1.2']
-  extra_dev_deps << ['rspec', '>= 2.0', '< 4']
-  extra_dev_deps << ['rake', '>= 10.0', '< 12']
-  extra_dev_deps << ['rdoc', '>= 0']
+  extra_dev_deps << ["hoe", ">= 3.0", "< 5"]
+  extra_dev_deps << ["hoe-doofus", "~> 1.0"]
+  extra_dev_deps << ["hoe-gemspec2", "~> 1.1"]
+  extra_dev_deps << ["hoe-git2", "~> 1.7"]
+  extra_dev_deps << ["hoe-rubygems", "~> 1.0"]
+  extra_dev_deps << ["rspec", ">= 2.0", "< 4"]
+  extra_dev_deps << ["rake", ">= 10.0", "< 14"]
+  extra_dev_deps << ["rdoc", ">= 6.3.1", "< 7"]
 end
 
-unless Rake::Task.task_defined? :test
-  task :test => :spec
-  Rake::Task['travis'].prerequisites.replace(%w(spec))
+desc "Run all specifications"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  rspec_dirs = %w[spec lib].join(":")
+  t.rspec_opts = ["-I#{rspec_dirs}"]
 end
 
-if RUBY_VERSION >= '2.0' && RUBY_ENGINE == 'ruby'
-  namespace :spec do
-    task :coveralls do
-      if ENV['CI'] or ENV['TRAVIS']
-        ENV['COVERALLS'] = 'yes'
-        Rake::Task['spec'].execute
-      else
-        Rake::Task['spec:coverage'].execute
-      end
-    end
+Rake::Task["spec"].actions.uniq! { |a| a.source_location }
 
+# standard:disable Style/HashSyntax
+task :default => :spec unless Rake::Task["default"].prereqs.include?("spec")
+task :test => :spec unless Rake::Task["test"].prereqs.include?("spec")
+# standard:enable Style/HashSyntax
+
+if RUBY_VERSION >= "2.0" && RUBY_ENGINE == "ruby"
+  namespace :spec do
     desc "Runs test coverage. Only works Ruby 2.0+ and assumes 'simplecov' is installed."
     task :coverage do
-      ENV['COVERAGE'] = 'yes'
-      Rake::Task['spec'].execute
+      ENV["COVERAGE"] = "yes"
+      Rake::Task["spec"].execute
     end
   end
+end
+
+task :ruby18 do
+  # standard:disable Layout/HeredocIndentation
+  puts <<-MESSAGE
+You are starting a barebones Ruby 1.8 docker environment. You will need to
+do the following:
+
+- mv Gemfile.lock{,.v2}
+- gem install bundler --version 1.17.2 --no-ri --no-rdoc
+- ruby -S bundle
+- rake
+
+Don't forget to restore your Gemfile.lock after testing.
 
-  # Rake::Task['travis'].prerequisites.replace(%w(spec:coveralls))
+  MESSAGE
+  # standard:enable Layout/HeredocIndentation
+  sh "docker run -it --rm -v #{Dir.pwd}:/root/diff-lcs bellbind/docker-ruby18-rails2 bash -l"
 end

data/bin/htmldiff

@@ -1,17 +1,18 @@
-#!ruby -w
+#! /usr/bin/env ruby -w
+# frozen_string_literal: true
 
-require 'diff/lcs'
-require 'diff/lcs/htmldiff'
+require "diff/lcs"
+require "diff/lcs/htmldiff"
 
 begin
-  require 'text/format'
+  require "text/format"
 rescue LoadError
   Diff::LCS::HTMLDiff.can_expand_tabs = false
 end
 
 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"
+  warn "usage: #{File.basename($0)} old new [output.html]"
+  warn "       #{File.basename($0)} old new > output.html"
   exit 127
 end
 
@@ -30,3 +31,5 @@ if ARGV[2]
 else
   htmldiff.run
 end
+
+# vim: ft=ruby

data/bin/ldiff

@@ -1,6 +1,9 @@
-#!ruby -w
+#! /usr/bin/env ruby -w
+# frozen_string_literal: true
 
 require 'diff/lcs'
 require 'diff/lcs/ldiff'
 
 exit Diff::LCS::Ldiff.run(ARGV)
+
+# vim: ft=ruby

data/lib/diff/lcs/array.rb

@@ -1,6 +1,6 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require 'diff/lcs'
+require "diff/lcs"
 
 class Array
   include Diff::LCS

data/lib/diff/lcs/backports.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+unless 0.respond_to?(:positive?)
+  class Fixnum # standard:disable Lint/UnifiedInteger
+    def positive?
+      self > 0
+    end
+  end
+end

data/lib/diff/lcs/block.rb

@@ -1,4 +1,4 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 # A block is an operation removing, adding, or changing a group of items.
 # Basically, this is just a list of changes, where each change adds or
@@ -25,13 +25,13 @@ class Diff::LCS::Block
   def op
     case [@remove.empty?, @insert.empty?]
     when [false, false]
-      '!'
+      "!"
     when [false, true]
-      '-'
+      "-"
     when [true, false]
-      '+'
+      "+"
     else # [true, true]
-      '^'
+      "^"
     end
   end
 end

data/lib/diff/lcs/callbacks.rb

@@ -1,6 +1,6 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require 'diff/lcs/change'
+require "diff/lcs/change"
 
 module Diff::LCS
   # This callback object implements the default set of callback events,
@@ -17,14 +17,17 @@ module Diff::LCS
       def match(event)
         event
       end
+
       # Called when the old value is discarded in favour of the new value.
       def discard_a(event)
         event
       end
+
       # Called when the new value is discarded in favour of the old value.
       def discard_b(event)
         event
       end
+
       # Called when both the old and new values have changed.
       def change(event)
         event
@@ -47,7 +50,9 @@ module Diff::LCS
   BalancedCallbacks = DefaultCallbacks
 
   def self.callbacks_for(callbacks)
-    callbacks.new rescue callbacks
+    callbacks.new
+  rescue
+    callbacks
   end
 end
 
@@ -104,16 +109,16 @@ class Diff::LCS::DiffCallbacks
   # Returns the difference set collected during the diff process.
   attr_reader :diffs
 
-  def initialize # :yields self:
+  def initialize # :yields: self
     @hunk = []
     @diffs = []
 
-    if block_given?
-      begin
-        yield self
-      ensure
-        self.finish
-      end
+    return unless block_given?
+
+    begin
+      yield self
+    ensure
+      finish
     end
   end
 
@@ -123,16 +128,16 @@ class Diff::LCS::DiffCallbacks
     finish_hunk
   end
 
-  def match(event)
+  def match(_event)
     finish_hunk
   end
 
   def discard_a(event)
-    @hunk << Diff::LCS::Change.new('-', event.old_position, event.old_element)
+    @hunk << Diff::LCS::Change.new("-", event.old_position, event.old_element)
   end
 
   def discard_b(event)
-    @hunk << Diff::LCS::Change.new('+', event.new_position, event.new_element)
+    @hunk << Diff::LCS::Change.new("+", event.new_position, event.new_element)
   end
 
   def finish_hunk
@@ -190,7 +195,7 @@ end
 # Diff::LCS::SDiffCallbacks. They may be compared as:
 #
 #     s = Diff::LCS.sdiff(seq1, seq2).reject { |e| e.action == "=" }
-#     c = Diff::LCS.sdiff(seq1, seq2, Diff::LCS::ContextDiffCallbacks).flatten
+#     c = Diff::LCS.sdiff(seq1, seq2, Diff::LCS::ContextDiffCallbacks).flatten(1)
 #
 #     s == c # -> true
 #
@@ -241,7 +246,7 @@ end
 # will compute and display the necessary components to show two sequences
 # and their minimized differences side by side, just like the Unix utility
 # +sdiff+.
-# 
+#
 #     same             same
 #     before     |     after
 #     old        <     -
@@ -270,7 +275,7 @@ end
 # Diff::LCS::ContextDiffCallbacks. They may be compared as:
 #
 #     s = Diff::LCS.sdiff(seq1, seq2).reject { |e| e.action == "=" }
-#     c = Diff::LCS.sdiff(seq1, seq2, Diff::LCS::ContextDiffCallbacks).flatten
+#     c = Diff::LCS.sdiff(seq1, seq2, Diff::LCS::ContextDiffCallbacks).flatten(1)
 #
 #     s == c # -> true
 #
@@ -299,7 +304,7 @@ class Diff::LCS::SDiffCallbacks
   # Returns the difference set collected during the diff process.
   attr_reader :diffs
 
-  def initialize #:yields self:
+  def initialize # :yields: self
     @diffs = []
     yield self if block_given?
   end

data/lib/diff/lcs/change.rb

@@ -1,16 +1,16 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 # Represents a simplistic (non-contextual) change. Represents the removal or
 # addition of an element from either the old or the new sequenced
 # enumerable.
 class Diff::LCS::Change
-  IntClass = 1.class # Fixnum is deprecated in Ruby 2.4
+  IntClass = 1.class # Fixnum is deprecated in Ruby 2.4 # rubocop:disable Naming/ConstantName
 
   # The only actions valid for changes are '+' (add), '-' (delete), '='
   # (no change), '!' (changed), '<' (tail changes from first sequence), or
   # '>' (tail changes from second sequence). The last two ('<>') are only
   # found with Diff::LCS::diff and Diff::LCS::sdiff.
-  VALID_ACTIONS = %W(+ - = ! > <)
+  VALID_ACTIONS = %w[+ - = ! > <].freeze
 
   def self.valid_action?(action)
     VALID_ACTIONS.include? action
@@ -27,20 +27,20 @@ class Diff::LCS::Change
   def initialize(*args)
     @action, @position, @element = *args
 
-    unless Diff::LCS::Change.valid_action?(@action)
-      raise "Invalid Change Action '#{@action}'"
-    end
-    raise "Invalid Position Type" unless @position.kind_of? IntClass
+    fail "Invalid Change Action '#{@action}'" unless Diff::LCS::Change.valid_action?(@action)
+    fail "Invalid Position Type" unless @position.is_a? IntClass
   end
 
-  def inspect
-    to_a.inspect
+  def inspect(*_args)
+    "#<#{self.class}: #{to_a.inspect}>"
   end
 
   def to_a
-    [ @action, @position, @element ]
+    [@action, @position, @element]
   end
 
+  alias_method :to_ary, :to_a
+
   def self.from_a(arr)
     arr = arr.flatten(1)
     case arr.size
@@ -49,7 +49,7 @@ class Diff::LCS::Change
     when 3
       Diff::LCS::Change.new(*(arr[0...3]))
     else
-      raise "Invalid change array format provided."
+      fail "Invalid change array format provided."
     end
   end
 
@@ -57,40 +57,40 @@ class Diff::LCS::Change
 
   def ==(other)
     (self.class == other.class) and
-    (self.action == other.action) and
-    (self.position == other.position) and
-    (self.element == other.element)
+      (action == other.action) and
+      (position == other.position) and
+      (element == other.element)
   end
 
   def <=>(other)
-    r = self.action <=> other.action
-    r = self.position <=> other.position if r.zero?
-    r = self.element <=> other.element if r.zero?
+    r = action <=> other.action
+    r = position <=> other.position if r.zero?
+    r = element <=> other.element if r.zero?
     r
   end
 
   def adding?
-    @action == '+'
+    @action == "+"
   end
 
   def deleting?
-    @action == '-'
+    @action == "-"
   end
 
   def unchanged?
-    @action == '='
+    @action == "="
   end
 
   def changed?
-    @action == '!'
+    @action == "!"
   end
 
   def finished_a?
-    @action == '>'
+    @action == ">"
   end
 
   def finished_b?
-    @action == '<'
+    @action == "<"
   end
 end
 
@@ -114,27 +114,20 @@ class Diff::LCS::ContextChange < Diff::LCS::Change
   def initialize(*args)
     @action, @old_position, @old_element, @new_position, @new_element = *args
 
-    unless Diff::LCS::Change.valid_action?(@action)
-      raise "Invalid Change Action '#{@action}'"
-    end
-    unless @old_position.nil? or @old_position.kind_of? IntClass
-      raise "Invalid (Old) Position Type"
-    end
-    unless @new_position.nil? or @new_position.kind_of? IntClass
-      raise "Invalid (New) Position Type"
-    end
+    fail "Invalid Change Action '#{@action}'" unless Diff::LCS::Change.valid_action?(@action)
+    fail "Invalid (Old) Position Type" unless @old_position.nil? || @old_position.is_a?(IntClass)
+    fail "Invalid (New) Position Type" unless @new_position.nil? || @new_position.is_a?(IntClass)
   end
 
   def to_a
-    [ @action,
-      [ @old_position, @old_element ],
-      [ @new_position, @new_element ]
+    [
+      @action,
+      [@old_position, @old_element],
+      [@new_position, @new_element]
     ]
   end
 
-  def inspect(*args)
-    to_a.inspect
-  end
+  alias_method :to_ary, :to_a
 
   def self.from_a(arr)
     Diff::LCS::Change.from_a(arr)
@@ -146,15 +139,15 @@ class Diff::LCS::ContextChange < Diff::LCS::Change
     ea = event.to_a
 
     case ea[0]
-    when '-'
+    when "-"
       ea[2][1] = nil
-    when '<'
-      ea[0] = '-'
+    when "<"
+      ea[0] = "-"
       ea[2][1] = nil
-    when '+'
+    when "+"
       ea[1][1] = nil
-    when '>'
-      ea[0] = '+'
+    when ">"
+      ea[0] = "+"
       ea[1][1] = nil
     end
 
@@ -163,11 +156,11 @@ class Diff::LCS::ContextChange < Diff::LCS::Change
 
   def ==(other)
     (self.class == other.class) and
-    (@action == other.action) and
-    (@old_position == other.old_position) and
-    (@new_position == other.new_position) and
-    (@old_element == other.old_element) and
-    (@new_element == other.new_element)
+      (@action == other.action) and
+      (@old_position == other.old_position) and
+      (@new_position == other.new_position) and
+      (@old_element == other.old_element) and
+      (@new_element == other.new_element)
   end
 
   def <=>(other)