rails_product 0.5

data/lib/rails_generator/generators/applications/app/app_generator.rb

@@ -0,0 +1,126 @@
+require 'rbconfig'
+
+class AppGenerator < Rails::Generator::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options   :gem => true, :shebang => DEFAULT_SHEBANG
+  mandatory_options :source  => "#{File.dirname(__FILE__)}/../../../../.."
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+  end
+
+  def manifest
+    script_options = { :chmod => 0755, :shebang => options[:shebang] }
+
+    record do |m|
+      # Root directory and all subdirectories.
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Root
+      m.file "fresh_rakefile", "Rakefile"
+      m.file "README",         "README"
+      m.file "CHANGELOG",      "CHANGELOG"
+
+      # Application
+      m.template "helpers/application.rb",        "app/controllers/application.rb"
+      m.template "helpers/application_helper.rb", "app/helpers/application_helper.rb"
+      m.template "helpers/test_helper.rb",        "test/test_helper.rb"
+
+      # database.yml and .htaccess
+      m.template "configs/database.yml", "config/database.yml"
+      m.template "configs/routes.rb",    "config/routes.rb"
+      m.template "configs/apache.conf",  "public/.htaccess"
+
+      # Environments
+      m.file "environments/environment.rb", "config/environment.rb"
+      m.file "environments/production.rb",  "config/environments/production.rb"
+      m.file "environments/development.rb", "config/environments/development.rb"
+      m.file "environments/test.rb",        "config/environments/test.rb"
+
+      # Scripts
+      %w(console destroy generate server runner benchmarker profiler process/reaper process/spinner process/spawner ).each do |file|
+        m.file "bin/#{file}", "script/#{file}", script_options
+      end
+      if options[:gem]
+        m.file "bin/breakpointer_for_gem", "script/breakpointer", script_options
+      else
+        m.file "bin/breakpointer", "script/breakpointer", script_options
+      end
+
+      # Dispatches
+      m.file "dispatches/dispatch.rb",   "public/dispatch.rb", script_options
+      m.file "dispatches/dispatch.rb",   "public/dispatch.cgi", script_options
+      m.file "dispatches/dispatch.fcgi", "public/dispatch.fcgi", script_options
+
+      # HTML files
+      %w(404 500 index).each do |file|
+        m.template "html/#{file}.html", "public/#{file}.html"
+      end
+      
+      m.template "html/favicon.ico", "public/favicon.ico"
+      m.template "html/robots.txt", "public/robots.txt"
+
+      # Javascripts
+      m.file "html/javascripts/prototype.js", "public/javascripts/prototype.js"
+      m.file "html/javascripts/effects.js",   "public/javascripts/effects.js"
+      m.file "html/javascripts/dragdrop.js",  "public/javascripts/dragdrop.js"
+      m.file "html/javascripts/controls.js",  "public/javascripts/controls.js"
+
+      # Docs
+      m.file "doc/README_FOR_APP", "doc/README_FOR_APP"
+
+      # Logs
+      %w(server production development test).each { |file|
+        m.file "configs/empty.log", "log/#{file}.log", :chmod => 0666
+      }
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} /path/to/your/app [options]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--ruby [#{DEFAULT_SHEBANG}]",
+             "Path to the Ruby binary of your choice.") { |options[:shebang]| }
+      opt.on("--without-gems",
+             "Don't use the Rails gems for your app.",
+             "WARNING: see note below.") { |options[:gem]| }
+    end
+
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    app/apis
+    app/controllers
+    app/helpers
+    app/models
+    app/views/layouts
+    config/environments
+    components
+    db
+    doc
+    lib
+    log
+    public/images
+    public/javascripts
+    public/stylesheets
+    script
+    script/process
+    test/fixtures
+    test/functional
+    test/mocks/development
+    test/mocks/test
+    test/unit
+    vendor
+  )
+end

data/lib/rails_generator/generators/applications/productized_app/USAGE

@@ -0,0 +1,16 @@
+Description:
+    The 'rails_product' command creates a new Productized Rails Application
+    with a default directory structure and configuration at the path you
+    specify.
+
+Example:
+    rails_product ~/Code/Ruby/cart
+
+    This generates a skeletal Productized Rails installation in
+      ~/Code/Ruby/cart
+    
+    See the README in the newly created application to get going.
+
+On-line Documentation:
+    http://inquirylabs.com/productize/ or
+    http://wiki.rubyonrails.com/rails/show/HowToProductizeYourApplication

