simplediff-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 828b2453c0f2dc00a611c3db384401a97f743e42
+  data.tar.gz: 4ad216cdfefe86ded7e46bde4d6050f9b703800d
+SHA512:
+  metadata.gz: e392f127f0e96620191b8d6263bea380a2e591bc1b419f0c5093feba24e209266a6841d507d1efa7070db05f67825a21a9c998a8eb01d33495636368fbbce473
+  data.tar.gz: 6dd464e0bb9235dd66a0ba4ca787ac1b783d87f4a170e17a4a01fa83a6754f907d521e86848edbd791ba5022ce775d3effb70d0db261a289722bbbae78c62825

data/README.md

@@ -0,0 +1,39 @@
+
+SimpleDiff Ruby 1.0
+==============
+
+**simplediff-ruby** is a Ruby gem implementation of the [simplediff](https://github.com/paulgb/simplediff) algorithm. It finds the difference between two arrays of strings, numbers, hashes, or arrays.
+
+Use
+----
+
+`require` the gem to expose the `SimpleDiff` class.
+
+    require "simplediff-ruby"
+
+Then call `SimpleDiff.compare` to find the diffs.
+
+    source = ['The', 'quick', 'brown', 'fox']
+    target = ['The', 'slow', 'green', 'turtle']
+    SimpleDiff.compare(source, target)
+
+The output will be an array of hashes representing the differences between the compared arrays.
+
+    [
+      { change: '=', content: ['The'] },
+      { change: '-', content: ['quick', 'brown', 'fox'] },
+      { change: '+', content: ['slow', 'green', 'turtle'] }
+    ]
+
+Test
+----
+
+Use `ruby test/test.rb` to run the test cases.
+
+    $ ruby test/test.rb
+
+License
+-------
+
+SimpleDiff Ruby is available under a zlib/libpng
+license. See the provided `LICENSE` file for more details.

data/lib/simplediff-ruby.rb

@@ -0,0 +1,63 @@
+class SimpleDiff
+  # Diffing algorithm taken from - https://github.com/paulgb/simplediff
+  def self.compare(source, target)
+    source ||= []
+    target ||= []
+    max = si_start = ti_start = 0
+
+    source_matches = Hash.new { |h, k| h[k] = [] }
+    source.each_with_index { |el, i| source_matches[el] << i }
+
+    subsequences = Hash.new { |k, v| k[v] = 0 }
+
+    target.each_with_index do |el, ti|
+      # Generate a new hash to use for the current iteration
+      _subsequences = Hash.new { |k, v| k[v] = 0 }
+
+      # This will return an array of indices that represent the positions
+      # of tokens
+      # in the source list that match the current token in the target list
+      source_matches[el].each do |si|
+        # This sets the current subsequence hash to have the length of any
+        # subsequence found at a the current source index (si) - 1. This is how
+        # subsequence lengths are tracked.
+        #
+        # If that length is greater than the current max the indexes where the
+        # sequence is found are persisted
+        if (_subsequences[si] = subsequences[si - 1] + 1) > max
+          max = _subsequences[si]
+          si_start = si - max + 1
+          ti_start = ti - max + 1
+        end
+      end
+
+      # Assign the current subsequence hash to the previous one so it can be passed
+      # into the next iteration.
+      subsequences = _subsequences
+    end
+
+    if max > 0
+      # If the max is greater than 0 a subsequence must have been found. This marks
+      # the sequence as being the same in both the source and the target. It then
+      # recursively looks at either side of the source and target list to try and
+      # find more subsequences.
+      start = [source[0...si_start], target[0...ti_start]]
+      middle = [
+        { change: '=', content: target[ti_start...(ti_start + max)] }
+      ]
+      finish = [
+        source[(si_start + max)..-1],
+        target[(ti_start + max)..-1]
+      ]
+
+      compare(*start) + middle + compare(*finish)
+    else
+      # If no subsequence is found then anything in the source list must be a
+      # removal and anything in the target must be an addition.
+      [].tap do |changes|
+        changes << { change: '-', content: source } if !source.empty?
+        changes << { change: '+', content: target } if !target.empty?
+      end
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,125 @@
+require_relative "../lib/simplediff-ruby"
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new)
+class SimpleDiffTest < MiniTest::Test
+  test_cases = {
+    insertions: [
+      {
+        source: [1, 3, 4],
+        target: [1, 2, 3, 4],
+        diff: [
+          {change: '=', content: [1]},
+          {change: '+', content: [2]},
+          {change: '=', content: [3, 4]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 8, 9, 12, 13],
+        target: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15],
+        diff: [
+          {change: '=', content: [1, 2, 3]},
+          {change: '+', content: [4, 5, 6, 7]},
+          {change: '=', content: [8, 9]},
+          {change: '+', content: [10, 11]},
+          {change: '=', content: [12, 13]},
+          {change: '+', content: [14, 15]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 4, 5],
+        target: [1, 2, 2, 3, 4, 5],
+        diff: [
+          {change: '=', content: [1]},
+          {change: '+', content: [2]},
+          {change: '=', content: [2, 3, 4, 5]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 4, 5],
+        target: [1, 2, 2, 3, 4, 4, 5],
+        diff: [
+          {change: '=', content: [1]},
+          {change: '+', content: [2]},
+          {change: '=', content: [2, 3, 4]},
+          {change: '+', content: [4]},
+          {change: '=', content: [5]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 4, 5],
+        target: [1, 2, 1, 2, 3, 3, 2, 1, 4, 5],
+        diff: [
+          {change: '+', content: [1, 2]},
+          {change: '=',content:  [1, 2, 3]},
+          {change: '+', content: [3, 2, 1]},
+          {change: '=',content:  [4, 5]}
+        ]
+      }
+    ],
+    deletions: [
+      {
+        source: [1, 2, 3, 4, 5],
+        target: [1, 2, 5],
+        diff: [
+          {change: '=', content: [1, 2]},
+          {change: '-', content: [3, 4]},
+          {change: '=', content: [5]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 4, 5, 6, 7, 8],
+        target: [3, 6, 7],
+        diff: [
+          {change: '-', content: [1, 2]},
+          {change: '=', content: [3]},
+          {change: '-', content: [4, 5]},
+          {change: '=', content: [6, 7]},
+          {change: '-', content: [8]}
+        ]
+      },
+      {
+        source: [1, 2, 3, 4, 5, 1, 2, 3, 4, 5],
+        target: [1, 2, 3, 4, 5],
+        diff: [
+          {change: '=', content: [1, 2, 3, 4, 5]},
+          {change: '-', content: [1, 2, 3, 4, 5]}
+        ]
+      }
+    ],
+    changes: [
+      {
+        source: ['The', 'quick', 'brown', 'fox'],
+        target: ['The', 'slow', 'green', 'turtle'],
+        diff: [
+          {change: '=', content: ['The']},
+          {change: '-', content: ['quick', 'brown', 'fox']},
+          {change: '+', content: ['slow', 'green', 'turtle']}
+        ]
+      },
+      {
+        source: ['jumps', 'over', 'the', 'lazy', 'dog'],
+        target: ['walks', 'around', 'the', 'orange', 'cat'],
+        diff: [
+          {change: '-', content: ['jumps', 'over']},
+          {change: '+', content: ['walks', 'around']},
+          {change: '=', content: ['the']},
+          {change: '-', content: ['lazy', 'dog']},
+          {change: '+', content: ['orange', 'cat']}
+        ]
+      }
+    ]
+  }
+
+  test_cases.each do |key, cases|
+    cases.each do |test_case|
+      define_method("test_#{key}_#{test_case[:source]}-#{test_case[:target]}".to_sym) do
+        assert_equal(
+          test_case[:diff],
+          SimpleDiff.compare(test_case[:source], test_case[:target])
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: simplediff-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- albertldlan
+- JaredShay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby implemention of https://github.com/paulgb/simplediff.
+email:
+- albertldlan@gmail.com
+- Jared.Shay@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/simplediff-ruby.rb
+- test/test.rb
+homepage: https://github.com/albertldlan/simplediff-ruby
+licenses:
+- zlib-acknowledgement
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby implemention of https://github.com/paulgb/simplediff.
+test_files:
+- test/test.rb