rails 0.9.5 → 0.10.0

data/lib/rails_generator/generators/components/controller/USAGE

@@ -0,0 +1,30 @@
+Description:
+    The controller generator creates stubs for a new controller and its views.
+
+    The generator takes a controller name and a list of views as arguments.
+    The controller name may be given in CamelCase or under_score and should
+    not be suffixed with 'Controller'.  To create a controller within a
+    module, specify the controller name as 'module/controller'.
+
+    The generator creates a controller class in app/controllers with view
+    templates in app/views/controller_name, a helper class in app/helpers,
+    and a functional test suite in test/functional.
+
+Example:
+    ./script/generate controller CreditCard open debit credit close
+
+    Credit card controller with URLs like /credit_card/debit.
+        Controller: app/controllers/credit_card_controller.rb
+        Views:      app/views/credit_card/debit.rhtml [...]
+        Helper:     app/helpers/credit_card_helper.rb
+        Test:       test/functional/credit_card_controller_test.rb
+
+Modules Example:
+    ./script/generate controller 'admin/credit_card' suspend late_fee
+
+    Credit card admin controller with URLs /admin/credit_card/suspend.
+        Controller: app/controllers/admin/credit_card_controller.rb
+        Views:      app/views/admin/credit_card/debit.rhtml [...]
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Test:       test/functional/admin/credit_card_controller_test.rb
+

data/lib/rails_generator/generators/components/controller/controller_generator.rb

@@ -0,0 +1,37 @@
+class ControllerGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Controller", "#{class_name}ControllerTest", "#{class_name}Helper"
+
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('test/functional', class_path)
+
+      # Controller class, functional test, and helper class.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            class_path,
+                            "#{file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            class_path,
+                            "#{file_name}_controller_test.rb")
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            class_path,
+                            "#{file_name}_helper.rb")
+
+      # View template for each action.
+      actions.each do |action|
+        m.template 'view.rhtml',
+          File.join('app/views', class_path, file_name, "#{action}.rhtml"),
+          :assigns => { :action => action }
+      end
+    end
+  end
+end

data/{generators → lib/rails_generator/generators/components}/controller/templates/controller.rb

@@ -1,4 +1,4 @@
-class <%= full_class_name %> < ApplicationController
+class <%= class_name %>Controller < ApplicationController
 <% if options[:scaffold] -%>
   scaffold :<%= singular_name %>
 <% end -%>

data/lib/rails_generator/generators/components/controller/templates/functional_test.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+require '<%= file_path %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= class_name %>ControllerTest < Test::Unit::TestCase
+  def setup
+    @controller = <%= class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/lib/rails_generator/generators/components/mailer/USAGE

@@ -0,0 +1,19 @@
+Description:
+    The mailer generator creates stubs for a new mailer and its views.
+
+    The generator takes a mailer name and a list of views as arguments.
+    The mailer name may be given in CamelCase or under_score and should
+    not be suffixed with 'Mailer'.
+
+    The generator creates a mailer class in app/models with view templates
+    in app/views/mailer_name, and a test suite with fixtures in test/unit.
+
+Example:
+    ./script/generate mailer Notifications signup forgot_password invoice
+
+    This will create a NotificationsMailer:
+        Mailer:     app/models/notifications.rb
+        Views:      app/views/notifications/signup.rhtml [...]
+        Test:       test/unit/credit_card_controller_test.rb
+        Fixtures:   test/fixtures/notifications/signup [...]
+

data/lib/rails_generator/generators/components/mailer/mailer_generator.rb

@@ -0,0 +1,32 @@
+class MailerGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      # Mailer, view, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path, table_name)
+
+      # Mailer class and unit test.
+      m.template "mailer.rb",    File.join('app/models',
+                                           class_path,
+                                           "#{file_name}.rb")
+      m.template "unit_test.rb", File.join('test/unit',
+                                           class_path,
+                                           "#{file_name}_test.rb")
+
+      # View template and fixture for each action.
+      actions.each do |action|
+        m.template "view.rhtml",
+                   File.join('app/views', class_path, file_name, "#{action}.rhtml"),
+                   :assigns => { :action => action }
+        m.template "fixture.rhtml",
+                   File.join('test/fixtures', class_path, table_name, action),
+                   :assigns => { :action => action }
+      end
+    end
+  end
+end

data/{generators → lib/rails_generator/generators/components}/mailer/templates/unit_test.rb

@@ -3,6 +3,7 @@ require '<%= file_name %>'
 
 class <%= class_name %>Test < Test::Unit::TestCase
   FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
