ninja-differ 1.0.0

data/provision.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+# Shell user settings.
+USER_NAME=vagrant
+USER_HOME=/home/$USER_NAME
+DEFAULT_RUBY='3.1.2'
+
+###############################################################################
+# Functions
+###############################################################################
+# Most of the time we can get by with this DRY wrapper for sudo commands.
+as_user() {
+  echo "$USER_NAME:~$ > ${*}"
+  su -l $USER_NAME -c "$*"
+}
+
+###############################################################################
+# Base System
+###############################################################################
+apt-get -y update
+apt-get -yfV dist-upgrade
+
+###############################################################################
+# rbenv & ruby-build, and Rubies
+# From https://github.com/sstephenson/rbenv
+# and https://github.com/sstephenson/ruby-build
+###############################################################################
+
+# Install dependencies.
+apt-get install -yfV         \
+  build-essential            \
+  curl                       \
+  git-core                   \
+  libcurl4-openssl-dev       \
+  libreadline-dev            \
+  libsqlite3-dev             \
+  libssl-dev                 \
+  libxml2-dev                \
+  libxslt1-dev               \
+  libyaml-dev                \
+  software-properties-common \
+  sqlite3                    \
+  zlib1g-dev                 \
+  autoconf                   \
+  bison                      \
+  libreadline6-dev           \
+  libncurses5-dev            \
+  libffi-dev                 \
+  libgdbm6                   \
+  libgdbm-dev                \
+  libdb-dev                  \
+  libgmp-dev                 \
+  patch                      \
+  rustc                      \
+  uuid-dev
+
+# Install rbenv and ruby-build.
+as_user "git clone https://github.com/sstephenson/rbenv.git $USER_HOME/.rbenv"
+as_user "git clone https://github.com/sstephenson/ruby-build.git $USER_HOME/.rbenv/plugins/ruby-build"
+
+# Setup bash to use rbenv for $USER_NAME.
+truncate -s 0 $USER_HOME/.bashrc
+echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> $USER_HOME/.bashrc
+echo 'eval "$(rbenv init -)"'               >> $USER_HOME/.bashrc
+echo 'cd /vagrant'                          >> $USER_HOME/.bashrc
+
+as_user "mkdir ~/.gem"
+echo 'gem: --no-document' > $USER_HOME/.gemrc
+
+# Install the requested version of Ruby, with Bundler.
+as_user "rbenv install -s $DEFAULT_RUBY"
+as_user "rbenv global $DEFAULT_RUBY"
+as_user "RBENV_VERSION=$DEFAULT_RUBY gem install bundler"
+as_user "cd /vagrant && bundle"

data/spec/differ/change_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Differ::Change do
+  before(:each) do
+    @format = Module.new { def self.call(c); end }
+    Differ.format = @format
+  end
+
+  describe '(empty)' do
+    before(:each) do
+      @change = Differ::Change.new()
+    end
+
+    it 'should have a default insert' do
+      expect(@change.insert).to eq('')
+    end
+
+    it 'should have a default delete' do
+      expect(@change.delete).to eq('')
+    end
+
+    it 'should stringify to ""' do
+      expect(@format).to receive(:call).once.and_return('')
+      expect(@change.to_s).to eq('')
+    end
+  end
+
+  describe '(insert only)' do
+    before(:each) do
+      @change = Differ::Change.new(:insert => 'foo')
+    end
+
+    it 'should populate the :insert parameter' do
+      expect(@change.insert).to eq('foo')
+    end
+
+    it 'should have a default delete' do
+      expect(@change.delete).to eq('')
+    end
+
+    it { expect(@change).to be_an_insert }
+  end
+
+  describe '(delete only)' do
+    before(:each) do
+      @change = Differ::Change.new(:delete => 'bar')
+    end
+
+    it 'should have a default :insert' do
+      expect(@change.insert).to eq('')
+    end
+
+    it 'should populate the :delete parameter' do
+      expect(@change.delete).to eq('bar')
+    end
+
+    it { expect(@change).to be_a_delete }
+  end
+
+  describe '(both insert and delete)' do
+    before(:each) do
+      @change = Differ::Change.new(:insert => 'foo', :delete => 'bar')
+    end
+
+    it 'should populate the :insert parameter' do
+      expect(@change.insert).to eq('foo')
+    end
+
+    it 'should populate the :delete parameter' do
+      expect(@change.delete).to eq('bar')
+    end
+
+    it { expect(@change).to be_an_insert }
+    it { expect(@change).to be_a_delete }
+    it { expect(@change).to be_a_change }
+  end
+
+  it "should stringify via the current format's #format method" do
+    expect(@format).to receive(:call).once
+    Differ::Change.new.to_s
+  end
+end

