https://github.com/izumin5210/rspec-cheki

Support snapshot testing, inspired Jest.
https://github.com/izumin5210/rspec-cheki

rspec snapshot snapshot-testing

Last synced: 3 months ago
JSON representation

Support snapshot testing, inspired Jest.

• Host: GitHub
• URL: https://github.com/izumin5210/rspec-cheki
• Owner: izumin5210
• License: mit
• Created: 2017-06-14T03:10:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-07-15T14:29:48.000Z (over 6 years ago)
• Last Synced: 2024-10-31T09:41:47.367Z (3 months ago)
• Topics: rspec, snapshot, snapshot-testing
• Language: Ruby
• Homepage: https://rubygems.org/gems/rspec-cheki
• Size: 30.3 KB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# RSpec::Cheki

[![Gem Version](https://badge.fury.io/rb/rspec-cheki.svg)](https://badge.fury.io/rb/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)

[![Dependency Status](https://gemnasium.com/badges/github.com/izumin5210/rspec-cheki.svg)](https://gemnasium.com/github.com/izumin5210/rspec-cheki)

[![Inline docs](http://inch-ci.org/github/izumin5210/rspec-cheki.svg?branch=master&style=shields)](http://inch-ci.org/github/izumin5210/rspec-cheki)

Support snapshot testing, inspired by [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

Require `rspec/cheki` from your `spec_helper.rb`.

```ruby

require '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 snapshot 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).