rspec-request_snapshot 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca942ac1703a10b7062475e78aa65cee5be244d06fa630bec9c6e317807e7cba
-  data.tar.gz: 985cecfe4a2b42897cac99fcca8d2eabd473f6210b181cd1c4167e92d4c71ae0
+  metadata.gz: 63e2665c7ef3ad56f77f9cdf3d037e1c889a15218ffa8350929ba3fe77c63335
+  data.tar.gz: ab9c6146284efd2db0b2f9821160ccebc83a75ad40b1c1826e1c1c3b0c103573
 SHA512:
-  metadata.gz: 410e38254160532d97af140d308742cc122cb84c234586d91f1f36fb31cb1ba557efbce1e4b298c3abfeba1794b0b7ab7faab81df3e0ab9a0741a7b547022b1e
-  data.tar.gz: 407246c76b84a0b0b185cd2dfec465983cdfeb7ddfdc34197344a542aedbd79358fb0c18f78f6dc5549cefc989da022c127cc56f62e27a9be00b9dd41efd796d
+  metadata.gz: e9a7b6a9592f44ca0cab09167e15aaa90436935aab9f16989fe68488edebb0f22fd945a83c47bc8ccdba1b8c8c6733f1ae40fa337cd82f9572d308e0b7fd8939
+  data.tar.gz: 5af511e46ac7d7968970b4738e39a5d1657652492b9239a85136db6c5f705862bec92ed7a1b5211eb4ae3696f6c00986e2fa74248190acba7488ca0569f50170

data/Gemfile.lock

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

data/README.md

@@ -59,6 +59,9 @@ expect(response.body).to match_snapshot("api/resources_index", format: :text)
 
 # Defining specific test dynamic attributes
 expect(response.body).to match_snapshot("api/resources_index", dynamic_attributes: %w(confirmed_at relation_id))
+
+# 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))
 ```
 
 ## Development

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

@@ -0,0 +1,12 @@
+module Rspec::RequestSnapshot::Handlers
+  class Base
+    def initialize(options = {})
+      @options = options
+    end
+
+    def dynamic_attributes
+      @dynamic_attributes ||= RSpec.configuration.request_snapshots_dynamic_attributes |
+                              Array(@options[:dynamic_attributes])
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+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
+  end
+
+  def comparable(str)
+    JSON.parse(str)
+  end
+
+  def writable(str)
+    JSON.pretty_generate(JSON.parse(str))
+  end
+
+  private
+
+  def compare_hash(key, actual, expected)
+    actual[key].is_a?(Hash) && expected[key].is_a?(Hash) && compare(actual[key], expected[key])
+  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]
+      end
+    end
+  end
+
+  def compare_value(key, actual ,expected)
+    dynamic_attributes.include?(key) ? true : actual[key] == expected[key]
+  end
+end

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

@@ -0,0 +1,13 @@
+class Rspec::RequestSnapshot::Handlers::Text < Rspec::RequestSnapshot::Handlers::Base
+  def compare(actual, expected)
+    actual == expected
+  end
+
+  def comparable(str)
+    str
+  end
+
+  def writable(str)
+    str
+  end
+end

data/lib/rspec/request_snapshot/matcher.rb

@@ -1,5 +1,3 @@
-require "json"
-
 module Rspec::RequestSnapshot
   RSpec::Matchers.define :match_snapshot do |snapshot_name, options|
     attr_reader :actual, :expected, :options
@@ -14,11 +12,12 @@ module Rspec::RequestSnapshot
       FileUtils.mkdir_p(File.dirname(snapshot_file_path)) unless Dir.exist?(File.dirname(snapshot_file_path))
 
       if File.exist?(snapshot_file_path) && !(ENV["REPLACE_SNAPSHOTS"] == "true")
-        @actual = comparable(replace_dynamic_attributes(actual))
-        @expected = comparable(replace_dynamic_attributes(File.read(snapshot_file_path)))
-        @actual == @expected
+        @actual = handler.comparable(actual)
+        @expected = handler.comparable(File.read(snapshot_file_path))
+
+        handler.compare(@actual, @expected)
       else
-        File.write(snapshot_file_path, writable(comparable(@actual)))
+        File.write(snapshot_file_path, handler.writable(actual))
         true
       end
     end
@@ -30,38 +29,20 @@ module Rspec::RequestSnapshot
       ].join("\n")
     end
 
-    def comparable(str)
-      case format
-      when :text
-        str
-      when :json
-        JSON.parse(str)
-      end
-    end
-
-    def writable(str)
-      case format
-      when :text
-        str
-      when :json
-        JSON.pretty_generate(str)
-      end
-    end
-
     def format
       @options[:format]&.to_sym || :json
     end
 
-    def replace_dynamic_attributes(json)
-      dynamic_attributes.each do |attribute|
-        json.gsub!(/\"#{attribute}\":\s*(\".*?\"|\d+|\w+)/, "\"#{attribute}\":\"REPLACED\"")
+    def handler
+      @handler ||= begin
+        handler_class = case format
+        when :text
+          Handlers::Text
+        when :json
+          Handlers::JSON
+        end
+        handler_class.new(@options)
       end
-      json
-    end
-
-    def dynamic_attributes
-      @dynamic_attributes ||= RSpec.configuration.request_snapshots_dynamic_attributes |
-                              Array(options[:dynamic_attributes])
     end
   end
 end

data/lib/rspec/request_snapshot/version.rb

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

data/lib/rspec/request_snapshot.rb

@@ -2,3 +2,6 @@ require "rspec"
 require "rspec/request_snapshot/version"
 require "rspec/request_snapshot/config"
 require "rspec/request_snapshot/matcher"
+require "rspec/request_snapshot/handlers/base"
+require "rspec/request_snapshot/handlers/json"
+require "rspec/request_snapshot/handlers/text"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Bruno Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-03 00:00:00.000000000 Z
+date: 2019-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -87,6 +87,9 @@ files:
 - bin/setup
 - lib/rspec/request_snapshot.rb
 - lib/rspec/request_snapshot/config.rb
+- lib/rspec/request_snapshot/handlers/base.rb
+- lib/rspec/request_snapshot/handlers/json.rb
+- lib/rspec/request_snapshot/handlers/text.rb
 - lib/rspec/request_snapshot/matcher.rb
 - lib/rspec/request_snapshot/version.rb
 - rspec-request_snapshot.gemspec