kotovalexarian-likes-github/thoughtbot--factory_bot_rails
1
0
Fork 0
mirror of https://github.com/thoughtbot/factory_bot_rails.git synced 2022-11-09 11:49:18 -05:00
Code Releases Activity

Update readme

Browse source
This commit is contained in:
Joshua Clayton 2014-07-25 16:26:52 -04:00
parent 37b1f02b9f
commit 4496e5262c
1 changed files with 26 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -1,33 +1,29 @@
factory_girl [![Build Status](https://secure.travis-ci.org/thoughtbot/factory_girl_rails.png)](http://travis-ci.org/thoughtbot/factory_girl_rails?branch=master) # factory_girl_rails [![Build Status][ci-image]][ci] [![Code Climate][grade-image]][grade]
============
`factory_girl` is a fixtures replacement with a straightforward definition [factory_girl][fg] is a fixtures replacement with a straightforward definition
syntax, support for multiple build strategies (saved instances, unsaved syntax, support for multiple build strategies (saved instances, unsaved
instances, attribute hashes, and stubbed objects), and support for multiple instances, attribute hashes, and stubbed objects), and support for multiple
factories for the same class (`user`, `admin_user`, and so on), including factory factories for the same class (`user`, `admin_user`, and so on), including factory
inheritance. inheritance.
Rails ## Rails
-----
`factory_girl_rails` provides Rails integration for `factory_girl`. factory_girl_rails provides Rails integration for [factory_girl][fg].
Currently, automatic factory definition loading is the only Rails-specific feature. Currently, automatic factory definition loading is the only Rails-specific feature.
Supported Rails versions are listed in [`Appraisals`](Appraisals). Supported Supported Rails versions are listed in [`Appraisals`](Appraisals). Supported
Ruby versions are listed in [`.travis.yml`](.travis.yml). Ruby versions are listed in [`.travis.yml`](.travis.yml).
Download ## Download
--------
Github: http://github.com/thoughtbot/factory_girl_rails/tree/master Github: http://github.com/thoughtbot/factory_girl_rails
Gem: Gem:
gem install factory_girl_rails gem install factory_girl_rails
Configuration ## Configuration
-------------
Add `factory_girl_rails` to your Gemfile: Add `factory_girl_rails` to your Gemfile:
@ -54,28 +50,20 @@ config.generators do |g|
end end
``` ```
If you use `factory_girl` for fixture replacement, ensure that If you use factory_girl for fixture replacement, ensure that
`factory_girl_rails` is available in the development group. If it's not, Rails factory_girl_rails is available in the development group. If it's not, Rails
will generate standard yml files instead of factory files. will generate standard .yml files instead of factory files.
`factory_girl` takes an option `suffix: 'some_suffix'` factory_girl takes an option `suffix: 'some_suffix'` to generate factories as
to generate factories as "modelname_some_suffix.rb" `modelname_some_suffix.rb`.
More Information ## Contributing
----------------
factory_girl: http://github.com/thoughtbot/factory_girl/tree/master Please see [CONTRIBUTING.md]().
## Credits
Contributing [factory_girl][fg] was originally written by Joe Ferris.
------------
Please see CONTRIBUTING.md for details.
Credits
-------
factory_girl was originally written by Joe Ferris.
![thoughtbot](http://thoughtbot.com/images/tm/logo.png) ![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
@ -83,9 +71,14 @@ factory_girl is maintained and funded by [thoughtbot, inc](http://thoughtbot.com
The names and logos for thoughtbot are trademarks of thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
License ## License
-------
factory_girl is Copyright © 2008-2014 Joe Ferris and thoughtbot. It is free factory_girl_rails is Copyright © 2008-2014 Joe Ferris and thoughtbot. It is free
software, and may be redistributed under the terms specified in the LICENSE software, and may be redistributed under the terms specified in the
file. [LICENSE]() file.
[fg]: https://github.com/thoughtbot/factory_girl
[ci]: http://travis-ci.org/thoughtbot/factory_girl_rails?branch=master
[ci-image]: https://secure.travis-ci.org/thoughtbot/factory_girl_rails.png
[grade]: https://codeclimate.com/github/thoughtbot/factory_girl_rails
[grade-image]: https://codeclimate.com/github/thoughtbot/factory_girl_rails.png