rspec-approvals 0.0.2 → 0.0.3

data/README.md

@@ -5,10 +5,14 @@ Approvals are based on the idea of the *_golden master_*.
 You take a snapshot of an object, and then compare all future
 versions of the object to the snapshot.
 
-See [ApprovalTests](http://www.approvaltests.com) for videos and additional documentation about the general concept.
+Big hat tip to Llewellyn Falco who developed the approvals concept, as
+well as the original approvals libraries (.NET, Java, Ruby, PHP,
+probably others).
 
-The original Approvals libraries for Java and C# were developed by Llewellyn Falco.
+See [ApprovalTests](http://www.approvaltests.com) for videos and additional documentation about the general concept.
 
+Also, check out  Herding Code's podcast #117 http://t.co/GLn88R5 in
+which Llewellyn Falco is interviewed about approvals.
 
 ## Configuration
 
@@ -32,11 +36,11 @@ The basic format of the approval is modeled after RSpec's `it`:
     end
 
 
-The `:to_s` method on the object will be used to generate the output for
+The `:inspect` method on the object will be used to generate the output for
 the `*.received.txt` file. For custom objects you will need to override
-the `:to_s` to get helpful output, rather than the default:
+the `:inspect` to get helpful output, rather than the default:
 
-    #<Object:0x0000010105ea40>
+    #<Object:0x0000010105ea40> # or whatever the object id is
 
 The first time the specs are run, two files will be created:
 

data/lib/rspec/approvals/approval.rb

@@ -5,6 +5,12 @@ module RSpec
 
     class ReceivedDiffersError < RSpec::Expectations::ExpectationNotMetError; end
 
+    class EmptyApproval
+      def inspect
+        ""
+      end
+    end
+
     class Approval
 
       def self.normalize(s)
@@ -26,7 +32,7 @@ module RSpec
           :approved => approved_path,
         }
 
-        write(:approved, '') unless File.exists?(approved_path)
+        write(:approved, EmptyApproval.new) unless File.exists?(approved_path)
         write(:received, received)
       end
 
@@ -40,7 +46,17 @@ module RSpec
 
       def write(suffix, contents)
         File.open("#{@path}.#{suffix}.txt", 'w') do |f|
-          f.write contents
+          if contents.respond_to?(:each_pair)
+            contents.each_pair do |k,v|
+              f.write "#{k.inspect} => #{v.inspect}\n"
+            end
+          elsif contents.respond_to?(:each_with_index)
+            contents.each_with_index do |v,i|
+              f.write "[#{i.inspect}] #{v.inspect}\n"
+            end
+          else
+            f.write contents.inspect
+          end
         end
       end
 
@@ -56,7 +72,7 @@ module RSpec
         #{approved_path}
 
         If you like what you see in the *.received.txt file, you can approve it
-        like so:
+        by renaming it with the .approved.txt suffix.
 
         mv #{received_path} #{approved_path}
 

data/lib/rspec/approvals/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Approvals
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/approval_spec.rb

@@ -88,7 +88,7 @@ The::Class       \t \r\n \fname
         approval = Approvals::Approval.new(example, 'oooh, shiney!')
 
         File.exists?(@received_file).should be_true
-        File.read(@received_file).should eq("oooh, shiney!")
+        File.read(@received_file).should eq('"oooh, shiney!"')
       end
     end
 
@@ -144,7 +144,7 @@ The::Class       \t \r\n \fname
         #{approval.approved_path}
 
         If you like what you see in the *.received.txt file, you can approve it
-        like so:
+        by renaming it with the .approved.txt suffix.
 
         mv #{approval.received_path} #{approval.approved_path}
 

data/spec/approvals/rspec_approvals_a_complex_object.approved.txt

@@ -1 +1 @@
-Hello, World!
+#<The World Says: Hello!>

data/spec/approvals/rspec_approvals_a_hash.approved.txt

@@ -1 +1,3 @@
-{:universe=>{:side=>:dark, :other_side=>:light}, :force=>true}
+:universe => {:side=>:dark, :other_side=>:light}
+:force => true
+:evil => "undecided"

data/spec/approvals/rspec_approvals_a_string.approved.txt

@@ -1 +1 @@
-We have, I fear, confused power with greatness.
+"We have, I fear, confused power with greatness."

data/spec/approvals/rspec_approvals_an_array.approved.txt

@@ -1 +1,4 @@
-["abc", 123, ["cheese", "burger", "ribs", "steak", "bacon"]]
+[0] "abc"
+[1] 123
+[2] :zomg_fooooood
+[3] ["cheese", "burger", "ribs", "steak", "bacon"]

data/spec/approvals_spec.rb

@@ -36,7 +36,8 @@ describe Approvals do
         :side => :dark,
         :other_side => :light
       },
-      :force => true
+      :force => true,
+      :evil => "undecided"
     }
   end
 
@@ -44,6 +45,7 @@ describe Approvals do
     [
       "abc",
       123,
+      :zomg_fooooood,
       %w(cheese burger ribs steak bacon)
     ]
   end
@@ -55,10 +57,10 @@ describe Approvals do
     end
 
     def hello.inspect
-      "<HelloWorld id:#{object_id}>"
+      "#<The World Says: Hello!>"
     end
 
-    hello # => output matches hello.to_s
+    hello # => output matches hello.inspect
   end
 
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Katrina Owen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-11 00:00:00 +02:00
+date: 2011-07-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency