diffident 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTM4NGJjMWI2MDQ4OTllNTE5MmI4NDlmODkzM2IxZWYwYzQ1M2E0OA==
+  data.tar.gz: !binary |-
+    Njg4ZDk3OWFkMjg4YzMwOGFkNDMxODEwYmFiNzIzNWNlNDVmMjRiNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmYzYjk1NDE3NTJmY2VhMjEyOWZiYjg3YzgyN2ZjZTExMjIzZDk5NDg4ZGVh
+    OTQ1M2ZmZmYwYWUyZGMwNzVjZjMyODRjOGY2NGQzNGU1MzE5OGM4NGU1Mjcz
+    YzUzNzU3NDVkN2IwM2YwNjY4YTIyOGIyZTJiNmY2MDIwYWM2ZWM=
+  data.tar.gz: !binary |-
+    N2ZlMWVlZTIxZDFhZTJiOTQ3ZWJkNGYxODczYmMzMWU0YWU4Y2IwYTYxMzc0
+    NmY4YjU3MWI3YzY2YjBhMDBhYzdiMjk1YTJlOTJhNThmZjM2NGU3NDk3YWMy
+    ZWYyNTg5MWZiNmY0YzdiNzQ2MjFlYWNiNzFmNzRjZDFlNDE0NzQ=

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 my codeworks
+
+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,181 @@
+# Diffident
+
+[![Gem Version](https://badge.fury.io/rb/diffident.png)](http://badge.fury.io/rb/diffident)
+[![Build Status](https://travis-ci.org/my-codeworks/diffident.png?branch=master)](https://travis-ci.org/my-codeworks/diffident)
+[![Code Climate](https://codeclimate.com/github/my-codeworks/diffident.png)](https://codeclimate.com/github/my-codeworks/diffident)
+
+> Based on the [differ](http://github.com/pvande/differ) gem by Pieter Vande Bruggen
+
+Diffident 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.
+
+It also gives you raw access to the diff structure, should you need it, so you can build whatever you need that needs a diff.
+
+## Internals
+
+Diffident uses the ruby StringScan object to walk through the input and collect Diffidentances. It records additions, subtractions, changes and can merge two diffs that might additionally contain conflicts.
+
+## Installation
+
+### Bundler
+
+Add this to your `Gemfile`
+
+```ruby
+gem 'diffident'
+```
+
+and run bundle to install
+
+```bash
+bundle install
+```
+
+### Manual
+
+Install it via `gem`
+
+```bash
+sudo gem install diffident
+```
+
+and require it in your project
+
+```ruby
+require 'diffident'
+```
+
+## How do I use this thing?
+
+There are a number of ways to use Diffident, depending on your situation and needs. Lets examplify:
+
+```ruby
+@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
+Diffident.diff_by_line(@current, @original)
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+
+Diffident.diff_by_word(@current, @original)
+# => Epic {"lolcat" >> "wolfman"} fail!
+
+Diffident.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
+Diffident.diff(@current, @original) # Implicitly by line by default
+# => {"Epic lolcat fail!" >> "Epic wolfman fail!"}
+
+Diffident.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
+Diffident.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
+Diffident.diff(@original, @current, /([a-z]i)/)
+# => Epi{"c wolfman f" >> "c lolcat f"}ail!
+```
+
+### Ok, ok, but I don't like having to write "Diffident" everywhere.
+
+If you would like something a little more inline you can `require 'diffident/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!"}
+
+Diffident.separator = ' ' # Custom string
+@current - @original
+# => Epic {"lolcat" >> "wolfman"} fail!
+
+Diffident.separator = /[a-z]i/ # Custom regex without capture group
+@original - @current
+# => E{"c wolfman f" >> "c lolcat f"}l!
+
+Diffident.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 diffidentent output format?  We've got a few of those too:
+
+```ruby
+Diffident.format = :ascii  # Default
+Diffident.format = :color
+Diffident.format = :html
+
+Diffident.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})
+```
+
+## Copyright
+
+> Know always right from wrong, and let others see your good works. - Pieter Vande Bruggen
+
+The MIT License (MIT)
+
+Copyright (c) 2013 my codeworks.
+
+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/lib/diffident/change.rb

@@ -0,0 +1,30 @@
+module Diffident
+  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
+      Diffident.format.call(self)
+    end
+    alias :inspect :to_s
+
+    def ==(other)
+      self.insert == other.insert && self.delete == other.delete
+    end
+  end
+end

data/lib/diffident/diff.rb

@@ -0,0 +1,95 @@
+module Diffident
+  class Diff
+    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 = Diffident.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
+      Diffident.separator.is_a?(Regexp) ? '' : "#{Diffident.separator}"
+    end
+  end
+end

data/lib/diffident/format/ascii.rb

@@ -0,0 +1,27 @@
+module Diffident
+  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/diffident/format/color.rb

@@ -0,0 +1,27 @@
+module Diffident
+  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/diffident/format/html.rb

@@ -0,0 +1,27 @@
+module Diffident
+  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="Diffident">#{change.insert}</ins>}
+        end
+
+        def as_delete(change)
+          %Q{<del class="Diffident">#{change.delete}</del>}
+        end
+
+        def as_change(change)
+          as_delete(change) << as_insert(change)
+        end
+      end
+    end
+  end
+end

data/lib/diffident/string.rb

@@ -0,0 +1,12 @@
+module Diffident
+  module StringDiffident
+    def diff(old)
+      Diffident.diff(self, old, Diffident.separator || "\n")
+    end
+    alias :- :diff
+  end
+end
+
+String.class_eval do
+  include Diffident::StringDiffident
+end

data/lib/diffident/tokenizer.rb

@@ -0,0 +1,43 @@
+module Diffident
+  class Tokenizer
+
+    def initialize(this, base, separator)
+      @this = this.split(separator)
+      @base = base.split(separator)
+      @diff = Diff.new
+    end
+
+    def run
+      advance until @base.empty? || @this.empty?
+      @diff.insert(*@this) || @diff.delete(*@base)
+      return @diff
+    end
+
+  private
+
+    def advance
+      del, add = @base.shift, @this.shift
+
+      prioritize_insert = @this.length > @base.length
+      insert = @this.index(del)
+      delete = @base.index(add)
+
+      if del == add
+        @diff.same(add)
+      elsif insert && prioritize_insert
+        change(:insert, @this.unshift(add), insert)
+      elsif delete
+        change(:delete, @base.unshift(del), delete)
+      elsif insert
+        change(:insert, @this.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

data/lib/diffident/version.rb

@@ -0,0 +1,3 @@
+module Diffident
+  VERSION = "0.1.0"
+end

data/lib/diffident.rb

@@ -0,0 +1,64 @@
+require 'diffident/change'
+require 'diffident/diff'
+require 'diffident/tokenizer'
+require 'diffident/format/ascii'
+require 'diffident/format/color'
+require 'diffident/format/html'
+
+module Diffident
+  class << self
+
+    def separator=(separator)
+      @@separator = separator
+    end
+
+    def separator
+      @@separator
+    end    
+
+    def diff(this, base, new_sep = "\n")
+      old_sep = self.separator
+      self.separator = new_sep
+
+      tokenizer = Diffident::Tokenizer.new(this, base, new_sep)
+      tokenizer.run
+    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 nil    then nil
+        else raise "Unknown format type #{f.inspect}"
+        end
+      end
+    end
+    
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: diffident
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonas Schubert Erlandsson
+- Pieter van de Bruggen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: ! 'diffident: To show modest reserve, a gem to create and manipulate
+  text diffs. This gem provides a pure ruby implementation of a diff tool. It gives
+  access to several methods by which to get a diff from strings and ways to format
+  the output. It also gives direct access to the internal diff structure so that you
+  can manipulate and extend it any way you need to.'
+email: jonas.schubert.erlandsson@my-codeworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/diffident/change.rb
+- lib/diffident/diff.rb
+- lib/diffident/format/ascii.rb
+- lib/diffident/format/color.rb
+- lib/diffident/format/html.rb
+- lib/diffident/string.rb
+- lib/diffident/tokenizer.rb
+- lib/diffident/version.rb
+- lib/diffident.rb
+- LICENSE
+- README.md
+homepage: http://github.com/my-codeworks/diffident
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A pure ruby implementation for generating and merging string diffs
+test_files: []
+has_rdoc: