authorails 1.0.0

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/integration_test/USAGE

@@ -0,0 +1,14 @@
+Description:
+    The model generator creates a stub for a new integration test.
+
+    The generator takes an integration test name as its argument.  The test
+    name may be given in CamelCase or under_score and should not be suffixed
+    with 'Test'.
+
+    The generator creates an integration test class in test/integration.
+
+Example:
+    ./script/generate integration_test GeneralStories
+
+    This will create a GeneralStores integration test:
+        test/integration/general_stories_test.rb

data/lib/rails_generator/generators/components/integration_test/integration_test_generator.rb

@@ -0,0 +1,16 @@
+class IntegrationTestGenerator < Rails::Generator::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/lib/rails_generator/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/lib/rails_generator/generators/components/mailer/USAGE

@@ -0,0 +1,18 @@
+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.
+
+    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 Notifications mailer class:
+        Mailer:     app/models/notifications.rb
+        Views:      app/views/notifications/signup.rhtml [...]
+        Test:       test/unit/test/unit/notifications_test.rb
+        Fixtures:   test/fixtures/notifications/signup [...]
+

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

@@ -0,0 +1,34 @@
+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', 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}.rhtml")
+        fixture_path  = File.join('test/fixtures', relative_path)
+
+        m.template "view.rhtml", view_path,
+                   :assigns => { :action => action, :path => view_path }
+        m.template "fixture.rhtml", fixture_path,
+                   :assigns => { :action => action, :path => view_path }
+      end
+    end
+  end
+end

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

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

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__) + '<%= '/..' * 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/lib/rails_generator/generators/components/mailer/templates/view.rhtml

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

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/005_add_ssl_flag.rb

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

@@ -0,0 +1,7 @@
+class MigrationGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate'
+    end
+  end
+end

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

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

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

@@ -0,0 +1,26 @@
+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'.
+
+    As additional parameters, the generator will take attribute pairs described by name and type. These attributes will
+    be used to prepopulate the migration to create the table for the model and give you a set of predefined fixture.    
+    You don't have to think up all attributes up front, but it's a good idea of adding just the baseline of what's 
+    needed to start really working with the resource.
+
+    The generator creates a model class in app/models, a test suite in test/unit, test fixtures in
+    test/fixtures/singular_name.yml, and a migration in db/migrate.
+
+Examples:
+    ./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
+            Migration:  db/migrate/XXX_add_accounts.rb
+
+    ./script/generate model post title:string created_on:date body:text published:boolean
+    
+        Creates post model with predefined attributes.

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

@@ -0,0 +1,38 @@
+class ModelGenerator < Rails::Generator::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/lib/rails_generator/generators/components/model/templates/fixtures.yml

@@ -0,0 +1,11 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+  id: 1
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>
+two:
+  id: 2
+<% for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<% end -%>

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

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

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,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/lib/rails_generator/generators/components/observer/USAGE

@@ -0,0 +1,15 @@
+Description:
+    The observer generator creates stubs for a new observer.
+
+    The generator takes a observer name as its argument.  The observer name may be
+    given in CamelCase or under_score and should not be suffixed with 'Observer'.
+
+    The generator creates a observer class in app/models and a test suite in
+    test/unit.
+
+Example:
+    ./script/generate observer Account
+
+    This will create an Account observer:
+        Observer:   app/models/account_observer.rb
+        Test:       test/unit/account_observer_test.rb

data/lib/rails_generator/generators/components/observer/observer_generator.rb

@@ -0,0 +1,16 @@
+class ObserverGenerator < Rails::Generator::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/lib/rails_generator/generators/components/observer/templates/observer.rb

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

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

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

data/lib/rails_generator/generators/components/plugin/USAGE

@@ -0,0 +1,35 @@
+Description:
+    The plugin generator creates stubs for a new plugin.
+
+    The generator takes a plugin name as its argument.  The plugin name may be
+    given in CamelCase or under_score and should not be suffixed with 'Plugin'.
+
+    The generator creates a plugin directory in vendor/plugins that includes
+    both init.rb and README files as well as lib, task, and test directories.
+
+    It's also possible to generate stub files for a generator to go with the 
+    plugin by using --with-generator
+
+Example:
+    ./script/generate plugin BrowserFilters
+
+    This will create:
+        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
+        vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake
+
+    ./script/generate plugin BrowserFilters --with-generator
+
+    This will create:
+        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
+        vendor/plugins/browser_filters/tasks/browser_filters_tasks.rake
+        vendor/plugins/browser_filters/generators/browser_filters/browser_filters_generator.rb
+        vendor/plugins/browser_filters/generators/browser_filters/USAGE
+        vendor/plugins/browser_filters/generators/browser_filters/templates/

data/lib/rails_generator/generators/components/plugin/plugin_generator.rb

@@ -0,0 +1,38 @@
+class PluginGenerator < Rails::Generator::NamedBase
+  attr_reader :plugin_path
+
+  def initialize(runtime_args, runtime_options = {})
+    @with_generator = runtime_args.delete("--with-generator")
+    super
+    @plugin_path = "vendor/plugins/#{file_name}"
+  end
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name
+
+      m.directory "#{plugin_path}/lib"
+      m.directory "#{plugin_path}/tasks"
+      m.directory "#{plugin_path}/test"
+
+      m.template 'README',        "#{plugin_path}/README"
+      m.template 'Rakefile',      "#{plugin_path}/Rakefile"
+      m.template 'init.rb',       "#{plugin_path}/init.rb"
+      m.template 'install.rb',    "#{plugin_path}/install.rb"
+      m.template 'uninstall.rb',  "#{plugin_path}/uninstall.rb"
+      m.template 'plugin.rb',     "#{plugin_path}/lib/#{file_name}.rb"
+      m.template 'tasks.rake',    "#{plugin_path}/tasks/#{file_name}_tasks.rake"
+      m.template 'unit_test.rb',  "#{plugin_path}/test/#{file_name}_test.rb"
+      
+      if @with_generator
+        m.directory "#{plugin_path}/generators"
+        m.directory "#{plugin_path}/generators/#{file_name}"
+        m.directory "#{plugin_path}/generators/#{file_name}/templates"
+
+        m.template 'generator.rb', "#{plugin_path}/generators/#{file_name}/#{file_name}_generator.rb"
+        m.template 'USAGE',        "#{plugin_path}/generators/#{file_name}/USAGE"
+      end
+    end
+  end
+end