+  CHARSET = "utf-8"
 
   def setup
     ActionMailer::Base.delivery_method = :test
@@ -10,11 +11,12 @@ class <%= class_name %>Test < Test::Unit::TestCase
     ActionMailer::Base.deliveries = []
 
     @expected = TMail::Mail.new
+    @expected.set_content_type "text", "plain", { "charset" => CHARSET }
   end
 
 <% for action in actions -%>
   def test_<%= action %>
-    @expected.subject = '<%= class_name %>#<%= action %>'
+    @expected.subject = encode '<%= class_name %>#<%= action %>'
     @expected.body    = read_fixture('<%= action %>')
     @expected.date    = Time.now
 
@@ -26,4 +28,8 @@ class <%= class_name %>Test < Test::Unit::TestCase
     def read_fixture(action)
       IO.readlines("#{FIXTURES_PATH}/<%= file_name %>/#{action}")
     end
+
+    def encode(subject)
+      ActionMailer::Base.quoted_printable(subject, CHARSET)
+    end
 end

data/lib/rails_generator/generators/components/model/USAGE

@@ -0,0 +1,17 @@
+Description:
+    The model generator creates stubs for a new model.
+
+    The generator takes a model name as its argument.  The model name may be
+    given in CamelCase or under_score and should not be suffixed with 'Model'.
+
+    The generator creates a model class in app/models, a test suite in
+    test/unit, and test fixtures in test/fixtures/model_name.yml.
+
+Example:
+    ./script/generate model Account
+
+    This will create an Account model:
+        Model:      app/models/account.rb
+        Test:       test/unit/account_test.rb
+        Fixtures:   test/fixtures/accounts.yml
+

data/lib/rails_generator/generators/components/model/model_generator.rb

@@ -0,0 +1,18 @@
+class ModelGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      # Model, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', class_path)
+
+      # Model class, unit test, and fixtures.
+      m.template 'model.rb',      File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'unit_test.rb',  File.join('test/unit', class_path, "#{file_name}_test.rb")
+      m.template 'fixtures.yml',  File.join('test/fixtures', class_path, "#{table_name}.yml")
+    end
+  end
+end

data/{generators/scaffold → lib/rails_generator/generators/components/model}/templates/fixtures.yml

@@ -1,7 +1,5 @@
 # Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
-
 first_<%= singular_name %>:
   id: 1
-
 another_<%= singular_name %>:
   id: 2

data/{generators → lib/rails_generator/generators/components}/model/templates/unit_test.rb

@@ -3,8 +3,12 @@ require File.dirname(__FILE__) + '/../test_helper'
 class <%= class_name %>Test < Test::Unit::TestCase
   fixtures :<%= table_name %>
 
+  def setup
+    @<%= singular_name %> = <%= class_name %>.find(1)
+  end
+
   # Replace this with your real tests.
   def test_truth
-    assert true
+    assert_kind_of <%= class_name %>,  @<%= singular_name %>
   end
 end

data/lib/rails_generator/generators/components/scaffold/USAGE

@@ -0,0 +1,32 @@
+Description:
+    The scaffold generator creates a controller to interact with a model.
+    If the model does not exist, it creates the model as well.  The generated
+    code is equivalent to the "scaffold :model" declaration, making it easy
+    to migrate when you wish to customize your controller and views.
+
+    The generator takes a model name, an optional controller name, and a
+    list of views as arguments.  Scaffolded actions and views are created
+    automatically.  Any views left over generate empty stubs.
+
+    The scaffolded actions and views are:
+        index, list, show, new, create, edit, update, destroy
+
+    If a controller name is not given, the plural form of the model name
+    will be used.  The model and controller names may be given in CamelCase
+    or under_score and should not be suffixed with 'Model' or 'Controller'.
+    Both model and controller names may be prefixed with a module like a
+    file path; see the Modules Example for usage.
+
+Example:
+    ./script/generate scaffold Account Bank debit credit
+
+    This will generate an Account model and BankController with a full test
+    suite and a basic user interface.  Now create the accounts table in your
+    database and browse to http://localhost/bank/ -- voila, you're on Rails!
+
+Modules Example:
+    ./script/generate controller 'admin/credit_card' suspend late_fee
+
+    This will generate a CreditCard model and CreditCardController controller
+    in the admin module.
+

data/lib/rails_generator/generators/components/scaffold/scaffold_generator.rb

