diff-lcs 1.1.3 → 1.5.0

data/lib/diff/lcs/change.rb

@@ -1,151 +1,140 @@
-#! /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$
-#++
-# Provides Diff::LCS::Change and Diff::LCS::ContextChange.
-
-  # Centralises the change test code in Diff::LCS::Change and
-  # Diff::LCS::ContextChange, since it's the same for both classes.
-module Diff::LCS::ChangeTypeTests
-  def deleting?
-    @action == '-'
-  end
+# frozen_string_literal: true
 
-  def adding?
-    @action == '+'
-  end
+# 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 # rubocop:disable Naming/ConstantName
 
-  def unchanged?
-    @action == '='
+  # 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(+ - = ! > <).freeze
+
+  def self.valid_action?(action)
+    VALID_ACTIONS.include? action
   end
 
-  def changed?
-    @changed == '!'
+  # Returns the action this Change represents.
+  attr_reader :action
+
+  # Returns the position of the Change.
+  attr_reader :position
+  # Returns the sequence element of the Change.
+  attr_reader :element
+
+  def initialize(*args)
+    @action, @position, @element = *args
+
+    fail "Invalid Change Action '#{@action}'" unless Diff::LCS::Change.valid_action?(@action)
+    fail 'Invalid Position Type' unless @position.kind_of? IntClass
   end
 
-  def finished_a?
-    @changed == '>'
+  def inspect(*_args)
+    "#<#{self.class}: #{to_a.inspect}>"
   end
 
-  def finished_b?
-    @changed == '<'
+  def to_a
+    [@action, @position, @element]
   end
-end
 
-  # 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
-    # Returns the action this Change represents. Can be '+' (#adding?), '-'
-    # (#deleting?), '=' (#unchanged?), # or '!' (#changed?). When created by
-    # Diff::LCS#diff or Diff::LCS#sdiff, it may also be '>' (#finished_a?) or
-    # '<' (#finished_b?).
-  attr_reader :action
-  attr_reader :position
-  attr_reader :element
+  alias to_ary to_a
+
+  def self.from_a(arr)
+    arr = arr.flatten(1)
+    case arr.size
+    when 5
+      Diff::LCS::ContextChange.new(*(arr[0...5]))
+    when 3
+      Diff::LCS::Change.new(*(arr[0...3]))
+    else
+      fail 'Invalid change array format provided.'
+    end
+  end
 
   include Comparable
+
   def ==(other)
