diff-lcs 2.0.0.beta.1 → 2.0.0

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "rubygems"
-require "pathname"
-
-require "psych" if RUBY_VERSION >= "1.9"
+$LOAD_PATH.unshift File.expand_path(__dir__, "../lib")
 
+require "rubygems"
 require "simplecov"
 require "simplecov-lcov"
 
+require "diff/lcs"
+
 SimpleCov::Formatter::LcovFormatter.config do |config|
   config.report_with_single_file = true
   config.lcov_file_name = "lcov.info"
@@ -23,12 +23,6 @@ SimpleCov.start "test_frameworks" do
   ])
 end
 
-file = Pathname.new(__FILE__).expand_path
-path = file.parent
-parent = path.parent
-
-$:.unshift parent.join("lib")
-
 module CaptureSubprocessIO
   def _synchronize
     yield
@@ -62,8 +56,6 @@ module CaptureSubprocessIO
   private :_capture_subprocess_io
 end
 
-require "diff-lcs"
-
 module Diff::LCS::SpecHelper
   def hello
     "hello"

data/test/fixtures/ldiff/output.diff-c

@@ -0,0 +1,7 @@
+*** test/fixtures/aX	2020-06-23 11:15:32.000000000 -0400
+--- test/fixtures/bXaX	2020-06-23 11:15:32.000000000 -0400
+***************
+*** 1 ****
+! aX
+--- 1 ----
+! bXaX

data/test/fixtures/ldiff/output.diff-u

@@ -0,0 +1,5 @@
+--- test/fixtures/aX	2020-06-23 11:15:32.000000000 -0400
++++ test/fixtures/bXaX	2020-06-23 11:15:32.000000000 -0400
+@@ -1 +1 @@
+-aX
++bXaX

data/test/fixtures/ldiff/output.diff.bin2

@@ -0,0 +1 @@
+Binary files test/fixtures/file1.bin and test/fixtures/file2.bin differ

data/test/fixtures/ldiff/output.diff.bin2-c

@@ -0,0 +1 @@
+Binary files test/fixtures/file1.bin and test/fixtures/file2.bin differ

data/test/fixtures/ldiff/output.diff.bin2-e

@@ -0,0 +1 @@
+Binary files test/fixtures/file1.bin and test/fixtures/file2.bin differ

data/test/fixtures/ldiff/output.diff.bin2-f

@@ -0,0 +1 @@
+Binary files test/fixtures/file1.bin and test/fixtures/file2.bin differ

data/test/fixtures/ldiff/output.diff.bin2-u

@@ -0,0 +1 @@
+Binary files test/fixtures/file1.bin and test/fixtures/file2.bin differ

data/{spec → test}/fixtures/ldiff/output.diff.chef-c

@@ -1,5 +1,5 @@
-*** spec/fixtures/old-chef	2020-06-23 23:18:20.000000000 -0400
---- spec/fixtures/new-chef	2020-06-23 23:18:20.000000000 -0400
+*** test/fixtures/old-chef	2020-06-23 23:18:20.000000000 -0400
+--- test/fixtures/new-chef	2020-06-23 23:18:20.000000000 -0400
 ***************
 *** 1,4 ****
   {

data/test/fixtures/ldiff/output.diff.chef-u

@@ -0,0 +1,9 @@
+--- test/fixtures/old-chef	2020-06-23 23:18:20.000000000 -0400
++++ test/fixtures/new-chef	2020-06-23 23:18:20.000000000 -0400
+@@ -1,4 +1,4 @@
+ {
+   "name": "x",
+-  "description": "hi"
++  "description": "lo"
+ }
+

data/{spec → test}/fixtures/ldiff/output.diff.chef2-c

@@ -1,5 +1,5 @@
-*** spec/fixtures/old-chef2	2020-06-30 09:43:35.000000000 -0400
---- spec/fixtures/new-chef2	2020-06-30 09:44:32.000000000 -0400
+*** test/fixtures/old-chef2	2020-06-30 09:43:35.000000000 -0400
+--- test/fixtures/new-chef2	2020-06-30 09:44:32.000000000 -0400
 ***************
 *** 1,5 ****
   recipe[a::default]

data/{spec → test}/fixtures/ldiff/output.diff.chef2-u

@@ -1,5 +1,5 @@
---- spec/fixtures/old-chef2	2020-06-30 09:43:35.000000000 -0400
-+++ spec/fixtures/new-chef2	2020-06-30 09:44:32.000000000 -0400
+--- test/fixtures/old-chef2	2020-06-30 09:43:35.000000000 -0400
++++ test/fixtures/new-chef2	2020-06-30 09:44:32.000000000 -0400
 @@ -1,5 +1,4 @@
  recipe[a::default]
 -recipe[b::default]

data/test/fixtures/ldiff/output.diff.empty.vs.four_lines-c

@@ -0,0 +1,9 @@
+*** test/fixtures/empty	2025-01-31 12:14:52.856031635 +0100
+--- test/fixtures/four_lines	2025-01-31 12:13:45.476036544 +0100
+***************
+*** 0 ****
+--- 1,4 ----
++ one
++ two
++ three
++ four

data/test/fixtures/ldiff/output.diff.empty.vs.four_lines-u

@@ -0,0 +1,7 @@
+--- test/fixtures/empty	2025-01-31 12:14:52.856031635 +0100
++++ test/fixtures/four_lines	2025-01-31 12:13:45.476036544 +0100
+@@ -0,0 +1,4 @@
++one
++two
++three
++four

data/test/fixtures/ldiff/output.diff.four_lines.vs.empty-c

@@ -0,0 +1,9 @@
+*** test/fixtures/four_lines	2025-01-31 12:13:45.476036544 +0100
+--- test/fixtures/empty	2025-01-31 12:14:52.856031635 +0100
+***************
+*** 1,4 ****
+- one
+- two
+- three
+- four
+--- 0 ----

data/test/fixtures/ldiff/output.diff.four_lines.vs.empty-u

@@ -0,0 +1,7 @@
+--- test/fixtures/four_lines	2025-01-31 12:13:45.476036544 +0100
++++ test/fixtures/empty	2025-01-31 12:14:52.856031635 +0100
+@@ -1,4 +0,0 @@
+-one
+-two
+-three
+-four

data/test/fixtures/ldiff/output.diff.issue95_trailing_context-c

@@ -0,0 +1,9 @@
+*** test/fixtures/123_x	2025-01-31 17:00:17.070615716 +0100
+--- test/fixtures/456_x	2025-01-31 16:58:26.380624827 +0100
+***************
+*** 1,2 ****
+! 123
+  x
+--- 1,2 ----
+! 456
+  x

data/test/fixtures/ldiff/output.diff.issue95_trailing_context-u

@@ -0,0 +1,6 @@
+--- test/fixtures/123_x	2025-01-31 17:00:17.070615716 +0100
++++ test/fixtures/456_x	2025-01-31 16:58:26.380624827 +0100
+@@ -1,2 +1,2 @@
+-123
++456
+ x

data/{spec → test}/fixtures/ldiff/output.diff.missing_new_line1-c

@@ -1,5 +1,5 @@
-*** spec/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
---- spec/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
+*** test/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
+--- test/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
 ***************
 *** 1,4 ****
   one

data/test/fixtures/ldiff/output.diff.missing_new_line1-u

@@ -0,0 +1,9 @@
+--- test/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
++++ test/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
+@@ -1,4 +1,4 @@
+ one
+ two
+ three
+-four
++four
+

data/{spec → test}/fixtures/ldiff/output.diff.missing_new_line2-c

@@ -1,5 +1,5 @@
-*** spec/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
---- spec/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
+*** test/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
+--- test/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
 ***************
 *** 1,4 ****
   one

data/test/fixtures/ldiff/output.diff.missing_new_line2-u

@@ -0,0 +1,9 @@
+--- test/fixtures/four_lines_with_missing_new_line	2025-01-31 12:17:43.926013315 +0100
++++ test/fixtures/four_lines	2025-01-31 12:17:43.926013315 +0100
+@@ -1,4 +1,4 @@
+ one
+ two
+ three
+-four
+
++four

data/test/test_block.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+require "diff/lcs/block"
+
+class TestBlock < Minitest::Test
+  include Diff::LCS::TestHelper
+
+  def test_op_unchanged
+    block = Diff::LCS::Block.from_chunk([])
+    assert_equal "^", block.op
+  end
+
+  def test_op_delete
+    changes = [Diff::LCS::Change.new("-", 0, "a")]
+    block = Diff::LCS::Block.from_chunk(changes)
+    assert_equal "-", block.op
+  end
+
+  def test_op_insert
+    changes = [Diff::LCS::Change.new("+", 0, "a")]
+    block = Diff::LCS::Block.from_chunk(changes)
+    assert_equal "+", block.op
+  end
+
+  def test_op_conflict
+    changes = [
+      Diff::LCS::Change.new("-", 0, "a"),
+      Diff::LCS::Change.new("+", 0, "b")
+    ]
+    block = Diff::LCS::Block.from_chunk(changes)
+    assert_equal "!", block.op
+  end
+end

data/test/test_change.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class TestChange < Minitest::Test
+  def test_invalid_change
+    assert_raises RuntimeError, /Invalid CHange Action/ do
+      change("~", 0, "element")
+    end
+
+    assert_raises RuntimeError, /Invalid Position Type/ do
+      change("+", 3.5, "element")
+    end
+  end
+
+  def test_from_a
+    assert_kind_of Diff::LCS::Change, change_from_a(["+", 0, "element"])
+    assert_kind_of Diff::LCS::Change, change_from_a(["+", 0, "element"], Diff::LCS::ContextChange)
+    assert_kind_of Diff::LCS::ContextChange,
+      change_from_a(["!", [1, "old_element"], [2, "new_element"]])
+    assert_kind_of Diff::LCS::ContextChange,
+      change_from_a(["!", [1, "old_element"], [2, "new_element"]], Diff::LCS::ContextChange)
+
+    assert_raises RuntimeError, "Invalid change array format provided." do
+      change_from_a(["+", 0])
+    end
+
+    assert_raises RuntimeError, "Invalid change array format provided." do
+      change_from_a(["+", 0], Diff::LCS::ContextChange)
+    end
+  end
+
+  def test_spaceship_reflexive
+    c1 = change("=", 5, "x")
+    c2 = change("=", 5, "x")
+    assert_equal 0, c1 <=> c2
+  end
+
+  def test_spaceship_position_precedence
+    c1 = change("=", 5, "x")
+    c2 = change("=", 10, "x")
+
+    assert_equal(-1, c1 <=> c2)
+    assert_equal 1, c2 <=> c1
+  end
+
+  def test_spaceship_action_precedence
+    valid_actions.each_cons(2) do |a1, a2|
+      c1 = change(a1, 5, "x")
+      c2 = change(a2, 5, "x")
+
+      assert_equal(-1, c1 <=> c2, "#{a1} should sort before #{a2}")
+      assert_equal 1, c2 <=> c1
+    end
+  end
+
+  def test_spaceship_element_precedence
+    c1 = change("=", 5, "a")
+    c2 = change("=", 5, "z")
+
+    assert_equal(-1, c1 <=> c2)
+    assert_equal 1, c2 <=> c1
+    assert_equal 0, c1 <=> change("=", 5, "a")
+  end
+
+  def test_add
+    change = change("+", 0, "element")
+
+    assert change.adding?
+
+    refute change.deleting?
+    refute change.unchanged?
+    refute change.changed?
+    refute change.finished_a?
+    refute change.finished_b?
+  end
+
+  def test_delete
+    change = change("-", 0, "element")
+
+    assert change.deleting?
+
+    refute change.adding?
+    refute change.unchanged?
+    refute change.changed?
+    refute change.finished_a?
+    refute change.finished_b?
+  end
+
+  def test_unchanged
+    change = change("=", 0, "element")
+
+    assert change.unchanged?
+
+    refute change.deleting?
+    refute change.adding?
+    refute change.changed?
+    refute change.finished_a?
+    refute change.finished_b?
+  end
+
+  def test_changed
+    change = change("!", 0, "element")
+
+    assert change.changed?
+
+    refute change.deleting?
+    refute change.adding?
+    refute change.unchanged?
+    refute change.finished_a?
+    refute change.finished_b?
+  end
+
+  def test_finished_a
+    change = change(">", 0, "element")
+
+    assert change.finished_a?
+
+    refute change.deleting?
+    refute change.adding?
+    refute change.unchanged?
+    refute change.changed?
+    refute change.finished_b?
+  end
+
+  def test_finished_b
+    change = change("<", 0, "element")
+
+    assert change.finished_b?
+
+    refute change.deleting?
+    refute change.adding?
+    refute change.unchanged?
+    refute change.changed?
+    refute change.finished_a?
+  end
+
+  def test_as_array
+    action, position, element = change("!", 0, "element")
+    assert_equal "!", action
+    assert_equal 0, position
+    assert_equal "element", element
+  end
+end
+
+class TestContextChange < Minitest::Test
+  private def change(...) = Diff::LCS::ContextChange.new(...)
+  private def simplify(...) = Diff::LCS::ContextChange.simplify(change(...))
+
+  def test_invalid_change
+    assert_raises RuntimeError, /Invalid CHange Action/ do
+      change("~", 0, "old", 0, "new")
+    end
+
+    assert_raises RuntimeError, /Invalid Position Type/ do
+      change("+", 3.5, "old", 0, "new")
+    end
+
+    assert_raises RuntimeError, /Invalid Position Type/ do
+      change("+", 0, "old", 3.5, "new")
+    end
+  end
+
+  def test_as_array
+    action, old, new = change("!", 1, "old_element", 2, "new_element")
+
+    assert_equal "!", action
+    assert_equal [1, "old_element"], old
+    assert_equal [2, "new_element"], new
+  end
+
+  def test_spaceship_reflexive
+    c1 = change("=", 5, "x", 10, "y")
+    c2 = change("=", 5, "x", 10, "y")
+    assert_equal 0, c1 <=> c2
+  end
+
+  def test_spaceship_position_precedence
+    c1 = change("=", 5, "x", 10, "y")
+    c2 = change("=", 15, "x", 10, "y")
+
+    assert_equal(-1, c1 <=> c2)
+    assert_equal 1, c2 <=> c1
+
+    c1 = change("=", 5, "x", 10, "y")
+    c2 = change("=", 5, "x", 20, "y")
+
+    assert_equal(-1, c1 <=> c2)
+    assert_equal 1, c2 <=> c1
+  end
+
+  def test_spaceship_action_precedence
+    valid_actions.each_cons(2) do |a1, a2|
+      c1 = change(a1, 5, "x", 10, "y")
+      c2 = change(a2, 5, "x", 10, "y")
+
+      assert_equal(-1, c1 <=> c2, "#{a1} should sort before #{a2}")
+      assert_equal 1, c2 <=> c1
+    end
+  end
+
+  def test_spaceship_element_precedence
+    c1 = change("=", 5, "a", 10, "y")
+    c2 = change("=", 5, "z", 10, "y")
+
+    assert_equal(-1, c1 <=> c2, "old_element precedence")
+    assert_equal 1, c2 <=> c1
+
+    c3 = change("=", 5, "x", 10, "a")
+    c4 = change("=", 5, "x", 10, "z")
+
+    assert_equal(-1, c3 <=> c4, "new_element precedence")
+    assert_equal 1, c4 <=> c3
+    assert_equal 0, c3 <=> Diff::LCS::ContextChange.new("=", 5, "x", 10, "a")
+  end
+
+  def test_simplify
+    simplify("-", 5, "old", 10, "new") => {action:, new_element:}
+    assert_equal action, "-"
+    assert_nil new_element
+
+    simplify("<", 5, "old", 10, "new") => {action:, new_element:}
+    assert_equal action, "-"
+    assert_nil new_element
+
+    simplify("+", 5, "old", 10, "new") => {action:, old_element:}
+    assert_equal action, "+"
+    assert_nil old_element
+
+    simplify(">", 5, "old", 10, "new") => {action:, old_element:}
+    assert_equal action, "+"
+    assert_nil old_element
+  end
+end

data/test/test_diff.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "test_helper"
+
+class TestDiff < Minitest::Test
+  def test_correctly_diffs_seq1_to_seq2
+    assert_equal change_diff(correct_forward_diff), diff(seq1, seq2)
+  end
+
+  def test_correctly_diffs_seq2_to_seq1
+    assert_equal change_diff(correct_backward_diff), diff(seq2, seq1)
+  end
+
+  def test_correctly_diffs_against_empty_sequence_forward
+    correct_diff = [
+      [
+        ["-", 0, "abcd"],
+        ["-", 1, "efgh"],
+        ["-", 2, "ijkl"],
+        ["-", 3, "mnopqrstuvwxyz"]
+      ]
+    ]
+
+    assert_equal change_diff(correct_diff), diff(word_sequence, [])
+  end
+
+  def test_correctly_diffs_against_empty_sequence_backward
+    correct_diff = [
+      [
+        ["+", 0, "abcd"],
+        ["+", 1, "efgh"],
+        ["+", 2, "ijkl"],
+        ["+", 3, "mnopqrstuvwxyz"]
+      ]
+    ]
+
+    assert_equal change_diff(correct_diff), diff([], word_sequence)
+  end
+
+  def test_correctly_diffs_xx_and_xaxb
+    left = "xx"
+    right = "xaxb"
+    assert_equal right, patch(left, diff(left, right))
+  end
+
+  def test_returns_empty_diff_with_hello_hello
+    assert_empty diff(hello, hello)
+  end
+
+  def test_returns_empty_diff_with_hello_ary_hello_ary
+    assert_empty diff(hello_ary, hello_ary)
+  end
+end