approvals 0.0.8 → 0.0.9

data/README.md

@@ -48,6 +48,8 @@ Since you have not yet approved anything, the `*.approved` file does not exist,
 
 For the moment the only direct integration is with RSpec.
 
+    require 'approvals/rspec'
+
 The default directory for output files when using RSpec is
 
     spec/fixtures/approvals/
@@ -95,6 +97,23 @@ In RSpec, it looks like this:
       "{\"beverage\":\"coffee\"}"
     end
 
+### Exclude dynamicly changed values from json
+
+    Approvals.configure do |c|
+      c.excluded_json_keys = {
+        :id =>/(\A|_)id$/,
+        :date => /_at$/
+      }
+    end
+
+It will replace values with placeholders:
+
+    {id: 5, created_at: "2013-08-29 13:48:08 -0700"}
+
+=>
+
+    {id: "<id>", created_at: "<date>"}
+
 ### Approving a spec
 
 If the contents of the received file is to your liking, you can approve

data/lib/approvals/approval.rb

@@ -1,3 +1,4 @@
+require 'erb' # It is referenced on line 56
 module Approvals
   class Approval
     class << self
@@ -15,9 +16,17 @@ module Approvals
       Approvals::Approval.namer || Namers::DefaultNamer.new(name)
     end
 
+    # Add a Proc that tests if subject is a kind of format
+    IDENTITIES = {
+      hash: Proc.new(){|subject|subject.respond_to? :each_pair},
+      array: Proc.new(){|subject|subject.respond_to? :each_with_index},      
+    }
+    
     def identify_format
-      return :hash if subject.respond_to? :each_pair
-      return :array if subject.respond_to? :each_with_index
+      IDENTITIES.each_pair do |format, id_test|
+        return format if id_test.call(subject)
+      end
+      # otherwise
       return :txt
     end
 
@@ -51,8 +60,14 @@ module Approvals
       File.exists? approved_path
     end
 
+    BINARY_FORMATS = [:binary]
+    
     def received_matches?
-      IO.read(received_path).chomp == ERB.new(IO.read(approved_path).chomp).result
+      if BINARY_FORMATS.include?(@format) # Read without ERB
+        IO.read(received_path).chomp == IO.read(approved_path).chomp
+      else
+        IO.read(received_path).chomp == ERB.new(IO.read(approved_path).chomp).result
+      end
     end
 
     def fail_with(message)

data/lib/approvals/configuration.rb

@@ -16,9 +16,14 @@ module Approvals
     include Singleton
 
     attr_writer :approvals_path
+    attr_writer :excluded_json_keys
 
     def approvals_path
       @approvals_path ||= 'fixtures/approvals/'
     end
+
+    def excluded_json_keys
+      @excluded_json_keys ||= {}
+    end
   end
 end

data/lib/approvals/version.rb

@@ -1,3 +1,3 @@
 module Approvals
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/approvals/writer.rb

@@ -4,19 +4,25 @@ require 'approvals/writers/hash_writer'
 require 'approvals/writers/html_writer'
 require 'approvals/writers/xml_writer'
 require 'approvals/writers/json_writer'
+require 'approvals/writers/binary_writer'
 
 module Approvals
   module Writer
     extend Writers
+    
+    REGISTRY = {
+      json: Writers::JsonWriter.instance,
+      xml: Writers::XmlWriter.instance,
+      html: Writers::HtmlWriter.instance,
+      hash: Writers::HashWriter.instance,
+      array: Writers::ArrayWriter.instance,
+    }
+        
 
     class << self
       def for(format)
-        case format
-        when :json then JsonWriter.instance
-        when :xml then XmlWriter.instance
-        when :html then HtmlWriter.instance
-        when :hash then HashWriter.instance
-        when :array then ArrayWriter.instance
+        if REGISTRY.include?(format)
+          REGISTRY[format]
         else
           TextWriter.instance
         end

data/lib/approvals/writers/binary_writer.rb

@@ -0,0 +1,59 @@
+module Approvals
+
+  module Writers
+
+    class BinaryWriter
+      include Singleton
+
+      EXCEPTION_WRITER = Proc.new do |data, file|
+        raise "BinaryWriter#callback missing"
+      end
+
+      def initialize(opts = {})
+        self.autoregister = opts[:autoregister] || true
+        self.detect = opts[:detect]
+        self.extension = opts[:extension] || ''
+        self.write = opts[:write] || EXCEPTION_WRITER
+        self.format = opts[:format] || :binary
+      end
+           
+      attr_accessor :autoregister
+      attr_accessor :extension
+      attr_accessor :write
+      attr_accessor :detect
+      
+      
+      attr_reader :format
+
+      def format=(sym)
+        unregister if autoregister
+                
+        @format = sym        
+        
+        register if autoregister
+        
+      end
+      
+      def register
+        if @format
+          Writer::REGISTRY[@format] = self 
+          Approval::BINARY_FORMATS << @format
+          Approval::IDENTITIES[@format] = @detect if @detect
+        end
+      end
+      
+      def unregister
+        if @format
+          Writer::REGISTRY.delete!(@format)
+          Approval::BINARY_FORMATS.delete!(@format)
+          Approval::IDENTITIES.delete!(@format)
+        end
+      end
+
+      def write(data,path)
+        @write.call(data,path)
+      end
+
+    end
+  end
+end