-    (self.action == other.action) and
-    (self.position == other.position) and
-    (self.element == other.element)
+    (self.class == other.class) and
+      (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 initialize(action, position, element)
-    @action = action
-    @position = position
-    @element = element
+  def adding?
+    @action == '+'
   end
 
-    # Creates a Change from an array produced by Change#to_a.
-  def to_a
-    [@action, @position, @element]
+  def deleting?
+    @action == '-'
   end
 
-  def self.from_a(arr)
-    Diff::LCS::Change.new(arr[0], arr[1], arr[2])
+  def unchanged?
+    @action == '='
   end
 
-  include Diff::LCS::ChangeTypeTests
+  def changed?
+    @action == '!'
+  end
+
+  def finished_a?
+    @action == '>'
+  end
+
+  def finished_b?
+    @action == '<'
+  end
 end
 
-  # Represents a contextual change. Contains the position and values of the
-  # elements in the old and the new sequenced enumerables as well as the action
-  # taken.
-class Diff::LCS::ContextChange
-    # Returns the action this Change represents. Can be '+' (#adding?), '-'
-    # (#deleting?), '=' (#unchanged?), # or '!' (#changed?). When
-    # created by Diff::LCS#diff or Diff::LCS#sdiff, it may also be '>'
-    # (#finished_a?) or '<' (#finished_b?).
-  attr_reader :action
+# Represents a contextual change. Contains the position and values of the
+# elements in the old and the new sequenced enumerables as well as the action
+# taken.
+class Diff::LCS::ContextChange < Diff::LCS::Change
+  # We don't need these two values.
+  undef :position
+  undef :element
+
+  # Returns the old position being changed.
   attr_reader :old_position
-  attr_reader :old_element
+  # Returns the new position being changed.
   attr_reader :new_position
+  # Returns the old element being changed.
+  attr_reader :old_element
+  # Returns the new element being changed.
   attr_reader :new_element
 
-  include Comparable
-
-  def ==(other)
-    (@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 initialize(*args)
+    @action, @old_position, @old_element, @new_position, @new_element = *args
 
-  def inspect(*args)
-    %Q(#<#{self.class.name}:#{__id__} @action=#{action} positions=#{old_position},#{new_position} elements=#{old_element.inspect},#{new_element.inspect}>)
-  end
-
-  def <=>(other)
-    r = @action <=> other.action
-    r = @old_position <=> other.old_position if r.zero?
-    r = @new_position <=> other.new_position if r.zero?
-    r = @old_element <=> other.old_element if r.zero?
-    r = @new_element <=> other.new_element if r.zero?
-    r
-  end
-
-  def initialize(action, old_position, old_element, new_position, new_element)
-    @action = action
-    @old_position = old_position
-    @old_element = old_element
-    @new_position = new_position
-    @new_element = new_element
+    fail "Invalid Change Action '#{@action}'" unless Diff::LCS::Change.valid_action?(@action)
+    fail 'Invalid (Old) Position Type' unless @old_position.nil? or @old_position.kind_of? IntClass
+    fail 'Invalid (New) Position Type' unless @new_position.nil? or @new_position.kind_of? IntClass
   end
 
   def to_a
-    [@action, [@old_position, @old_element], [@new_position, @new_element]]
+    [
+      @action,
+      [@old_position, @old_element],
+      [@new_position, @new_element]
+    ]
   end
 
-    # Creates a ContextChange from an array produced by ContextChange#to_a.
+  alias to_ary to_a
+
   def self.from_a(arr)
-    if arr.size == 5
-      Diff::LCS::ContextChange.new(arr[0], arr[1], arr[2], arr[3], arr[4])
-    else
-      Diff::LCS::ContextChange.new(arr[0], arr[1][0], arr[1][1], arr[2][0],
-                                   arr[2][1])
-    end
+    Diff::LCS::Change.from_a(arr)
   end
 
-    # Simplifies a context change for use in some diff callbacks. '<' actions
-    # are converted to '-' and '>' actions are converted to '+'. 
+  # Simplifies a context change for use in some diff callbacks. '<' actions
+  # are converted to '-' and '>' actions are converted to '+'.
   def self.simplify(event)
     ea = event.to_a
 
@@ -165,5 +154,21 @@ class Diff::LCS::ContextChange
     Diff::LCS::ContextChange.from_a(ea)
   end
 
-  include Diff::LCS::ChangeTypeTests
+  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)
+  end
+
+  def <=>(other)
+    r = @action <=> other.action
+    r = @old_position <=> other.old_position if r.zero?
+    r = @new_position <=> other.new_position if r.zero?
+    r = @old_element <=> other.old_element if r.zero?
+    r = @new_element <=> other.new_element if r.zero?
+    r
+  end
 end

data/lib/diff/lcs/htmldiff.rb

@@ -1,14 +1,15 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
 require 'cgi'
 
+# Produce a simple HTML diff view.
 class Diff::LCS::HTMLDiff
   class << self
     attr_accessor :can_expand_tabs #:nodoc:
   end
   self.can_expand_tabs = true
 
-  class Callbacks
+  class Callbacks #:nodoc:
     attr_accessor :output
     attr_accessor :match_class
     attr_accessor :only_a_class
@@ -18,14 +19,14 @@ class Diff::LCS::HTMLDiff
       @output = output
       options ||= {}
 
-      @match_class = options[:match_class] || "match"
-      @only_a_class = options[:only_a_class] || "only_a"
-      @only_b_class = options[:only_b_class] || "only_b"
+      @match_class = options[:match_class] || 'match'
+      @only_a_class = options[:only_a_class] || 'only_a'
+      @only_b_class = options[:only_b_class] || 'only_b'
     end
 
     def htmlize(element, css_class)
-      element = "&nbsp;" if element.empty?
-      %Q|<pre class="#{__send__(css_class)}">#{element}</pre>\n|
+      element = '&nbsp;' if element.empty?
+      %Q(<pre class="#{__send__(css_class)}">#{element}</pre>\n)
     end
     private :htmlize
 
@@ -49,8 +50,8 @@ class Diff::LCS::HTMLDiff
     :expand_tabs => nil,
     :output => nil,
     :css => nil,
-    :title => nil,
-  }
+    :title => nil
+  }.freeze
 
   DEFAULT_CSS = <<-CSS
 body { margin: 0; }
@@ -96,13 +97,13 @@ h1 { margin-left: 2em; }
 
   def verify_options
     @options[:expand_tabs] ||= 4
-    @options[:expand_tabs] = 4 if @options[:expand_tabs] < 0
+    @options[:expand_tabs] = 4 if @options[:expand_tabs].negative?
 
     @options[:output] ||= $stdout
 
     @options[:css] ||= DEFAULT_CSS.dup
 
-    @options[:title] ||= "diff"
+    @options[:title] ||= 'diff'
   end
   private :verify_options
 
@@ -111,16 +112,16 @@ h1 { margin-left: 2em; }
   def run
     verify_options
 
-    if @options[:expand_tabs] > 0 && self.class.can_expand_tabs
+    if @options[:expand_tabs].positive? && self.class.can_expand_tabs
       formatter = Text::Format.new
       formatter.tabstop = @options[:expand_tabs]
 
-      @left = left.map { |line| formatter.expand(line.chomp) }
-      @right = right.map { |line| formatter.expand(line.chomp) }
+      @left.map! do |line| formatter.expand(line.chomp) end
+      @right.map! do |line| formatter.expand(line.chomp) end
     end
 
-    @left.map! { |line| CGI.escapeHTML(line.chomp) }
-    @right.map! { |line| CGI.escapeHTML(line.chomp) }
+    @left.map! do |line| CGI.escapeHTML(line.chomp) end
+    @right.map! do |line| CGI.escapeHTML(line.chomp) end
 
     @options[:output] << <<-OUTPUT
 <html>
@@ -147,5 +148,3 @@ h1 { margin-left: 2em; }
     OUTPUT
   end
 end
-
-# vim: ft=ruby