2013-02-02 15:22:32 -05:00
# factory_girl [](http://travis-ci.org/thoughtbot/factory_girl?branch=master) [](https://gemnasium.com/thoughtbot/factory_girl) [](https://codeclimate.com/github/thoughtbot/factory_girl)
2011-01-19 11:21:20 -05:00
factory_girl 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.
2012-03-09 15:52:29 -05:00
If you want to use factory_girl with Rails, see
2012-01-12 15:23:33 -05:00
[factory_girl_rails ](https://github.com/thoughtbot/factory_girl_rails ).
2011-02-07 17:48:29 -05:00
Documentation
-------------
2012-01-12 15:23:33 -05:00
You should find the documentation for your version of factory_girl on [Rubygems ](https://rubygems.org/gems/factory_girl ).
2011-02-07 17:48:29 -05:00
2011-12-21 22:34:32 -05:00
See [GETTING_STARTED ](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md ) for information on defining and using factories.
2011-01-19 11:21:20 -05:00
2011-07-05 08:17:41 -04:00
Install
2011-01-19 11:21:20 -05:00
--------
2011-07-05 13:18:15 -04:00
```shell
2011-07-05 08:17:41 -04:00
gem install factory_girl
```
or add the following line to Gemfile:
2011-07-16 17:26:30 -04:00
2011-07-05 08:17:41 -04:00
```ruby
gem 'factory_girl'
```
2011-07-05 13:18:15 -04:00
and run `bundle install` from your shell.
2011-01-19 11:21:20 -05:00
2012-03-23 17:14:13 -04:00
Supported Ruby versions
-----------------------
2012-08-02 09:19:51 -04:00
The FactoryGirl 3.x+ series supports MRI Ruby 1.9. Additionally, FactoryGirl
3.6+ supports JRuby 1.6.7.2+ while running in 1.9 mode. See
[GETTING_STARTED ](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md )
for more information on configuring the JRuby environment.
2012-03-23 17:14:13 -04:00
2012-08-02 09:19:51 -04:00
For versions of Ruby prior to 1.9, please use FactoryGirl 2.x.
2012-03-23 17:14:13 -04:00
2011-01-19 11:21:20 -05:00
More Information
----------------
2012-01-12 15:23:33 -05:00
* [Rubygems ](https://rubygems.org/gems/factory_girl )
2011-01-19 11:21:20 -05:00
* [Mailing list ](http://groups.google.com/group/factory_girl )
2012-01-12 15:23:33 -05:00
* [Issues ](https://github.com/thoughtbot/factory_girl/issues )
2012-01-12 15:24:14 -05:00
* [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS ](http://robots.thoughtbot.com/ )
2011-01-19 11:21:20 -05:00
Contributing
------------
2012-01-12 15:23:33 -05:00
Please see the [contribution guidelines ](https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTION_GUIDELINES.md ).
2011-01-19 11:21:20 -05:00
Credits
-------
2013-10-13 15:25:26 -04:00
factory_girl 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_girl/graphs/contributors).
2011-01-19 11:21:20 -05:00
2012-12-21 10:30:15 -05:00
2011-01-19 11:21:20 -05:00
factory_girl is maintained and funded by [thoughtbot, inc ](http://thoughtbot.com/community )
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
License
-------
2013-05-03 23:26:52 -04:00
factory_girl is Copyright © 2008-2013 Joe Ferris and thoughtbot. It is free software, and may be redistributed under the terms specified in the [LICENSE ](https://github.com/thoughtbot/factory_girl/blob/master/LICENSE ) file.
