giraffesoft-resource_controller 0.5.1 → 0.5.2

data/generators/scaffold_resource/USAGE

@@ -0,0 +1,29 @@
+Description:
+    The scaffold resource generator creates a model, a controller, and a set of templates that's ready to use as the
+    starting point for your REST-like, resource-oriented application. This basically means that it follows a set of
+    conventions to exploit the full set of HTTP verbs (GET/POST/PUT/DELETE) and is prepared for multi-client access
+    (like one view for HTML, one for an XML API, one for ATOM, etc). Everything comes with sample unit and functional
+    tests as well.
+    
+    The generator takes the name of the model as its first argument. This model name is then pluralized to get the 
+    controller name. So "scaffold_resource post" will generate a Post model and a PostsController and will be intended
+    for URLs like /posts and /posts/45.
+    
+    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 to give you a set of templates for the
+    view. For example, "scaffold_resource post title:string created_on:date body:text published:boolean" will give
+    you a model with those four attributes, forms to create and edit those models from, and an index that'll list them 
+    all.
+    
+    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.
+    
+    Once the generator has run, you'll need to add a declaration to your config/routes.rb file to hook up the rules
+    that'll point URLs to this new resource. If you create a resource like "scaffold_resource post", you'll need to
+    add "map.resources :posts" (notice the plural form) in the routes file. Then your new resource is accessible from
+    /posts.
+
+Examples:
+    ./script/generate scaffold_resource post # no attributes, view will be anemic
+    ./script/generate scaffold_resource post title:string created_on:date body:text published:boolean
+    ./script/generate scaffold_resource purchase order_id:integer created_at:datetime amount:decimal

data/generators/scaffold_resource/scaffold_resource_generator.rb

