dirb 0.1.0

data/README.md

@@ -0,0 +1,71 @@
+Dirb - Easy Diffing With Ruby
+============================
+
+Need diffs in your ruby app?  Dirb has you covered.  It provides a convenient
+way to generate a diff from two strings.  Instead of reimplementing the LCS diff
+algorithm Dirb uses battle tested Unix diff to generate diffs, and focuses on
+providing a convenient interface, and getting out of your way.
+
+It provides several built in format options.  Pass `:text`, `:color`, or
+`:html` to `Dirb::Diff#to_s` to force that format, or set
+`Dirb::Diff.default_format`
+
+    $ irb
+    >> require 'rubygems'
+    >> require 'dirb'
+    => true
+    >> string1 = <<-TXT
+    >" Hello how are you
+    >" I'm fine
+    >" That's great
+    >" TXT
+    => "Hello how are you\nI'm fine\nThat's great\n"
+    >> string2 = <<-TXT
+    >" Hello how are you?
+    >" I'm fine
+    >" That's swell
+    >" TXT
+    => "Hello how are you?\nI'm fine\nThat's swell\n"
+    >> puts Dirb::Diff.new(string1, string2)
+    -Hello how are you
+    +Hello how are you?
+     I'm fine
+    -That's great
+    +That's swell
+    => nil
+    >> puts Dirb::Diff.new(string1, string2).to_s(:html)
+    <ul class="diff">
+      <li class="del"><del>Hello how are you</del></li>
+      <li class="ins"><ins>Hello how are you?</ins></li>
+      <li class="unchanged"><span>I'm fine</span></li>
+      <li class="del"><del>That's great</del></li>
+      <li class="ins"><ins>That's swell</ins></li>
+    </ul>
+    => nil
+    >> Dirb::Diff.default_format = :color
+    => :color
+    irb(main):015:0> puts Dirb::Diff.new(string1, string2) # prints color in the terminal
+    -Hello how are you
+    +Hello how are you?
+     I'm fine
+    -That's great
+    +That's swell
+    => nil
+
+
+Creating custom formatted output is easy too.  `Dirb::Diff` provides an
+enumberable interface which lets you iterate over lines in the diff.
+
+    >> Dirb::Diff.new("foo\nbar\n", "foo\nbar\nbaz\n").each do |line|
+    >*   case line
+    >>   when /^\+/ then puts "line #{line.chomp} added"
+    >>   when /^-/ then puts "line #{line.chomp} removed"
+    >>   end
+    >> end
+    line +baz added
+    => [" foo\n", " bar\n", "+baz\n"]
+
+Use `#map`, `#inject`, or any of Enumerable's methods.  Go crazy.
+
+Report bugs or request features at http://github.com/samg/Dirb/issues
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README"
+  rd.rdoc_dir = 'doc'
+  rd.rdoc_files.include("README", "**/*.rb")
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = %q{dirb}
+    s.version = "0.1.0"
+
+    s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+    s.authors = ["Sam Goldstein"]
+    s.date = %q{2010-06-28}
+    s.description = %q{Convenient diffing in ruby}
+    s.email = %q{sgrock@gmail.com}
+    s.has_rdoc = true
+    s.homepage = "http://github.com/samg/dirb/tree/master"
+    s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+    s.require_paths = ["lib"]
+    s.summary = %q{A convenient way to diff string in ruby}
+
+    if s.respond_to? :specification_version then
+      current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+      s.specification_version = 2
+
+      if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+        s.add_runtime_dependency(%q<mime-types>, [">= 1.16"])
+        s.add_runtime_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      else
+        s.add_dependency(%q<mime-types>, [">= 1.16"])
+        s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+      end
+    else
+      s.add_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_dependency(%q<diff-lcs>, [">= 1.1.2"])
+    end
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/dirb.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'tempfile'
+require 'open3'
+module Dirb
+  class Diff
+    class << self
+      attr_writer :default_format
+      def default_format
+        @default_format || :text
+      end
+    end
+    include Enumerable
+    attr_reader :string1, :string2, :diff_options, :diff
+    def initialize(string1, string2, diff_options = "-U 10000")
+      @string1, @string2 = string1, string2
+      @diff_options = diff_options
+    end
+
+    def diff
+      @diff ||= Open3.popen3(
+        *[diff_bin, diff_options, tempfile(string1), tempfile(string2)]
+      ) { |i, o, e| o.read }
+      @diff = @string1.gsub(/^/, " ") if @diff =~ /\A\s*\Z/
+      @diff
+    end
+
+    def each &block
+      diff.each_line.reject{|x| x =~ /^---|\+\+\+|@@/ }.each &block
+    end
+
+    def tempfile(string)
+      t = Tempfile.new('dirb')
+      t.print(string)
+      t.flush
+      t.path
+    end
+
+    def to_s(format = nil)
+      format ||= self.class.default_format
+      formats = Format.instance_methods(false)
+      if formats.include? format.to_s
+        enum = self.each
+        enum.extend Format
+        enum.send format
+      else
+        raise ArgumentError,
+          "Format #{format.inspect} not found in #{formats.inspect}"
+      end
+    end
+    private
+
+    def diff_bin
+      bin = `which diff`.chomp
+      if bin.empty?
+        raise "Can't find a diff executable in PATH #{ENV['PATH']}"
+      end
+      bin
+    end
+
+    module Format
+      def color
+        map do |line|
+          case line
+          when /^\+/
+            "\033[32m#{line.chomp}\033[0m"
+          when /^-/
+            "\033[31m#{line.chomp}\033[0m"
+          else
+            line.chomp
+          end
+        end.join("\n") + "\n"
+      end
+
+      def text
+        to_a.join
+      end
+
+      def html
+        lines = map do |line|
+          case line
+          when /^\+/
+            '  <li class="ins"><ins>' + line.gsub(/^./, '').chomp + '</ins></li>'
+          when /^-/
+            '  <li class="del"><del>' + line.gsub(/^./, '').chomp + '</del></li>'
+          when /^ /
+            '  <li class="unchanged"><span>' + line.gsub(/^./, '').chomp + '</span></li>'
+          end
+        end
+        %'<ul class="diff">\n#{lines.join("\n")}\n</ul>\n'
+      end
+    end
+  end
+end

