mconnell-generators 1.0.6

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

data/generators/rubaidh_scaffold/templates/controller_spec.rb

@@ -0,0 +1,251 @@
+# <%= 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 <%= controller_class_name %>Controller do
+  def mock_<%= file_name %>(stubs={})
+    @mock_<%= file_name %> ||= mock_model(<%= class_name %>, stubs)
+  end
+
+  describe "responding to GET index" do
+    before(:each) do
+      @<%= table_name %> = [mock_<%= file_name %>]
+      <%= class_name %>.stub!(:find).and_return(@<%= table_name %>)
+    end
+
+    def do_get
+      get :index
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+
+    it "should render the index template" do
+      do_get
+      response.should render_template(:index)
+    end
+
+    it "should query the model for a list of <%= table_name %>" do
+      <%= class_name %>.should_receive(:find).with(:all).and_return([mock_<%= file_name %>])
+      do_get
+    end
+
+    it "should expose all <%= table_name %> as @<%= table_name %>" do
+      do_get
+      assigns[:<%= table_name %>].should == [mock_<%= file_name %>]
+    end
+  end
+
+  describe "responding to GET show" do
+    before(:each) do
+      <%= class_name %>.stub!(:find).and_return(mock_<%= file_name %>)
+    end
+
+    def do_get
+      get :show, :id => "37"
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+
+    it "should render the show template" do
+      do_get
+      response.should render_template(:show)
+    end
+
+    it "should query the model for the requested <%= file_name %>" do
+      <%= class_name %>.should_receive(:find).with("37").and_return(mock_<%= file_name %>)
+      do_get
+    end
+
+    it "should expose the requested <%= file_name %> as @<%= file_name %>" do
+      do_get
+      assigns[:<%= file_name %>].should equal(mock_<%= file_name %>)
+    end
+  end
+
+  describe "responding to GET new" do
+    before(:each) do
+      <%= class_name %>.stub!(:new).and_return(mock_<%= file_name %>)
+    end
+
+    def do_get
+      get :new
+    end
+
+    it "should ask the model for a new <%= file_name %>" do
+      <%= class_name %>.should_receive(:new).and_return(mock_<%= file_name %>)
+      do_get
+    end
+
+    it "should expose a new <%= file_name %> as @<%= file_name %>" do
+      do_get
+      assigns[:<%= file_name %>].should equal(mock_<%= file_name %>)
+    end
+  end
+
+  describe "responding to GET edit" do
+    before(:each) do
+      <%= class_name %>.stub!(:find).and_return(mock_<%= file_name %>)
+    end
+
+    def do_get
+      get :edit, :id => "37"
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+
+    it "should render the edit template" do
+      do_get
+      response.should render_template(:edit)
+    end
+
+    it "should query the model for the requested <%= file_name %>" do
+      <%= class_name %>.should_receive(:find).with("37").and_return(mock_<%= file_name %>)
+      do_get
+    end
+
+    it "should expose the requested <%= file_name %> as @<%= file_name %>" do
+      do_get
+      assigns[:<%= file_name %>].should equal(mock_<%= file_name %>)
+    end
+  end
+
+  describe "responding to POST create" do
+    before(:each) do
+      <%= class_name %>.stub!(:new).and_return(mock_<%= file_name %>)
+      mock_<%= file_name %>.stub!(:save)
+    end
+
+    def do_post
+      post :create, :<%= file_name %> => { "dummy" => "parameters" }
+    end
+
+    it "should build a new <%= file_name %> with the supplied parameters" do
+      <%= class_name %>.should_receive(:new).with({ "dummy" => "parameters" })
+      do_post
+    end
+
+    it "should attempt to save the new <%= file_name %>" do
+      mock_<%= file_name %>.should_receive(:save)
+      do_post
+    end
+
+    describe "with valid params" do
+      before(:each) do
+        mock_<%= file_name %>.stub!(:save).and_return(true)
+      end
+
+      it "should redirect to the created <%= file_name %>" do
+        do_post
+        response.should redirect_to(<%= file_name %>_url(mock_<%= file_name %>))
+      end
+    end
+
+    describe "with invalid params" do
+      before(:each) do
+        mock_<%= file_name %>.stub!(:save).and_return(false)
+      end
+
+      it "should expose a newly created but unsaved <%= file_name %> as @<%= file_name %>" do
+        do_post
+        assigns(:<%= file_name %>).should equal(mock_<%= file_name %>)
+      end
+
+      it "should re-render the 'new' template" do
+        do_post
+        response.should render_template(:new)
+      end
+    end
+  end
+
+  describe "responding to PUT udpate" do
+    before(:each) do
+      <%= class_name %>.stub!(:find).and_return(mock_<%= file_name %>)
+      mock_<%= file_name %>.stub!(:update_attributes)
+    end
+
+    def do_put
+      put :update, :id => "37", :<%= file_name %> => { "dummy" => "parameters" }
+    end
+
+    it "should query the model for the requested <%= file_name %>" do
+      <%= class_name %>.should_receive(:find).with("37").and_return(mock_<%= file_name %>)
+      do_put
+    end
+
+    it "should attempt to update the attributes of the requested <%= file_name %>" do
+      mock_<%= file_name %>.should_receive(:update_attributes).with({ "dummy" => "parameters" })
+      do_put
+    end
+
+    describe "with valid params" do
+      before(:each) do
+        mock_<%= file_name %>.stub!(:update_attributes).and_return(true)
+      end
+
+      it "should redirect to the <%= file_name %>" do
+        do_put
+        response.should redirect_to(<%= file_name %>_url(mock_<%= file_name %>))
+      end
+    end
+
+    describe "with invalid params" do
+      before(:each) do
+        mock_<%= file_name %>.stub!(:update_attributes).and_return(false)
+      end
+
+      it "should expose the <%= file_name %> as @<%= file_name %>" do
+        do_put
+        assigns(:<%= file_name %>).should equal(mock_<%= file_name %>)
+      end
+
+      it "should re-render the 'edit' template" do
+        do_put
+        response.should render_template(:edit)
+      end
+    end
+
+  end
+
+  describe "responding to DELETE destroy" do
+    before(:each) do
+      <%= class_name %>.stub!(:find).and_return(mock_<%= file_name %>)
+      mock_<%= file_name %>.stub!(:destroy)
+    end
+
+    def do_delete(params = {})
+      delete :destroy, { :id => "37" }.merge(params)
+    end
+
+    it "should query the model for the requested <%= file_name %>" do
+      <%= class_name %>.should_receive(:find).with("37").and_return(mock_<%= file_name %>)
+      do_delete
+    end
+
+    it "should destroy the requested <%= file_name %>" do
+      mock_<%= file_name %>.should_receive(:destroy)
+      do_delete
+    end
+
+    it "should redirect to the <%= table_name %> index action" do
+      do_delete
+      response.should redirect_to(<%= table_name %>_url)
+    end
+  end
+end