github/rails
1
1
Fork 0
mirror of https://github.com/github/rails.git synced 2026-01-31 09:18:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

Added proper USAGE to the scaffold_resource generator [DHH]

Browse Source 
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@5235 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
This commit is contained in:
David Heinemeier Hansson
2006-10-08 23:35:00 +00:00
parent c447d443dd
commit 5728b82c01
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
railties/lib/rails_generator/generators/components/scaffold_resource/USAGE
View File

@@ -1,8 +1,9 @@
Description:
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 scaffold resource generator creates a model, a controller, and a set of templates that's ready to use as the
starting point for your REST-like, resource-oriented application. 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
@@ -16,6 +17,11 @@ Description:
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.
Once the generator has run, you'll need to add a declaration to your config/routes.rb file to hook up the rules
that'll point URLs to this new resource. If you create a resource like "scaffold_resource post", you'll need to
add "map.resources :posts" (notice the plural form) in the routes file. Then your new resource is accessible from
/posts.
Example:
./script/generate scaffold_resource post # no attributes, view will be anemic