Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattbrictson/minitest-snapshots
Minitest plugin for asserting that strings are the same as a saved snapshot, jest style
https://github.com/mattbrictson/minitest-snapshots
minitest ruby testing
Last synced: about 1 month ago
JSON representation
Minitest plugin for asserting that strings are the same as a saved snapshot, jest style
- Host: GitHub
- URL: https://github.com/mattbrictson/minitest-snapshots
- Owner: mattbrictson
- License: mit
- Created: 2019-09-11T21:32:37.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T13:15:11.000Z (about 2 months ago)
- Last Synced: 2024-08-01T14:43:43.272Z (about 2 months ago)
- Topics: minitest, ruby, testing
- Language: Ruby
- Homepage:
- Size: 72.3 KB
- Stars: 33
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minitest::Snapshots
[](https://rubygems.org/gems/minitest-snapshots)
[](https://www.ruby-toolbox.com/projects/minitest-snapshots)
[](https://github.com/mattbrictson/minitest-snapshots/actions/workflows/ci.yml)
Simple minitest plugin gem implementing Jest-style snapshot testing. It's like VCR, but for any value.
## Requirements
- Ruby 2.7 or later
## Usage
Instead of copying and pasting large segments of machine generated text into your test files, and updating them all the time, assert against a snapshot managed by this library. The first time the snapshot assertion is run it will write the value to disk, and then then next time, it will check against that value.
Example:
```ruby
class QueryCompilerText < Minitest::Test
def test_it_can_compile_a_query
assert_matches_snapshot QueryCompiler.new.compile
end
end
```
## Command line options
- `-u` or `--update-snapshots`: Update snapshots on disk to the new actual value when re-running the test. Useful when you know the new output of a test case is correct and the snapshot is out of date.
- `-l` or `--lock-snapshots`: Prevents new snapshots from being written. This is enabled by default in CI (i.e. when the `CI` env var is present).
For example, to update snapshots on a Rails project:
bin/rails test -u
In a Rake project:
rake test TESTOPTS=-u
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'minitest-snapshots'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install minitest-snapshots
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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/mattbrictson/minitest-snapshots.
## License
The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
## Code of Conduct
Everyone interacting in the this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
## History
`minitest-snapshots` was created by Harry Brundage (@airhorns) and originally published to rubygems in 2019. Significant contributions were [added](https://github.com/mattbrictson/minitest-snapshots/pull/6) by @chocolateboy in 2020. In June 2023, ownership of the project was transferred to Matt Brictson (@mattbrictson).