2016-08-09 13:08:12 -04:00
# factory_girl [![Build Status](https://travis-ci.org/thoughtbot/factory_girl.svg)](http://travis-ci.org/thoughtbot/factory_girl?branch=master) [![Dependency Status](https://gemnasium.com/thoughtbot/factory_girl.svg)](https://gemnasium.com/thoughtbot/factory_girl) [![Code Climate](https://codeclimate.com/github/thoughtbot/factory_girl/badges/gpa.svg)](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
2016-08-30 11:45:43 -04:00
_[Interested in the project name?](NAME.md)._
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
2016-02-17 22:27:29 -05:00
See [GETTING_STARTED] for information on defining and using factories. We also
have [a detailed introductory video][], available for free on Upcase.
[a detailed introductory video]: https://upcase.com/videos/factory-girl?utm_source=github& utm_medium=open-source& utm_campaign=factory-girl
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
--------
2016-07-12 05:26:44 -04:00
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'
```
2016-07-12 05:26:44 -04:00
2011-07-05 13:18:15 -04:00
and run `bundle install` from your shell.
2011-01-19 11:21:20 -05:00
2016-07-12 05:26:44 -04:00
To install the gem manually from your shell, run:
```shell
gem install factory_girl
```
**Caveat:** As of ActiveSupport 5.0 and above, Ruby 2.2.2+ is required. Because
of Rubygems' dependency resolution when installing gems, you may see an error
similar to:
```
$ gem install factory_girl
ERROR: Error installing factory_girl:
activesupport requires Ruby version >= 2.2.2.
```
To bypass this, install a pre-5.0 version of ActiveSupport before installing
manually.
2012-03-23 17:14:13 -04:00
Supported Ruby versions
-----------------------
2014-01-24 12:02:17 -05:00
The factory_girl 3.x+ series supports MRI Ruby 1.9. Additionally, factory_girl
2014-05-30 13:53:05 -04:00
3.6+ supports JRuby 1.6.7.2+ while running in 1.9 mode. See [GETTING_STARTED]
2012-08-02 09:19:51 -04:00
for more information on configuring the JRuby environment.
2012-03-23 17:14:13 -04:00
2014-01-24 12:02:17 -05:00
For versions of Ruby prior to 1.9, please use factory_girl 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 )
2013-12-19 10:11:25 -05:00
* [Stack Overflow ](http://stackoverflow.com/questions/tagged/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
2014-05-30 13:53:05 -04:00
[GETTING_STARTED]: http://rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md
2011-01-19 11:21:20 -05:00
Contributing
------------
2014-05-29 10:26:42 -04:00
Please see [CONTRIBUTING.md ](https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTING.md ).
2011-01-19 11:21:20 -05:00
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
2015-03-12 09:52:31 -04:00
License
-------
2011-01-19 11:21:20 -05:00
2016-01-02 00:54:00 -05:00
factory_girl is Copyright © 2008-2016 Joe Ferris and thoughtbot. It is free
2015-03-12 09:52:31 -04:00
software, and may be redistributed under the terms specified in the
[LICENSE ](/LICENSE ) file.
2011-01-19 11:21:20 -05:00
2015-03-12 09:52:31 -04:00
About thoughtbot
----------------
2017-03-10 09:37:57 -05:00
![thoughtbot ](http://presskit.thoughtbot.com/images/thoughtbot-logo-for-readmes.svg )
2015-03-12 09:52:31 -04:00
factory_girl is maintained and funded by thoughtbot, inc.
2011-01-19 11:21:20 -05:00
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
2015-03-12 09:52:31 -04:00
We love open source software!
See [our other projects][community] or
[hire us][hire] to design, develop, and grow your product.
2011-01-19 11:21:20 -05:00
2015-03-12 09:52:31 -04:00
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com?utm_source=github