data/spec/differ/diff_spec.rb

@@ -0,0 +1,298 @@
+require 'spec_helper'
+
+describe Differ::Diff do
+  before(:each) do
+    Differ.separator = nil
+    @diff = Differ::Diff.new
+  end
+
+  describe '#to_s' do
+    before(:each) do
+      @format = Differ.format
+    end
+
+    it 'should concatenate the result list' do
+      expect(diff('a', 'b', 'c').to_s).to eq('abc')
+    end
+
+    it 'should concatenate without regard for the Differ.separator' do
+      Differ.separator = '*'
+      expect(diff('a', 'b', 'c').to_s).to eq('abc')
+    end
+
+    it 'should delegate insertion changes to Differ#format' do
+      i = +'b'
+      expect(@format).to receive(:call).once.with(i).and_return('!')
+      expect(diff('a', i, 'c').to_s).to eq('a!c')
+    end
+  end
+
+  describe '#format_as' do
+    before(:each) do
+      @change = +'b'
+      Differ.format = Module.new { def self.call(c); raise :error; end }
+      @format = Module.new { def self.call(c); end }
+    end
+
+    it 'should delegate change formatting to the given format' do
+      expect(@format).to receive(:call).once.with(@change).and_return('!')
+      expect(diff('a', @change, 'c').format_as(@format)).to eq('a!c')
+    end
+
+    it 'should use Differ#format_for to grab the correct format' do
+      expect(Differ).to receive(:format_for).once.with(@format)
+      diff().format_as(@format)
+    end
+  end
+
+  describe '#same' do
+    it 'should append to the result list' do
+      @diff.same('c')
+      expect(@diff).to eq(diff('c'))
+    end
+
+    it 'should concatenate its arguments' do
+      @diff.same('a', 'b', 'c', 'd')
+      expect(@diff).to eq(diff('abcd'))
+    end
+
+    it 'should join its arguments with Differ.separator' do
+      Differ.separator = '*'
+      @diff.same(*'a*b*c*d'.split)
+      expect(@diff).to eq(diff('a*b*c*d'))
+    end
+
+    describe 'when the last result was a String' do
+      before(:each) do
+        @diff = diff('a')
+      end
+
+      it 'should append to the last result' do
+        @diff.same('b')
+        expect(@diff).to eq(diff('ab'))
+      end
+
+      it 'should join to the last result with Differ.separator' do
+        Differ.separator = '*'
+        @diff.same('b')
+        expect(@diff).to eq(diff('a*b'))
+      end
+    end
+
+    describe 'when the last result was a change' do
+      before(:each) do
+        @diff = diff('z' >> 'd')
+      end
+
+      it 'should append to the result list' do
+        @diff.same('a')
+        expect(@diff).to eq(diff(('z' >> 'd'), 'a'))
+      end
+
+      it 'should prepend Differ.separator to the result' do
+        Differ.separator = '*'
+        @diff.same('a')
+        expect(@diff).to eq(diff(('z' >> 'd'), '*a'))
+      end
+
+      it "should do nothing to a leading Differ.separator on the insert" do
+        @diff = diff('a', ('*-' >> '*+'))
+        Differ.separator = '*'
+        @diff.same('c')
+        expect(@diff).to eq(diff('a', ('*-' >> '*+'), '*c'))
+      end
+    end
+
+    describe 'when the last result was just a delete' do
+      before(:each) do
+        @diff = diff(-'z')
+      end
+
+      it 'should append to the result list' do
+        @diff.same('a')
+        expect(@diff).to eq(diff(Differ::Change.new(:delete => 'z'), 'a'))
+      end
+
+      it 'should append Differ.separator to the previous result' do
+        Differ.separator = '*'
+        @diff.same('a')
+        expect(@diff).to eq(diff(Differ::Change.new(:delete => 'z*'), 'a'))
+      end
+
+      it "should relocate a leading Differ.separator on the delete to the previous item" do
+        @diff = diff('a', -'*b')
+        Differ.separator = '*'
+        @diff.same('c')
+        expect(@diff).to eq(diff('a*', -'b*', 'c'))
+      end
+    end
+
+    describe 'when the last result was just an insert' do
+      before(:each) do
+        @diff = diff(+'z')
+      end
+
+      it 'should append to the result list' do
+        @diff.same('a')
+        expect(@diff).to eq(diff(+'z', 'a'))
+      end
+
+      it 'should append Differ.separator to the previous result' do
+        Differ.separator = '*'
+        @diff.same('a')
+        expect(@diff).to eq(diff(+'z*', 'a'))
+      end
+
+      it "should relocate a leading Differ.separator on the insert to the previous item" do
+        @diff = diff('a', +'*b')
+        Differ.separator = '*'
+        @diff.same('c')
+        expect(@diff).to eq(diff('a*', +'b*', 'c'))
+      end
+    end
+  end
+
+  describe '#delete' do
+    it 'should append to the result list' do
+      @diff.delete('c')
+      expect(@diff).to eq(diff(-'c'))
+    end
+
+    it 'should concatenate its arguments' do
+      @diff.delete('a', 'b', 'c', 'd')
+      expect(@diff).to eq(diff(-'abcd'))
+    end
+
+    it 'should join its arguments with Differ.separator' do
+      Differ.separator = '*'
+      @diff.delete(*'a*b*c*d'.split)
+      expect(@diff).to eq(diff(-'a*b*c*d'))
+    end
+
+    describe 'when the last result was a Change' do
+      describe '(delete)' do
+        before(:each) do
+          @diff = diff(-'a')
+        end
+
+        it 'should append to the last result' do
+          @diff.delete('b')
+          expect(@diff).to eq(diff(-'ab'))
+        end
+
+        it 'should join to the last result with Differ.separator' do
+          Differ.separator = '*'
+          @diff.delete('b')
+          expect(@diff).to eq(diff(-'a*b'))
+        end
+      end
+
+      describe '(insert)' do
+        before(:each) do
+          @diff = diff(+'a')
+        end
+
+        it "should turn the insert into a change" do
+          @diff.delete('b')
+          expect(@diff).to eq(diff('b' >> 'a'))
+        end
+
+        it "should relocate a leading Differ.separator on the insert to the previous item" do
+          @diff = diff('a', +'*b')
+          Differ.separator = '*'
+          @diff.delete('z')
+          expect(@diff).to eq(diff('a*', ('z' >> 'b')))
+        end
+      end
+    end
+
+    describe 'when the last result was not a Change' do
+      before(:each) do
+        @diff = diff('a')
+      end
+
+      it 'should append a Change to the result list' do
+        @diff.delete('b')
+        expect(@diff).to eq(diff('a', -'b'))
+      end
+
+      it 'should prepend Differ.separator to the result' do
+        Differ.separator = '*'
+        @diff.delete('b')
+        expect(@diff).to eq(diff('a', -'*b'))
+      end
+    end
+  end
+
+  describe '#insert' do
+    it 'should append to the result list' do
+      @diff.insert('c')
+      expect(@diff).to eq(diff(+'c'))
+    end
+
+    it 'should concatenate its arguments' do
+      @diff.insert('a', 'b', 'c', 'd')
+      expect(@diff).to eq(diff(+'abcd'))
+    end
+
+    it 'should join its arguments with Differ.separator' do
+      Differ.separator = '*'
+      @diff.insert(*'a*b*c*d'.split)
+      expect(@diff).to eq(diff(+'a*b*c*d'))
+    end
+
+    describe 'when the last result was a Change' do
+      describe '(delete)' do
+        before(:each) do
+          @diff = diff(-'b')
+        end
+
+        it "should not change the 'insert' portion of the last result" do
+          @diff.insert('a')
+          expect(@diff).to eq(diff('b' >> 'a'))
+        end
+
+        it "should relocate a leading Differ.separator on the delete to the previous item" do
+          @diff = diff('a', -'*b')
+          Differ.separator = '*'
+          @diff.insert('z')
+          expect(@diff).to eq(diff('a*', ('b' >> 'z')))
+        end
+      end
+
+      describe '(insert)' do
+        before(:each) do
+          @diff = diff(+'a')
+        end
+
+        it 'should append to the last result' do
+          @diff.insert('b')
+          expect(@diff).to eq(diff(+'ab'))
+        end
+
+        it 'should join to the last result with Differ.separator' do
+          Differ.separator = '*'
+          @diff.insert('b')
+          expect(@diff).to eq(diff(+'a*b'))
+        end
+      end
+    end
+
+    describe 'when the last result was not a Change' do
+      before(:each) do
+        @diff = diff('a')
+      end
+
+      it 'should append a Change to the result list' do
+        @diff.insert('b')
+        expect(@diff).to eq(diff('a', +'b'))
+      end
+
+      it 'should prepend Differ.separator to the result' do
+        Differ.separator = '*'
+        @diff.insert('b')
+        expect(@diff).to eq(diff('a', +'*b'))
+      end
+    end
+  end
+end

