rspec-request_snapshot 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e2665c7ef3ad56f77f9cdf3d037e1c889a15218ffa8350929ba3fe77c63335
-  data.tar.gz: ab9c6146284efd2db0b2f9821160ccebc83a75ad40b1c1826e1c1c3b0c103573
+  metadata.gz: ea875af5bb2032c8034482032dc737d7ec60b55e2f977551adddee0d0bb5f0cf
+  data.tar.gz: 946666e33db659d180bd8762d8cbfc1400f1bcd28c25725a3cc13d639486385e
 SHA512:
-  metadata.gz: e9a7b6a9592f44ca0cab09167e15aaa90436935aab9f16989fe68488edebb0f22fd945a83c47bc8ccdba1b8c8c6733f1ae40fa337cd82f9572d308e0b7fd8939
-  data.tar.gz: 5af511e46ac7d7968970b4738e39a5d1657652492b9239a85136db6c5f705862bec92ed7a1b5211eb4ae3696f6c00986e2fa74248190acba7488ca0569f50170
+  metadata.gz: b78cc8aa841430a3d9134b263bd092e31ddadb9b91fee63683dadf9ed856730ecae3d4844d2bcec0d230c2e2e3559f9617d1940c8435925fc0221bcf7614f05b
+  data.tar.gz: 1b327bc6fec76fda28c437a6093e2d43fb025af9361dde518ee8e11f1a7967da1cd88b889fa71a4d76e0df4e75f93642d7b327e62186ed0c1402a35dde7751f9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-request_snapshot (0.2.0)
+    rspec-request_snapshot (0.3.0)
       rspec (~> 3.0)
 
 GEM

data/README.md

@@ -56,14 +56,34 @@ expect(response.body).to match_snapshot("api/resources_index")
 
 # Using plain text instead of parsing JSON
 expect(response.body).to match_snapshot("api/resources_index", format: :text)
+```
+
+#### Matcher options
+
+##### dynamic_attributes
 
+Using `dynamic_attributes` inline allows to ignore attributes for a specific snapshot.
+This is useful to ignore changing attributes, like `id` or `created_at`.
+Notice that **all** nodes matching those (nested or not) will be ignored. Usage:
+
+```ruby
 # Defining specific test dynamic attributes
 expect(response.body).to match_snapshot("api/resources_index", dynamic_attributes: %w(confirmed_at relation_id))
+```
+
+##### ignore_order
+
+It is possible to use the `ignore_order` inline option to mark which array nodes are unsorted and that elements position
+should not be taken into consideration.
 
+```ruby
 # Ignoring order for certain arrays (this will ignore the ordering for the countries array inside the json response)
 expect(response.body).to match_snapshot("api/resources_index", ignore_order: %w(countries))
 ```
 
+**Note:** If you are using `ignore_order` for arrays of objects/hashes (ie: `[{name: "name", value: "value"}, ...]`),
+it won't perform well depending on the array and hash size (number of keys)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rspec/request_snapshot/handlers/base.rb

@@ -8,5 +8,9 @@ module Rspec::RequestSnapshot::Handlers
       @dynamic_attributes ||= RSpec.configuration.request_snapshots_dynamic_attributes |
                               Array(@options[:dynamic_attributes])
     end
+
+    def ignore_order
+      @ignore_order ||= @options[:ignore_order] || []
+    end
   end
 end

data/lib/rspec/request_snapshot/handlers/json.rb

@@ -1,22 +1,10 @@
 class Rspec::RequestSnapshot::Handlers::JSON < Rspec::RequestSnapshot::Handlers::Base
   def compare(actual, expected)
-    equal = true
-
-    actual.each do |key, value|
-      if actual[key].is_a?(Hash)
-        equal &= compare_hash(key, actual, expected)
-      elsif actual[key].is_a?(Array)
-        equal &= compare_array(key, actual, expected)
-      else
-        equal &= compare_value(key, actual, expected)
-      end
-    end
-
-    equal
+    actual == expected
   end
 
   def comparable(str)
-    JSON.parse(str)
+    deep_transform_values(JSON.parse(str).dup)
   end
 
   def writable(str)
@@ -25,21 +13,25 @@ class Rspec::RequestSnapshot::Handlers::JSON < Rspec::RequestSnapshot::Handlers:
 
   private
 
-  def compare_hash(key, actual, expected)
-    actual[key].is_a?(Hash) && expected[key].is_a?(Hash) && compare(actual[key], expected[key])
-  end
+  def deep_transform_values(hash)
+    hash.each do |key, value|
+      if dynamic_attributes.include?(key)
+        hash[key] = "REPLACED"
+      end
 
-  def compare_array(key, actual, expected)
-    if actual[key].is_a?(Array) && expected[key].is_a?(Array)
-      if @options[:ignore_order] && @options[:ignore_order].include?(key)
-        actual[key].sort == expected[key].sort
-      else
-        actual[key] == expected[key]
+      if hash[key].is_a?(Hash)
+        deep_transform_values(hash[key])
       end
-    end
-  end
 
-  def compare_value(key, actual ,expected)
-    dynamic_attributes.include?(key) ? true : actual[key] == expected[key]
+      if hash[key].is_a?(Array)
+        hash[key].each do |value|
+          deep_transform_values(value) if value.is_a?(Hash)
+        end
+
+        if ignore_order.include?(key)
+          hash[key].first.is_a?(Hash) ? hash[key].sort_by! { |e| e.keys.map { |k| e[k] } } : hash[key].sort!
+        end
+      end
+    end
   end
 end

data/lib/rspec/request_snapshot/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module RequestSnapshot
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bruno Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-07 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec