2011-12-23 12:44:23 -05:00
# factory_girl [![Build Status](https://secure.travis-ci.org/thoughtbot/factory_girl.png)](http://travis-ci.org/thoughtbot/factory_girl?branch=master) [![Dependency Status](https://gemnasium.com/thoughtbot/factory_girl.png)](https://gemnasium.com/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-07-13 16:41:27 -04:00
The FactoryGirl 3.x series supports Ruby 1.9.x.
2012-03-23 17:14:13 -04:00
2012-07-13 16:41:27 -04:00
For older versions of Ruby, please use the FactoryGirl 2.x series.
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
-------
factory_girl was written by Joe Ferris with contributions from several authors, including:
* Alex Sharp
* Eugene Bolshakov
* Jon Yurek
* Josh Nichols
* Josh Owens
* Nate Sutton
2011-09-02 13:24:39 -04:00
* Josh Clayton
* Thomas Walpole
2011-01-19 11:21:20 -05:00
The syntax layers are derived from software written by the following authors:
* Pete Yandell
* Rick Bradley
* Yossef Mendelssohn
![thoughtbot ](http://thoughtbot.com/images/tm/logo.png )
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
-------
factory_girl is Copyright © 2008-2011 Joe Ferris and thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.