data/spec/differ/format/ascii_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Differ::Format::Ascii do
+  it 'should format inserts well' do
+    @expected = '{+"SAMPLE"}'
+    expect(Differ::Format::Ascii.call(+'SAMPLE')).to eq(@expected)
+  end
+
+  it 'should format deletes well' do
+    @expected = '{-"SAMPLE"}'
+    expect(Differ::Format::Ascii.call(-'SAMPLE')).to eq(@expected)
+  end
+
+  it 'should format changes well' do
+    @expected = '{"THEN" >> "NOW"}'
+    expect(Differ::Format::Ascii.call('THEN' >> 'NOW')).to eq(@expected)
+  end
+end

data/spec/differ/format/color_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Differ::Format::Color do
+  it 'should format inserts well' do
+    @expected = "\033[32mSAMPLE\033[0m"
+    expect(Differ::Format::Color.call(Differ::Change.new(:insert => 'SAMPLE'))).to eq(@expected)
+  end
+
+  it 'should format deletes well' do
+    @expected = "\033[31mSAMPLE\033[0m"
+    expect(Differ::Format::Color.call(Differ::Change.new(:delete => 'SAMPLE'))).to eq(@expected)
+  end
+
+  it 'should format changes well' do
+    @expected = "\033[31mTHEN\033[0m\033[32mNOW\033[0m"
+    expect(Differ::Format::Color.call(Differ::Change.new(:delete => 'THEN', :insert => 'NOW'))).to eq(@expected)
+  end
+end