@@ -0,0 +1,179 @@
+class ScaffoldResourceGenerator < Rails::Generator::NamedBase
+  attr_reader   :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name,
+                :resource_edit_path,
+                :default_file_extension,
+                :generator_default_file_extension
+  alias_method  :controller_file_name,  :controller_singular_name
+  alias_method  :controller_table_name, :controller_plural_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+
+    if @rspec = has_rspec?
+      if ActionController::Base.respond_to?(:resource_action_separator)
+        @resource_edit_path = "/edit"
+      else
+        @resource_edit_path = ";edit"
+      end
+    end
+
+    @generator_default_file_extension = (defined? Haml )? "haml" : "erb"
+    
+    # we want to call erb templates .rhtml or .haml if this is rails 1
+    if RAILS_GEM_VERSION.to_i == 1
+      @default_file_extension = @generator_default_file_extension == 'erb' ? 'rhtml' : @generator_default_file_extension
+    else
+      @default_file_extension = "html.#{@generator_default_file_extension}"
+    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_singular_name, @controller_plural_name = inflect_names(base_name)
+
+    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_path, "#{controller_class_name}Controller", "#{controller_class_name}Helper")
+      m.class_collisions(class_path, "#{class_name}")
+
+      # Controller, helper, views, and test directories.
+      m.directory(File.join('app/models', class_path))
+      m.directory(File.join('app/controllers', controller_class_path))
+      m.directory(File.join('app/helpers', controller_class_path))
+      m.directory(File.join('app/views', controller_class_path, controller_file_name))
+
+      if @rspec
+        m.directory(File.join('spec/controllers', controller_class_path))
+        m.directory(File.join('spec/helpers', class_path))
+        m.directory(File.join('spec/models', class_path))
+        m.directory File.join('spec/views', controller_class_path, controller_file_name)
+        m.directory(File.join('spec/fixtures', class_path))
+      else
+        m.directory(File.join('test/functional', controller_class_path))
+        m.directory(File.join('test/unit', class_path))
+      end
+      
+      scaffold_views.each do |action|
+        m.template(
+          "view_#{action}.#{generator_default_file_extension}",
+          File.join('app/views', controller_class_path, controller_file_name, "#{action}.#{default_file_extension}")
+        )
+      end
+
+      m.template('model.rb', File.join('app/models', class_path, "#{file_name}.rb"))
+      m.template('controller.rb', File.join('app/controllers', controller_class_path, "#{controller_file_name}_controller.rb"))
+      m.template('helper.rb',          File.join('app/helpers',     controller_class_path, "#{controller_file_name}_helper.rb"))
+
+      if @rspec
+        m.template('rspec/functional_spec.rb',  File.join('spec/controllers', controller_class_path, "#{controller_file_name}_controller_spec.rb"))
+        m.template('rspec/routing_spec.rb',     File.join('spec/controllers', controller_class_path, "#{controller_file_name}_routing_spec.rb"))
+        m.template('rspec/helper_spec.rb',      File.join('spec/helpers',     class_path, "#{controller_file_name}_helper_spec.rb"))
+        m.template('rspec/unit_spec.rb',        File.join('spec/models',      class_path, "#{file_name}_spec.rb"))
+        m.template('fixtures.yml',        File.join('spec/fixtures',    "#{table_name}.yml"))
+
+        rspec_views.each do |action|
+          m.template(
+            "rspec/views/#{action}_spec.rb",
+            File.join('spec/views', controller_class_path, controller_file_name, "#{action}_spec.rb")
+          )
+        end
+
+      else
+        functional_test = (defined? ThoughtBot::Shoulda) ? "shoulda_functional_test.rb" : "functional_test.rb"
+
+        m.template("#{functional_test}", File.join('test/functional', controller_class_path, "#{controller_file_name}_controller_test.rb"))
+        m.template('unit_test.rb',       File.join('test/unit',       class_path, "#{file_name}_test.rb"))
+        m.template('fixtures.yml',       File.join('test/fixtures',   "#{table_name}.yml"))
+      end
+
+
+      unless options[:skip_migration]
+        migration_template = RAILS_GEM_VERSION.to_i == 1 ? 'old_migration.rb' : 'migration.rb'
+        
+        m.migration_template(
+          migration_template, 'db/migrate', 
+          :assigns => {
+            :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+            :attributes     => attributes
+          }, 
+          :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+        )
+      end
+
+      m.route_resources controller_file_name
+    end
+  end
+
+  # Lifted from Rick Olson's restful_authentication
+  def has_rspec?
+    options[:rspec] || (File.exist?('spec') && File.directory?('spec'))
+  end
+  
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} scaffold_resource ModelName [field:type, field:type]"
+    end
+
+    def rspec_views
+      %w[ index show new edit ]
+    end
+    
+    def scaffold_views
+      rspec_views + %w[ _form ]
+    end
+
+    def model_name 
+      class_name.demodulize
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--rspec", "Force rspec mode (checks for RAILS_ROOT/spec by default)") { |v| options[:rspec] = true }
+    end
+end
+
+module Rails
+  module Generator
+    class GeneratedAttribute
+      def default_value
+        @default_value ||= case type
+          when :int, :integer               then "\"1\""
+          when :float                       then "\"1.5\""
+          when :decimal                     then "\"9.99\""
+          when :datetime, :timestamp, :time then "Time.now"
+          when :date                        then "Date.today"
+          when :string                      then "\"MyString\""
+          when :text                        then "\"MyText\""
+          when :boolean                     then "false"
+          else
+            ""
+        end      
+      end
+
+      def input_type
+        @input_type ||= case type
+          when :text                        then "textarea"
+          else
+            "input"
+        end      
+      end
+    end
+  end
+end

data/generators/scaffold_resource/templates/controller.rb

@@ -0,0 +1,2 @@
+class <%= controller_class_name %>Controller < ResourceController::Base
+end

data/generators/scaffold_resource/templates/fixtures.yml

