thoughtbot--factory_bot/README.md

78 lines
2.5 KiB
Markdown
Raw Normal View History

2011-12-23 17:44:23 +00: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)
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 20:52:29 +00:00
If you want to use factory_girl with Rails, see
2012-01-12 20:23:33 +00:00
[factory_girl_rails](https://github.com/thoughtbot/factory_girl_rails).
Documentation
-------------
2012-01-12 20:23:33 +00:00
You should find the documentation for your version of factory_girl on [Rubygems](https://rubygems.org/gems/factory_girl).
2011-12-22 03:34:32 +00:00
See [GETTING_STARTED](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md) for information on defining and using factories.
2011-07-05 12:17:41 +00:00
Install
--------
```shell
2011-07-05 12:17:41 +00:00
gem install factory_girl
```
or add the following line to Gemfile:
2011-07-16 21:26:30 +00:00
2011-07-05 12:17:41 +00:00
```ruby
gem 'factory_girl'
```
and run `bundle install` from your shell.
Supported Ruby versions
-----------------------
The Factory Girl 3.x series supports Ruby 1.9.x.
For older versions of Ruby, please use the Factory Girl 2.x series.
More Information
----------------
2012-01-12 20:23:33 +00:00
* [Rubygems](https://rubygems.org/gems/factory_girl)
* [Mailing list](http://groups.google.com/group/factory_girl)
2012-01-12 20:23:33 +00:00
* [Issues](https://github.com/thoughtbot/factory_girl/issues)
2012-01-12 20:24:14 +00:00
* [GIANT ROBOTS SMASHING INTO OTHER GIANT ROBOTS](http://robots.thoughtbot.com/)
Contributing
------------
2012-01-12 20:23:33 +00:00
Please see the [contribution guidelines](https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTION_GUIDELINES.md).
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 17:24:39 +00:00
* Josh Clayton
* Thomas Walpole
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.