data/lib/rails_generator/generators/applications/productized_app/productized_app_generator.rb

@@ -0,0 +1,133 @@
+require 'rbconfig'
+
+class ProductizedAppGenerator < Rails::Generator::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options   :gem => true, :shebang => DEFAULT_SHEBANG
+  mandatory_options :source  => "#{File.dirname(__FILE__)}/../../../../.."
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+  end
+
+  def manifest
+    script_options = { :chmod => 0755, :shebang => options[:shebang] }
+
+    record do |m|
+      # Root directory and all subdirectories.
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Root
+      m.file "fresh_rakefile", "Rakefile"
+      m.file "README",         "README"
+      m.file "CHANGELOG",      "CHANGELOG"
+
+      # Application
+      m.template "helpers/application.rb",        "app/controllers/application.rb"
+      m.template "helpers/application_helper.rb", "app/helpers/application_helper.rb"
+      m.template "helpers/test_helper.rb",        "test/test_helper.rb"
+
+      # database.yml and .htaccess
+      m.file "configs/database.yml",     "config/database.yml"
+      m.template "configs/routes.rb",    "config/routes.rb"
+      m.template "configs/apache.conf",  "public/.htaccess"
+
+      # Productized App Files
+      m.file "sites/fresh_rakefile",  "sites/Rakefile"
+      m.file "lib/productize.rb",     "lib/productize.rb"
+      m.file "configs/apache/vhost.example.conf", "config/apache/vhost.example.conf"
+
+      # Environments
+      m.file "environments/environment.rb", "config/environment.rb"
+      m.file "environments/production.rb",  "config/environments/production.rb"
+      m.file "environments/development.rb", "config/environments/development.rb"
+      m.file "environments/test.rb",        "config/environments/test.rb"
+
+      # Scripts (tracker listener)
+      %w(console destroy generate server runner benchmarker profiler ).each do |file|
+        m.file "bin/#{file}", "script/#{file}", script_options
+      end
+      if options[:gem]
+        m.file "bin/breakpointer_for_gem", "script/breakpointer", script_options
+      else
+        m.file "bin/breakpointer", "script/breakpointer", script_options
+      end
+
+      # Dispatches
+      m.file "dispatches/dispatch.rb",   "public/dispatch.rb", script_options
+      m.file "dispatches/dispatch.rb",   "public/dispatch.cgi", script_options
+      m.file "dispatches/dispatch.fcgi", "public/dispatch.fcgi", script_options
+      # m.file "dispatches/gateway.cgi",   "public/gateway.cgi", script_options
+
+      # HTML files
+      %w(404 500 index).each do |file|
+        m.template "html/#{file}.html", "public/#{file}.html"
+      end
+      
+      m.template "html/favicon.ico", "public/favicon.ico"
+      m.template "html/robots.txt", "public/robots.txt"
+
+      # Javascripts
+      m.file "html/javascripts/prototype.js", "public/javascripts/prototype.js"
+      m.file "html/javascripts/effects.js",   "public/javascripts/effects.js"
+      m.file "html/javascripts/dragdrop.js",  "public/javascripts/dragdrop.js"
+      m.file "html/javascripts/controls.js",  "public/javascripts/controls.js"
+
+      # Docs
+      m.file "doc/README_FOR_APP", "doc/README_FOR_APP"
+
+      # Logs
+      %w(server production development test).each { |file|
+        m.file "configs/empty.log", "log/#{file}.log", :chmod => 0666
+      }
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} /path/to/your/app [options]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--ruby [#{DEFAULT_SHEBANG}]",
+             "Path to the Ruby binary of your choice.") { |options[:shebang]| }
+      opt.on("--without-gems",
+             "Don't use the Rails gems for your app.",
+             "WARNING: see note below.") { |options[:gem]| }
+    end
+
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    app/apis
+    app/controllers
+    app/helpers
+    app/models
+    app/views/layouts
+    config/environments
+    config/apache
+    components
+    db
+    doc
+    lib
+    log
+    public/images
+    public/javascripts
+    public/stylesheets
+    script
+    test/fixtures
+    test/functional
+    test/mocks/development
+    test/mocks/test
+    test/unit
+    vendor
+    sites
+  )
+end

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,38 @@
+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|
+        path = File.join('app/views', class_path, file_name, "#{action}.rhtml")
+        m.template 'view.rhtml',
+          path,
+          :assigns => { :action => action, :path => path }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+class <%= class_name %>Controller < ApplicationController
+<% if options[:scaffold] -%>
+  scaffold :<%= singular_name %>
+<% end -%>
+<% for action in actions -%>
+
+  def <%= action %>
+  end
+<% end -%>
+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/controller/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= class_name %>Helper
+end

