rspec-rcv 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a783908cd11d083077bf4eb98891e8a54353c29e
-  data.tar.gz: e816f2cd43c83027eca2382c152aec84f26b6ee3
+  metadata.gz: 6594a5efc10dfc904a94eab1c8edc61c4671e054
+  data.tar.gz: 34bee1dfb7ffc22268827ec07d2c8e84c32e67e9
 SHA512:
-  metadata.gz: b055ccc2c89a77db00197fc3adae47b1cdb623a780ca2a24078b951c953eccb14c0f4aa10196bca8fe0fdc8947d06310e93f08bec1f21d3f1f1f704c60602c63
-  data.tar.gz: 8ac4afdf9b6fd7d7681e70a16d590c851d3ee594a698f3e8068bad9f3a9448ecd4add5fc4d2c1d60ffd65217f032369c7bcc31c92bf27dbc8416dd3016a635fa
+  metadata.gz: 6af94e5c1df0e47eb082d9ec9a483e1ce35c6bc1f3bb323db09796a862c634bf031d32a8d1e57cdea4bf7cdf5fab8e49de2a0ff1cbd7e77381918817aff0ea25
+  data.tar.gz: f3b5cad2b80a2289d2d37dacef440edd18f4d46d3ea9aa2cdfa8cb69a81a6e682cc612f69f5b58aec7fba55741ded4e1e5aa178a57ef92aa0e93e1fc2f68a05c

data/README.md

@@ -30,34 +30,50 @@ the file in the spec suite.
 
 # Configuration Options
 
-The following options are available to override, as well as their default values:
+The following options are available to override, as well as important default values:
 
 ```ruby
 config.exportable_proc = Proc.new { response.body }
-config.compare_with = Proc.new { |existing, new| existing == new }
-config.export_with = Proc.new do |hash|
-                               begin
-                                 hash[:data] = JSON.parse(hash[:data])
-                               rescue JSON::ParserError
-                               end
-                               JSON.pretty_generate(hash)
-                             end
+config.compare_with # Deep ignoring comparison by default
+config.codec = Codecs::PrettyJson.new
+config.ignore_keys = []
 config.base_path = nil
 config.fail_on_changed_output = true
 ```
 
-`exportable_proc`, `compare_with`, `export_with` must implement `.call`. For `exportable_proc`, the result will be written to disk
-and should be a String. For `compare_with`, the proc should return true when existing and new are considered equal. For `export_with`
-a hash will be passed in and the result will be a String written to disk.
+`exportable_proc`, `compare_with` must implement `.call`. For `exportable_proc`, the result will be written to disk
+and should be a String. For `compare_with`, the proc should return true when existing and new are considered equal.
 
-`export_with` by default tries to take hash[:data] (a string) and JSON parse it. If it isn't successful, that is fine and hash[:data] isn't
-changed. If it is JSON, then the pretty print will work more optimally.
-
-Note: This can support things that aren't JSON because you can override Proc's that you need to. However, some of the internal workings assume JSON and so it is recommended to just keep the file as JSON.
+`codec` must implement `export_with(hash)` and `decode_with(str)`. There is a PrettyJson and Yaml codec included in this gem,
+and PrettyJson is the default as it can be directly consumed by javascript.
 
 # What about fields that change everytime I run the specs?
 
-This is why you can override `compare_with`. For instance, here is a configuration to ignore `id, created_at, updated_at` in a Rails app:
+There is an option called `ignore_keys` which will deep ignore keys that you don't want to cause spec change. For instance,
+the following hashes would not trigger a change with `ignore_keys = [:id]`
+
+```
+{
+  id: 1,
+  deep: {
+    id: 2,
+    name: "Steve"
+  }
+}
+
+{
+  id: "DIFF",
+  deep: {
+    id: "DIFF,
+    name: "Steve"
+  }
+}
+```
+
+but if the name changed from "Steve", then a change would be triggered.
+
+If you want more configuration, you can override `compare_with`. For instance, here is a configuration to shallowly ignore 
+`id, created_at, updated_at` in a Rails app:
 
 ```ruby
 RSpecRcv.configure do |config|

data/lib/rspec_rcv.rb

@@ -2,6 +2,7 @@ require "rspec_rcv/version"
 
 require "rspec_rcv/codecs/pretty_json"
 require "rspec_rcv/codecs/yaml"
+require "rspec_rcv/helpers/deep_except"
 
 require "rspec_rcv/configuration"
 require "rspec_rcv/test_frameworks/rspec"

data/lib/rspec_rcv/configuration.rb

@@ -2,8 +2,11 @@ module RSpecRcv
   class Configuration
     DEFAULTS = {
         exportable_proc: Proc.new { JSON.parse(response.body) },
-        compare_with: Proc.new { |existing, new| existing == new },
+        compare_with: Proc.new do |existing, new, opts|
+          Helpers::DeepExcept.new(existing, opts[:ignore_keys]).to_h == Helpers::DeepExcept.new(new, opts[:ignore_keys]).to_h
+        end,
         codec: Codecs::PrettyJson.new,
+        ignore_keys: [],
         fail_on_changed_output: true,
         base_path: nil,
         fixture: nil
@@ -44,6 +47,14 @@ module RSpecRcv
       @opts[:codec] = val
     end
 
+    def ignore_keys
+      @opts[:ignore_keys]
+    end
+
+    def ignore_keys=(val)
+      @opts[:ignore_keys] = val
+    end
+
     def compare_with
       @opts[:compare_with]
     end

data/lib/rspec_rcv/handler.rb

@@ -15,7 +15,7 @@ module RSpecRcv
       output = opts[:codec].export_with(output) + "\n"
 
       if existing_data
-        eq = opts[:compare_with].call(existing_data["data"], data)
+        eq = opts[:compare_with].call(existing_data["data"], data, opts)
 
         if !eq && opts[:fail_on_changed_output]
           diff = Diffy::Diff.new(existing_file, output)

data/lib/rspec_rcv/helpers/deep_except.rb

@@ -0,0 +1,28 @@
+module RSpecRcv
+  module Helpers
+    class DeepExcept
+      def initialize(hash, except)
+        @hash = hash
+        @except = except
+      end
+
+      def to_h
+        inject(@hash, @except.map(&:to_sym))
+      end
+
+      private
+
+      def inject(hash, except)
+        hash.inject({}) do |h, (k, v)|
+          if v && v.respond_to?(:to_h)
+            h[k] = inject(v, except)
+          elsif !except.include?(k.to_sym)
+            h[k] = v
+          end
+          h
+        end
+      end
+    end
+  end
+end
+

data/lib/rspec_rcv/version.rb

@@ -1,3 +1,3 @@
 module RSpecRcv
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rcv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Stephen Bussey
@@ -85,6 +85,7 @@ files:
 - lib/rspec_rcv/configuration.rb
 - lib/rspec_rcv/data_changed_error.rb
 - lib/rspec_rcv/handler.rb
+- lib/rspec_rcv/helpers/deep_except.rb
 - lib/rspec_rcv/test_frameworks/rspec.rb
 - lib/rspec_rcv/version.rb
 - rspec-rcv.gemspec