@@ -0,0 +1,10 @@
+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/generators/scaffold_resource/templates/functional_test.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '<%= '/..' * controller_class_nesting_depth %>/../test_helper'
+require '<%= controller_file_path %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+  fixtures :<%= table_name %>
+
+  def setup
+    @controller = <%= controller_class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+  def test_should_get_index
+    get :index
+    assert_response :success
+    assert assigns(:<%= table_name %>)
+  end
+
+  def test_should_get_new
+    get :new
+    assert_response :success
+  end
+  
+  def test_should_create_<%= file_name %>
+    old_count = <%= class_name %>.count
+    post :create, :<%= file_name %> => { }
+    assert_equal old_count+1, <%= class_name %>.count
+    
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+
+  def test_should_show_<%= file_name %>
+    get :show, :id => 1
+    assert_response :success
+  end
+
+  def test_should_get_edit
+    get :edit, :id => 1
+    assert_response :success
+  end
+  
+  def test_should_update_<%= file_name %>
+    put :update, :id => 1, :<%= file_name %> => { }
+    assert_redirected_to <%= file_name %>_path(assigns(:<%= file_name %>))
+  end
+  
+  def test_should_destroy_<%= file_name %>
+    old_count = <%= class_name %>.count
+    delete :destroy, :id => 1
+    assert_equal old_count-1, <%= class_name %>.count
+    
+    assert_redirected_to <%= table_name %>_path
+  end
+end

data/generators/scaffold_resource/templates/helper.rb

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

data/generators/scaffold_resource/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %>, :force => true 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/generators/scaffold_resource/templates/model.rb

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

data/generators/scaffold_resource/templates/old_migration.rb

@@ -0,0 +1,13 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %>, :force => true 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/generators/scaffold_resource/templates/rspec/functional_spec.rb