@@ -0,0 +1,178 @@
+class ScaffoldingSandbox
+  include ActionView::Helpers::ActiveRecordHelper
+
+  attr_accessor :form_action, :singular_name, :suffix, :model_instance
+
+  def sandbox_binding
+    binding
+  end
+end
+
+class ActionView::Helpers::InstanceTag
+  def to_input_field_tag(field_type, options={})
+    field_meth = "#{field_type}_field"
+    "<%= #{field_meth} '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+options.inspect} %>"
+  end
+
+  def to_text_area_tag(options = {})
+    "<%= text_area '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+
+  def to_date_select_tag(options = {})
+    "<%= date_select '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+
+  def to_datetime_select_tag(options = {})
+    "<%= datetime_select '#{@object_name}', '#{@method_name}' #{options.empty? ? '' : ', '+ options.inspect} %>"
+  end
+end
+
+class ScaffoldGenerator < Rails::Generator::NamedBase
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_singular_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @controller_name = args.shift || @name.pluralize
+    base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(@controller_name)
+    @controller_class_name_without_nesting, @controller_singular_name, @controller_plural_name = inflect_names(base_name)
+    if @controller_class_nesting.empty?
+      @controller_class_name = @controller_class_name_without_nesting
+    else
+      @controller_class_name = "#{@controller_class_nesting}::#{@controller_class_name_without_nesting}"
+    end
+  end
+
+  def manifest
+    record do |m|
+      # Depend on model generator but skip if the model exists.
+      m.dependency 'model', [@name], :collision => :skip
+
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
+
+      # Controller, helper, views, and test directories.
+      m.directory File.join('app/controllers', controller_class_path)
+      m.directory File.join('app/helpers', controller_class_path)
+      m.directory File.join('app/views', controller_class_path, controller_file_name)
+      m.directory File.join('test/functional', controller_class_path)
+
+
+      # Controller class, functional test, helper, and views.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            controller_class_path,
+                            "#{controller_file_name}_controller_test.rb")
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            controller_class_path,
+                            "#{controller_file_name}_helper.rb")
+
+      # Layout and stylesheet.
+      m.template 'layout.rhtml',  "app/views/layouts/#{controller_file_name}.rhtml"
+      m.template 'style.css',     'public/stylesheets/scaffold.css'
+
+      # Scaffolded views.
+      scaffold_views.each do |action|
+        m.template "view_#{action}.rhtml",
+                   File.join('app/views',
+                             controller_class_path,
+                             controller_file_name,
+                             "#{action}.rhtml"),
+                   :assigns => { :action => action }
+      end
+
+      # Scaffolded forms.
+      scaffold_forms.each do |action|
+        m.complex_template "view_#{action}.rhtml",
+          File.join('app/views',
+                    controller_class_path,
+                    controller_file_name,
+                    "#{action}.rhtml"),
+          :assigns => { :action => action },
+          :insert => 'form.rhtml',
+          :sandbox => lambda { create_sandbox(action) },
+          :begin_mark => 'form',
+          :end_mark => 'eoform',
+          :mark_id => singular_name
+      end
+
+      # Unscaffolded views.
+      unscaffolded_actions.each do |action|
+        m.template "controller:view.rhtml",
+                   File.join('app/views',
+                             controller_class_path,
+                             controller_file_name,
+                             "#{action}.rhtml"),
+                   :assigns => { :action => action }
+      end
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold ModelName [ControllerName] [action, ...]"
+    end
+
+    def scaffold_views
+      %w(list show)
+    end
+
+    def scaffold_forms
+      %w(new edit)
+    end
+
+    def scaffold_actions
+      scaffold_views + %w(index create update destroy)
+    end
+
+    def unscaffolded_actions
+      args - scaffold_actions
+    end
+
+    def suffix
+      "_#{singular_name}" if options[:suffix]
+    end
+
+    def create_sandbox(action)
+      sandbox = ScaffoldingSandbox.new
+      action = if action == 'edit' then 'update' else 'create' end
+      sandbox.form_action = action
+      sandbox.singular_name = singular_name
+      begin
+        sandbox.model_instance = model_instance
+        sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
+      rescue ActiveRecord::StatementInvalid => e
+        logger.error "Before updating scaffolding from new DB schema, try creating a table for your model (#{class_name})"
+        raise SystemExit
+      end
+      sandbox.suffix = suffix
+      sandbox
+    end
+
+    def model_instance
+      base = class_nesting.split('::').inject(Object) do |base, nested|
+        break base.const_get(nested) if base.const_defined?(nested)
+        base.const_set(nested, Module.new)
+      end
+      unless base.const_defined?(@class_name_without_nesting)
+        base.const_set(@class_name_without_nesting, Class.new(ActiveRecord::Base))
+      end
+      class_name.constantize.new
+    end
+end