rspec-request_snapshot 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 064a2bd24422bf55dec9a6e2272481a14fbc8819
-  data.tar.gz: ad9e88a9e83e8216135d7b57d6eb7eaefadd00fb
+  metadata.gz: 5ba15dd1a24c663735cff748399371edcd987160
+  data.tar.gz: 9c3c9529912b9fe6161c12174ee72ead76ddf7fd
 SHA512:
-  metadata.gz: 6773e770587d2ad04ea6d3e049d0bca8bcc9663473801aebaeb6da9701df471b8e0f3b2fc0ed83147e449c57d8e3d3a5cf6219f027ba6ac186cf9db6a181c991
-  data.tar.gz: 5676af26f46bf00e36b6f4edfe95b2a5490dc9a1e20cce010ee5ea7f06f2a25be9dedeff5aabf14507274a25aafc2c49327840d270be53abe2380db5007a2de4
+  metadata.gz: 1d4d0e31e051360a7b123cdd2f7356209291b90405d7ba3372a704d20febf9911ca46183d91250c6c81abe2e3be54ec209f0d2b8bdb76497d44bd45c23234149
+  data.tar.gz: f0b050f54ba17e8341ae4be7220e6a86f33db26e80a995b70eb344688bfae5726f7f3eed5cf7f9d6af721f8fa7a6fe610edd158bff0b20b04f1e32b9b6f08db5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [v0.7.0]
+
+### Added
+- Added CONSERVATIVE_UPDATE_SNAPSHOTS flag
+
 ## [v0.6.2]
 
 ### Fixed

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    rspec-request_snapshot (0.6.2)
+    rspec-request_snapshot (0.7.0)
       rspec (~> 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    climate_control (0.1.0)
     diff-lcs (1.3)
     docile (1.3.1)
     json (2.1.0)
@@ -35,6 +36,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
+  climate_control (~> 0.1.0)
   rake (~> 10.0)
   rspec-request_snapshot!
   simplecov (~> 0.16.1)

data/README.md

@@ -57,6 +57,13 @@ If you need to replace snapshots, run the specs with:
 
     REPLACE_SNAPSHOTS=true bundle exec rspec
 
+If you only need to add, remove or replace data without replacing the whole snapshot:
+
+    CONSERVATIVE_UPDATE_SNAPSHOTS=true bundle exec rspec
+
+**Note:** Conservative update will not work along with ignore_order option. It should only be used when there is
+no major changes in the snapshots that will be updated.
+
 ### Matcher
 
 ```ruby

data/lib/rspec/request_snapshot.rb

@@ -7,3 +7,5 @@ require "rspec/request_snapshot/matcher"
 require "rspec/request_snapshot/handlers/base"
 require "rspec/request_snapshot/handlers/json"
 require "rspec/request_snapshot/handlers/text"
+require "rspec/request_snapshot/updaters/base"
+require "rspec/request_snapshot/updaters/json"

data/lib/rspec/request_snapshot/matcher.rb

@@ -14,6 +14,8 @@ 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")
+        updater.update(actual, snapshot_file_path) if ENV["CONSERVATIVE_UPDATE_SNAPSHOTS"] == "true"
+
         @actual = handler.comparable(actual)
         @expected = handler.comparable(File.read(snapshot_file_path))
 
@@ -46,5 +48,15 @@ module Rspec::RequestSnapshot
         handler_class.new(@options)
       end
     end
+
+    def updater
+      @updater ||= begin
+        convervative_updater_class = case format
+                                     when :json
+                                       Updaters::JSON
+                                     end
+        convervative_updater_class.new(@options)
+      end
+    end
   end
 end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Rspec::RequestSnapshot::Updaters
+  class Base < Rspec::RequestSnapshot::Handlers::Base
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Rspec::RequestSnapshot::Updaters::JSON < Rspec::RequestSnapshot::Updaters::Base
+  def update(expected_json, snapshot_file_path)
+    expected_json = JSON.parse(expected_json)
+    stored_json = JSON.parse(File.read(snapshot_file_path))
+
+    deep_update(expected_json, stored_json)
+
+    File.write(snapshot_file_path, stored_json.to_json)
+  end
+
+  private
+
+  def deep_update(expected_json, stored_json)
+    case expected_json
+    when Array
+      deep_update_array(expected_json, stored_json)
+    when Hash
+      deep_update_hash(expected_json, stored_json)
+    end
+  end
+
+  def deep_update_hash(expected_json, stored_json)
+    keys = expected_json.keys | stored_json.keys
+    keys.each do |key|
+      # If key present on expected and not stored, add it to stored
+      if stored_json[key].nil?
+        stored_json[key] = expected_json[key]
+        next
+      end
+
+      # If key only present on stored, remove it from stored
+      if expected_json[key].nil?
+        stored_json.delete(key)
+        next
+      end
+
+      # If key present on both, and not a dynamic attribute, update the stored one
+      unless dynamic_attributes.include?(key)
+        if expected_json[key].is_a?(Hash) || expected_json[key].is_a?(Array)
+          deep_update(expected_json[key], stored_json[key])
+        else
+          stored_json[key] = expected_json[key]
+        end
+      end
+    end
+  end
+
+  def deep_update_array(expected_json, stored_json)
+    max_size = [expected_json.size, stored_json.size].max
+
+    0.upto(max_size).each do |index|
+      # If element is only present on expected, add it to stored
+      stored_json[index] = expected_json[index] if !stored_json[index] && expected_json[index]
+
+      # If element is only present on stored, remove it from stored
+      stored_json.delete_at(index) if !expected_json[index] && stored_json[index]
+
+      deep_update(expected_json[index], stored_json[index])
+    end
+  end
+end

data/lib/rspec/request_snapshot/version.rb

@@ -3,7 +3,7 @@
 # rubocop:disable Style/ClassAndModuleChildren
 module Rspec
   module RequestSnapshot
-    VERSION = "0.6.2"
+    VERSION = "0.7.0"
   end
 end
 # rubocop:enable Style/ClassAndModuleChildren

data/rspec-request_snapshot.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "simplecov", "~> 0.16.1"
+  spec.add_development_dependency "climate_control", "~> 0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Bruno Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-20 00:00:00.000000000 Z
+date: 2019-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -66,6 +66,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Make sure API behavior is not changing by taking and storing a snapshot
   from an API response on a first run and check if they match on next spec runs.
 email:
@@ -94,6 +108,8 @@ files:
 - lib/rspec/request_snapshot/handlers/json.rb
 - lib/rspec/request_snapshot/handlers/text.rb
 - lib/rspec/request_snapshot/matcher.rb
+- lib/rspec/request_snapshot/updaters/base.rb
+- lib/rspec/request_snapshot/updaters/json.rb
 - lib/rspec/request_snapshot/version.rb
 - rspec-request_snapshot.gemspec
 homepage: https://github.com/CareMessagePlatform/rspec-request_snapshot