data/spec/dirb_spec.rb

@@ -0,0 +1,138 @@
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'dirb')
+
+describe Dirb::Diff do
+  describe "#to_s" do
+    describe "with no line different" do
+      before do
+        @string1 = "foo\nbar\nbang\n"
+        @string2 = "foo\nbar\nbang\n"
+      end
+
+      it "should show everything" do
+        Dirb::Diff.new(@string1, @string2).to_s.should == <<-DIFF
+ foo
+ bar
+ bang
+        DIFF
+      end
+    end
+    describe "with one line different" do
+      before do
+        @string1 = "foo\nbar\nbang\n"
+        @string2 = "foo\nbang\n"
+      end
+
+      it "should show one line removed" do
+        Dirb::Diff.new(@string1, @string2).to_s.should == <<-DIFF
+ foo
+-bar
+ bang
+        DIFF
+      end
+
+      it "to_s should accept a format key" do
+        Dirb::Diff.new(@string1, @string2).to_s(:color).
+          should == " foo\n\e[31m-bar\e[0m\n bang\n"
+      end
+
+      it "should accept a default format option" do
+        old_format = Dirb::Diff.default_format
+        Dirb::Diff.default_format = :color
+        Dirb::Diff.new(@string1, @string2).to_s.
+          should == " foo\n\e[31m-bar\e[0m\n bang\n"
+        Dirb::Diff.default_format = old_format
+      end
+
+      it "should show one line added" do
+        Dirb::Diff.new(@string2, @string1).to_s.should == <<-DIFF
+ foo
++bar
+ bang
+        DIFF
+      end
+    end
+
+    describe "with one line changed" do
+      before do
+        @string1 = "foo\nbar\nbang\n"
+        @string2 = "foo\nbong\nbang\n"
+      end
+      it "should show one line added and one removed" do
+        Dirb::Diff.new(@string1, @string2).to_s.should == <<-DIFF
+ foo
+-bar
++bong
+ bang
+        DIFF
+      end
+    end
+
+    describe "with totally different strings" do
+      before do
+        @string1 = "foo\nbar\nbang\n"
+        @string2 = "one\ntwo\nthree\n"
+      end
+      it "should show one line added and one removed" do
+        Dirb::Diff.new(@string1, @string2).to_s.should == <<-DIFF
+-foo
+-bar
+-bang
++one
++two
++three
+        DIFF
+      end
+    end
+
+    describe "with a somewhat complicated diff" do
+      before do
+        @string1 = "foo\nbar\nbang\nwoot\n"
+        @string2 = "one\ntwo\nthree\nbar\nbang\nbaz\n"
+        @diff = Dirb::Diff.new(@string1, @string2)
+      end
+      it "should show one line added and one removed" do
+        @diff.to_s.should == <<-DIFF
+-foo
++one
++two
++three
+ bar
+ bang
+-woot
++baz
+        DIFF
+      end
+
+      it "should make an awesome html diff" do
+        @diff.to_s(:html).should == <<-HTML
+<ul class="diff">
+  <li class="del"><del>foo</del></li>
+  <li class="ins"><ins>one</ins></li>
+  <li class="ins"><ins>two</ins></li>
+  <li class="ins"><ins>three</ins></li>
+  <li class="unchanged"><span>bar</span></li>
+  <li class="unchanged"><span>bang</span></li>
+  <li class="del"><del>woot</del></li>
+  <li class="ins"><ins>baz</ins></li>
+</ul>
+        HTML
+      end
+
+      it "should accept overrides to diff's options" do
+        @diff = Dirb::Diff.new(@string1, @string2, "--rcs")
+        @diff.to_s.should == <<-DIFF
+d1 1
+a1 3
+one
+two
+three
+d4 1
+a4 1
+baz
+          DIFF
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: dirb
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sam Goldstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: Convenient diffing in ruby
+email: sgrock@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION
+- lib/dirb.rb
+- spec/dirb_spec.rb
+has_rdoc: true
+homepage: http://github.com/samg/dirb/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: A convenient way to diff string in ruby
+test_files: 
+- spec/dirb_spec.rb