data/lib/rails_generator/generators/components/controller/templates/view.rhtml

@@ -0,0 +1,2 @@
+<h1><%= class_name %>#<%= action %></h1>
+<p>Find me in <%= path %></p>

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, file_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, file_name, action),
+                   :assigns => { :action => action }
+      end
+    end
+  end
+end

data/lib/rails_generator/generators/components/mailer/templates/fixture.rhtml

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in app/views/<%= file_name %>/<%= action %>.rhtml

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

@@ -0,0 +1,13 @@
+class <%= class_name %> < ActionMailer::Base
+<% for action in actions -%>
+
+  def <%= action %>(sent_at = Time.now)
+    @subject    = '<%= class_name %>#<%= action %>'
+    @body       = {}
+    @recipients = ''
+    @from       = ''
+    @sent_on    = sent_at
+    @headers    = {}
+  end
+<% end -%>
+end

data/lib/rails_generator/generators/components/mailer/templates/unit_test.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= file_name %>'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
+  CHARSET = "utf-8"
+
+  include ActionMailer::Quoting
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    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 = encode '<%= class_name %>#<%= action %>'
+    @expected.body    = read_fixture('<%= action %>')
+    @expected.date    = Time.now
+
+    assert_equal @expected.encoded, <%= class_name %>.create_<%= action %>(@expected.date).encoded
+  end
+
+<% end -%>
+  private
+    def read_fixture(action)
+      IO.readlines("#{FIXTURES_PATH}/<%= file_name %>/#{action}")
+    end
+
+    def encode(subject)
+      quoted_printable(subject, CHARSET)
+    end
+end

data/lib/rails_generator/generators/components/mailer/templates/view.rhtml

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in app/views/<%= file_name %>/<%= action %>.rhtml

data/lib/rails_generator/generators/components/migration/USAGE

@@ -0,0 +1,14 @@
+Description:
+    The migration generator creates a stub for a new database migration.
+
+    The generator takes a migration name as its argument.  The migration name may be
+    given in CamelCase or under_score.
+
+    The generator creates a migration class in db/migrate prefixed by its number
+    in the queue.
+
+Example:
+    ./script/generate migration AddSslFlag
+
+    With 4 existing migrations, this will create an AddSslFlag migration in the
+    file db/migrate/5_add_ssl_flag.rb

data/lib/rails_generator/generators/components/migration/migration_generator.rb

@@ -0,0 +1,9 @@
+class MigrationGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.directory File.join('db/migrate')
+      next_migration_number = Dir.glob("db/migrate/[0-9]*.*").size + 1
+      m.template 'migration.rb', File.join('db/migrate', "#{next_migration_number}_#{file_name}.rb")
+    end
+  end
+end

data/lib/rails_generator/generators/components/migration/templates/migration.rb

@@ -0,0 +1,7 @@
+class <%= class_name %> < ActiveRecord::Migration
+  def self.up
+  end
+
+  def self.down
+  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/singular_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, "#{ActiveRecord::Base.pluralize_table_names ? plural_name : singular_name}.yml")
+    end
+  end
+end

data/lib/rails_generator/generators/components/model/templates/fixtures.yml

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

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

@@ -0,0 +1,2 @@
+class <%= class_name %> < ActiveRecord::Base
+end

data/lib/rails_generator/generators/components/model/templates/unit_test.rb

@@ -0,0 +1,14 @@
+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_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 scaffold CreditCard 'admin/credit_card' suspend late_fee
+
+    This will generate a CreditCard model and CreditCardController controller
+    in the admin module.
+