data/lib/approvals/writers/json_writer.rb

@@ -7,9 +7,45 @@ module Approvals
       end
 
       def format(data)
-        JSON.pretty_generate(JSON.parse(data))
+        hash_or_array = parse_data(data)
+
+        apply_filters!(hash_or_array) if filters.any?
+
+        JSON.pretty_generate(hash_or_array)
+      end
+
+      private
+
+      def filters
+        Approvals.configuration.excluded_json_keys
       end
 
+      def parse_data(data)
+        JSON.parse(data)
+      end
+
+      def apply_filters!(hash_or_array)
+        case hash_or_array
+        when Array
+          for i in (0 ... hash_or_array.size) do
+            apply_filters!(hash_or_array[i])
+          end
+        when Hash
+          hash_or_array.each do |key, value|
+            next if value.nil?
+
+            if value.is_a?(Hash) || value.is_a?(Array)
+              apply_filters!(value)
+            else
+              filters.each do |placeholder, pattern|
+                if pattern && key.match(pattern)
+                  hash_or_array[key] = "<#{placeholder}>"
+                end
+              end
+            end
+          end
+        end
+      end
     end
   end
 end

data/spec/approvals_spec.rb

@@ -86,4 +86,25 @@ describe Approvals do
     string = "We have, I fear, confused power with greatness."
     Approvals.verify string, :namer => namer
   end
+
+  describe "supports excluded keys option for json" do
+    let(:hash) { {:object => {:id => rand(100), :created_at => Time.now, :name => 'test', deleted_at: nil}} }
+
+    before do
+      Approvals.configure do |c|
+        c.excluded_json_keys = {
+          :id => /(\A|_)id$/,
+          :date => /_at$/
+        }
+      end
+    end
+
+    it "verifies json with excluded keys" do
+      Approvals.verify JSON.dump(hash), :format => :json, :namer => namer
+    end
+
+    it "also supports an array of hashes" do
+      Approvals.verify JSON.dump([hash]), :format => :json, :namer => namer
+    end
+  end
 end

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_for_json_also_supports_an_array_of_hashes.approved.json

@@ -0,0 +1,10 @@
+[
+  {
+    "object": {
+      "id": "<id>",
+      "created_at": "<date>",
+      "name": "test",
+      "deleted_at": null
+    }
+  }
+]

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_for_json_verifies_json_with_excluded_keys.approved.json

@@ -0,0 +1,8 @@
+{
+  "object": {
+    "id": "<id>",
+    "created_at": "<date>",
+    "name": "test",
+    "deleted_at": null
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: approvals
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-29 00:00:00.000000000 Z
+date: 2013-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -123,6 +123,7 @@ files:
 - lib/approvals/version.rb
 - lib/approvals/writer.rb
 - lib/approvals/writers/array_writer.rb
+- lib/approvals/writers/binary_writer.rb
 - lib/approvals/writers/hash_writer.rb
 - lib/approvals/writers/html_writer.rb
 - lib/approvals/writers/json_writer.rb
@@ -131,8 +132,9 @@ files:
 - spec/approvals_spec.rb
 - spec/configuration_spec.rb
 - spec/extensions/rspec_approvals_spec.rb
-- spec/fixtures/approvals/approvals_fails.approved.txt
 - spec/fixtures/approvals/approvals_passes_approved_files_through_erb.approved.txt
+- spec/fixtures/approvals/approvals_supports_excluded_keys_option_for_json_also_supports_an_array_of_hashes.approved.json
+- spec/fixtures/approvals/approvals_supports_excluded_keys_option_for_json_verifies_json_with_excluded_keys.approved.json
 - spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt
 - spec/fixtures/approvals/approvals_verifies_a_hash.approved.txt
 - spec/fixtures/approvals/approvals_verifies_a_string.approved.txt
@@ -201,3 +203,4 @@ signing_key:
 specification_version: 3
 summary: Approval Tests for Ruby
 test_files: []
+has_rdoc: