rubigen 1.0.0

data/examples/rails_generators/applications/app/app_generator.rb

@@ -0,0 +1,177 @@
+require 'rbconfig'
+require 'digest/md5' 
+
+class AppGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  DATABASES = %w(mysql oracle postgresql sqlite2 sqlite3 frontbase)
+
+  default_options   :db => (ENV["RAILS_DEFAULT_DATABASE"] || "mysql"),
+    :shebang => DEFAULT_SHEBANG, :freeze => false
+  mandatory_options :source => "#{File.dirname(__FILE__)}/../../../../.."
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    usage("Databases supported for preconfiguration are: #{DATABASES.join(", ")}") if (options[:db] && !DATABASES.include?(options[:db]))
+    @destination_root = args.shift
+    @app_name = File.basename(File.expand_path(@destination_root))
+  end
+
+  def manifest
+    # Use /usr/bin/env if no special shebang was specified
+    script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+    dispatcher_options = { :chmod => 0755, :shebang => options[:shebang] }
+
+    # duplicate CGI::Session#generate_unique_id
+    md5 = Digest::MD5.new
+    now = Time.now
+    md5 << now.to_s
+    md5 << String(now.usec)
+    md5 << String(rand(0))
+    md5 << String($$)
+    md5 << @app_name
+
+    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"
+
+      # Application
+      m.template "helpers/application.rb",        "app/controllers/application.rb", :assigns => { :app_name => @app_name }
+      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/databases/#{options[:db]}.yml", "config/database.yml", :assigns => {
+        :app_name => @app_name,
+        :socket   => options[:db] == "mysql" ? mysql_socket_location : nil
+      }
+      m.template "configs/routes.rb",     "config/routes.rb"
+      m.template "configs/apache.conf",   "public/.htaccess"
+
+      # Initializers
+      m.template "configs/initializers/inflections.rb", "config/initializers/inflections.rb"
+      m.template "configs/initializers/mime_types.rb",  "config/initializers/mime_types.rb"
+
+      # Environments
+      m.file "environments/boot.rb",    "config/boot.rb"
+      m.template "environments/environment.rb", "config/environment.rb", :assigns => { :freeze => options[:freeze], :app_name => @app_name, :app_secret => md5.hexdigest }
+      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( about console destroy generate performance/benchmarker performance/profiler process/reaper process/spawner process/inspector runner server plugin ).each do |file|
+        m.file     "bin/#{file}",        "script/#{file}", script_options
+        m.template "bin/win_script.cmd", "script/#{file}.cmd", 
+          :assigns => { :filename => file } if RUBY_PLATFORM =~ /dos|win32|cygwin/i
+      end
+
+      # Dispatches
+      m.file "dispatches/dispatch.rb",   "public/dispatch.rb", dispatcher_options
+      m.file "dispatches/dispatch.rb",   "public/dispatch.cgi", dispatcher_options
+      m.file "dispatches/dispatch.fcgi", "public/dispatch.fcgi", dispatcher_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"
+      m.file "html/images/rails.png", "public/images/rails.png"
+
+      # 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"
+      m.file "html/javascripts/application.js",  "public/javascripts/application.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("-r", "--ruby=path", String,
+             "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).",
+             "Default: #{DEFAULT_SHEBANG}") { |v| options[:shebang] = v }
+
+      opt.on("-d", "--database=name", String,
+            "Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite2/sqlite3).",
+            "Default: mysql") { |v| options[:db] = v }
+
+      opt.on("-f", "--freeze",
+            "Freeze Rails in vendor/rails from the gems generating the skeleton",
+            "Default: false") { |v| options[:freeze] = v }
+    end
+
+    def mysql_socket_location
+      MYSQL_SOCKET_LOCATIONS.find { |f| File.exists?(f) } unless RUBY_PLATFORM =~ /(:?mswin|mingw)/
+    end
+
+
+  # Installation skeleton.  Intermediate directories are automatically
+  # created so don't sweat their absence here.
+  BASEDIRS = %w(
+    app/controllers
+    app/helpers
+    app/models
+    app/views/layouts
+    config/environments
+    config/initializers
+    db
+    doc
+    lib
+    lib/tasks
+    log
+    public/images
+    public/javascripts
+    public/stylesheets
+    script/performance
+    script/process
+    test/fixtures
+    test/functional
+    test/integration
+    test/mocks/development
+    test/mocks/test
+    test/unit
+    vendor
+    vendor/plugins
+    tmp/sessions
+    tmp/sockets
+    tmp/cache
+    tmp/pids
+  )
+
+  MYSQL_SOCKET_LOCATIONS = [
+    "/tmp/mysql.sock",                        # default
+    "/var/run/mysqld/mysqld.sock",            # debian/gentoo
+    "/var/tmp/mysql.sock",                    # freebsd
+    "/var/lib/mysql/mysql.sock",              # fedora
+    "/opt/local/lib/mysql/mysql.sock",        # fedora
+    "/opt/local/var/run/mysqld/mysqld.sock",  # mac + darwinports + mysql
+    "/opt/local/var/run/mysql4/mysqld.sock",  # mac + darwinports + mysql4
+    "/opt/local/var/run/mysql5/mysqld.sock",  # mac + darwinports + mysql5
+    "/opt/lampp/var/mysql/mysql.sock"         # xampp for linux
+  ]
+end

data/examples/rails_generators/components/controller/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Stubs out a new controller and its views. Pass the controller name, either
+    CamelCased or under_scored, and a list of views as arguments.
+
+    To create a controller within a module, specify the controller name as a
+    path like 'parent_module/controller_name'.
+
+    This generates a controller class in app/controllers, 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.html.erb [...]
+        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.html.erb [...]
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Test:       test/functional/admin/credit_card_controller_test.rb
+

data/examples/rails_generators/components/controller/controller_generator.rb

@@ -0,0 +1,37 @@
+class ControllerGenerator < RubiGen::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}.html.erb")
+        m.template 'view.html.erb', path,
+          :assigns => { :action => action, :path => path }
+      end
+    end
+  end
+end

data/examples/rails_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/examples/rails_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/examples/rails_generators/components/controller/templates/helper.rb

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

data/examples/rails_generators/components/controller/templates/view.html.erb

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

data/examples/rails_generators/components/integration_test/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Stubs out a new integration test. Pass the name of the test, either
+    CamelCased or under_scored, as an argument. The new test class is
+    generated in test/integration/testname_test.rb
+
+Example:
+    `./script/generate integration_test GeneralStories` creates a GeneralStories
+    integration test in test/integration/general_stories_test.rb

data/examples/rails_generators/components/integration_test/integration_test_generator.rb

@@ -0,0 +1,16 @@
+class IntegrationTestGenerator < RubiGen::NamedBase
+  default_options :skip_migration => false
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name, "#{class_name}Test"
+
+      # integration test directory
+      m.directory File.join('test/integration', class_path)
+
+      # integration test stub
+      m.template 'integration_test.rb', File.join('test/integration', class_path, "#{file_name}_test.rb")
+    end
+  end
+end

data/examples/rails_generators/components/integration_test/templates/integration_test.rb

@@ -0,0 +1,10 @@
+require "#{File.dirname(__FILE__)}<%= '/..' * class_nesting_depth %>/../test_helper"
+
+class <%= class_name %>Test < ActionController::IntegrationTest
+  # fixtures :your, :models
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/rails_generators/components/mailer/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Stubs out a new mailer and its views. Pass the mailer name, either
+    CamelCased or under_scored, and an optional list of emails as arguments.
+
+    This generates a mailer class in app/models, view templates in
+    app/views/mailer_name, a unit test in test/unit, and fixtures in
+    test/fixtures.
+
+Example:
+    `./script/generate mailer Notifications signup forgot_password invoice`
+
+    creates a Notifications mailer class, views, test, and fixtures:
+        Mailer:     app/models/notifications.rb
+        Views:      app/views/notifications/signup.erb [...]
+        Test:       test/unit/test/unit/notifications_test.rb
+        Fixtures:   test/fixtures/notifications/signup [...]

data/examples/rails_generators/components/mailer/mailer_generator.rb

@@ -0,0 +1,34 @@
+class MailerGenerator < RubiGen::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', file_path)
+      m.directory File.join('test/unit', class_path)
+      m.directory File.join('test/fixtures', file_path)
+
+      # 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|
+        relative_path = File.join(file_path, action)
+        view_path     = File.join('app/views', "#{relative_path}.erb")
+        fixture_path  = File.join('test/fixtures', relative_path)
+
+        m.template "view.erb", view_path,
+                   :assigns => { :action => action, :path => view_path }
+        m.template "fixture.erb", fixture_path,
+                   :assigns => { :action => action, :path => view_path }
+      end
+    end
+  end
+end

data/examples/rails_generators/components/mailer/templates/fixture.erb

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in <%= path %>

