railties 3.0.0.beta

data/lib/generators/rails/model/USAGE

@@ -0,0 +1,30 @@
+Description:
+    Stubs out a new model. Pass the model name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    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, which
+    defaults to ActiveRecord and TestUnit.
+
+    Finally, if --parent option is given, it's used as superclass of the
+    created model. This allows you create Single Table Inheritance models.
+
+Examples:
+    `./script/generate model account`
+
+        For ActiveRecord and TestUnit it creates:
+
+            Model:      app/models/account.rb
+            Test:       test/unit/account_test.rb
+            Fixtures:   test/fixtures/accounts.yml
+            Migration:  db/migrate/XXX_add_accounts.rb
+
+    `./script/generate model post title:string body:text published:boolean`
+
+        Creates a Post model with a string title, text body, and published flag.

data/lib/generators/rails/model/model_generator.rb

@@ -0,0 +1,8 @@
+module Rails
+  module Generators
+    class ModelGenerator < NamedBase #metagenerator
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      hook_for :orm, :required => true
+    end
+  end
+end

data/lib/generators/rails/model_subclass/model_subclass_generator.rb

@@ -0,0 +1,12 @@
+module Rails
+  module Generators
+    # TODO Deprecate me in a release > Rails 3.0
+    class ModelSubclassGenerator < Base
+      desc "model_subclass is deprecated. Invoke model with --parent option instead."
+
+      def say_deprecation_warn
+         say self.class.desc
+      end
+    end
+  end
+end

data/lib/generators/rails/observer/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Stubs out a new observer. Pass the observer name, either CamelCased or
+    under_scored, as an argument.
+
+    This generator only invokes your ORM and test framework generators.
+
+Example:
+    `./script/generate observer Account`
+
+    For ActiveRecord and TestUnit it creates:
+        Observer:   app/models/account_observer.rb
+        TestUnit:   test/unit/account_observer_test.rb

data/lib/generators/rails/observer/observer_generator.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Generators
+    class ObserverGenerator < NamedBase #metagenerator
+      hook_for :orm, :required => true
+    end
+  end
+end

data/lib/generators/rails/performance_test/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Stubs out a new performance test. Pass the name of the test, either
+    CamelCased or under_scored, as an argument.
+
+    This generator invokes the current performance tool, which defaults to
+    TestUnit.
+
+Example:
+    `./script/generate performance_test GeneralStories` creates a GeneralStories
+    performance test in test/performance/general_stories_test.rb

data/lib/generators/rails/performance_test/performance_test_generator.rb

@@ -0,0 +1,7 @@
+module Rails
+  module Generators
+    class PerformanceTestGenerator < NamedBase
+      hook_for :performance_tool, :as => :performance
+    end
+  end
+end

data/lib/generators/rails/plugin/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Stubs out a new plugin at vendor/plugins. Pass the plugin name, either
+    CamelCased or under_scored, as an argument. 
+
+Example:
+    `./script/generate plugin BrowserFilters`
+
+    creates a standard browser_filters plugin:
+        vendor/plugins/browser_filters/README
+        vendor/plugins/browser_filters/init.rb
+        vendor/plugins/browser_filters/install.rb
+        vendor/plugins/browser_filters/lib/browser_filters.rb
+        vendor/plugins/browser_filters/test/browser_filters_test.rb

data/lib/generators/rails/plugin/plugin_generator.rb

@@ -0,0 +1,47 @@
+require 'generators/rails/generator/generator_generator'
+
+module Rails
+  module Generators
+    class PluginGenerator < NamedBase
+      class_option :tasks, :desc => "When supplied creates tasks base files."
+
+      check_class_collision
+
+      def create_root_files
+        directory '.', plugin_dir, :recursive => false
+      end
+
+      def create_lib_files
+        directory 'lib', plugin_dir('lib'), :recursive => false
+      end
+
+      def create_tasks_files
+        return unless options[:tasks]
+        directory 'lib/tasks', plugin_dir('lib/tasks')
+      end
+
+      hook_for :generator do |generator|
+        inside plugin_dir, :verbose => true do
+          invoke generator, [ name ], :namespace => false
+        end
+      end
+
+      hook_for :test_framework do |test_framework|
+        inside plugin_dir, :verbose => true do
+          invoke test_framework
+        end
+      end
+
+      protected
+
+        def plugin_dir(join=nil)
+          if join
+            File.join(plugin_dir, join)
+          else
+            "vendor/plugins/#{file_name}"
+          end
+        end
+
+    end
+  end
+end

data/lib/generators/rails/plugin/templates/MIT-LICENSE.tt

@@ -0,0 +1,20 @@
+Copyright (c) <%= Date.today.year %> [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/generators/rails/plugin/templates/README.tt

@@ -0,0 +1,13 @@
+<%= class_name %>
+<%= "=" * class_name.size %>
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) <%= Date.today.year %> [name of plugin creator], released under the MIT license

data/lib/generators/rails/plugin/templates/Rakefile.tt

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the <%= file_name %> plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/generators/rails/plugin/templates/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/lib/generators/rails/plugin/templates/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/generators/rails/plugin/templates/lib/%file_name%.rb.tt

@@ -0,0 +1 @@
+# <%= class_name %>

data/lib/generators/rails/plugin/templates/lib/tasks/%file_name%_tasks.rake.tt

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :<%= file_name %> do
+#   # Task goes here
+# end

data/lib/generators/rails/plugin/templates/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

data/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`

data/lib/generators/rails/resource/resource_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators/resource_helpers'
+require 'generators/rails/model/model_generator'
+
+module Rails
+  module Generators
+    class ResourceGenerator < ModelGenerator #metagenerator
+      include ResourceHelpers
+
+      hook_for :resource_controller, :required => true do |controller|
+        invoke controller, [ controller_name, 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"
+
+      def add_resource_route
+        route "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

data/lib/generators/rails/scaffold/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views, along with a full test suite. The resource is ready to use as a
+    starting point for your RESTful, resource-oriented application.
+
+    Pass the name of the model (in singular form), 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 resource immediately.
+
+    For example, 'scaffold post title:string body:text published:boolean'
+    gives you a model with those three attributes, a controller that handles
+    the create/show/update/destroy, forms to create and edit your posts, and
+    an index that lists them all, as well as a resources :posts
+    declaration in config/routes.rb.
+
+    If you want to remove all the generated files, run
+    'script/destroy scaffold ModelName'.
+
+Examples:
+    `./script/generate scaffold post`
+    `./script/generate scaffold post title:string body:text published:boolean`
+    `./script/generate scaffold purchase order_id:integer amount:decimal`

data/lib/generators/rails/scaffold/scaffold_generator.rb

@@ -0,0 +1,13 @@
+require 'generators/rails/resource/resource_generator'
+
+module Rails
+  module Generators
+    class ScaffoldGenerator < ResourceGenerator #metagenerator
+      remove_hook_for :resource_controller
+      remove_class_option :actions
+
+      hook_for :scaffold_controller, :required => true
+      hook_for :stylesheets
+    end
+  end
+end

data/lib/generators/rails/scaffold_controller/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Stubs out a scaffolded controller and its views. Pass the model name,
+    either CamelCased or under_scored, and a list of views as arguments.
+    The controller name is retrieved as a pluralized version of the model
+    name.
+
+    To create a controller within a module, specify the model name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers and invokes helper,
+    template engine and test framework generators.
+
+Example:
+    `./script/generate scaffold_controller CreditCard`
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller:      app/controllers/credit_cards_controller.rb
+        Functional Test: test/functional/credit_cards_controller_test.rb
+        Views:           app/views/credit_cards/index.html.erb [...]
+        Helper:          app/helpers/credit_cards_helper.rb

data/lib/generators/rails/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/resource_helpers'
+
+module Rails
+  module Generators
+    class ScaffoldControllerGenerator < NamedBase
+      include ResourceHelpers
+
+      check_class_collision :suffix => "Controller"
+
+      class_option :orm, :banner => "NAME", :type => :string, :required => true,
+                         :desc => "ORM to generate the controller for"
+
+      class_option :singleton, :type => :boolean, :desc => "Supply to create a singleton controller"
+
+      def create_controller_files
+        template 'controller.rb', File.join('app/controllers', class_path, "#{controller_file_name}_controller.rb")
+      end
+
+      hook_for :template_engine, :test_framework, :as => :scaffold
+
+      # Invoke the helper using the controller name (pluralized)
+      hook_for :helper, :as => :scaffold do |invoked|
+        invoke invoked, [ controller_name ]
+      end
+    end
+  end
+end

data/lib/generators/rails/scaffold_controller/templates/controller.rb

@@ -0,0 +1,85 @@
+class <%= controller_class_name %>Controller < ApplicationController
+<% unless options[:singleton] -%>
+  # GET /<%= table_name %>
+  # GET /<%= table_name %>.xml
+  def index
+    @<%= table_name %> = <%= orm_class.all(class_name) %>
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @<%= table_name %> }
+    end
+  end
+<% end -%>
+
+  # GET /<%= table_name %>/1
+  # GET /<%= table_name %>/1.xml
+  def show
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/new
+  # GET /<%= table_name %>/new.xml
+  def new
+    @<%= file_name %> = <%= orm_class.build(class_name) %>
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @<%= file_name %> }
+    end
+  end
+
+  # GET /<%= table_name %>/1/edit
+  def edit
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+  end
+
+  # POST /<%= table_name %>
+  # POST /<%= table_name %>.xml
+  def create
+    @<%= file_name %> = <%= orm_class.build(class_name, "params[:#{file_name}]") %>
+
+    respond_to do |format|
+      if @<%= orm_instance.save %>
+        format.html { redirect_to(@<%= file_name %>, :notice => '<%= class_name %> was successfully created.') }
+        format.xml  { render :xml => @<%= file_name %>, :status => :created, :location => @<%= file_name %> }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /<%= table_name %>/1
+  # PUT /<%= table_name %>/1.xml
+  def update
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+
+    respond_to do |format|
+      if @<%= orm_instance.update_attributes("params[:#{file_name}]") %>
+        format.html { redirect_to(@<%= file_name %>, :notice => '<%= class_name %> was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /<%= table_name %>/1
+  # DELETE /<%= table_name %>/1.xml
+  def destroy
+    @<%= file_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    @<%= orm_instance.destroy %>
+
+    respond_to do |format|
+      format.html { redirect_to(<%= table_name %>_url) }
+      format.xml  { head :ok }
+    end
+  end
+end