diffr 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc/*
+coverage/*
+doc/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@diffr --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in diffr.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+Diffr
+======
+
+A simple diff utility written in Ruby. It works with single or
+multi-line strings and returns an array of hashes that indicates
+the line number affected and change: added, deleted, or same.
+
+Overview
+--------
+
+```ruby
+
+old = "This line of document stays the same.
+The dokument should be spelled correctly.
+This line should be deleted."
+
+new = "The new document has a line break!
+
+This line of document stays the same.
+The document should be spelled correctly.
+Finally, a brand new line."
+
+Diff.diffs(old, new).each do |diff|
+  puts diff
+end
+
+# Produces:
+
+# {:line => 1, :change => :add,    :string => "The new document has a line break!"}
+# {:line => 2, :change => :add,    :string => ""}
+# {:line => 1, :change => :same,   :string => "This line of document stays the same."}
+# {:line => 2, :change => :delete, :string => "The dokument should be spelled correctly."}
+# {:line => 3, :change => :delete, :string => "This line should be deleted."}
+# {:line => 4, :change => :add,    :string => "The document should be spelled correctly."}
+# {:line => 5, :change => :add,    :string => "Finally, a brand new line."}
+
+# With a little formatting, we can produce something very similar to Unix's diff (unified format):
+
+SYMBOLS = {:add => '+', :delete => '-', :same => ' '}
+
+Diff.diffs(old, new).each do |diff|
+  puts SYMBOLS[diff[:change]] + diff[:string]
+end
+
+# Produces:
+
+# +The new document has a line break!
+# +
+#  This line of document stays the same.
+# -The dokument should be spelled correctly.
+# -This line should be deleted.
+# +The document should be spelled correctly.
+# +Finally, a brand new line.
+
+```
+
+Installing Diffr
+----------------
+
+### In a Ruby app, as a gem
+
+First install the gem.
+
+    $ gem install diffr
+
+Next include it in your application.
+
+```ruby
+
+require 'diffr'
+
+```

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+task :default => :test
+
+desc 'Run tests (default)'
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.ruby_opts = ['-Itest']
+  t.libs << "lib" << "test"
+  t.ruby_opts << '-rubygems' if defined? Gem
+end
+
+if ENV['RAILS_ENV']=='development' # yard gem is only in development
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+  end
+end
+
+namespace :docs do
+  desc 'Generate documentation for the appliaction with Yard'
+  task :yard do
+    system("yardoc 'lib/**/*.rb' - README.md")
+  end
+end

data/diffr.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "diffr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "diffr"
+  s.version     = Diffr::VERSION
+  s.authors     = ["Matt Sears"]
+  s.email       = ["matt@mattsears.com"]
+  s.homepage    = "http://www.mattsears.com"
+  s.summary     = %q{A simple diff utility written in Ruby}
+  s.description = %q{A simple utility that returns the differences between two objects}
+
+  s.rubyforge_project = "diffr"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rdiscount"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/diffr.rb

@@ -0,0 +1,85 @@
+require "diffr/version"
+#
+# == Diffr Module
+#
+# A simple utility that returns the differences between two strings
+#
+# == Examples:
+#
+#   @old = "This line of document stays the same.
+#   The dokument should be spelled correctly.
+#   This line should be deleted."
+#
+#   @new = "The new document has a line break!
+#
+#   This line of document stays the same.
+#   The document should be spelled correctly.
+#   Finally, a brand new line."
+#
+#   Diff.diffs(old, new)
+#
+#  Produces:
+#  [ {:source=>:new, :line=>1, :change=>:add, :string=>"The new document has a line break!"},
+#    {:source=>:new, :line=>2, :change=>:add, :string=>""},
+#    {:source=>:old, :line=>1, :change=>:same, :string=>"This line of document stays the same."},
+#    {:source=>:old, :line=>2, :change=>:delete, :string=>"The dokument should be spelled correctly."},
+#    {:source=>:old, :line=>3, :change=>:delete, :string=>"This line should be deleted."},
+#    {:source=>:new, :line=>4, :change=>:add, :string=>"The document should be spelled correctly."},
+#    {:source=>:new, :line=>5, :change=>:add, :string=>"Finally, a brand new line."} ]
+#
+module Diffr
+  attr_accessor :diffs, :sequences
+
+  # Returns an array of hashes that contain metadata about the differences
+  # between the two given strings.
+  #
+  # @return [Array] of diffs
+  #
+  def self.diffs(old, new)
+    new, old, @diffs = new.lines.to_a, old.lines.to_a, []
+    build_sequences(old, new)
+    find_diffs(old, new, old.size, new.size)
+  end
+
+  private
+
+  # Backtrace through the sequences and determine what changed between the old
+  # string and new string
+  #
+  # @return [Array] of diffs
+  #
+  def self.find_diffs(old, new, row, col)
+    if row > 0 && col > 0 && old[row-1] == new[col-1]
+      find_diffs(old, new, row-1, col-1)
+      @diffs << { :source => :old, :line => row, :change => :same, :string => old[row-1].strip }
+    elsif col > 0 && (row == 0 || @sequences[row][col-1] >= @sequences[row-1][col])
+      find_diffs(old, new, row, col-1)
+      @diffs << { :source => :new, :line => col, :change => :add, :string => new[col-1].strip }
+    elsif row > 0 && (col == 0 || @sequences[row][col-1] < @sequences[row-1][col])
+      find_diffs(old, new, row-1, col)
+      @diffs << { :source => :old, :line => row, :change => :delete, :string => old[row-1].strip }
+    end
+  end
+
+  # Build a sequence matrix by finding the sequence of items that is present in
+  # both original string in the same order. That is, find a new sequence which
+  # can be obtained from the first sequence by deleting some items, and from the
+  # second sequence by deleting other items.
+  #
+  # @return [Array] of sequences
+  #
+  def self.build_sequences(old, new)
+    rows, cols = old.size+1, new.size+1
+    @sequences = rows.times.map{|x|[0]*(x+1)}
+    rows.times.each do |row|
+      cols.times.each do |col|
+        @sequences[row][col] = if old[row-1] == new[col-1]
+          @sequences[row-1][col-1] + 1
+        else
+          [@sequences[row][col-1].to_i, @sequences[row-1][col].to_i].max
+        end
+      end
+    end
+  end
+
+end

data/lib/diffr/version.rb

@@ -0,0 +1,3 @@
+module Diffr
+  VERSION = "0.0.1"
+end

data/test/diffr_test.rb

@@ -0,0 +1,44 @@
+require 'helper'
+
+describe Diffr do
+
+  describe "how do two strings diffr?" do
+
+    it "should return an array diffs for single line strings" do
+      Diffr.diffs("this is an old string", "this is a new string").must_equal [
+        {:source=>:old, :line=>1, :change=>:delete, :string=>"this is an old string"},
+        {:source=>:new, :line=>1, :change=>:add, :string=>"this is a new string"}
+      ]
+    end
+
+    describe "with multiline strings" do
+      before do
+        @old_text = <<-END.gsub(/^ {6}/, '')
+          This line of document stays the same.
+          The dokument should be spelled correctly.
+          This line should be deleted.
+        END
+        @new_text = <<-END.gsub(/^ {6}/, '')
+          The new document has a line break!
+
+          This line of document stays the same.
+          The document should be spelled correctly.
+          Finally, a brand new line.
+        END
+      end
+
+      it "should return the diffs for each line" do
+        Diffr.diffs(@old_text, @new_text).must_equal [
+          {:source=>:new, :line=>1, :change=>:add, :string=>"The new document has a line break!"},
+          {:source=>:new, :line=>2, :change=>:add, :string=>""},
+          {:source=>:old, :line=>1, :change=>:same, :string=>"This line of document stays the same."},
+          {:source=>:old, :line=>2, :change=>:delete, :string=>"The dokument should be spelled correctly."},
+          {:source=>:old, :line=>3, :change=>:delete, :string=>"This line should be deleted."},
+          {:source=>:new, :line=>4, :change=>:add, :string=>"The document should be spelled correctly."},
+          {:source=>:new, :line=>5, :change=>:add, :string=>"Finally, a brand new line."}
+        ]
+      end
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.start do
+  add_group 'Diffr', 'lib/diffr'
+end
+
+require 'minitest/autorun'
+require 'diffr'
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: diffr
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Sears
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A simple utility that returns the differences between two objects
+email: 
+- matt@mattsears.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- diffr.gemspec
+- lib/diffr.rb
+- lib/diffr/version.rb
+- test/diffr_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://www.mattsears.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: diffr
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple diff utility written in Ruby
+test_files: 
+- test/diffr_test.rb
+- test/helper.rb