aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/generators/rails/resource
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/generators/rails/resource')
-rw-r--r--railties/lib/generators/rails/resource/USAGE23
-rw-r--r--railties/lib/generators/rails/resource/resource_generator.rb40
2 files changed, 63 insertions, 0 deletions
diff --git a/railties/lib/generators/rails/resource/USAGE b/railties/lib/generators/rails/resource/USAGE
new file mode 100644
index 0000000000..936619b0db
--- /dev/null
+++ b/railties/lib/generators/rails/resource/USAGE
@@ -0,0 +1,23 @@
+Description:
+ Stubs out a new resource including an empty model and controller suitable
+ for a restful, resource-oriented application. Pass the singular model name,
+ either CamelCased or under_scored, as the first argument, and an optional
+ list of attribute pairs.
+
+ Attribute pairs are field: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'.
+
+ 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.
+
+ This generator invokes your configured ORM and test framework, besides
+ creating helpers and add routes to config/routes.rb.
+
+ Unlike the scaffold 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 body:text published:boolean`
+ `./script/generate resource purchase order_id:integer amount:decimal`
diff --git a/railties/lib/generators/rails/resource/resource_generator.rb b/railties/lib/generators/rails/resource/resource_generator.rb
new file mode 100644
index 0000000000..70babc0550
--- /dev/null
+++ b/railties/lib/generators/rails/resource/resource_generator.rb
@@ -0,0 +1,40 @@
+require 'generators/rails/model/model_generator'
+
+module Rails
+ module Generators
+ class ResourceGenerator < ModelGenerator #metagenerator
+ hook_for :resource_controller, :required => true do |base, controller|
+ base.invoke controller, [ base.name.pluralize, base.options[:actions] ]
+ end
+
+ class_option :actions, :type => :array, :banner => "ACTION ACTION", :default => [],
+ :desc => "Actions for the resource controller"
+
+ class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
+ class_option :force_plural, :type => :boolean, :desc => "Forces the use of a plural ModelName"
+
+ def initialize(*args)
+ super
+ if name == name.pluralize && !options[:force_plural]
+ say "Plural version of the model detected, using singularized version. Override with --force-plural."
+ name.replace name.singularize
+ end
+ end
+
+ def add_resource_route
+ route "map.resource#{:s unless options[:singleton]} :#{pluralize?(file_name)}"
+ end
+
+ protected
+
+ def pluralize?(name)
+ if options[:singleton]
+ name
+ else
+ name.pluralize
+ end
+ end
+
+ end
+ end
+end