data/spec/differ/format/html_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Differ::Format::HTML do
+  it 'should format inserts well' do
+    @expected = '<ins class="differ">SAMPLE</ins>'
+    expect(Differ::Format::HTML.call(Differ::Change.new(:insert => 'SAMPLE'))).to eq(@expected)
+  end
+
+  it 'should format deletes well' do
+    @expected = '<del class="differ">SAMPLE</del>'
+    expect(Differ::Format::HTML.call(Differ::Change.new(:delete => 'SAMPLE'))).to eq(@expected)
+  end
+
+  it 'should format changes well' do
+    @expected = '<del class="differ">THEN</del><ins class="differ">NOW</ins>'
+    expect(Differ::Format::HTML.call(Differ::Change.new(:delete => 'THEN', :insert => 'NOW'))).to eq(@expected)
+  end
+end

data/spec/differ/format/patch_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Differ::Format::Patch do
+  it 'should format inserts well' do
+    @expected = "\033[32m+ SAMPLE\033[0m"
+    expect(Differ::Format::Patch.format(+'SAMPLE')).to eq(@expected)
+  end
+
+  it 'should format deletes well' do
+    @expected = "\033[31m- SAMPLE\033[0m"
+    expect(Differ::Format::Patch.format(-'SAMPLE')).to eq(@expected)
+  end
+
+  it 'should format changes well' do
+    @expected = "\033[31m- THEN\033[0m\n\033[32m+ NOW\033[0m"
+    expect(Differ::Format::Patch.format('THEN' >> 'NOW')).to eq(@expected)
+  end
+end

data/spec/differ/string_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'differ/string'
+
+describe Differ::StringDiffer do
+  it 'should be automatically mixed into String' do
+    expect(String.included_modules).to include(Differ::StringDiffer)
+  end
+
+  before(:each) do
+    Differ.separator = nil
+  end
+
+  describe '#diff' do
+    it 'should call Differ#diff' do
+      expect(Differ).to receive(:diff).with('TO', 'FROM', "\n").once
+      'TO'.diff('FROM')
+    end
+
+    it 'should call Differ#diff with Differ.separator' do
+      Differ.separator = 'x'
+      expect(Differ).to receive(:diff).with('TO', 'FROM', Differ.separator).once
+      'TO'.diff('FROM')
+    end
+  end
+
+  describe '#-' do
+    it 'should call Differ#diff' do
+      expect(Differ).to receive(:diff).with('TO', 'FROM', "\n").once
+      'TO' - 'FROM'
+    end
+
+    it 'should call Differ#diff with Differ.separator' do
+      Differ.separator = 'x'
+      expect(Differ).to receive(:diff).with('TO', 'FROM', Differ.separator).once
+      'TO' - 'FROM'
+    end
+  end
+  
+  describe '#diff_by_char' do
+    it 'should call Differ#diff' do
+      expect(Differ).to receive(:diff).with('Othellos', 'hello', '').once
+      'Othellos'.diff_by_char('hello')
+    end
+  end
+  
+  describe '#diff_by_word' do
+    it 'should call Differ#diff' do
+      expect(Differ).to receive(:diff).with('Othellos', 'hello', /\b/).once
+      'Othellos'.diff_by_word('hello')
+    end
+  end
+  
+  describe '#diff_by_line' do
+    it 'should call Differ#diff' do
+      expect(Differ).to receive(:diff).with('Othellos', 'hello', "\n").once
+      'Othellos'.diff_by_line('hello')
+    end
+  end
+end