rspec-request_snapshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91f5656a0f745a0e13bee0f04738a1fc60a9217b614458433a12e0eb0734c300
+  data.tar.gz: 513056854ad49b8f92a26dbb7ac592542ef406b46690972a197ec75fb9516e8f
+SHA512:
+  metadata.gz: fe5490d3028654103286d208ac0b8f41ef5c801431ac2fea3db6215328ab17a59ea9905bf0a0a776cb5834d0217436520963583ff6b79cb9a696e94f23d36cd9
+  data.tar.gz: 6917720effe7ade229edad8c50196cdef162f4150da9c95a63afe131a0031986ba810e19f855484d73f702a5e0efbc373b1ab25852a8c270e63bcec4cc50eec3

data/.circleci/config.yml

@@ -0,0 +1,43 @@
+version: 2
+jobs:
+  build:
+    docker:
+       - image: circleci/ruby:2.5-node-browsers
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: Download CodeClimate cc-test-reporter
+          command: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+
+      - run:
+          name: Make cc-test-reporter executable
+          command: chmod +x ./cc-test-reporter
+
+      - run:
+          name: Report before build to CodeClimate
+          command: ./cc-test-reporter before-build
+
+      - run:
+          name: run tests
+          command: bundle exec rspec
+
+      - run:
+          name: Report after build to CodeClimate
+          command: ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,59 @@
+# require: rubocop-rspec
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Metrics/LineLength:
+  Max: 120
+  AllowURI: true
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Documentation:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Layout/FirstHashElementLineBreak:
+  Enabled: true
+
+Style/BlockDelimiters:
+  Exclude:
+    - "spec/**/*"
+
+Style/GlobalVars:
+  AllowedVariables:
+  - "$rails_rake_task"
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '()'
+    '%W': '()'
+    '%i': '()'
+    '%I': '()'
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Naming/PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+# Custom Checks
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+AllCops:
+  Exclude:
+    - "*.gemspec"

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-request_snapshot.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    rspec-request_snapshot (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.1)
+    json (2.1.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-request_snapshot!
+  simplecov (~> 0.16.1)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 CareMessage
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# Rspec::RequestSnapshot
+
+Gold master testing for RSpec API request specs. 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.
+
+By default, snapshots are stored under `spec/fixtures/snapshots` and should be code reviewed as well. The syntax is inspired by Jest.
+
+References:
+- [Gold Master Testing article by CodeClimate](https://codeclimate.com/blog/gold-master-testing/)
+- [Jest Snapshot Testing](https://jestjs.io/docs/en/snapshot-testing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-request_snapshot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-request_snapshot
+
+## Usage
+
+### Configuration
+
+```ruby
+RSpec.configure do |config|
+  # The place where snapshots will be stored
+  # Default value is spec/fixtures/snapshots
+  config.request_snapshots_dir = "spec/fixtures/snapshots"
+
+  # The json attributes that you want to ignore when comparing snapshots
+  # Default value is [id, created_at, updated_at]
+  config.request_snapshots_dynamic_attributes = %w(id created_at updated_at)
+end
+```
+
+### Snapshot files
+
+On the first run, the `match_snapshot` matcher will always return success and it will store a snapshot file. On the next runs, it will compare the response with the file content.
+
+If you need to replace snapshots, run the specs with:
+
+    REPLACE_SNAPSHOTS=true bundle exec rspec
+
+### Matcher
+
+```ruby
+# Stores snapshot under spec/fixtures/snapshots/api/resources_index.json
+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)
+
+# Defining specific test dynamic attributes
+expect(response.body).to match_snapshot("api/resources_index", dyanmic_attributes: %w(confirmed_at relation_id))
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CareMessagePlatform/rspec-request_snapshot.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/request_snapshot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/request_snapshot/config.rb

@@ -0,0 +1,6 @@
+module Rspec::RequestSnapshot
+  RSpec.configure do |config|
+    config.add_setting :request_snapshots_dir, default: "spec/fixtures/snapshots"
+    config.add_setting :request_snapshots_dynamic_attributes, default: %w(id created_at updated_at)
+  end
+end

data/lib/rspec/request_snapshot/matcher.rb

@@ -0,0 +1,67 @@
+require "json"
+
+module Rspec::RequestSnapshot
+  RSpec::Matchers.define :match_snapshot do |snapshot_name, options|
+    attr_reader :actual, :expected, :options
+
+    diffable
+
+    match do |actual|
+      @options = options || {}
+
+      snapshot_file_path = File.join(RSpec.configuration.request_snapshots_dir, "#{snapshot_name}.json")
+
+      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
+      else
+        File.write(snapshot_file_path, writable(comparable(@actual)))
+        true
+      end
+    end
+
+    failure_message do
+      [
+        "expected: #{expected}",
+        "     got: #{actual}"
+      ].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\"")
+      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

@@ -0,0 +1,5 @@
+module Rspec
+  module RequestSnapshot
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/rspec/request_snapshot.rb

@@ -0,0 +1,3 @@
+require "rspec/request_snapshot/version"
+require "rspec/request_snapshot/config"
+require "rspec/request_snapshot/matcher"

data/rspec-request_snapshot.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/request_snapshot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-request_snapshot"
+  spec.version       = Rspec::RequestSnapshot::VERSION
+  spec.authors       = ["Bruno Campos"]
+  spec.email         = ["bcampos@caremessage.org"]
+
+  spec.summary       = "Gold master testing for RSpec API request specs"
+  spec.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."
+  spec.homepage      = "https://github.com/CareMessagePlatform/rspec-request_snapshot"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16.1"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rspec-request_snapshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Campos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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
+  from an API response on a first run and check if they match on next spec runs.
+email:
+- bcampos@caremessage.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/request_snapshot.rb
+- lib/rspec/request_snapshot/config.rb
+- lib/rspec/request_snapshot/matcher.rb
+- lib/rspec/request_snapshot/version.rb
+- rspec-request_snapshot.gemspec
+homepage: https://github.com/CareMessagePlatform/rspec-request_snapshot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Gold master testing for RSpec API request specs
+test_files: []