rubaidh-generators 1.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+/rdoc
+/pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [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/README.rdoc

@@ -0,0 +1,8 @@
+= Rubaidh Generators
+
+Rails ships with its own generators for creating models, controllers and
+complete scaffolds. RSpec ships with its own take on these generators. We ship
+with yet another slightly different take on the generators, suited to
+Rubaidh's tastes.
+
+Copyright (c) 2009 Rubaidh Ltd, released under the MIT license.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the generators plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the generators plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Generators'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::GemPackageTask.new(eval(File.read('generators.gemspec'))) do |p|
+  p.need_tar = false
+  p.need_zip = false
+end

data/TODO

@@ -0,0 +1,11 @@
+= To do
+
+* Fix the scaffold to successfully create singleton resources too.
+
+* Create a layout generator which creates a sensible default layout using YUI
+  grids.
+
+* Figure out how to do automated testing of generators.
+
+* Figure a way to keep track of changes to the Rails (and RSpec) generators
+  used as inspiration so we can merge in changes.

data/bin/rubaidh_rails

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+gem 'rails'
+
+require 'rails/version'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+Rails::Generator::Base.use_application_sources!
+Rails::Generator::Scripts::Generate.new.run(["-d", "mysql", "-m", File.join(File.dirname(__FILE__), '..', 'templates', 'rubaidh.rb')] + ARGV, :generator => 'app')

data/generators/rubaidh_controller/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Stubs out a new controller, along with its helper, views and associated
+    specs. 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, a controller
+    spec in spec/controllers and a helper spec in spec/helpers.
+
+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
+        Controller Spec: spec/controllers/credit_card_controller_spec.rb
+        Views:           app/views/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/credit_card_helper.rb
+        Helper Spec:     spec/helpers/credit_card_helper_spec.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
+        Controller Spec: spec/controllers/admin/credit_card_controller_spec.rb
+        Views:           app/views/admin/credit_card/debit.html.erb [...]
+        Helper:          app/helpers/admin/credit_card_helper.rb
+        Helper Spec:     spec/helpers/admin/credit_card_helper_spec.rb

data/generators/rubaidh_controller/rubaidh_controller_generator.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhControllerGenerator < RubaidhNamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Controller"
+
+      # Controller, helper, views, and spec directories.
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('app/views', class_path, file_name)
+      m.directory File.join('spec/controllers', class_path)
+
+      # Controller spec, class, and helper.
+      m.template 'controller.rb',
+                 File.join('app/controllers',
+                           class_path,
+                           "#{file_name}_controller.rb")
+
+      m.template 'controller_spec.rb',
+                 File.join('spec/controllers',
+                           class_path,
+                           "#{file_name}_controller_spec.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
+
+      m.dependency 'rubaidh_helper', [name] + @args
+    end
+  end
+
+  protected
+  def banner
+    "Usage: #{$0} #{spec.name} ControllerName [action]..."
+  end
+end

data/generators/rubaidh_controller/templates/controller.rb

@@ -0,0 +1,17 @@
+# <%= class_name %> Controller
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+class <%= class_name %>Controller < ApplicationController
+<% for action in actions -%>
+
+  def <%= action %>
+  end
+<% end -%>
+end

data/generators/rubaidh_controller/templates/controller_spec.rb

@@ -0,0 +1,29 @@
+# <%= class_name %> Controller Spec
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %>Controller do
+<% unless actions.empty? -%>
+<% for action in actions -%>
+
+  describe "responding to GET '<%= action %>'" do
+    def do_get
+      get :<%= action %>
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+  end
+<% end -%>
+<% end -%>
+end

data/generators/rubaidh_controller/templates/view.html.erb

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

data/generators/rubaidh_helper/USAGE

@@ -0,0 +1,23 @@
+Description:
+    Stubs out a new helper. Pass the helper name, either
+    CamelCased or under_scored.
+
+    To create a helper within a module, specify the helper name as a
+    path like 'parent_module/helper_name'.
+
+    This generates a helper class in app/helpers and a helper spec
+    in spec/helpers.
+
+Example:
+    `./script/generate helper CreditCard`
+
+    Credit card helper.
+        Helper:     app/helpers/credit_card_helper.rb
+        Spec:       spec/helpers/credit_card_helper_spec.rb
+
+Modules Example:
+    `./script/generate helper 'admin/credit_card'`
+
+    Credit card admin helper.
+        Helper:     app/helpers/admin/credit_card_helper.rb
+        Spec:       spec/helpers/admin/credit_card_helper_spec.rb

data/generators/rubaidh_helper/rubaidh_helper_generator.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhHelperGenerator < RubaidhNamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions "#{class_name}Helper"
+
+      # Helper and helper test directories.
+      m.directory File.join('app/helpers', class_path)
+      m.directory File.join('spec/helpers', class_path)
+
+      # Helper and helper test class.
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            class_path,
+                            "#{file_name}_helper.rb")
+
+      m.template 'helper_spec.rb',
+                  File.join('spec/helpers',
+                            class_path,
+                            "#{file_name}_helper_spec.rb")
+
+    end
+  end
+end

data/generators/rubaidh_helper/templates/helper.rb

@@ -0,0 +1,12 @@
+# <%= class_name %> Helper
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+module <%= class_name %>Helper
+end

data/generators/rubaidh_helper/templates/helper_spec.rb

@@ -0,0 +1,14 @@
+# <%= class_name %> Helper Spec
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %>Helper do
+end

data/generators/rubaidh_model/USAGE

@@ -0,0 +1,25 @@
+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, an rspec specification in
+    spec/models and a migration in db/migrate.
+
+Examples:
+    `./script/generate model account`
+
+        creates an Account model, spec and migration:
+            Model:      app/models/account.rb
+            Spec:       spec/models/account_spec.rb
+            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/generators/rubaidh_model/rubaidh_model_generator.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhModelGenerator < RubaidhNamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_name
+
+      # Model, test, and fixture directories.
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('spec/models', class_path)
+      m.directory File.join('spec/exemplars', class_path)
+
+      # Model class, unit test, and fixtures.
+      m.template 'model.rb',      File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'model_spec.rb',  File.join('spec/models', class_path, "#{file_name}_spec.rb")
+      m.template 'model_exemplar.rb',  File.join('spec/exemplars', class_path, "#{file_name}_exemplar.rb")
+
+      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
+
+  protected
+  def banner
+    "Usage: #{$0} #{spec.name} ModelName [field:type] ..."
+  end
+end

data/generators/rubaidh_model/templates/migration.rb

@@ -0,0 +1,25 @@
+# <%= migration_name %> Migration
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/generators/rubaidh_model/templates/model.rb

@@ -0,0 +1,15 @@
+# <%= class_name %> Model
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+class <%= class_name %> < ActiveRecord::Base
+<% attributes.select(&:reference?).each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+end

data/generators/rubaidh_model/templates/model_exemplar.rb

@@ -0,0 +1,13 @@
+# <%= class_name %> Exemplar
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+<%= class_name %>.class_eval do
+
+end

data/generators/rubaidh_model/templates/model_spec.rb

@@ -0,0 +1,31 @@
+# <%= class_name %> Specification
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../spec_helper')
+
+describe <%= class_name %> do
+  describe "generator" do
+    it "should successfully create a new instance" do
+      lambda { <%= class_name %>.generate! }.should_not raise_error
+    end
+
+    it "should persist the new instance in the database" do
+      lambda { <%= class_name %>.generate }.should change(<%= class_name %>, :count).by(1)
+    end
+
+    it "should be valid" do
+      <%= class_name %>.generate.should be_valid
+    end
+  end
+
+  describe "validations" do
+
+  end
+end

data/generators/rubaidh_named_base.rb

@@ -0,0 +1,31 @@
+require 'grit'
+
+class RubaidhNamedBase < Rails::Generator::NamedBase
+  attr_reader :project_name, :user_full_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    assign_additional_names!
+  end
+
+  private
+  def assign_additional_names!
+    @user_full_name = figure_out_full_name_from_git_repository
+    @project_name = figure_out_project_name_from_rails_root
+  end
+
+  def figure_out_full_name_from_git_repository
+    repos = Grit::Repo.new(RAILS_ROOT)
+
+    repos.config['user.name']
+  rescue StandardError => e
+    # If Grit::Repo raises an error, chances are it's not a git repository. 
+    # It's not super-important, so just give up.
+    "a Rubaidh staff member"
+  end
+
+  def figure_out_project_name_from_rails_root
+    File.basename(RAILS_ROOT).humanize
+  end
+end

data/generators/rubaidh_scaffold/USAGE

@@ -0,0 +1,29 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views, along with a full rspec 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 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 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 map.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/generators/rubaidh_scaffold/rubaidh_scaffold_generator.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), '..', 'rubaidh_named_base')
+
+class RubaidhScaffoldGenerator < RubaidhNamedBase
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_underscore_name,
+                :controller_singular_name,
+                :controller_plural_name
+  alias_method  :controller_file_name,  :controller_underscore_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    if @name == @name.pluralize && !options[:force_plural]
+      logger.warning "Plural version of the model detected, using singularized version.  Override with --force-plural."
+      @name = @name.singularize
+    end
+
+    @controller_name = @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_underscore_name, @controller_plural_name = inflect_names(base_name)
+    @controller_singular_name=base_name.singularize
+    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|
+      # Check for class naming collisions.
+      m.class_collisions "#{controller_class_name}Controller"
+
+      # Controller, helper, views, test and stylesheets directories.
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+      m.directory(File.join('spec/controllers', controller_class_path))
+
+      [ :index, :show, :new, :edit ].each do |view|
+        m.template(
+          "view_#{view}.html.erb",
+          File.join('app/views', controller_class_path, controller_file_name, "#{view}.html.erb")
+        )
+      end
+
+      m.template(
+        "partial_form.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "_form.html.erb")
+      )
+
+      m.template(
+        "partial_layout.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "_#{plural_name}.html.erb")
+      )
+
+      m.template(
+        "partial_model.html.erb",
+        File.join('app/views', controller_class_path, controller_file_name, "_#{singular_name}.html.erb")
+      )
+
+      m.template(
+        'controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb")
+      )
+
+      m.template('routing_spec.rb',    File.join('spec/controllers', controller_class_path, "#{controller_file_name}_routing_spec.rb"))
+      m.template('controller_spec.rb', File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb"))
+
+      m.route_resources controller_file_name
+
+      m.dependency 'rubaidh_model', [name] + @args
+      m.dependency 'rubaidh_helper', [plural_name] + @args
+    end
+  end
+
+  protected
+  def banner
+    "Usage: #{$0} #{spec.name} ModelName [field:type] ..."
+  end
+
+  def model_name
+    class_name.demodulize
+  end
+end

data/generators/rubaidh_scaffold/templates/controller.rb

@@ -0,0 +1,76 @@
+# <%= class_name %> Controller
+#
+# Created on <%= Time.now.to_s :long %> by <%= user_full_name %> as part
+# of the "<%= project_name %>" project.
+#
+#--
+# Copyright (c) 2006-<%= Time.now.year %> Rubaidh Ltd.  All rights reserved.
+# See LICENSE in the top level source code folder for permissions.
+#++
+
+class <%= controller_class_name %>Controller < ApplicationController
+  def index
+    @<%= table_name %> = <%= class_name %>.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+    end
+  end
+
+  def show
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+    end
+  end
+
+  def new
+    @<%= file_name %> = <%= class_name %>.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+    end
+  end
+
+  def edit
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      format.html # edit.html.erb
+    end
+  end
+
+  def create
+    @<%= file_name %> = <%= class_name %>.new(params[:<%= file_name %>])
+
+    respond_to do |format|
+      if @<%= file_name %>.save
+        format.html { redirect_to(@<%= file_name %>) }
+      else
+        format.html { render :action => "new" }
+      end
+    end
+  end
+
+  def update
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+
+    respond_to do |format|
+      if @<%= file_name %>.update_attributes(params[:<%= file_name %>])
+        format.html { redirect_to(@<%= file_name %>) }
+      else
+        format.html { render :action => "edit" }
+      end
+    end
+  end
+
+  def destroy
+    @<%= file_name %> = <%= class_name %>.find(params[:id])
+    @<%= file_name %>.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(<%= table_name %>_url) }
+    end
+  end
+end