mirror of
https://github.com/thoughtbot/factory_bot_rails.git
synced 2022-11-09 11:49:18 -05:00
109 lines
3.8 KiB
Markdown
109 lines
3.8 KiB
Markdown
# factory_bot_rails [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade] [![Gem Version][version-image]][version] [![Reviewed by Hound][hound-image]][hound]
|
|
|
|
[factory_bot][fb] is a fixtures replacement with a straightforward definition
|
|
syntax, support for multiple build strategies (saved instances, unsaved
|
|
instances, attribute hashes, and stubbed objects), and support for multiple
|
|
factories for the same class (`user`, `admin_user`, and so on), including factory
|
|
inheritance.
|
|
|
|
### Transitioning from factory\_girl\_rails?
|
|
|
|
Check out the [guide](https://github.com/thoughtbot/factory_bot/blob/4-9-0-stable/UPGRADE_FROM_FACTORY_GIRL.md).
|
|
|
|
## Rails
|
|
|
|
factory_bot_rails provides Rails integration for [factory_bot][fb].
|
|
|
|
Currently, automatic factory definition loading is the only Rails-specific feature.
|
|
|
|
Supported Rails versions are listed in [`Appraisals`](Appraisals). Supported
|
|
Ruby versions are listed in [`.travis.yml`](.travis.yml).
|
|
|
|
## Download
|
|
|
|
Github: http://github.com/thoughtbot/factory_bot_rails
|
|
|
|
Gem:
|
|
|
|
$ gem install factory_bot_rails
|
|
|
|
## Configuration
|
|
|
|
Add `factory_bot_rails` to your Gemfile:
|
|
|
|
```ruby
|
|
group :development, :test do
|
|
gem 'factory_bot_rails'
|
|
end
|
|
```
|
|
|
|
Generators for factories will automatically substitute fixture (and maybe any other
|
|
`fixture_replacement` you set). If you want to disable this feature, add the
|
|
following to your application.rb file:
|
|
|
|
```ruby
|
|
config.generators do |g|
|
|
g.factory_bot false
|
|
end
|
|
```
|
|
|
|
Default factories directory is `test/factories`, or `spec/factories` if
|
|
`test_framework` generator is set to `:rspec`; change this behavior with:
|
|
|
|
```ruby
|
|
config.generators do |g|
|
|
g.factory_bot dir: 'custom/dir/for/factories'
|
|
end
|
|
```
|
|
|
|
If you use factory_bot for fixture replacement, ensure that
|
|
factory_bot_rails is available in the development group. If it's not, Rails
|
|
will generate standard .yml files instead of factory files.
|
|
|
|
factory_bot takes an option `suffix: 'some_suffix'` to generate factories as
|
|
`modelname_some_suffix.rb`.
|
|
|
|
If you use factory_bot for fixture replacement and already have a
|
|
`factories.rb` file in the directory that contains your tests,
|
|
factory_bot_rails will insert new factory definitions at the top of
|
|
`factories.rb`.
|
|
|
|
You may need to configure your test suite to include factory_bot methods; see
|
|
[configuration](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#configure-your-test-suite).
|
|
|
|
## Contributing
|
|
|
|
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
factory_bot_rails was originally written by Joe Ferris and is now maintained by Josh
|
|
Clayton. Many improvements and bugfixes were contributed by the [open source
|
|
community](https://github.com/thoughtbot/factory_bot_rails/graphs/contributors).
|
|
|
|
## License
|
|
|
|
factory_bot_rails is Copyright © 2008-2016 Joe Ferris and thoughtbot. It is free
|
|
software, and may be redistributed under the terms specified in the
|
|
[LICENSE](LICENSE) file.
|
|
|
|
## About thoughtbot
|
|
|
|
|
|
|
|
factory_bot_rails is maintained and funded by thoughtbot, inc.
|
|
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
|
|
|
|
We are passionate about open source software.
|
|
See [our other projects][community].
|
|
We are [available for hire][hire].
|
|
|
|
[fb]: https://github.com/thoughtbot/factory_bot
|
|
[ci]: http://travis-ci.org/thoughtbot/factory_bot_rails?branch=master
|
|
[ci-image]: https://secure.travis-ci.org/thoughtbot/factory_bot_rails.svg
|
|
[grade]: https://codeclimate.com/github/thoughtbot/factory_bot_rails
|
|
[grade-image]: https://codeclimate.com/github/thoughtbot/factory_bot_rails.svg
|
|
[community]: https://thoughtbot.com/community?utm_source=github
|
|
[hire]: https://thoughtbot.com/hire-us?utm_source=github
|
|
[version-image]: https://badge.fury.io/rb/factory_bot_rails.svg
|
|
[version]: https://badge.fury.io/rb/factory_bot_rails
|
|
[hound-image]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
|
|
[hound]: https://houndci.com
|