nifty-generators 0.3.1 → 0.3.2

data/rails_generators/nifty_scaffold/USAGE

@@ -0,0 +1,51 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views. The resource is ready to use as a starting point for your restful,
+    resource-oriented application. Tests or specs are also generated depending
+    on if you have a "spec" directory or not.
+    
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the nifty_layout generator. You may want to run that generator first.
+
+Usage:
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument along with an optional list of attribute pairs and controller actions.
+    
+    If no controller actions are specified, they will default to index, show,
+    new, create, edit, update, and destroy.
+    
+    IMPORTANT: If no attribute pairs are specified, no model will be generated.
+    It will try to determine the attributes from an existing model.
+
+    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'.
+
+    For example, `nifty_scaffold post name:string content:text hidden: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.
+    
+    Adding an "!" in the mix of arguments will invert the passed controller
+    actions. This will include all 7 controller actitons except the ones
+    mentioned. This option doesn't affect model attributes.
+
+Examples:
+    script/generate nifty_scaffold post
+        
+        Will create a controller called "posts" it will contain all seven
+        CRUD actions along with the views. A model will NOT be created,
+        instead it will look for an existing model and use those attributes.
+    
+    script/generate nifty_scaffold post name:string content:text index new edit
+        
+        Will create a Post model and migration file with the name and content
+        attributes. It will also create a controller with index, new, create,
+        edit, and update actions. Notice the create and update actions are
+        added automatically with new and edit.
+    
+    script/generate nifty_scaffold post ! show new
+        
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.

data/rails_generators/nifty_scaffold/nifty_scaffold_generator.rb

@@ -0,0 +1,232 @@
+class NiftyScaffoldGenerator < Rails::Generator::Base
+  attr_accessor :name, :attributes, :controller_actions
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if @args.empty?
+    
+    @name = @args.first
+    @controller_actions = []
+    @attributes = []
+    
+    @args[1..-1].each do |arg|
+      if arg == '!'
+        options[:invert] = true
+      elsif arg.include? ':'
+        @attributes << Rails::Generator::GeneratedAttribute.new(*arg.split(":"))
+      else
+        @controller_actions << arg
+        @controller_actions << 'create' if arg == 'new'
+        @controller_actions << 'update' if arg == 'edit'
+      end
+    end
+    
+    @controller_actions.uniq!
+    @attributes.uniq!
+    
+    if options[:invert] || @controller_actions.empty?
+      @controller_actions = all_actions - @controller_actions
+    end
+    
+    if @attributes.empty?
+      options[:skip_model] = true # default to skipping model if no attributes passed
+      if model_exists?
+        model_columns_for_attributes.each do |column|
+          @attributes << Rails::Generator::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+        end
+      else
+        @attributes << Rails::Generator::GeneratedAttribute.new('name', 'string')
+      end
+    end
+  end
+  
+  def manifest
+    record do |m|
+      unless options[:skip_model]
+        m.directory "app/models"
+        m.template "model.rb", "app/models/#{singular_name}.rb"
+        unless options[:skip_migration]
+          m.migration_template "migration.rb", "db/migrate", :migration_file_name => "create_#{plural_name}"
+        end
+        
+        if rspec?
+          m.directory "spec/models"
+          m.template "tests/#{test_framework}/model.rb", "spec/models/#{singular_name}_spec.rb"
+          m.directory "spec/fixtures"
+          m.template "fixtures.yml", "spec/fixtures/#{plural_name}.yml"
+        else
+          m.directory "test/unit"
+          m.template "tests/#{test_framework}/model.rb", "test/unit/#{singular_name}_test.rb"
+          m.directory "test/fixtures"
+          m.template "fixtures.yml", "test/fixtures/#{plural_name}.yml"
+        end
+      end
+      
+      unless options[:skip_controller]
+        m.directory "app/controllers"
+        m.template "controller.rb", "app/controllers/#{plural_name}_controller.rb"
+        
+        m.directory "app/helpers"
+        m.template "helper.rb", "app/helpers/#{plural_name}_helper.rb"
+        
+        m.directory "app/views/#{plural_name}"
+        controller_actions.each do |action|
+          if File.exist? source_path("views/#{view_language}/#{action}.html.#{view_language}")
+            m.template "views/#{view_language}/#{action}.html.#{view_language}", "app/views/#{plural_name}/#{action}.html.#{view_language}"
+          end
+        end
+      
+        if form_partial?
+          m.template "views/#{view_language}/_form.html.#{view_language}", "app/views/#{plural_name}/_form.html.#{view_language}"
+        end
+      
+        m.route_resources plural_name
+        
+        if rspec?
+          m.directory "spec/controllers"
+          m.template "tests/#{test_framework}/controller.rb", "spec/controllers/#{plural_name}_controller_spec.rb"
+        else
+          m.directory "test/functional"
+          m.template "tests/#{test_framework}/controller.rb", "test/functional/#{plural_name}_controller_test.rb"
+        end
+      end
+    end
+  end
+  
+  def form_partial?
+    actions? :new, :edit
+  end
+  
+  def all_actions
+    %w[index show new create edit update destroy]
+  end
+  
+  def action?(name)
+    controller_actions.include? name.to_s
+  end
+  
+  def actions?(*names)
+    names.all? { |n| action? n.to_s }
+  end
+  
+  def singular_name
+    name.underscore
+  end
+  
+  def plural_name
+    name.underscore.pluralize
+  end
+  
+  def class_name
+    name.camelize
+  end
+  
+  def plural_class_name
+    plural_name.camelize
+  end
+  
+  def controller_methods(dir_name)
+    controller_actions.map do |action|
+      read_template("#{dir_name}/#{action}.rb")
+    end.join("  \n").strip
+  end
+  
+  def render_form
+    if form_partial?
+      if options[:haml]
+        "= render :partial => 'form'"
+      else
+        "<%= render :partial => 'form' %>"
+      end
+    else
+      read_template("views/#{view_language}/_form.html.#{view_language}")
+    end
+  end
+  
+  def items_path(suffix = 'path')
+    if action? :index
+      "#{plural_name}_#{suffix}"
+    else
+      "root_#{suffix}"
+    end
+  end
+  
+  def item_path(suffix = 'path')
+    if action? :show
+      "@#{singular_name}"
+    else
+      items_path(suffix)
+    end
+  end
+  
+  def item_path_for_spec(suffix = 'path')
+    if action? :show
+      "#{singular_name}_#{suffix}(assigns[:#{singular_name}])"
+    else
+      items_path(suffix)
+    end
+  end
+  
+  def item_path_for_test(suffix = 'path')
+    if action? :show
+      "#{singular_name}_#{suffix}(assigns(:#{singular_name}))"
+    else
+      items_path(suffix)
+    end
+  end
+  
+  def model_columns_for_attributes
+    class_name.constantize.columns.reject do |column|
+      column.name.to_s =~ /^(id|created_at|updated_at)$/
+    end
+  end
+  
+  def rspec?
+    test_framework == :rspec
+  end
+  
+protected
+  
+  def view_language
+    options[:haml] ? 'haml' : 'erb'
+  end
+  
+  def test_framework
+    options[:test_framework] ||= default_test_framework
+  end
+  
+  def default_test_framework
+    File.exist?(destination_path("spec")) ? :rspec : :testunit
+  end
+  
+  def add_options!(opt)
+    opt.separator ''
+    opt.separator 'Options:'
+    opt.on("--skip-model", "Don't generate a model or migration file.") { |v| options[:skip_model] = v }
+    opt.on("--skip-migration", "Don't generate migration file for model.") { |v| options[:skip_migration] = v }
+    opt.on("--skip-timestamps", "Don't add timestamps to migration file.") { |v| options[:skip_timestamps] = v }
+    opt.on("--skip-controller", "Don't generate controller, helper, or views.") { |v| options[:skip_controller] = v }
+    opt.on("--invert", "Generate all controller actions except these mentioned.") { |v| options[:invert] = v }
+    opt.on("--haml", "Generate HAML views instead of ERB.") { |v| options[:haml] = v }
+    opt.on("--testunit", "Use test/unit for test files.") { options[:test_framework] = :testunit }
+    opt.on("--rspec", "Use RSpec for test files.") { options[:test_framework] = :rspec }
+    opt.on("--shoulda", "Use Shoulda for test files.") { options[:test_framework] = :shoulda }
+  end
+  
+  # is there a better way to do this? Perhaps with const_defined?
+  def model_exists?
+    File.exist? destination_path("app/models/#{singular_name}.rb")
+  end
+  
+  def read_template(relative_path)
+    ERB.new(File.read(source_path(relative_path)), nil, '-').result(binding)
+  end
+  
+  def banner
+    <<-EOS
+Creates a controller and optional model given the name, actions, and attributes.
+
+USAGE: #{$0} #{spec.name} ModelName [controller_actions and model:attributes] [options]
+EOS
+  end
+end

data/rails_generators/nifty_scaffold/templates/actions/create.rb

@@ -0,0 +1,9 @@
+  def create
+    @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+      flash[:notice] = "Successfully created <%= name.underscore.humanize.downcase %>."
+      redirect_to <%= item_path('url') %>
+    else
+      render :action => 'new'
+    end
+  end

data/rails_generators/nifty_scaffold/templates/actions/destroy.rb

@@ -0,0 +1,6 @@
+  def destroy
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    @<%= singular_name %>.destroy
+    flash[:notice] = "Successfully destroyed <%= name.underscore.humanize.downcase %>."
+    redirect_to <%= items_path('url') %>
+  end

data/rails_generators/nifty_scaffold/templates/actions/edit.rb

@@ -0,0 +1,3 @@
+  def edit
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end

data/rails_generators/nifty_scaffold/templates/actions/index.rb

@@ -0,0 +1,3 @@
+  def index
+    @<%= plural_name %> = <%= class_name %>.all
+  end

data/rails_generators/nifty_scaffold/templates/actions/new.rb

@@ -0,0 +1,3 @@
+  def new
+    @<%= singular_name %> = <%= class_name %>.new
+  end

data/rails_generators/nifty_scaffold/templates/actions/show.rb

@@ -0,0 +1,3 @@
+  def show
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end

data/rails_generators/nifty_scaffold/templates/actions/update.rb

@@ -0,0 +1,9 @@
+  def update
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      flash[:notice] = "Successfully updated <%= name.underscore.humanize.downcase %>."
+      redirect_to <%= item_path('url') %>
+    else
+      render :action => 'edit'
+    end
+  end

data/rails_generators/nifty_scaffold/templates/controller.rb

@@ -0,0 +1,3 @@
+class <%= plural_class_name %>Controller < ApplicationController
+  <%= controller_methods :actions %>
+end

data/rails_generators/nifty_scaffold/templates/fixtures.yml

@@ -0,0 +1,9 @@
+one:
+<%- for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<%- end -%>
+
+two:
+<%- for attribute in attributes -%>
+  <%= attribute.name %>: <%= attribute.default %>
+<%- end -%>

data/rails_generators/nifty_scaffold/templates/helper.rb

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

data/rails_generators/nifty_scaffold/templates/migration.rb

@@ -0,0 +1,16 @@
+class Create<%= plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= plural_name %> do |t|
+    <%- for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+    <%- end -%>
+    <%- unless options[:skip_timestamps] -%>
+      t.timestamps
+    <%- end -%>
+    end
+  end
+  
+  def self.down
+    drop_table :<%= plural_name %>
+  end
+end

data/rails_generators/nifty_scaffold/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveRecord::Base
+  attr_accessible <%= attributes.map { |a| ":#{a.name}" }.join(", ") %>
+end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/create.rb

@@ -0,0 +1,11 @@
+  it "create action should render new template when model is invalid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(false)
+    post :create
+    response.should render_template(:new)
+  end
+  
+  it "create action should redirect when model is valid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(true)
+    post :create
+    response.should redirect_to(<%= item_path_for_spec('url') %>)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/destroy.rb

@@ -0,0 +1,6 @@
+  it "destroy action should destroy model and redirect to index action" do
+    <%= singular_name %> = <%= class_name %>.first
+    delete :destroy, :id => <%= singular_name %>
+    response.should redirect_to(<%= items_path('url') %>)
+    <%= class_name %>.exists?(<%= singular_name %>.id).should be_false
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/edit.rb

@@ -0,0 +1,4 @@
+  it "edit action should render edit template" do
+    get :edit, :id => <%= class_name %>.first
+    response.should render_template(:edit)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/index.rb

@@ -0,0 +1,4 @@
+  it "index action should render index template" do
+    get :index
+    response.should render_template(:index)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/new.rb

@@ -0,0 +1,4 @@
+  it "new action should render new template" do
+    get :new
+    response.should render_template(:new)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/show.rb

@@ -0,0 +1,4 @@
+  it "show action should render show template" do
+    get :show, :id => <%= class_name %>.first
+    response.should render_template(:show)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/actions/update.rb

@@ -0,0 +1,11 @@
+  it "update action should render edit template when model is invalid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(false)
+    put :update, :id => <%= class_name %>.first
+    response.should render_template(:edit)
+  end
+  
+  it "update action should redirect when model is valid" do
+    <%= class_name %>.any_instance.stubs(:valid?).returns(true)
+    put :update, :id => <%= class_name %>.first
+    response.should redirect_to(<%= item_path_for_spec('url') %>)
+  end

data/rails_generators/nifty_scaffold/templates/tests/rspec/controller.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+ 
+describe <%= plural_class_name %>Controller do
+  fixtures :all
+  integrate_views
+  
+  <%= controller_methods 'tests/rspec/actions' %>
+end

data/rails_generators/nifty_scaffold/templates/tests/rspec/model.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe <%= class_name %> do
+  it "should be valid" do
+    <%= class_name %>.new.should be_valid
+  end
+end