rspec-snapshot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 399a12bddd879883df59d2585f9b79f0af141f13
+  data.tar.gz: 05f6017e55fa1cd0475e88c0c5c8c085a81ac9c2
+SHA512:
+  metadata.gz: a1e1bf2d3e3498d3edabc29e4327cd224086e6e0e4f5b990e33b5bd97e2ddb98b3b4d6360266e9cf46ef3352c2fb3b8faa42b21a9e57d3910354be1849453624
+  data.tar.gz: e7c596351101233fe6faf2eaf2e567062b6abf256a2f1a935d626a1ea0376d920c27720a9b8dbb05660a7924b146b987b072240ac8138bc28fde355a3056e57b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+  - 2.3.1
+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.gemspec
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+# RSpec::Snapshot
+
+Adding snapshot testing to RSpec, inspired by [jest](http://facebook.github.io/jest/blog/2016/07/27/jest-14.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-snapshot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-snapshot
+
+## Usage
+
+### Configration
+
+```ruby
+RSpec.configure do |config|
+  # The default setting is `:relative`, that means snapshots will be generate to
+  # the relative path of the spec file.
+  config.snapshot_dir = "spec/fixtures/snapshots"
+end
+```
+
+### Rails JSON API controller testing
+
+```ruby
+describe TeamsController do
+  describe "GET index" do
+    it "returns a list of team" do
+      get :index
+      expect(response.body).to match_snapshot('controllers/teams/index')
+    end
+  end
+end
+```
+
+### Rails view testing
+
+```ruby
+describe "widgets/index" do
+  it "displays all the widgets" do
+    assign(:widgets, [
+      Widget.create!(:name => "slicer"),
+      Widget.create!(:name => "dicer")
+    ])
+
+    render
+
+    expect(rendered).to match_snapshot('views/widgets/index')
+  end
+end
+```
+
+Use your imagination for other usages!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/yesmeck/rspec-snapshot.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task test: [:spec]
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/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

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

@@ -0,0 +1,4 @@
+require "rspec"
+require "rspec/snapshot/version"
+require "rspec/snapshot/configuration"
+require "rspec/snapshot/matchers"

data/lib/rspec/snapshot/configuration.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Snapshot
+    class Configuration; end
+
+    def self.initialize_configuration(config)
+      config.add_setting :snapshot_dir, :default => :relative
+    end
+
+    initialize_configuration RSpec.configuration
+  end
+end

data/lib/rspec/snapshot/matchers.rb

@@ -0,0 +1,16 @@
+require "json"
+require "rspec/snapshot/matchers/match_snapshot"
+
+module RSpec
+  module Snapshot
+    module Matchers
+      def match_snapshot(snapshot_name)
+        MatchSnapShot.new(self.class.metadata, snapshot_name)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Snapshot::Matchers
+end

data/lib/rspec/snapshot/matchers/match_snapshot.rb

@@ -0,0 +1,46 @@
+require "fileutils"
+
+module RSpec
+  module Snapshot
+    module Matchers
+      class MatchSnapShot
+        def initialize(metadata, snapshot_name)
+          @metadata = metadata
+          @snapshot_name = snapshot_name
+        end
+
+        def matches?(actual)
+          @actual = actual
+          filename = "#{@snapshot_name}.snap"
+          snap_path = File.join(snapshot_dir, filename)
+          FileUtils.mkdir_p(File.dirname(snap_path)) unless Dir.exist?(File.dirname(snap_path))
+          if File.exist?(snap_path)
+            file = File.new(snap_path)
+            @expect = file.read
+            file.close
+            @actual == @expect
+          else
+            RSpec.configuration.reporter.message "Generate #{snap_path}"
+            file = File.new(snap_path, "w+")
+            file.write(@actual)
+            file.close
+            true
+          end
+        end
+
+
+        def failure_message
+          "\nexpected: #{@expect_snap}\n     got: #{@actual_snap}\n"
+        end
+
+        def snapshot_dir
+          if RSpec.configuration.snapshot_dir.to_s == 'relative'
+            File.dirname(@metadata[:file_path]) << "/__snapshots__"
+          else
+            RSpec.configuration.snapshot_dir
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/snapshot/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Snapshot
+    VERSION = "0.1.0"
+  end
+end

data/rspec-snapshot.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/snapshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-snapshot"
+  spec.version       = RSpec::Snapshot::VERSION
+  spec.authors       = ["Wei Zhu"]
+  spec.email         = ["yesmeck@gmail.com"]
+
+  spec.summary       = %q{RSpec Snapshot Matcher}
+  spec.description   = %q{Adding snapshot testing to RSpec}
+  spec.homepage      = "https://github.com/yesmeck/rspec-snapshot"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "> 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "activesupport", "~> 5.0.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: rspec-snapshot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wei Zhu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-05 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Adding snapshot testing to RSpec
+email:
+- yesmeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/snapshot.rb
+- lib/rspec/snapshot/configuration.rb
+- lib/rspec/snapshot/matchers.rb
+- lib/rspec/snapshot/matchers/match_snapshot.rb
+- lib/rspec/snapshot/version.rb
+- rspec-snapshot.gemspec
+homepage: https://github.com/yesmeck/rspec-snapshot
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: RSpec Snapshot Matcher
+test_files: []