data/examples/rails_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/examples/rails_generators/components/mailer/templates/unit_test.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../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 }
+    @expected.mime_version = '1.0'
+  end
+
+<% for action in actions -%>
+  def test_<%= action %>
+    @expected.subject = '<%= 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_path %>/#{action}")
+    end
+
+    def encode(subject)
+      quoted_printable(subject, CHARSET)
+    end
+end

data/examples/rails_generators/components/mailer/templates/view.erb

@@ -0,0 +1,3 @@
+<%= class_name %>#<%= action %>
+
+Find me in <%= path %>

data/examples/rails_generators/components/migration/USAGE

@@ -0,0 +1,24 @@
+Description:
+    Stubs out a new database migration. Pass the migration name, either
+    CamelCased or under_scored, as an argument. A migration class is generated
+    in db/migrate prefixed by the latest migration number.
+
+    You can name your migration in either of these formats to generate add/remove
+    column lines: AddColumnToTable or RemoveColumnFromTable
+
+Example:
+    `./script/generate migration AddSslFlag`
+
+    With 4 existing migrations, this creates the AddSslFlag migration in
+    db/migrate/005_add_ssl_flag.rb
+
+    `./script/generate migration AddSslFlagToAccount`
+    
+    This will create the AddSslFlagToAccount in db/migrate/005_add_ssl_flag_to_account.rb with
+    this in the Up migration:
+
+      add_column :accounts, :ssl_flag, :type, :null => :no?, :default => :maybe?
+
+    And this in the Down migration:
+    
+      remove_column :accounts, :ssl_flag

data/examples/rails_generators/components/migration/migration_generator.rb

@@ -0,0 +1,20 @@
+class MigrationGenerator < RubiGen::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+
+  def auto_migration direction
+    case class_name.underscore
+    when /^(add|remove)_(.*)_(?:to|from)_(.*)/ then
+      action, col, tbl = $1, $2, $3.pluralize
+
+      unless (action == "add") ^ (direction == :up) then
+        %(\n    add_column :#{tbl}, :#{col}, :type, :null => :no?, :default => :maybe?)
+      else
+        %(\n    remove_column :#{tbl}, :#{col})
+      end
+    end
+  end
+end

data/examples/rails_generators/components/migration/templates/migration.rb

@@ -0,0 +1,7 @@
+class <%= class_name.underscore.camelize %> < ActiveRecord::Migration
+  def self.up<%= auto_migration :up %>
+  end
+
+  def self.down<%= auto_migration :down %>
+  end
+end

data/examples/rails_generators/components/model/USAGE

@@ -0,0 +1,27 @@
+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 column_name:sql_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 generates a model class in app/models, a unit test in test/unit,
+    a test fixture in test/fixtures/singular_name.yml, and a migration in
+    db/migrate.
+
+Examples:
+    `./script/generate model account`
+
+        creates an Account model, test, fixture, and migration:
+            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/examples/rails_generators/components/model/model_generator.rb

@@ -0,0 +1,38 @@
+class ModelGenerator < RubiGen::NamedBase
+  default_options :skip_migration => false
+
+  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")
+
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} generate ModelName [field:type, field:type]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+    end
+end

data/examples/rails_generators/components/model/templates/fixtures.yml

@@ -0,0 +1,15 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>
+two:
+  id: 2
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+  created_at: <%= Time.now.to_s(:db) %>
+  updated_at: <%= Time.now.to_s(:db) %>

data/examples/rails_generators/components/model/templates/migration.rb

@@ -0,0 +1,14 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end %>
+      t.timestamps 
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/examples/rails_generators/components/model/templates/model.rb

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

data/examples/rails_generators/components/model/templates/unit_test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/rails_generators/components/observer/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Stubs out a new observer. Pass the observer name, either CamelCased or
+    under_scored, as an argument.
+
+    The generator creates an observer class in app/models and a unit test in
+    test/unit.
+
+Example:
+    `./script/generate observer Account`
+
+    creates an Account observer and unit test:
+        Observer:   app/models/account_observer.rb
+        Test:       test/unit/account_observer_test.rb

data/examples/rails_generators/components/observer/observer_generator.rb

@@ -0,0 +1,16 @@
+class ObserverGenerator < RubiGen::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Observer", "#{class_name}ObserverTest"
+
+      # Observer, and test directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('test/unit', class_path)
+
+      # Observer class and unit test fixtures.
+      m.template 'observer.rb',   File.join('app/models', class_path, "#{file_name}_observer.rb")
+      m.template 'unit_test.rb',  File.join('test/unit', class_path, "#{file_name}_observer_test.rb")
+    end
+  end
+end

data/examples/rails_generators/components/observer/templates/observer.rb

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