ninja-differ 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b260977aada3497597330621cbb0babbcaf5f9f98cc06daeec34054d0a5e6994
+  data.tar.gz: 842d5b48dbc2f4dd0ce57fa67258a8aac1ba274f47a2b71e792aeaadfc69d393
+SHA512:
+  metadata.gz: 9c80cc3497778c90d1123b37b7ecc72a0c19022d09002585b97ff70a548996165c682d52043d9bcf6ad31e8cf649d113fb9876f1ec21f98b3367ac83738e6c16
+  data.tar.gz: ea948a01e9a87731c3b857b087fd2e8554cad23e05f5a2be682bc9b9391406cea94d5f3fe846ffa13a0d091c454a85da0ddbf10474053cc98afb405de3273810

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.vagrant

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rspec"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    ninja-differ (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  ninja-differ!
+  rspec
+
+BUNDLED WITH
+   2.3.24

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright © 2009 Pieter Vande Bruggen.
+Copyright © 2022 Frank Koehl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,149 @@
+# NinjaDiffer
+
+_NinjaDiffer was forked from [Differ](https://github.com/pvande/differ), by Pieter Vande Bruggen.
+This gem shares logical and grammatical namespace with Differ. You will see the
+names used interchangeably for a time. This is a full replacement for Differ,
+running both gems together is not recommended._
+
+> As streams of text swirled before the young man's eyes, his mind swam with thoughts of many things. They would have to wait, however, as he focussed his full concentration on the shifting patterns ahead of him. A glint of light reflecting off a piece of buried code caught his eye and any hope he had was lost. For the very moment he glanced aside, the landscape became Different.
+> The young man gave a small sigh and trudged onward in solemn resignation, fated to wander the desolate codebanks in perpetuity.
+
+NinjaDiffer is a flexible, pure-Ruby diff library, suitable for use in both command
+line scripts and web applications.  The flexibility comes from the fact that
+diffs can be built at completely arbitrary levels of granularity (some common
+ones are built-in), and can be output in a variety of formats.
+
+## Installation
+
+Add this to your gemfile if you use bundler
+
+```ruby
+gem 'ninja-differ'
+```
+
+and bundle to install
+
+```bash
+bundle install
+```
+
+or install it manually
+
+```bash
+sudo gem install differ
+```
+
+## How do I use this thing?
+
+There are a number of ways to use Differ, depending on your situation and needs. Lets examplify:
+
+```ruby
+require 'differ'
+
+@original = "Epic lolcat fail!"
+@current  = "Epic wolfman fail!"
+```
+
+There are a number of built-in diff_by_* methods to choose from for standard use:
+
+```ruby
+Differ.diff_by_line(@current, @original)
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+
+Differ.diff_by_word(@current, @original)
+# => Epic {"lolcat" >> "wolfman"} fail!
+
+Differ.diff_by_char(@current, @original)
+# => Epic {+"wo"}l{-"olcat "}f{+"m"}a{+"n fa"}il!
+```
+
+### Ok, but that doesn't quite cover my case, I have to split by "whatever".
+
+No problem, you can call diff directly and supply your own boundary string:
+
+```ruby
+Differ.diff(@current, @original) # Implicitly by line by default
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+
+Differ.diff(@current, @original, 'i')
+# => Epi{"c lolcat fa" >> "c wolfman fa"}il
+```
+
+### Yeah, thats nice. But a simple string might not always cut it...
+
+Well, you can supply a regex instead of your string if you have to:
+
+```ruby
+Differ.diff(@original, @current, /[a-z]i/)
+# => E{"c wolfman f" >> "c lolcat f"}l!
+```
+
+Include a capture group if you want to keep the separator:
+
+```ruby
+Differ.diff(@original, @current, /([a-z]i)/)
+# => Epi{"c wolfman f" >> "c lolcat f"}ail!
+```
+
+### Ok, ok, but I don't like having to write "Differ" everywhere.
+
+If you would like something a little more inline you can `require 'differ/string'` to get some added inline string magic:
+
+```ruby
+@current.diff(@original) # Implicitly by line by default
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+```
+
+Or a lot more inline:
+
+```ruby
+@current - @original # Implicitly by line by default
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+
+Differ.separator = ' ' # Custom string
+@current - @original
+# => Epic {"lolcat" >> "wolfman"} fail!
+
+Differ.separator = /[a-z]i/ # Custom regex without capture group
+@original - @current
+# => E{"c wolfman f" >> "c lolcat f"}l!
+
+Differ.separator = /([a-z]i)/ # Custom regex with capture group
+@original - @current
+# => Epi{"c wolfman f" >> "c lolcat f"}ail!
+```
+
+So we've pretty much got you covered.
+
+## What about output formatting?
+
+Need a different output format?  We've got a few of those too:
+
+```ruby
+Differ.format = :ascii  # Default
+Differ.format = :color
+Differ.format = :html
+Differ.format = :patch
+
+Differ.format = MyCustomFormatModule
+```
+
+The formatter must respond to the call method that takes an instant of the Change class as an argument and returns a string.
+
+### But I don't want to change the system-wide default for only a single diff output!
+
+Yeah, we either:
+
+```ruby
+diff = @current - @original
+diff.format_as(:color)
+```
+
+Or with your own formatter:
+
+```ruby
+diff = @current - @original
+diff.format_as(->(c){c.to_s})
+```
+
+> Know always right from wrong, and let others see your good works.

data/Rakefile

@@ -0,0 +1,29 @@
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r differ.rb"
+end
+task :c => :console
+
+namespace :gem do
+  desc "Connect to RubyGems.org account"
+  task :auth do
+    sh "curl -u battlebrisket https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials"
+  end
+
+  desc "Build the gem according to gemspec"
+  task :build do
+    sh "gem build differ.gemspec"
+  end
+
+  require "./lib/differ/version"
+  desc "Push the gem to RubyGems.org"
+  task :push do
+    sh "gem push differ-#{Differ::VERSION}.gem"
+  end
+end
+
+task :publish do
+  Rake::Task["gem:build"].invoke
+  Rake::Task["gem:push"].invoke
+end

data/Vagrantfile

@@ -0,0 +1,47 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+NAME = "ninja-differ"
+FQDN = "#{NAME}.example.com"
+
+Vagrant.configure("2") do |config|
+  config.vm.box = "ubuntu/focal64"
+  config.vm.boot_timeout = 900
+
+  # Use the normal insecure key
+  # https://github.com/mitchellh/vagrant/issues/2608
+  config.ssh.insert_key = false
+
+  config.vm.provider :virtualbox do |vb|
+    vb.customize ["modifyvm", :id,
+      # Basics.
+      "--name",       NAME,
+      "--memory",     4096,
+      # I/O APIC must be enabled to support a multi-core guest.
+      "--cpus",       2,
+      "--ioapic",     "on",
+      # Enable native host virtualization features (yields better performance).
+      "--pae",        "on",
+      "--hwvirtex",   "on",
+      "--largepages", "on",
+      "--vtxvpid",    "on",
+      # This causes the virtual machine to proxy DNS requests through the host
+      # via NAT. Without this, the default resolver on the guest will introduce
+      # a 5 second latency on every HTTP request... which is a real downer.
+      "--natdnshostresolver1", "on"
+    ]
+  end
+
+  config.vm.hostname = FQDN
+  config.vm.provision :shell, path: "provision.sh"
+end
+
+#
+# DONT FORGET!
+#
+# Force update VirtualBox Guest Additions
+# Run the following command inside same directory as Vagrantfile
+# Must be done once on your dev system
+#
+#   vagrant plugin install vagrant-vbguest
+#

data/differ.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'differ/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ninja-differ"
+  spec.version       = Differ::VERSION
+  spec.authors       = ["Frank Koehl", "Pieter van de Bruggen", "Jonas Schubert Erlandsson", "Eddie Cianci", "Chad Boyd"]
+  spec.date          = "2022-10-26"
+  spec.email         = ["fkoehl@gmail.com", "pvande@gmail.com", "jonas.schubert.erlandsson@my-codeworks.com", "chad@txt2give.co"]
+  spec.description   = "A simple gem for generating string diffs"
+  spec.summary       = "A simple gem for generating string diffs"
+  spec.homepage      = "https://github.com/BattleBrisket/ninja-differ"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # spec.add_development_dependency 'rspec', '~> 3.11'
+end

data/lib/differ/change.rb

@@ -0,0 +1,30 @@
+module Differ
+  class Change # :nodoc:
+    attr_accessor :insert, :delete
+    def initialize(options = {})
+      @insert = options[:insert] || ''
+      @delete = options[:delete] || ''
+    end
+
+    def insert?
+      !@insert.empty?
+    end
+
+    def delete?
+      !@delete.empty?
+    end
+
+    def change?
+      !@insert.empty? && !@delete.empty?
+    end
+
+    def to_s
+      Differ.format.call(self)
+    end
+    alias :inspect :to_s
+
+    def ==(other)
+      self.insert == other.insert && self.delete == other.delete
+    end
+  end
+end

data/lib/differ/diff.rb

@@ -0,0 +1,97 @@
+module Differ
+  class Diff
+    attr_reader :raw
+
+    def initialize
+      @raw = []
+    end
+
+    def same(*str)
+      return if str.empty?
+      if @raw.last.is_a? String
+        @raw.last << sep
+      elsif @raw.last.is_a? Change
+        if @raw.last.change?
+          @raw << sep
+        else
+          change = @raw.pop
+          if change.insert? && @raw.last
+            @raw.last << sep if change.insert.sub!(/^#{Regexp.quote(sep)}/, '')
+          end
+          if change.delete? && @raw.last
+            @raw.last << sep if change.delete.sub!(/^#{Regexp.quote(sep)}/, '')
+          end
+          @raw << change
+
+          @raw.last.insert << sep if @raw.last.insert?
+          @raw.last.delete << sep if @raw.last.delete?
+          @raw << ''
+        end
+      else
+        @raw << ''
+      end
+      @raw.last << str.join(sep)
+    end
+
+    def delete(*str)
+      return if str.empty?
+      if @raw.last.is_a? Change
+        change = @raw.pop
+        if change.insert? && @raw.last
+          @raw.last << sep if change.insert.sub!(/^#{Regexp.quote(sep)}/, '')
+        end
+        change.delete << sep if change.delete?
+      else
+        change = Change.new(:delete => @raw.empty? ? '' : sep)
+      end
+
+      @raw << change
+      @raw.last.delete << str.join(sep)
+    end
+
+    def insert(*str)
+      return if str.empty?
+      if @raw.last.is_a? Change
+        change = @raw.pop
+        if change.delete? && @raw.last
+          @raw.last << sep if change.delete.sub!(/^#{Regexp.quote(sep)}/, '')
+        end
+        change.insert << sep if change.insert?
+      else
+        change = Change.new(:insert => @raw.empty? ? '' : sep)
+      end
+
+      @raw << change
+      @raw.last.insert << str.join(sep)
+    end
+
+    def ==(other)
+      @raw == other.raw_array
+    end
+
+    def to_s
+      @raw.join()
+    end
+
+    def format_as(f)
+      f = Differ.format_for(f)
+      @raw.inject('') do |sum, part|
+        part = case part
+        when String then part
+        when Change then f.call(part)
+        end
+        sum << part
+      end
+    end
+
+  protected
+    def raw_array
+      @raw
+    end
+
+  private
+    def sep
+      "#{Differ.separator}"
+    end
+  end
+end

data/lib/differ/format/ascii.rb

@@ -0,0 +1,27 @@
+module Differ
+  module Format
+    module Ascii
+      class << self
+        def call(change)
+          (change.change? && as_change(change)) ||
+          (change.delete? && as_delete(change)) ||
+          (change.insert? && as_insert(change)) ||
+          ''
+        end
+
+      private
+        def as_insert(change)
+          "{+#{change.insert.inspect}}"
+        end
+
+        def as_delete(change)
+          "{-#{change.delete.inspect}}"
+        end
+
+        def as_change(change)
+          "{#{change.delete.inspect} >> #{change.insert.inspect}}"
+        end
+      end
+    end
+  end
+end

data/lib/differ/format/color.rb

@@ -0,0 +1,27 @@
+module Differ
+  module Format
+    module Color
+      class << self
+        def call(change)
+          (change.change? && as_change(change)) ||
+          (change.delete? && as_delete(change)) ||
+          (change.insert? && as_insert(change)) ||
+          ''
+        end
+
+      private
+        def as_insert(change)
+          "\033[32m#{change.insert}\033[0m"
+        end
+
+        def as_delete(change)
+          "\033[31m#{change.delete}\033[0m"
+        end
+
+        def as_change(change)
+          as_delete(change) << as_insert(change)
+        end
+      end
+    end
+  end
+end

data/lib/differ/format/html.rb

@@ -0,0 +1,27 @@
+module Differ
+  module Format
+    module HTML
+      class << self
+        def call(change)
+          (change.change? && as_change(change)) ||
+          (change.delete? && as_delete(change)) ||
+          (change.insert? && as_insert(change)) ||
+          ''
+        end
+
+      private
+        def as_insert(change)
+          %Q{<ins class="differ">#{change.insert}</ins>}
+        end
+
+        def as_delete(change)
+          %Q{<del class="differ">#{change.delete}</del>}
+        end
+
+        def as_change(change)
+          as_delete(change) << as_insert(change)
+        end
+      end
+    end
+  end
+end

data/lib/differ/format/patch.rb

@@ -0,0 +1,28 @@
+module Differ
+  module Format
+    module Patch
+      class << self
+        def format(change)
+          (change.change? && as_change(change)) ||
+          (change.delete? && as_delete(change)) ||
+          (change.insert? && as_insert(change)) ||
+          ''
+        end
+
+      private
+
+        def as_insert(change)
+          "\033[32m+ #{change.insert}\033[0m"
+        end
+
+        def as_delete(change)
+          "\033[31m- #{change.delete}\033[0m"
+        end
+
+        def as_change(change)
+          [as_delete(change), as_insert(change)].join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/differ/string.rb

@@ -0,0 +1,24 @@
+module Differ
+  module StringDiffer
+    def diff(old)
+      Differ.diff(self, old, Differ.separator || "\n")
+    end
+    alias :- :diff
+    
+    def diff_by_char(old)
+      Differ.diff(self, old, '')
+    end
+
+    def diff_by_word(old)
+      Differ.diff(self, old, /\b/)
+    end
+
+    def diff_by_line(old)
+      Differ.diff(self, old, "\n")
+    end
+  end
+end
+
+String.class_eval do
+  include Differ::StringDiffer
+end

data/lib/differ/version.rb

@@ -0,0 +1,3 @@
+module Differ
+  VERSION = "1.0.0"
+end

data/lib/differ.rb

@@ -0,0 +1,97 @@
+require 'differ/change'
+require 'differ/diff'
+require 'differ/format/ascii'
+require 'differ/format/color'
+require 'differ/format/html'
+require 'differ/format/patch'
+
+module Differ
+  class << self
+
+    def separator=(separator)
+      @@separator = separator
+    end
+
+    def separator
+      @@separator
+    end    
+
+    def diff(target, source, new_sep = "\n")
+      old_sep = self.separator
+      self.separator = new_sep
+
+      target = target.split(new_sep)
+      source = source.split(new_sep)
+
+      self.separator = '' if new_sep.is_a? Regexp
+
+      @diff = Diff.new
+      advance(target, source) until source.empty? || target.empty?
+      @diff.insert(*target) || @diff.delete(*source)
+      return @diff
+    ensure
+      self.separator = old_sep
+    end
+
+    def diff_by_char(to, from)
+      diff(to, from, '')
+    end
+
+    def diff_by_word(to, from)
+      diff(to, from, /\b/)
+    end
+
+    def diff_by_line(to, from)
+      diff(to, from, "\n")
+    end
+
+    def format=(f)
+      @format = format_for(f)
+    end
+
+    def format
+      return @format || Format::Ascii
+    end
+
+    def format_for(f)
+      if f.respond_to? :call
+        f
+      else       
+        case f
+        when :ascii then Format::Ascii
+        when :color then Format::Color
+        when :html  then Format::HTML
+        when :patch then Format::Patch
+        when nil    then nil
+        else raise "Unknown format type #{f.inspect}"
+        end
+      end
+    end
+
+  private
+    def advance(target, source)
+      del, add = source.shift, target.shift
+
+      prioritize_insert = target.length > source.length
+      insert = target.index(del)
+      delete = source.index(add)
+
+      if del == add
+        @diff.same(add)
+      elsif insert && prioritize_insert
+        change(:insert, target.unshift(add), insert)
+      elsif delete
+        change(:delete, source.unshift(del), delete)
+      elsif insert && !prioritize_insert
+        change(:insert, target.unshift(add), insert)
+      else
+        @diff.insert(add) && @diff.delete(del)
+      end
+    end
+
+    def change(method, array, index)
+      @diff.send(method, *array.slice!(0..index))
+      @diff.same(array.shift)
+    end
+  end
+end