rspec-request_snapshot 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: ebce346679cd3afa78a14b57d9483e9afdfa936daa9f154324f5e4e0b46faf84
-  data.tar.gz: 8df3dcbfaaeff8d973c8595e91238bd361a8a740d532dc3df4a6c5aebf151c12
+SHA1:
+  metadata.gz: 8f2c9dc8612a821675811ac7621e84a9da8bb54d
+  data.tar.gz: d09a1183cc112880e8f4fbb61fd34a6be5d6dd91
 SHA512:
-  metadata.gz: a9fa5861c5387b50d73d2348210b270282129ea7fe68825a3c6ccef21418e3df42200de04fbb2714258ccbd26fcc449216534c7ae0d16e82263056470dff489a
-  data.tar.gz: 63303ef240dce2b6872152903fc514297fc393004301a91e5016cc8863421dac9425750b6793cee700d60e8677bbb7fec90e6b52d60d354ac6596f99d0fa56a7
+  metadata.gz: ea9601e44240f191364333687fc2e3541887d01ca7e965b488d58a3ed62048747bcaa08104a338397e3fffb6101a8330d8fef2fcc5a172acf71d69971640aa10
+  data.tar.gz: 2f2cb89d4effa9f238d112f19743c81ec7bbef73ee55123574398130c906fb4059c8e6540019fb8eedd9357a8379e9b14a27ef5384d4b87810ae3d042e0da464

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-       - image: circleci/ruby:2.5-node-browsers
+       - image: circleci/ruby:2.1
 
     working_directory: ~/repo
 

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [v0.6.0]
+
+### Fixed
+- Removed code that made gem compatible only with ruby >= 2.3
+
+### Added
+- Added support for regex on dynamic attributes
+- Added a CHANGELOG.md file

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-request_snapshot (0.5.0)
+    rspec-request_snapshot (0.6.0)
       rspec (~> 3.0)
 
 GEM
@@ -40,4 +40,4 @@ DEPENDENCIES
   simplecov (~> 0.16.1)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -80,6 +80,19 @@ Notice that **all** nodes matching those (nested or not) will be ignored. Usage:
 expect(response.body).to match_snapshot("api/resources_index", dynamic_attributes: %w(confirmed_at relation_id))
 ```
 
+##### dynamic_attributes with regex
+
+Sometimes you don't want to fully ignore an attribute. For example, you want to make sure
+that `generated_id` is present and following a given pattern, but that attribute can change
+randonly, use `dynamic_attributes` with object/regex notation:
+
+```ruby
+# Example generated_id: ABC-001
+expect(response.body).to match_snapshot("api/resources_index", dynamic_attributes: [{ generated_id: /^\w{3}-\d{3}$/ }])
+```
+
+**Note:** Partial matches are also possible, so use the start/end of line characters for a strict match
+
 ##### ignore_order
 
 It is possible to use the `ignore_order` inline option to mark which array nodes are unsorted and that elements position

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

@@ -2,18 +2,37 @@
 
 module Rspec::RequestSnapshot::Handlers
   class Base
+    attr_reader :dynamic_attributes_with_regex
+
     def initialize(options = {})
       @options = options
     end
 
     def dynamic_attributes
-      @dynamic_attributes ||= RSpec.configuration.request_snapshots_dynamic_attributes |
-                              Array(@options[:dynamic_attributes])
+      @dynamic_attributes ||= begin
+        list = RSpec.configuration.request_snapshots_dynamic_attributes | Array(@options[:dynamic_attributes])
+        strip_attributes_with_regex(list)
+      end
     end
 
     def ignore_order
       @ignore_order ||= RSpec.configuration.request_snapshots_ignore_order |
                         Array(@options[:ignore_order])
     end
+
+    private
+
+    def strip_attributes_with_regex(list)
+      @dynamic_attributes_with_regex = {}
+      list.map do |element|
+        if element.is_a?(String)
+          element
+        else
+          key = element.keys.first.to_s
+          @dynamic_attributes_with_regex[key] = element.values.first
+          key
+        end
+      end
+    end
   end
 end

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

@@ -18,7 +18,7 @@ class Rspec::RequestSnapshot::Handlers::JSON < Rspec::RequestSnapshot::Handlers:
   def deep_transform_values(hash)
     hash.each_key do |key|
       if dynamic_attributes.include?(key)
-        hash[key] = "REPLACED"
+        handle_dynamic_attribute(hash, key)
         next
       end
 
@@ -42,4 +42,12 @@ class Rspec::RequestSnapshot::Handlers::JSON < Rspec::RequestSnapshot::Handlers:
   def sort_elements(hash, key)
     hash[key].first.is_a?(Hash) ? hash[key].sort_by! { |e| e.keys.map { |k| e[k] } } : hash[key].sort!
   end
+
+  def handle_dynamic_attribute(hash, key)
+    if dynamic_attributes_with_regex.key?(key)
+      hash[key] = dynamic_attributes_with_regex[key] if dynamic_attributes_with_regex[key].match(hash[key].to_s)
+    else
+      hash[key] = "IGNORED"
+    end
+  end
 end

data/lib/rspec/request_snapshot/matcher.rb

@@ -32,7 +32,7 @@ module Rspec::RequestSnapshot
     end
 
     def format
-      @options[:format]&.to_sym || RSpec.configuration.request_snapshots_default_format
+      (@options[:format] && @options[:format].to_sym) || RSpec.configuration.request_snapshots_default_format
     end
 
     def handler

data/lib/rspec/request_snapshot/version.rb

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

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_snapshot
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Bruno Campos
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.1
 description: Make sure API behavior is not changing by taking and storing a snapshot
@@ -74,12 +74,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".codeclimate.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
+- .circleci/config.yml
+- .codeclimate.yml
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-version
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -105,17 +106,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Gold master testing for RSpec API request specs