Browse files

Added proper USAGE to the scaffold_resource generator [DHH]

git-svn-id: 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
  • Loading branch information...
1 parent 7ea8677 commit c447d443dd1507c3485de30159adeaeacdc8254d @dhh dhh committed Oct 8, 2006
Showing with 20 additions and 5 deletions.
  1. +20 −5 railties/lib/rails_generator/generators/components/scaffold_resource/USAGE
@@ -1,8 +1,23 @@
- Explain the generator
+ The scaffold resource generator creates a model, a controller, and a set of templates for use in a REST-like,
+ resource-oriented fashion. This basically means that it follows a set of conventions to exploit the full set of
+ HTTP verbs (GET/POST/PUT/DELETE) and is prepared for multi-client access (like one view for HTML, one for an XML
+ API, one for ATOM, etc). Everything comes with sample unit and functional tests as well.
+ The generator takes the name of the model as its first argument. This model name is then pluralized to get the
+ controller name. So "scaffold_resource post" will generate a Post model and a PostsController and will be intended
+ for URLs like /posts and /posts/45.
+ 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 to give you a set of templates for the
+ view. For example, "scaffold_resource post title:string created_on:date body:text published:boolean" will give
+ you a model with those four attributes, forms to create and edit those models from, and an index that'll list them
+ all.
+ 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.
- ./script/generate scaffold_resource Thing
- This will create:
- what/will/it/create
+ ./script/generate scaffold_resource post # no attributes, view will be anemic
+ ./script/generate scaffold_resource post title:string created_on:date body:text published:boolean
+ ./script/generate scaffold_resource purchase order_id:integer created_at:datetime amount:decimal

0 comments on commit c447d44

Please sign in to comment.