diffy 1.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/CHANGELOG

@@ -0,0 +1,5 @@
+== 1.0.1 ==
+* Compatibility with ruby 1.8.6 and 1.9
+
+== 1.0.0 ==
+* HTML output and better documentation

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Sam Goldstein
+
+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,92 @@
+Diffy - Easy Diffing With Ruby
+============================
+
+Need diffs in your ruby app?  Diffy has you covered.  It provides a convenient
+way to generate a diff from two strings.  Instead of reimplementing the LCS diff
+algorithm Diffy 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 `Diffy::Diff#to_s` to force that format, or set
+`Diffy::Diff.default_format`
+
+Getting Started
+---------------
+
+    sudo gem install diffy
+
+Here's an example of using Diffy to diff two strings
+
+    $ irb
+    >> 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 Diffy::Diff.new(string1, string2)
+    -Hello how are you
+    +Hello how are you?
+     I'm fine
+    -That's great
+    +That's swell
+
+Outputing the diff as html is easy too.
+
+    >> puts Diffy::Diff.new(string1, string2).to_s(:html)
+    <div class="diff">
+      <ul>
+        <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>
+    </div>
+
+Then try adding this css to your stylesheets:
+
+    .diff{overflow:auto;}
+    .diff ul{background:#fff;overflow:auto;font-size:13px;list-style:none;margin:0;padding:0;display:table;width:100%;}
+    .diff del, .diff ins{display:block;text-decoration:none;}
+    .diff li{padding:0; display:table-row;margin: 0;}
+    .diff li.ins{background:#9f9;}
+    .diff li.del{background:#ccf;}
+    .diff li:hover{background:#ffc}
+    .diff del, .diff ins, .diff span{white-space:pre;font-family:courier;}
+
+`Diffy::Diff` also alows you to set a default format.  Here we set the default to
+use ANSI termnial color escape sequences.
+
+    >> Diffy::Diff.default_format = :color
+    => :color
+    >> puts Diffy::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
+
+
+Creating custom formatted output is easy too.  `Diffy::Diff` provides an
+enumberable interface which lets you iterate over lines in the diff.
+
+    >> Diffy::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/Diffy/issues
+

data/Rakefile

@@ -0,0 +1,39 @@
+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']
+  t.spec_opts = %w{--color --format profile}
+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{diffy}
+
+    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/diffy/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}
+
+  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 @@
+1.1.0

data/dirb.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{diffy}
+  s.version = "1.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-10-15}
+  s.description = %q{Convenient diffing in ruby}
+  s.email = %q{sgrock@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "diffy.gemspec",
+     "lib/diffy.rb",
+     "spec/diffy_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/samg/diffy/tree/master}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A convenient way to diff string in ruby}
+  s.test_files = [
+    "spec/diffy_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/diffy_spec.rb

@@ -0,0 +1,155 @@
+require 'spec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'diffy')
+
+describe Diffy::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
+        Diffy::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
+        Diffy::Diff.new(@string1, @string2).to_s.should == <<-DIFF
+ foo
+-bar
+ bang
+        DIFF
+      end
+
+      it "to_s should accept a format key" do
+        Diffy::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 = Diffy::Diff.default_format
+        Diffy::Diff.default_format = :color
+        Diffy::Diff.new(@string1, @string2).to_s.
+          should == " foo\n\e[31m-bar\e[0m\n bang\n"
+        Diffy::Diff.default_format = old_format
+      end
+
+      it "should show one line added" do
+        Diffy::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
+        Diffy::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
+        Diffy::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 = Diffy::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
+<div class="diff">
+  <ul>
+    <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>
+</div>
+        HTML
+      end
+
+      it "should accept overrides to diff's options" do
+        @diff = Diffy::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
+
+    it "should escape diffed html in html output" do
+      diff = Diffy::Diff.new("<script>alert('bar')</script>", "<script>alert('foo')</script>").to_s(:html)
+      diff.should include('&lt;script&gt;')
+      diff.should_not include('<script>')
+    end
+
+    it "should be easy to generate custom format" do
+      Diffy::Diff.new("foo\nbar\n", "foo\nbar\nbaz\n").map do |line|
+        case line
+        when /^\+/ then "line #{line.chomp} added"
+        when /^-/ then "line #{line.chomp} removed"
+        end
+      end.compact.join.should == "line +baz added"
+    end
+  end
+end
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: diffy
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Sam Goldstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-22 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Convenient diffing in ruby
+email: sgrock@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- dirb.gemspec
+- spec/diffy_spec.rb
+has_rdoc: true
+homepage: http://github.com/samg/diffy/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A convenient way to diff string in ruby
+test_files: 
+- spec/diffy_spec.rb