rspec_snapshot_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dd8baeccde6842990b6f4d3674d04ed06f148f7
+  data.tar.gz: 59b5d4c87b1c79823b000242bcbed57a6c167233
+SHA512:
+  metadata.gz: db1cd82d6542d153fd5ea34b81ee49610ff2b44394c84c90d6341c81666770723ffecf80cb54cd8cb99de2d3da1f6d558c3a6b4d049fd5ef939166f2fede7d4d
+  data.tar.gz: 2383e45372c766eeb6a3336291ef71106dac0a0b91e4536984db693652c23c26dfa3c55775b7e2ba61d2794c0ab4385e3c6fdbe6ad23e6ebe28fc8d24f3bc6a8

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/fixtures/snapshots
+
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+Style/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+  FunctionalMethods:
+    - before
+    - let
+    - let!
+    - subject
+    - expect

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-snapshot-matcher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Patrick Caldwell
+
+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,41 @@
+# Rspec::Snapshot::Matcher
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/snapshot/matcher`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-snapshot-matcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-snapshot-matcher
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/rspec-snapshot-matcher.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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_snapshot_matcher'
+
+# 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

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_snapshot_matcher.rb

@@ -0,0 +1,2 @@
+require 'rspec_snapshot_matcher/version'
+require 'rspec_snapshot_matcher/matchers'

data/lib/rspec_snapshot_matcher/matchers.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'rspec_snapshot_matcher/matchers/snapshot_matcher.rb'
+
+RSpec.configure do |config|
+  config.include(RSpecSnapshotMatcher::Matchers)
+
+  config.around(:all) do |example|
+    Thread.current[:rspec_snapshot_matcher_example] = example
+    example.run
+    Thread.current[:rspec_snapshot_matcher_example] = nil
+  end
+end

data/lib/rspec_snapshot_matcher/matchers/snapshot_matcher.rb

@@ -0,0 +1,87 @@
+require 'yaml'
+
+module RSpecSnapshotMatcher
+  module Matchers
+    class MatchSnapshot
+      attr_reader :actual, :expected
+
+      def matches?(actual)
+        @actual = actual
+
+        if File.exist?(snapshot_filename)
+          @expected = YAML.load_file(snapshot_filename)
+          return @actual == @expected
+        else
+          save_snapshot(actual, snapshot_filename)
+          return true
+        end
+      end
+
+      def description
+        "match snapshot #{snapshot_filename}"
+      end
+
+      def failure_message
+        [
+          "expected: #{expected.inspect}",
+          "     got: #{actual.inspect}",
+          '',
+          "(using snapshot #{snapshot_filename})"
+        ].join("\n")
+      end
+
+      def failure_message_when_negated
+        [
+          'expected value not to match snapshot but it did',
+          "snapshot: #{actual.inspect}",
+          '',
+          "(using snapshot #{snapshot_filename})",
+          '',
+          'does negating this matcher really make sense?'
+        ].join("\n")
+      end
+
+      def diffable?
+        true
+      end
+
+      private
+
+      def save_snapshot(actual, filename)
+        snapshot_directory = File.dirname(filename)
+        FileUtils.mkdir_p(snapshot_directory)
+
+        File.open(snapshot_filename, 'w') do |io|
+          io.write(actual.to_yaml)
+        end
+      end
+
+      def snapshot_filename
+        @snapshot_filename ||= begin
+          parts = [
+            'spec',
+            'fixtures',
+            'snapshots',
+            *example_group_path,
+            example.description
+          ].map { |part| part.gsub(/\W/, '_') }
+
+          "#{File.join(*parts)}.yml"
+        end
+      end
+
+      def example_group_path
+        return [] unless example.example_group
+        example.example_group.parent_groups.reverse.map(&:description)
+      end
+
+      def example
+        Thread.current[:rspec_snapshot_matcher_example]
+      end
+    end
+
+    def match_snapshot(*args)
+      MatchSnapshot.new(*args)
+    end
+  end
+end

data/lib/rspec_snapshot_matcher/version.rb

@@ -0,0 +1,3 @@
+module RSpecSnapshotMatcher
+  VERSION = '0.1.0'.freeze
+end

data/rspec_snapshot_matcher.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_snapshot_matcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_snapshot_matcher'
+  spec.version       = RSpecSnapshotMatcher::VERSION
+  spec.authors       = ['Patrick Caldwell']
+  spec.email         = ['tncbbthositg@gmail.com']
+
+  spec.summary       = 'Matcher to compare objects to snapshots like Jest'
+  spec.description   = %(This is an RSpec matcher that compares an actual value with the expected
+value from an autogenerated snapshot file.)
+  spec.homepage      = 'https://github.com/autopilotconsulting/rspec-snapshot-matcher'
+  spec.license       = 'MIT'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49.1'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: rspec_snapshot_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Patrick Caldwell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+description: |-
+  This is an RSpec matcher that compares an actual value with the expected
+  value from an autogenerated snapshot file.
+email:
+- tncbbthositg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec_snapshot_matcher.rb
+- lib/rspec_snapshot_matcher/matchers.rb
+- lib/rspec_snapshot_matcher/matchers/snapshot_matcher.rb
+- lib/rspec_snapshot_matcher/version.rb
+- rspec_snapshot_matcher.gemspec
+homepage: https://github.com/autopilotconsulting/rspec-snapshot-matcher
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Matcher to compare objects to snapshots like Jest
+test_files: []