ninja-differ 1.0.0

data/spec/differ_spec.rb

@@ -0,0 +1,512 @@
+require 'spec_helper'
+
+describe Differ do
+  describe '#format' do
+    before(:each) { Differ.format = nil }
+
+    it 'should return the last value it was set to' do
+      Differ.format = Differ::Format::HTML
+      expect(Differ.format).to eq(Differ::Format::HTML)
+    end
+
+    it 'should default to Differ::Format::Ascii' do
+      expect(Differ.format).to eq(Differ::Format::Ascii)
+    end
+  end
+
+  describe '#format=' do
+    it 'should call #format_for with the passed argument' do
+      expect(Differ).to receive(:format_for).with(:format).once
+      Differ.format = :format
+    end
+
+    it 'should raise an error on undefined behavior' do
+      expect {
+        Differ.format = 'threeve'
+      }.to raise_error('Unknown format type "threeve"')
+    end
+  end
+
+  describe '#format_for' do
+    before(:each) { Differ.format = nil }
+
+    it 'should store any callable passed to it' do
+      formatter = ->(c){ c.to_s }
+      expect(Differ.format_for(formatter)).to eq(formatter)
+    end
+
+    it 'should permit nil (default behavior)' do
+      expect(Differ.format_for(nil)).to eq(nil)
+    end
+
+    it 'should raise an error on undefined behavior' do
+      expect {
+        Differ.format_for('threeve')
+      }.to raise_error('Unknown format type "threeve"')
+    end
+
+    describe 'when passed a symbol' do
+      it 'should translate the symbol :ascii into Differ::Format::Ascii' do
+        expect(Differ.format_for(:ascii)).to eq(Differ::Format::Ascii)
+      end
+
+      it 'should translate the symbol :color into Differ::Format::Color' do
+        expect(Differ.format_for(:color)).to eq(Differ::Format::Color)
+      end
+
+      it 'should translate the symbol :html into Differ::Format::HTML' do
+        expect(Differ.format_for(:html)).to eq(Differ::Format::HTML)
+      end
+    end
+  end
+
+  describe '#diff_by_char' do
+    def diff_by_char
+      Differ.send(:diff_by_char, @to, @from)
+    end
+
+    before(:each) do
+      @to = @from = 'self'
+    end
+
+    it 'should hande no-change situations' do
+      @expected = diff('self')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle prepends' do
+      @to = "myself"
+      @expected = diff(+'my', 'self')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle appends' do
+      @to = 'self-interest'
+      @expected = diff('self', +'-interest')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle leading deletes' do
+      @to = 'elf'
+      @expected = diff(-'s', 'elf')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle trailing deletes' do
+      @to = 'sel'
+      @expected = diff('sel', -'f')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle simultaneous leading changes' do
+      @to = 'wood-elf'
+      @expected = diff(('s' >> 'wood-'), 'elf')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle simultaneous trailing changes' do
+      @to = "seasoning"
+      @expected = diff('se', ('lf' >> 'asoning'))
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle full-string changes' do
+      @to = 'turgid'
+      @expected = diff('self' >> 'turgid')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle complex string additions' do
+      @to = 'my sleeplife'
+      @expected = diff(+'my ', 's', +'l', 'e', +'ep', 'l', +'i', 'f', +'e')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle complex string deletions' do
+      @from = 'my sleeplife'
+      @expected = diff(-'my ', 's', -'l', 'e', -'ep', 'l', -'i', 'f', -'e')
+      expect(diff_by_char).to eq(@expected)
+    end
+
+    it 'should handle complex string changes' do
+      @from = 'my sleeplife'
+      @to = 'seasonal'
+      @expected = diff(-'my ', 's', -'l', 'e', ('ep' >> 'asona'), 'l', -'ife')
+      expect(diff_by_char).to eq(@expected)
+    end
+  end
+
+  describe '#diff_by_word' do
+    def diff_by_word
+      Differ.send(:diff_by_word, @to, @from)
+    end
+
+    before(:each) do
+      @to = @from = 'the daylight will come'
+    end
+
+    it 'should hande no-change situations' do
+      @expected = diff('the daylight will come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle prepends' do
+      @to = "surely the daylight will come"
+      @expected = diff(+'surely ', 'the daylight will come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle appends' do
+      @to = 'the daylight will come in the morning'
+      @expected = diff('the daylight will come', +' in the morning')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle leading deletes' do
+      @to = 'daylight will come'
+      @expected = diff(-'the ', 'daylight will come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle trailing deletes' do
+      @to = 'the daylight'
+      @expected = diff('the daylight', -' will come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle simultaneous leading changes' do
+      @to = 'some daylight will come'
+      @expected = diff(('the' >> 'some'), ' daylight will come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle simultaneous trailing changes' do
+      @to = "the daylight will flood the room"
+      @expected = diff('the daylight will ', ('come' >> 'flood the room'))
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle full-string changes' do
+      @to = 'if we should expect it'
+      @expected = diff(
+        ('the' >> 'if'),
+        ' ',
+        ('daylight' >> 'we'),
+        ' ',
+        ('will' >> 'should'),
+        ' ',
+        ('come' >> 'expect it')
+      )
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle complex string additions' do
+      @to = 'the fresh daylight will surely come'
+      @expected = diff('the ', +'fresh ', 'daylight will ', +'surely ', 'come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle complex string deletions' do
+      @from = 'the fresh daylight will surely come'
+      @expected = diff('the ', -'fresh ', 'daylight will ', -'surely ', 'come')
+      expect(diff_by_word).to eq(@expected)
+    end
+
+    it 'should handle complex string changes' do
+      @from = 'the fresh daylight will surely come'
+      @to = 'something fresh will become surly'
+      @expected = diff(
+        ('the' >> 'something'),
+        ' fresh ',
+        -'daylight ',
+        'will ',
+        ( 'surely' >> 'become'),
+        ' ',
+        ( 'come' >> 'surly' )
+      )
+      expect(diff_by_word).to eq(@expected)
+    end
+  end
+
+  describe '#diff_by_line' do
+    def diff_by_line
+      Differ.send(:diff_by_line, @to, @from)
+    end
+
+    before(:each) do
+      @to = @from = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+      HAIKU
+    end
+
+    it 'should hande no-change situations' do
+      @expected = diff(@to)
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle prepends' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        A Haiku:
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+      HAIKU
+      @expected = diff(+"A Haiku:\n", @from)
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle appends' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+        -- http://everypoet.net
+      HAIKU
+      @expected = diff(@from, +"\n-- http://everypoet.net")
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle leading deletes' do
+      @from = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        A Haiku:
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+      HAIKU
+      @expected = diff(-"A Haiku:\n", @to)
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle trailing deletes' do
+      @from = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+        -- http://everypoet.net
+      HAIKU
+      @expected = diff(@to, -"\n-- http://everypoet.net")
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle simultaneous leading changes' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sings gently
+        slowly, sleeplessly
+        following harp flails
+      HAIKU
+      @expected = diff(
+        ('stallion sinks gently' >> 'stallion sings gently'),
+        "\nslowly, sleeplessly" <<
+        "\nfollowing harp flails"
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle simultaneous trailing changes' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, sleeplessly
+        drifting ever on
+      HAIKU
+      @expected = diff(
+        "stallion sinks gently\n" <<
+        "slowly, sleeplessly\n",
+        ('following harp flails' >> 'drifting ever on')
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle full-string changes' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        glumly inert coals
+        slumber lazily, shoulda
+        used more Burma Shave
+      HAIKU
+      @expected = diff(@from >> @to)
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle complex string additions' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        A Haiku, with annotation:
+        stallion sinks gently
+        slowly, sleeplessly
+        (flailing)
+        following harp flails
+        -- modified from source
+      HAIKU
+      @expected = diff(
+        +"A Haiku, with annotation:\n",
+        "stallion sinks gently\n" <<
+        "slowly, sleeplessly\n",
+        +"(flailing)\n",
+        'following harp flails',
+        +"\n-- modified from source"
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle complex string deletions' do
+      @from = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        A Haiku, with annotation:
+        stallion sinks gently
+        slowly, sleeplessly
+        (flailing)
+        following harp flails
+        -- modified from source
+      HAIKU
+      @expected = diff(
+        -"A Haiku, with annotation:\n",
+        "stallion sinks gently\n" <<
+        "slowly, sleeplessly\n",
+        -"(flailing)\n",
+        'following harp flails',
+        -"\n-- modified from source"
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+
+    it 'should handle complex string changes' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sings gently
+        slowly, sleeplessly
+        (flailing)
+        following harp flails
+        -- modified from source
+      HAIKU
+      @expected = diff(
+        ('stallion sinks gently' >> 'stallion sings gently'),
+        "\nslowly, sleeplessly\n",
+        +"(flailing)\n",
+        'following harp flails',
+        +"\n-- modified from source"
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+  end
+
+  describe '#diff (with arbitrary boundary)' do
+    def diff_by_comma
+      Differ.send(:diff, @to, @from, ', ')
+    end
+
+    before(:each) do
+      @to = @from = 'alteration, asymmetry, a deviation'
+    end
+
+    it 'should hande no-change situations' do
+      @expected = diff('alteration, asymmetry, a deviation')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle prepends' do
+      @to = "aberration, alteration, asymmetry, a deviation"
+      @expected = diff(+'aberration, ', 'alteration, asymmetry, a deviation')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle appends' do
+      @to = "alteration, asymmetry, a deviation, change"
+      @expected = diff('alteration, asymmetry, a deviation', +', change')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle leading deletes' do
+      @to = 'asymmetry, a deviation'
+      @expected = diff(-'alteration, ', 'asymmetry, a deviation')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle trailing deletes' do
+      @to = 'alteration, asymmetry'
+      @expected = diff('alteration, asymmetry', -', a deviation')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle simultaneous leading changes' do
+      @to = 'aberration, asymmetry, a deviation'
+      @expected = diff(('alteration' >> 'aberration'), ', asymmetry, a deviation')
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle simultaneous trailing changes' do
+      @to = 'alteration, asymmetry, change'
+      @expected = diff('alteration, asymmetry, ', ('a deviation' >> 'change'))
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle full-string changes' do
+      @to = 'uniformity, unison, unity'
+      @expected = diff(@from >> @to)
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle complex string additions' do
+      @to = 'aberration, alteration, anomaly, asymmetry, a deviation, change'
+      @expected = diff(
+        +'aberration, ',
+        'alteration, ',
+        +'anomaly, ',
+        'asymmetry, a deviation',
+        +', change'
+      )
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle complex string deletions' do
+      @from = 'aberration, alteration, anomaly, asymmetry, a deviation, change'
+      @expected = diff(
+        -'aberration, ',
+        'alteration, ',
+        -'anomaly, ',
+        'asymmetry, a deviation',
+        -', change'
+      )
+      expect(diff_by_comma).to eq(@expected)
+    end
+
+    it 'should handle complex string changes' do
+      @from = 'a, d, g, gh, x'
+      @to = 'a, b, c, d, e, f, g, h, i, j'
+      @expected = diff(
+        'a, ',
+        +'b, c, ',
+        'd, ',
+        +'e, f, ',
+        'g, ',
+        ('gh, x' >> 'h, i, j')
+      )
+      expect(diff_by_comma).to eq(@expected)
+    end
+  end
+
+  describe '#diff (with implied boundary)' do
+    def diff_by_line
+      Differ.send(:diff, @to, @from)
+    end
+
+    before(:each) do
+      @to = @from = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, sleeplessly
+        following harp flails
+      HAIKU
+    end
+
+    it 'should do diffs by line' do
+      @to = <<-HAIKU.gsub(/  +|\n\Z/, '')
+        stallion sinks gently
+        slowly, restlessly
+        following harp flails
+      HAIKU
+      @expected = diff(
+        "stallion sinks gently\n",
+        ('slowly, sleeplessly' >> 'slowly, restlessly'),
+        "\nfollowing harp flails"
+      )
+      expect(diff_by_line).to eq(@expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'differ'
+
+RSpec.configure do |config|
+  # config.order            = 'random'
+  # config.profile_examples = 3
+end
+
+def diff(*parts)
+  x = Differ::Diff.new
+  x.instance_variable_set(:@raw, parts)
+  return x
+end
+
+class String
+  def +@
+    Differ::Change.new(:insert => self)
+  end
+
+  # this breaks rspec currently
+  # undefined method `call' for nil:NilClass
+  # def -@
+  #   Differ::Change.new(:delete => self)
+  # end
+
+  def >>(to)
+    Differ::Change.new(:delete => self, :insert => to)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ninja-differ
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Frank Koehl
+- Pieter van de Bruggen
+- Jonas Schubert Erlandsson
+- Eddie Cianci
+- Chad Boyd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-26 00:00:00.000000000 Z
+dependencies: []
+description: A simple gem for generating string diffs
+email:
+- fkoehl@gmail.com
+- pvande@gmail.com
+- jonas.schubert.erlandsson@my-codeworks.com
+- chad@txt2give.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- Vagrantfile
+- differ.gemspec
+- lib/differ.rb
+- lib/differ/change.rb
+- lib/differ/diff.rb
+- lib/differ/format/ascii.rb
+- lib/differ/format/color.rb
+- lib/differ/format/html.rb
+- lib/differ/format/patch.rb
+- lib/differ/string.rb
+- lib/differ/version.rb
+- provision.sh
+- spec/differ/change_spec.rb
+- spec/differ/diff_spec.rb
+- spec/differ/format/ascii_spec.rb
+- spec/differ/format/color_spec.rb
+- spec/differ/format/html_spec.rb
+- spec/differ/format/patch_spec.rb
+- spec/differ/string_spec.rb
+- spec/differ_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BattleBrisket/ninja-differ
+licenses:
+- MIT
+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: []
+rubygems_version: 3.3.24
+signing_key: 
+specification_version: 4
+summary: A simple gem for generating string diffs
+test_files:
+- spec/differ/change_spec.rb
+- spec/differ/diff_spec.rb
+- spec/differ/format/ascii_spec.rb
+- spec/differ/format/color_spec.rb
+- spec/differ/format/html_spec.rb
+- spec/differ/format/patch_spec.rb
+- spec/differ/string_spec.rb
+- spec/differ_spec.rb
+- spec/spec_helper.rb