Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add/Update usage documentation for script/destroy, resource generator…
… and scaffold_resource generator. Closes #7092, #7271, #7267. [bscofield] git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6016 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
- Loading branch information
1 parent
fee8856
commit 37fa17f
Showing
4 changed files
with
60 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
30 changes: 30 additions & 0 deletions
30
railties/lib/rails_generator/generators/components/resource/USAGE
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Description: | ||
The resource generator creates an empty model, controller, and functional | ||
suitable for inclusion in a REST-like, resource-oriented application. | ||
|
||
The generator takes the name of the model as its first argument. This | ||
model name is then pluralized to get the controller name. So "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. For | ||
example, "resource post title:string created_on:date body:text | ||
published:boolean" will give you a Post model with those four attributes. | ||
|
||
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. | ||
|
||
The generator also adds an appropriate map.resources declaration to | ||
your config/routes.rb file, hooking up the rules that'll point URLs to | ||
this new resource. | ||
|
||
Unlike the scaffold_resource generator, the resource generator does not | ||
create views or add any methods to the generated controller. | ||
|
||
Examples: | ||
./script/generate resource post # no attributes | ||
./script/generate resource post title:string created_on:date body:text published:boolean | ||
./script/generate resource purchase order_id:integer created_at:datetime amount:decimal |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters