rspec-cheki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e079e7662848acc9fe720fa18ceb6ecb763bd178
+  data.tar.gz: 688dea3cf905528d15651ca6f16cde6b8316194f
+SHA512:
+  metadata.gz: 94b385a70d24165e37d267cbc7ba9b37f25abafb7470561ee0016fd70cbbaed6157db707fe2a7a545a9b8f605d1df3c1bb290f922368098d355a02a0a7b75f2a
+  data.tar.gz: 67059f796c90becc1a72add2ec4cc90e1c5404f988552f450ac1a6005f9b3fc55ca9aeba518fffc423965ccc5602583be2790a3e327cf1398dc492294b6693bc

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+# To use the MeowCop gem.
+inherit_gem:
+  meowcop:
+    - config/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 100
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7
+script:
+  - bundle exec rubocop
+  - bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at masayuki@izumin.info. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 izumin5210
+
+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,70 @@
+# RSpec::Cheki
+[![Build Status](https://travis-ci.org/izumin5210/rspec-cheki.svg?branch=master)](https://travis-ci.org/izumin5210/rspec-cheki)
+[![license](https://img.shields.io/github/license/izumin5210/rspec-cheki.svg)](https://github.com/izumin5210/rspec-cheki/blob/master/LICENSE.txt)
+
+Support snapshot testing, inspired [Jest](https://facebook.github.io/jest/).
+
+```ruby
+expect(response.body).to match_snapshot
+
+# or...
+
+expect(response.body).to say_cheese
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-cheki'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-cheki
+
+## Usage
+
+Requrie `rspec-cheki` from your `spec_helper.rb`.
+
+```ruby
+requrie 'rspec-cheki'
+```
+
+### `match_snapshot` matcher
+
+```ruby
+expect(response.body).to match_snapshot
+
+# And you can use `say_cheese` matcher (This is an alias of `match_snapshot` matcher)
+expect(response.body).to say_cheese
+```
+
+### Update snapshots
+
+Run rspec with `UPDATE_SNAPSHOTS=1` to update snapshtos files.
+
+```
+$ UPDATE_SNAPSHOTS=1 rspec
+```
+
+## 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-cheki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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/cheki"
+
+# 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/cheki.rb

@@ -0,0 +1,21 @@
+require "rspec/cheki/errors"
+require "rspec/cheki/manager"
+require "rspec/cheki/matchers"
+require "rspec/cheki/snap_file"
+require "rspec/cheki/snapshot"
+require "rspec/cheki/version"
+
+module RSpec
+  module Cheki
+  end
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Cheki::Matchers
+
+  config.add_setting RSpec::Cheki::Manager.settings_name, default: RSpec::Cheki::Manager.new
+
+  config.after :suite do
+    RSpec::Cheki::Manager.update(update: !!ENV["UPDATE_SNAPSHOTS"])
+  end
+end

data/lib/rspec/cheki/errors.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Cheki
+    class SnapshotsFileNotLoadedError < StandardError; end
+  end
+end

data/lib/rspec/cheki/manager.rb

@@ -0,0 +1,54 @@
+module RSpec
+  module Cheki
+    class Manager
+      SETTINGS_NAME = :"rspec_cheki_manager"
+
+      class << self
+        # Create snapshot instance from example object
+        # @param [RSpec::Core::Example] example The example
+        # @return [RSpec::Cheki::Snapshot] The snapshot
+        def create_snapshot(example:)
+          instance.create_snapshot(example)
+        end
+
+        # @return [String] The settings name
+        def settings_name
+          SETTINGS_NAME
+        end
+
+        # Save snapshots to file
+        # @param update [boolean] Save updated snapshots if true
+        def update(update: false)
+          instance.save(update: update)
+        end
+
+        private
+
+        def instance
+          RSpec.configuration.send(settings_name)
+        end
+      end
+
+      attr_reader :files
+
+      def initialize
+        @files = {}
+      end
+
+      # Create snapshot instance from example object
+      # @param [RSpec::Core::Example] example The example
+      # @return [RSpec::Cheki::Snapshot] The snapshot
+      def create_snapshot example
+        key = example.file_path
+        @files[key] = SnapFile.create(example: example) unless @files.key? key
+        @files[key].create_snapshot(example.id)
+      end
+
+      # Save snapshots to file
+      # @param update [boolean] Save updated snapshots if true
+      def save(update: false)
+        @files.each { |_, f| f.save(update: update) }
+      end
+    end
+  end
+end

data/lib/rspec/cheki/matchers.rb

@@ -0,0 +1,12 @@
+require "rspec/cheki/matchers/match_snapshot"
+
+module RSpec
+  module Cheki
+    module Matchers
+      def match_snapshot
+        MatchSnapshot.new
+      end
+      alias_method :say_cheese, :match_snapshot
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module RSpec
+  module Cheki
+    module Matchers
+      class MatchSnapshot
+        attr_reader :example, :snapshot
+
+        extend Forwardable
+        def_delegators :snapshot, :expected, :actual
+
+        def initialize
+          @example = RSpec.current_example
+          @snapshot = RSpec::Cheki::Manager.create_snapshot(example: example)
+        end
+
+        def failure_message
+          "received value does not match stored snapshot #{snapshot.key}"
+        end
+
+        def description
+          "match stored snapshot"
+        end
+
+        def matches?(actual)
+          snapshot.actual = actual
+          snapshot.match?
+        end
+
+        def diffable?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/rspec/cheki/snap_file.rb

@@ -0,0 +1,76 @@
+module RSpec
+  module Cheki
+    class SnapFile
+      # TODO: Should be confugurable
+      SNAPSHOTS_DIRNAME = "__snapshots__"
+      SNAPSHOTS_FILE_EXT = ".yml.snap"
+
+      class << self
+        # Creata SnapFile instance from example object
+        # @param [RSpec::Core::Example] example The example
+        # @return [RSpec::Cheki::SnapFile] The SnapFile object
+        def create(example:)
+          SnapFile.new(example.file_path).tap do |file|
+            file.create_snapshots_file
+            file.load
+          end
+        end
+      end
+
+      attr_reader :spec_path, :dirname, :file_path, :snapshots
+
+      # @param [String] spec_path The sepc file path
+      def initialize spec_path
+        init_paths spec_path
+        @snapshots = {}
+      end
+
+      # Load snapshots file
+      def load
+        @yaml = YAML.load(File.read(file_path)) || {}
+      end
+
+      # Save snapshots to file
+      # @param update [boolean] Save updated snapshots if true
+      def save(update: false)
+        snapshots.each do |key, s|
+          @yaml[key] = (s.new? || (update && s.needs_update?)) ? s.actual : s.expected
+        end
+        File.write(file_path, YAML.dump(@yaml))
+      end
+
+      # Create the snapshot object from a stored snapshots file
+      # @param [String] key The snapshot key
+      # @return [RSpec::Cheki::Snapshot] snapshot The snapshot
+      def create_snapshot key
+        fail SnapshotsFileNotLoadedError if @yaml.nil?
+        Snapshot.new(key).tap do |s|
+          s.expected = @yaml[s.key] if @yaml.key? s.key
+          snapshots[s.key] = s
+        end
+      end
+
+      # @return [boolean] true if the snapshots file has not been existed
+      def exists?
+        File.exist? file_path
+      end
+
+      # Create the snapshots directory and the file
+      def create_snapshots_file
+        unless exists?
+          FileUtils.mkdir dirname unless File.exist? dirname
+          FileUtils.touch file_path
+        end
+      end
+
+      private
+
+      def init_paths spec_rel_path
+        @spec_path = File.expand_path spec_rel_path
+        basename = "#{File.basename spec_path}#{SNAPSHOTS_FILE_EXT}"
+        @dirname = File.join(File.dirname(spec_path), SNAPSHOTS_DIRNAME)
+        @file_path = File.join(dirname, basename)
+      end
+    end
+  end
+end

data/lib/rspec/cheki/snapshot.rb

@@ -0,0 +1,41 @@
+require "yaml"
+
+module RSpec
+  module Cheki
+    class Snapshot
+      attr_reader :key, :expected, :actual
+
+      # @param [String] key The key
+      def initialize key
+        @key = key
+        @expected_updated = false
+        @actual_updated = false
+      end
+
+      # @return [boolean] true if the actual value is equal to stored value from snapshot
+      def match?
+        actual == expected
+      end
+
+      # @return [boolean] true if the snapshot is stored
+      def new?
+        !@expected_updated
+      end
+
+      # @return [boolean] true if the snapshot changed
+      def needs_update?
+        @actual_updated && !match?
+      end
+
+      def expected= value
+        @expected_updated = true
+        @expected = value
+      end
+
+      def actual= value
+        @actual_updated = true
+        @actual = value
+      end
+    end
+  end
+end

data/lib/rspec/cheki/version.rb

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

data/rspec-cheki.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/cheki/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-cheki"
+  spec.version       = RSpec::Cheki::VERSION
+  spec.authors       = ["izumin5210"]
+  spec.email         = ["masayuki@izumin.info"]
+
+  spec.summary       = %q{RSpec::Cheki supports snapshot testing, inspired by Jest}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/izumin5210/rspec-cheki"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "meowcop", "~> 1.11"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "fakefs", "~> 0.11"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rspec-cheki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- izumin5210
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-17 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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: meowcop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: RSpec::Cheki supports snapshot testing, inspired by Jest
+email:
+- masayuki@izumin.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec/cheki.rb
+- lib/rspec/cheki/errors.rb
+- lib/rspec/cheki/manager.rb
+- lib/rspec/cheki/matchers.rb
+- lib/rspec/cheki/matchers/match_snapshot.rb
+- lib/rspec/cheki/snap_file.rb
+- lib/rspec/cheki/snapshot.rb
+- lib/rspec/cheki/version.rb
+- rspec-cheki.gemspec
+homepage: https://github.com/izumin5210/rspec-cheki
+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.6.8
+signing_key: 
+specification_version: 4
+summary: RSpec::Cheki supports snapshot testing, inspired by Jest
+test_files: []