@@ -0,0 +1,255 @@
+require File.expand_path(File.dirname(__FILE__) + '<%= '/..' * controller_class_nesting_depth %>/../spec_helper')
+
+describe <%= controller_class_name %>Controller do
+  describe "handling GET /<%= table_name %>" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>)
+      <%= controller_class_name.singularize %>.stub!(:find).and_return([@<%= file_name %>])
+    end
+  
+    def do_get
+      get :index
+    end
+  
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+
+    it "should render index template" do
+      do_get
+      response.should render_template('index')
+    end
+  
+    it "should find all <%= table_name %>" do
+      <%= controller_class_name.singularize %>.should_receive(:find).with(:all).and_return([@<%= file_name %>])
+      do_get
+    end
+  
+    it "should assign the found <%= table_name %> for the view" do
+      do_get
+      assigns[:<%= table_name %>].should == [@<%= file_name %>]
+    end
+  end
+
+  describe "handling GET /<%= table_name %>/1" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>)
+      <%= controller_class_name.singularize %>.stub!(:find).and_return(@<%= file_name %>)
+    end
+  
+    def do_get
+      get :show, :id => "1"
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+  
+    it "should render show template" do
+      do_get
+      response.should render_template('show')
+    end
+  
+    it "should find the <%= file_name %> requested" do
+      <%= controller_class_name.singularize %>.should_receive(:find).with("1").and_return(@<%= file_name %>)
+      do_get
+    end
+  
+    it "should assign the found <%= file_name %> for the view" do
+      do_get
+      assigns[:<%= file_name %>].should equal(@<%= file_name %>)
+    end
+  end
+
+  describe "handling GET /<%= table_name %>/new" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>)
+      <%= controller_class_name.singularize %>.stub!(:new).and_return(@<%= file_name %>)
+    end
+  
+    def do_get
+      get :new
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+  
+    it "should render new template" do
+      do_get
+      response.should render_template('new')
+    end
+  
+    it "should create an new <%= file_name %>" do
+      <%= controller_class_name.singularize %>.should_receive(:new).and_return(@<%= file_name %>)
+      do_get
+    end
+  
+    it "should not save the new <%= file_name %>" do
+      @<%= file_name %>.should_not_receive(:save)
+      do_get
+    end
+  
+    it "should assign the new <%= file_name %> for the view" do
+      do_get
+      assigns[:<%= file_name %>].should equal(@<%= file_name %>)
+    end
+  end
+
+  describe "handling GET /<%= table_name %>/1/edit" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>)
+      <%= controller_class_name.singularize %>.stub!(:find).and_return(@<%= file_name %>)
+    end
+  
+    def do_get
+      get :edit, :id => "1"
+    end
+
+    it "should be successful" do
+      do_get
+      response.should be_success
+    end
+  
+    it "should render edit template" do
+      do_get
+      response.should render_template('edit')
+    end
+  
+    it "should find the <%= file_name %> requested" do
+      <%= controller_class_name.singularize %>.should_receive(:find).and_return(@<%= file_name %>)
+      do_get
+    end
+  
+    it "should assign the found <%= controller_class_name %> for the view" do
+      do_get
+      assigns[:<%= file_name %>].should equal(@<%= file_name %>)
+    end
+  end
+
+  describe "handling POST /<%= table_name %>" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>, :to_param => "1")
+      <%= controller_class_name.singularize %>.stub!(:new).and_return(@<%= file_name %>)
+    end
+    
+    describe "with successful save" do
+  
+      def do_post
+        @<%= file_name %>.should_receive(:save).and_return(true)
+        post :create, :<%= file_name %> => {}
+      end
+  
+      it "should create a new <%= file_name %>" do
+        <%= controller_class_name.singularize %>.should_receive(:new).with({}).and_return(@<%= file_name %>)
+        do_post
+      end
+
+      it "should redirect to the new <%= file_name %>" do
+        do_post
+        response.should redirect_to(<%= table_name.singularize %>_url("1"))
+      end
+      
+    end
+    
+    describe "with failed save" do
+
+      def do_post
+        @<%= file_name %>.should_receive(:save).and_return(false)
+        post :create, :<%= file_name %> => {}
+      end
+  
+      it "should re-render 'new'" do
+        do_post
+        response.should render_template('new')
+      end
+      
+    end
+  end
+
+  describe "handling PUT /<%= table_name %>/1" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>, :to_param => "1")
+      <%= controller_class_name.singularize %>.stub!(:find).and_return(@<%= file_name %>)
+    end
+    
+    describe "with successful update" do
+
+      def do_put
+        @<%= file_name %>.should_receive(:update_attributes).and_return(true)
+        put :update, :id => "1"
+      end
+
+      it "should find the <%= file_name %> requested" do
+        <%= controller_class_name.singularize %>.should_receive(:find).with("1").and_return(@<%= file_name %>)
+        do_put
+      end
+
+      it "should update the found <%= file_name %>" do
+        do_put
+        assigns(:<%= file_name %>).should equal(@<%= file_name %>)
+      end
+
+      it "should assign the found <%= file_name %> for the view" do
+        do_put
+        assigns(:<%= file_name %>).should equal(@<%= file_name %>)
+      end
+
+      it "should redirect to the <%= file_name %>" do
+        do_put
+        response.should redirect_to(<%= table_name.singularize %>_url("1"))
+      end
+
+    end
+    
+    describe "with failed update" do
+
+      def do_put
+        @<%= file_name %>.should_receive(:update_attributes).and_return(false)
+        put :update, :id => "1"
+      end
+
+      it "should re-render 'edit'" do
+        do_put
+        response.should render_template('edit')
+      end
+
+    end
+  end
+
+  describe "handling DELETE /<%= table_name %>/1" do
+
+    before(:each) do
+      @<%= file_name %> = mock_model(<%= controller_class_name.singularize %>, :destroy => true)
+      <%= controller_class_name.singularize %>.stub!(:find).and_return(@<%= file_name %>)
+    end
+  
+    def do_delete
+      delete :destroy, :id => "1"
+    end
+
+    it "should find the <%= file_name %> requested" do
+      <%= controller_class_name.singularize %>.should_receive(:find).with("1").and_return(@<%= file_name %>)
+      do_delete
+    end
+  
+    it "should call destroy on the found <%= file_name %>" do
+      @<%= file_name %>.should_receive(:destroy).and_return(true) 
+      do_delete
+    end
+  
+    it "should redirect to the <%= table_name %> list" do
+      do_delete
+      response.should redirect_to(<%= table_name %>_url)
+    end
+  end
+end