diff options
Diffstat (limited to 'railties/generators')
-rw-r--r-- | railties/generators/controller/USAGE | 25 | ||||
-rw-r--r-- | railties/generators/mailer/USAGE | 20 | ||||
-rw-r--r-- | railties/generators/model/USAGE | 18 | ||||
-rw-r--r-- | railties/generators/scaffold/USAGE | 19 |
4 files changed, 43 insertions, 39 deletions
diff --git a/railties/generators/controller/USAGE b/railties/generators/controller/USAGE index 0259b3d027..e653d7e7ec 100644 --- a/railties/generators/controller/USAGE +++ b/railties/generators/controller/USAGE @@ -1,29 +1,28 @@ -NAME - new_controller - create controller and view stub files +GENERATOR + controller - create controller and view stub files SYNOPSIS - new_controller ControllerName action [action ...] + generate controller ControllerName action [action ...] DESCRIPTION - The new_controller generator takes the name of the new controller as the + The controller generator takes the name of the new controller as the first argument and a variable number of view names as subsequent arguments. The controller name should be supplied without a "Controller" suffix. The generator will add that itself. - From the passed arguments, new_controller generates a controller file in - app/controllers with a render action for each of the view names passed. - It then creates a controller test suite in test/functional with one failing - test case. Finally, it creates an HTML stub for each of the view names in - app/views under a directory with the same name as the controller. + Controller generates a controller file in app/controllers with a render + action for each of the view names passed, a test suite in test/functional + with one passing test case, and HTML stubs for each view in app/views + under a directory with the same name as the controller. EXAMPLE - new_controller Blog list display new edit + ./script/generate controller Blog list display new edit This will generate a BlogController class in app/controllers/blog_controller.rb, a BlogHelper class in app/helpers/blog_helper.rb and a BlogControllerTest in - test/functional/blog_controller_test.rb. It will also create list.rhtml, + test/functional/blog_controller_test.rb, and list.rhtml, display.rhtml, new.rhtml, and edit.rhtml in app/views/blog. - The BlogController class will have the following methods: list, display, new, edit. - Each will default to render the associated template file. + The BlogController class will have list, display, new, and edit actions. + Each action will render the associated view by default. diff --git a/railties/generators/mailer/USAGE b/railties/generators/mailer/USAGE index b6f2bbd54b..8cfc7e59c9 100644 --- a/railties/generators/mailer/USAGE +++ b/railties/generators/mailer/USAGE @@ -1,23 +1,21 @@ -NAME - new_mailer - create mailer and view stub files +GENERATOR + mailer - create mailer and view stub files SYNOPSIS - new_mailer MailerName action [action ...] + generate mailer MailerName action [action ...] DESCRIPTION - The new_mailer generator takes the name of the new mailer class as the + The mailer generator takes the name of the new mailer class as the first argument and a variable number of mail action names as subsequent arguments. - From the passed arguments, new_mailer generates a class file in - app/models with a mail action for each of the mail action names passed. - It then creates a mail test suite in test/unit with one stub test case - and one stub fixture per mail action. Finally, it creates a template stub - for each of the mail action names in app/views under a directory with the - same name as the class. + Mailer generates a class file in app/models with action methods for each + of the mail action names passed, a test suite in test/unit with a stub + test case and fixture per action, and template stubs for each action in + app/views under a directory with the same name as the class. EXAMPLE - new_mailer Notifications signup forgot_password invoice + ./script/generate mailer Notifications signup forgot_password invoice This will generate a Notifications class in app/models/notifications.rb, a NotificationsTest in diff --git a/railties/generators/model/USAGE b/railties/generators/model/USAGE index debf185bea..50ab3a8f09 100644 --- a/railties/generators/model/USAGE +++ b/railties/generators/model/USAGE @@ -1,17 +1,17 @@ -NAME - new_model - create model stub files +GENERATOR + model - create model stub files SYNOPSIS - new_model ModelName + generate model ModelName DESCRIPTION - The new_model generator takes a model name (in CamelCase) and generates - a new, empty model in app/models, a test suite in test/unit with one - failing test case, and a fixtures directory in test/fixtures. + The model generator takes a model name and generates an empty model in + app/models, a test suite in test/unit with one passing test case, and a + fixtures YAML file in the test/fixtures directory. EXAMPLE - new_model Account + ./script/generate model Account This will generate an Account class in app/models/account.rb, an - AccountTest in test/unit/account_test.rb, and the directory - test/fixtures/account. + AccountTest in test/unit/account_test.rb, and the fixtures file + test/fixtures/account.yml. diff --git a/railties/generators/scaffold/USAGE b/railties/generators/scaffold/USAGE index f299ee6f06..338ba5aaf5 100644 --- a/railties/generators/scaffold/USAGE +++ b/railties/generators/scaffold/USAGE @@ -1,18 +1,25 @@ -NAME - new_scaffold - create a model and a skeleton controller +GENERATOR + scaffold - create a model and basic controller SYNOPSIS - new_scaffold ModelName [action ...] + generate scaffold ModelName [action ...] DESCRIPTION - The new_scaffold generator takes the name of the new model as the + The scaffold generator takes the name of the new model as the first argument and an optional list of controller actions as the subsequent arguments. Any actions with scaffolding code available will be generated in your controller; others will be left as stubs. + The generated controller has the same code that "scaffold :model" + uses, so it's easy to migrate when you want to start customizing + your controller. + EXAMPLE - new_scaffold Account + ./script/generate scaffold Account debit credit + + This will generate the Account model with unit tests and fixtures, + the AccountController controller with actions, views, and tests for + index, list, show, new, create, edit, update, and destroy. - This will generate an Account model and controller. Now create the accounts table in your database and browse to http://localhost/account/ -- voila, you're on Rails! |