aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components/model
diff options
context:
space:
mode:
authorJeremy Kemper <jeremy@bitsweat.net>2007-05-29 02:07:08 +0000
committerJeremy Kemper <jeremy@bitsweat.net>2007-05-29 02:07:08 +0000
commit20fa105c353331eebef0843afa3d71505f7475f5 (patch)
tree0cec10dc34eda15727591e696dd2672c0c68cb83 /railties/lib/rails_generator/generators/components/model
parent06744bb4c5777cae45dca3b0ed4826ab14cbc558 (diff)
downloadrails-20fa105c353331eebef0843afa3d71505f7475f5.tar.gz
rails-20fa105c353331eebef0843afa3d71505f7475f5.tar.bz2
rails-20fa105c353331eebef0843afa3d71505f7475f5.zip
Wordsmith generator USAGEs.
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6884 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'railties/lib/rails_generator/generators/components/model')
-rw-r--r--railties/lib/rails_generator/generators/components/model/USAGE28
1 files changed, 14 insertions, 14 deletions
diff --git a/railties/lib/rails_generator/generators/components/model/USAGE b/railties/lib/rails_generator/generators/components/model/USAGE
index b93cf73716..24b03b4d4a 100644
--- a/railties/lib/rails_generator/generators/components/model/USAGE
+++ b/railties/lib/rails_generator/generators/components/model/USAGE
@@ -1,27 +1,27 @@
Description:
- The model generator creates stubs for a new model.
+ Stubs out a new model. Pass the model name, either CamelCased or
+ under_scored, and an optional list of attribute pairs as arguments.
- The generator takes a model name as its argument. The model name may be given in CamelCase or under_score and
- should not be suffixed with 'Model'.
+ Attribute pairs are column_name:sql_type arguments specifying the
+ model's attributes. Timestamps are added by default, so you don't have to
+ specify them by hand as 'created_at:datetime updated_at:datetime'.
- As additional parameters, the generator will take attribute pairs described by name and type. These attributes will
- be used to prepopulate the migration to create the table for the model and give you a set of predefined fixture. By
- default, created_at and updated_at timestamps are added to migration for you, so you needn't specify them by hand.
- You don't have to think up all attributes up front, but it's a good idea of adding just the baseline of what's
- needed to start really working with the resource.
+ You don't have to think up every attribute up front, but it helps to
+ sketch out a few so you can start working with the model immediately.
- The generator creates a model class in app/models, a test suite in test/unit, test fixtures in
- test/fixtures/singular_name.yml, and a migration in db/migrate.
+ This generates a model class in app/models, a unit test in test/unit,
+ a test fixture in test/fixtures/singular_name.yml, and a migration in
+ db/migrate.
Examples:
- ./script/generate model account
+ `./script/generate model account`
- This will create an Account model:
+ creates an Account model, test, fixture, and migration:
Model: app/models/account.rb
Test: test/unit/account_test.rb
Fixtures: test/fixtures/accounts.yml
Migration: db/migrate/XXX_add_accounts.rb
- ./script/generate model post title:string body:text published:boolean
+ `./script/generate model post title:string body:text published:boolean`
- Creates post model with predefined attributes.
+ creates a Post model with a string title, text body, and published flag.