LICENSE @@ -1,90 +1,79 @@ -# shoulda generators +# Shoulda generators -One night at a Boston Ruby hackfest, I finally got sick of using the Rails default generators, and have to hack them to meet my needs and tastes. This includes: +One night at a Boston Ruby hackfest, I finally got sick of using the Rails default generators, and then having to twiddle them to meet my needs and tastes. This includes using things like: * [shoulda](http://thoughtbot.com/projects/shoulda) - * [factory_girl](http://github.com/thoughtbot/factory_girl) + * [factory\_girl](http://github.com/thoughtbot/factory_girl) * [haml](http://haml.hamptoncatlin.com/) * [blueprint](http://code.google.com/p/blueprintcss/) +The next morning, I was struck awake at 5am with the inspiration to start implementing it. shoulda\_generator is the result of this effort. -The next morning, I was struck awake at 5am with the inspiration to start implementing it. - -## what you get +## What you get ### shoulda\_model - * works the same as the 'model' generator - * a new model - * a migration for the model - * a factory using [factory_girl](http://github.com/thoughtbot/factory_girl) - * a [shoulda](http://thoughtbot.com/projects/shoulda) unit test with a few simple 'should's + * A new model + * A migration for the model + * Skip using --skip-migration + * A factory defined with [factory_girl](http://github.com/thoughtbot/factory_girl) + * Skip using --skip-factory + * A [shoulda](http://thoughtbot.com/projects/shoulda) unit test with a few simple 'should's #### Prereqs: * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin - * [factory_girl](http://github.com/thoughtbot/factory_girl) gem installed - -In `test/test_helper.rb`, include this: - - require 'factory_girl' - Dir[File.join(RAILS_ROOT, 'test', 'factories', '*')].each do |file| - require file - end + * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed + * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin ### shoulda\_scaffold - * everything included in shoulda_model - * a controller (sans unnecessary comments) - * templates built written in [haml](http://haml.hamptoncatlin.com/) - * a layout written in [haml](http://haml.hamptoncatlin.com/) and styled with [blueprint](http://code.google.com/p/blueprintcss/) - * a helper - * a shoulda functional test which uses the factory_girl factory + * Everything included in shoulda_model + * A controller (sans unnecessary comments) + * Choice of [haml](http://haml.hamptoncatlin.com/) (default) or ERB + * Specify which with the --templating option + * Simple layout styled with blueprint + * Skip using --skip-layout + * A helper + * A shoulda functional test using factory_girl factory, using should\_be\_restful or not + * Specify with --functional-test-style, accepts basic and should\_be\_restful -Prereqs: +#### Prereqs: * [shoulda](http://thoughtbot.com/projects/shoulda) installed as a plugin - * [factory_girl](http://github.com/thoughtbot/factory_girl) gem installed - * [haml](http://haml.hamptoncatlin.com/) gem installed on the system, and the project has been hamlified using `haml --rails` on the project - * the code snippet above for `test/test_helper.rb` - -## getting it - -You can install it as a plugin for the time being. I plan on having a gem soon enough. + * [factory\_girl](http://github.com/thoughtbot/factory_girl) gem installed + * [factory\_girl\_on\_rails](http://github.com/technicalpickles/factory_girl_on_rails) installed as a plugin + * [haml](http://haml.hamptoncatlin.com/) gem installed on the system, and the project has been hamlified using `haml --rails` -With Rails 2.1, you can do: +## Getting it - $ script/plugin install git://github.com/technicalpickles/shoulda-generators.git +shoulda\_generator is available as a gem via [GitHub](http://github.com). If you haven't done so already, you need to setup GitHub as a gem source: -... or better yet, use piston 1.9.x... + $ gem sources -a http://gems.github.com + +Now you can install it: + + $ sudo gem install technicalpickles-shoulda_generator - $ piston install git://github.com/technicalpickles/shoulda-generators.git vendor/plugins/shoulda-generators - -## using it +## Example usage Usage is the same as the default Rails generators. $ script/generate shoulda_model post title:string body:text published:boolean - $ script/generate shoulda_scaffold post title:string body:text published:boolean - -## configuring it + $ script/generate shoulda_scaffold post title:string body:text published:boolean -You can override the default values for templating and functional\_test\_style by placing a .shoulda\_generator file in your home directory. -example `.shoulda\_generator`: +## Configuring it - :templating: erb # supported options: haml|erb - :functional_test_syle: basic # supported options: should_be_restful|basic - -## developing it +You can override the default values for templating and functional\_test\_style by placing a .shoulda\_generator file in your home directory. -Make a checkout somewhere: +Here's an example `.shoulda_generator`: - $ git clone git://github.com/technicalpickles/shoulda_generator.git + :templating: erb # supported options: haml|erb + :functional_test_syle: basic # supported options: should_be_restful|basic -Add symlinks so that Rails will pickup the generators from your checkout: +## Developing it - $ mkdir -p ~/.rails/generators - $ ln -s shoulda_generator/*_generator ~/.rails/generators +Source is hosted on GitHub: [http://github.com/technicalpickles/shoulda_generator/tree/master](http://github.com/technicalpickles/shoulda_generator/tree/master) -Send pull requests to me, and I'll take a look at them. +You can do the usual fork/commit cycle until you have something ready to share. Send pull requests my way. \ No newline at end of file README.markdown @@ -43,7 +43,7 @@ class ShouldaModelGenerator < Rails::Generator::NamedBase "Don't add timestamps to the migration file for this model") { |v| options[:skip_timestamps] = v } opt.on("--skip-migration", "Don't generate a migration file for this model") { |v| options[:skip_migration] = v } - opt.on("--skip-fixture", - "Don't generation a fixture file for this model") { |v| options[:skip_fixture] = v} + opt.on("--skip-factory", + "Don't generation a fixture file for this model") { |v| options[:skip_factory] = v} end end rails_generators/shoulda_model/shoulda_model_generator.rb 2075b0ffe381a8fa43297611900178a7604c4245 Josh Nichols josh@technicalpickles.com http://github.com/technicalpickles/shoulda_generator/commit/feb740ca22bd69b3d35037bb0b073035de12914f feb740ca22bd69b3d35037bb0b073035de12914f 2008-09-05T11:41:46-07:00 2008-09-05T11:41:46-07:00 Added LICENSE. README cleanups. 6f1fd1e9aee09b67a7bd5f7a91e07b28efff5b2b Josh Nichols josh@technicalpickles.com