dirb 0.1.1 → 1.0.0

data/README.md

@@ -10,10 +10,14 @@ 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`
 
+Getting Started
+---------------
+
+    sudo gem install dirb
+
+Here's an example of using Dirb to diff two strings
+
     $ irb
-    >> require 'rubygems'
-    >> require 'dirb'
-    => true
     >> string1 = <<-TXT
     >" Hello how are you
     >" I'm fine
@@ -32,7 +36,9 @@ It provides several built in format options.  Pass `:text`, `:color`, or
      I'm fine
     -That's great
     +That's swell
-    => nil
+
+Outputing the diff as html is easy too.
+
     >> puts Dirb::Diff.new(string1, string2).to_s(:html)
     <ul class="diff">
       <li class="del"><del>Hello how are you</del></li>
@@ -41,16 +47,29 @@ It provides several built in format options.  Pass `:text`, `:color`, or
       <li class="del"><del>That's great</del></li>
       <li class="ins"><ins>That's swell</ins></li>
     </ul>
-    => nil
+
+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;}
+
+Dirb::Diff also alows you to set a default format.  Here we set the default to
+use ANSI termnial color escape sequences.
+
     >> Dirb::Diff.default_format = :color
     => :color
-    irb(main):015:0> puts Dirb::Diff.new(string1, string2) # prints color in the terminal
+    >> 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

data/VERSION

@@ -1 +1 @@
-0.1.1
+1.0.0

data/dirb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dirb}
-  s.version = "0.1.1"
+  s.version = "1.0.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.date = %q{2010-06-29}
   s.description = %q{Convenient diffing in ruby}
   s.email = %q{sgrock@gmail.com}
   s.extra_rdoc_files = [

data/lib/dirb.rb

@@ -79,14 +79,14 @@ module Dirb
         lines = map do |line|
           case line
           when /^\+/
-            '  <li class="ins"><ins>' + line.gsub(/^./, '').chomp + '</ins></li>'
+            '    <li class="ins"><ins>' + line.gsub(/^./, '').chomp + '</ins></li>'
           when /^-/
-            '  <li class="del"><del>' + line.gsub(/^./, '').chomp + '</del></li>'
+            '    <li class="del"><del>' + line.gsub(/^./, '').chomp + '</del></li>'
           when /^ /
-            '  <li class="unchanged"><span>' + line.gsub(/^./, '').chomp + '</span></li>'
+            '    <li class="unchanged"><span>' + line.gsub(/^./, '').chomp + '</span></li>'
           end
         end
-        %'<ul class="diff">\n#{lines.join("\n")}\n</ul>\n'
+        %'<div class="diff">\n  <ul>\n#{lines.join("\n")}\n  </ul>\n</div>\n'
       end
     end
   end

data/spec/dirb_spec.rb

@@ -106,16 +106,18 @@ describe Dirb::Diff do
 
       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>
+<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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dirb
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Sam Goldstein
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-28 00:00:00 -07:00
+date: 2010-06-29 00:00:00 -07:00
 default_executable: 
 dependencies: []