Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/featurist/fixture_farm
Why writing fixtures when they can write themselves?
https://github.com/featurist/fixture_farm
rails
Last synced: 24 days ago
JSON representation
Why writing fixtures when they can write themselves?
- Host: GitHub
- URL: https://github.com/featurist/fixture_farm
- Owner: featurist
- License: mit
- Created: 2021-11-18T20:58:37.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-09T10:39:04.000Z (about 2 years ago)
- Last Synced: 2024-04-25T06:20:23.973Z (7 months ago)
- Topics: rails
- Language: Ruby
- Homepage:
- Size: 44.9 KB
- Stars: 6
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# FixtureFarm
This gem lets you do two things:
- record fixtures as you browse.
- record fixtures for a block of code (e.g. setup part of a test).
Generated fixture that `belongs_to` a record from an existing fixture, will reference that fixture by name.
### Limitations
- doesn't update fixtures
- doesn't delete fixtures
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'fixture_farm', group: %i[development test]
```
And then execute:
```bash
bundle install
```
Or install it yourself as:
```bash
gem install fixture_farm
```
## Usage
### Record as you browse
To record as you browse in development add this to `ApplicationController`:
```ruby
include FixtureFarm::ControllerHook if defined?(FixtureFarm)
```
And in `ApplicationJob` if needed:
```ruby
include FixtureFarm::ActiveJobHook if defined?(FixtureFarm)
```
Then start/stop recording using tasks:
```bash
bundle exec fixture_farm record some_awesome_name_prefix
bundle exec fixture_farm status
bundle exec fixture_farm stop
```
### Record in tests
To record in tests, wrap some code in `record_new_fixtures` block. For example:
```ruby
include FixtureFarm::TestHelper
test 'some stuff does the right thing' do
record_new_fixtures('some_stuff') do |stop_recording|
user = User.create!(name: 'Bob')
post = user.posts.create!(title: 'Stuff')
stop_recording.call
assert_difference 'user.published_posts.size' do
post.publish!
end
end
end
```
Running this test generates user and post fixtures. Now you can rewrite this test to use them:
```ruby
test 'some stuff does the right thing' do
user = users('some_stuff_user_1')
assert_difference 'user.published_posts.size' do
user.posts.first.publish!
end
end
```
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).