diff-lcs 1.3 → 1.6.2

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 # standard: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,29 +27,29 @@ 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
     when 5
-      Diff::LCS::ContextChange.new(*(arr[0...5]))
+      Diff::LCS::ContextChange.new(*arr[0...5])
     when 3
-      Diff::LCS::Change.new(*(arr[0...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)

data/lib/diff/lcs/htmldiff.rb

@@ -1,14 +1,17 @@
-# -*- ruby encoding: utf-8 -*-
+# frozen_string_literal: true
 
-require 'cgi'
+require "erb"
 
+# Produce a simple HTML diff view.
 class Diff::LCS::HTMLDiff
   class << self
-    attr_accessor :can_expand_tabs #:nodoc:
+    # standard:disable ThreadSafety/ClassAndModuleAttributes
+    attr_accessor :can_expand_tabs # :nodoc:
+    # standard:enable ThreadSafety/ClassAndModuleAttributes
   end
   self.can_expand_tabs = true
 
-  class Callbacks
+  class Callbacks # :nodoc:
     attr_accessor :output
     attr_accessor :match_class
     attr_accessor :only_a_class
@@ -25,7 +28,7 @@ class Diff::LCS::HTMLDiff
 
     def htmlize(element, css_class)
       element = "&nbsp;" if element.empty?
-      %Q|<pre class="#{__send__(css_class)}">#{element}</pre>\n|
+      %(<pre class="#{__send__(css_class)}">#{element}</pre>\n)
     end
     private :htmlize
 
@@ -45,13 +48,16 @@ class Diff::LCS::HTMLDiff
     end
   end
 
+  # standard:disable Style/HashSyntax
   DEFAULT_OPTIONS = {
     :expand_tabs => nil,
     :output => nil,
     :css => nil,
-    :title => nil,
-  }
+    :title => nil
+  }.freeze
+  # standard:enable Style/HashSyntax
 
+  # standard:disable Layout/HeredocIndentation
   DEFAULT_CSS = <<-CSS
 body { margin: 0; }
 .diff
@@ -85,18 +91,19 @@ pre
 }
 h1 { margin-left: 2em; }
   CSS
+  # standard:enable Layout/HeredocIndentation
 
   def initialize(left, right, options = nil)
-    @left     = left
-    @right    = right
-    @options  = options
+    @left = left
+    @right = right
+    @options = options
 
     @options = DEFAULT_OPTIONS.dup if @options.nil?
   end
 
   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
 
@@ -111,7 +118,7 @@ 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]
 
@@ -119,9 +126,10 @@ h1 { margin-left: 2em; }
       @right.map! { |line| formatter.expand(line.chomp) }
     end
 
-    @left.map! { |line| CGI.escapeHTML(line.chomp) }
-    @right.map! { |line| CGI.escapeHTML(line.chomp) }
+    @left.map! { |line| ERB::Util.html_escape(line.chomp) }
+    @right.map! { |line| ERB::Util.html_escape(line.chomp) }
 
+    # standard:disable Layout/HeredocIndentation
     @options[:output] << <<-OUTPUT
 <html>
   <head>
@@ -136,14 +144,17 @@ h1 { margin-left: 2em; }
     <span class="only_b">Only in New</span></p>
     <div class="diff">
     OUTPUT
+    # standard:enable Layout/HeredocIndentation
 
     callbacks = Callbacks.new(@options[:output])
     Diff::LCS.traverse_sequences(@left, @right, callbacks)
 
+    # standard:disable Layout/HeredocIndentation
     @options[:output] << <<-OUTPUT
     </div>
   </body>
 </html>
     OUTPUT
+    # standard:enable Layout/HeredocIndentation
   end
 end