ajax_scaffold_generator 2.0.0 → 2.1.0

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2006 Richard White
-
-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.
+Copyright (c) 2006 Richard White
+
+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

@@ -1,28 +1,28 @@
-Description:
-    The ajax scaffold generator creates a controller to interact with a model.
-    If the model does not exist, it creates the model as well. Unlike the
-    standard scaffold, the ajax scaffold generator uses AJAX.
-
-    The generator takes a model name, an optional controller name, and a
-    list of views as arguments.  Scaffolded actions and views are created
-    automatically.  Any views left over generate empty stubs.
-
-    If a controller name is not given, the plural form of the model name
-    will be used.  The model and controller names may be given in CamelCase
-    or under_score and should not be suffixed with 'Model' or 'Controller'.
-    Both model and controller names may be prefixed with a module like a
-    file path; see the Modules Example for usage.
-
-Example:
-    ./script/generate ajax_scaffold Account Bank debit credit
-
-    This will generate an Account model and BankController with a full test
-    suite and a basic user interface.  Now create the accounts table in your
-    database and browse to http://localhost/bank/ -- voila, you're on Rails!
-
-Modules Example:
-    ./script/generate ajax_scaffold CreditCard 'admin/credit_card' suspend late_fee
-
-    This will generate a CreditCard model and CreditCardController controller
-    in the admin module.
-
+Description:
+    The ajax scaffold generator creates a controller to interact with a model.
+    If the model does not exist, it creates the model as well. Unlike the
+    standard scaffold, the ajax scaffold generator uses AJAX.
+
+    The generator takes a model name, an optional controller name, and a
+    list of views as arguments.  Scaffolded actions and views are created
+    automatically.  Any views left over generate empty stubs.
+
+    If a controller name is not given, the plural form of the model name
+    will be used.  The model and controller names may be given in CamelCase
+    or under_score and should not be suffixed with 'Model' or 'Controller'.
+    Both model and controller names may be prefixed with a module like a
+    file path; see the Modules Example for usage.
+
+Example:
+    ./script/generate ajax_scaffold Account Bank debit credit
+
+    This will generate an Account model and BankController with a full test
+    suite and a basic user interface.  Now create the accounts table in your
+    database and browse to http://localhost/bank/ -- voila, you're on Rails!
+
+Modules Example:
+    ./script/generate ajax_scaffold CreditCard 'admin/credit_card' suspend late_fee
+
+    This will generate a CreditCard model and CreditCardController controller
+    in the admin module.
+

data/ajax_scaffold_generator.rb

@@ -1,123 +1,123 @@
-require "rails_generator/generators/components/scaffold/scaffold_generator"
-
-class AjaxScaffoldingSandbox < ScaffoldingSandbox
-  def default_input_block
-    Proc.new { |record, column| "<div class=\"form-element\">\n  <label for=\"#{record}_#{column.name}\">#{column.human_name}</label>\n  #{input(record, column.name)}\n</div>\n" }
-  end
-end
-
-class AjaxScaffoldGenerator < ScaffoldGenerator
-
-  def manifest
-    record do |m|
-      # Check for class naming collisions.
-      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
-
-      # Controller, helper, views, and test directories.
-      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)
-      m.directory File.join('public/images')
-      m.directory File.join('test/functional', controller_class_path)
-
-      # Depend on model generator but skip if the model exists.
-      m.dependency 'model', [singular_name], :collision => :skip
-
-      # Scaffolded forms.
-      m.complex_template 'form.rhtml',
-        File.join('app/views',
-                  controller_class_path,
-                  controller_file_name,
-                  '_form.rhtml'),
-        :insert => 'form_scaffolding.rhtml',
-        :sandbox => lambda { create_sandbox },
-        :begin_mark => 'form',
-        :end_mark => 'eoform',
-        :mark_id => singular_name
-
-      # Scaffolded partials.
-      m.template "partial_item.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "_#{controller_file_name}.rhtml")
-
-      m.template "partial_form_errors.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "_form_errors.rhtml")
-
-      # Scaffolded views.
-      scaffold_views.each do |action|
-        m.template "view_#{action}.rhtml",
-                    File.join('app/views',
-                              controller_class_path,
-                              controller_file_name,
-                              "#{action}.rhtml"),
-                    :assigns => { :action => action }
-      end
-
-      # Controller class, functional test, helper, and views.
-      m.template 'controller.rb',
-                  File.join('app/controllers',
-                            controller_class_path,
-                            "#{controller_file_name}_controller.rb")
-
-      m.template 'functional_test.rb',
-                  File.join('test/functional',
-                            controller_class_path,
-                            "#{controller_file_name}_controller_test.rb")
-
-      m.template 'helper.rb',
-                  File.join('app/helpers',
-                            controller_class_path,
-                            "#{controller_file_name}_helper.rb")
-
-      # Layout and stylesheet.
-      m.template 'layout.rhtml',        "app/views/layouts/#{controller_file_name}.rhtml"
-      m.template 'style.css',           'public/stylesheets/ajax_scaffold.css'
-      m.template 'script.js',           'public/javascripts/ajax_scaffold.js'
-      m.template 'rico_corner.js',      'public/javascripts/rico_corner.js'
-      m.template 'indicator.gif',       'public/images/indicator.gif'
-      m.template 'add.gif',             'public/images/add.gif'
-      m.template 'error.gif',           'public/images/error.gif'
-
-      # Unscaffolded views.
-      unscaffolded_actions.each do |action|
-        path = File.join('app/views',
-                          controller_class_path,
-                          controller_file_name,
-                          "#{action}.rhtml")
-
-        m.template 'controller:view.rhtml', path,
-                    :assigns => { :action => action, :path => path }
-      end
-    end
-  end
-
-  protected
-    # Override with your own usage banner.
-    def banner
-      "Usage: #{$0} ajax_scaffold ModelName [ControllerName] [action, ...]"
-    end
-
-    def scaffold_views
-      %w( list edit new index )
-    end
-    
-    def create_sandbox
-      sandbox = AjaxScaffoldingSandbox.new
-      sandbox.singular_name = singular_name
-      begin
-        sandbox.model_instance = model_instance
-        sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
-      rescue ActiveRecord::StatementInvalid => e
-        logger.error "Before updating scaffolding from new DB schema, try creating a table for your model (#{class_name})"
-        raise SystemExit
-      end
-      sandbox.suffix = suffix
-      sandbox
-    end
-
-end
+require "rails_generator/generators/components/scaffold/scaffold_generator"
+
+class AjaxScaffoldingSandbox < ScaffoldingSandbox
+  def default_input_block
+    Proc.new { |record, column| "<div class=\"form-element\">\n  <label for=\"#{record}_#{column.name}\">#{column.human_name}</label>\n  #{input(record, column.name)}\n</div>\n" }
+  end
+end
+
+class AjaxScaffoldGenerator < ScaffoldGenerator
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions controller_class_path, "#{controller_class_name}Controller", "#{controller_class_name}ControllerTest", "#{controller_class_name}Helper"
+
+      # Controller, helper, views, and test directories.
+      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)
+      m.directory File.join('public/images')
+      m.directory File.join('test/functional', controller_class_path)
+
+      # Depend on model generator but skip if the model exists.
+      m.dependency 'model', [singular_name], :collision => :skip
+
+      # Scaffolded forms.
+      m.complex_template 'form.rhtml',
+        File.join('app/views',
+                  controller_class_path,
+                  controller_file_name,
+                  '_form.rhtml'),
+        :insert => 'form_scaffolding.rhtml',
+        :sandbox => lambda { create_sandbox },
+        :begin_mark => 'form',
+        :end_mark => 'eoform',
+        :mark_id => singular_name
+
+      # Scaffolded partials.
+      m.template "partial_item.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "_#{singular_name}.rhtml")
+
+      m.template "partial_form_errors.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "_form_errors.rhtml")
+
+      # Scaffolded views.
+      scaffold_views.each do |action|
+        m.template "view_#{action}.rhtml",
+                    File.join('app/views',
+                              controller_class_path,
+                              controller_file_name,
+                              "#{action}.rhtml"),
+                    :assigns => { :action => action }
+      end
+
+      # Controller class, functional test, helper, and views.
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            controller_class_path,
+                            "#{controller_file_name}_controller.rb")
+
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            controller_class_path,
+                            "#{controller_file_name}_controller_test.rb")
+
+      m.template 'helper.rb',
+                  File.join('app/helpers',
+                            controller_class_path,
+                            "#{controller_file_name}_helper.rb")
+
+      # Layout and stylesheet.
+      m.template 'layout.rhtml',        "app/views/layouts/#{controller_file_name}.rhtml"
+      m.template 'style.css',           'public/stylesheets/ajax_scaffold.css'
+      m.template 'script.js',           'public/javascripts/ajax_scaffold.js'
+      m.template 'rico_corner.js',      'public/javascripts/rico_corner.js'
+      m.template 'indicator.gif',       'public/images/indicator.gif'
+      m.template 'add.gif',             'public/images/add.gif'
+      m.template 'error.gif',           'public/images/error.gif'
+
+      # Unscaffolded views.
+      unscaffolded_actions.each do |action|
+        path = File.join('app/views',
+                          controller_class_path,
+                          controller_file_name,
+                          "#{action}.rhtml")
+
+        m.template 'controller:view.rhtml', path,
+                    :assigns => { :action => action, :path => path }
+      end
+    end
+  end
+
+  protected
+    # Override with your own usage banner.
+    def banner
+      "Usage: #{$0} ajax_scaffold ModelName [ControllerName] [action, ...]"
+    end
+
+    def scaffold_views
+      %w( list edit new index )
+    end
+    
+    def create_sandbox
+      sandbox = AjaxScaffoldingSandbox.new
+      sandbox.singular_name = singular_name
+      begin
+        sandbox.model_instance = model_instance
+        sandbox.instance_variable_set("@#{singular_name}", sandbox.model_instance)
+      rescue ActiveRecord::StatementInvalid => e
+        logger.error "Before updating scaffolding from new DB schema, try creating a table for your model (#{class_name})"
+        raise SystemExit
+      end
+      sandbox.suffix = suffix
+      sandbox
+    end
+
+end

data/templates/controller.rb

@@ -1,61 +1,61 @@
-class <%= controller_class_name %>Controller < ApplicationController
-
-<% unless suffix -%>
-  def index
-
-  end
-<% end -%>
-
-<% for action in unscaffolded_actions -%>
-  def <%= action %><%= suffix %>
-  end
-<% end -%>
-
-  def list<%= suffix %>
-    @<%= plural_name %> = <%= model_name %>.find :all
-    render :layout => false
-  end
-
-  def new<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.new
-    
-    @temp_id = Time.new.to_i
-    @headers['<%= singular_name %>-id'] = @temp_id
-    @headers['Content-Type'] = 'text/html; charset=utf-8'
-    
-    render :layout => false
-    
-    # If you want to send an error message:
-    # render :inline => "Error text goes here", :layout => false, :status => 500
-  end
-
-  def create<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
-    if @<%= singular_name %>.save
-      @headers['<%= singular_name %>-id'] = @<%= singular_name %>.id
-      @headers['Content-Type'] = 'text/html; charset=utf-8'
-      render :partial => '<%= singular_name %><%= suffix %>', :layout => false
-    else
-      render :partial => 'form_errors', :layout => false, :status => 500
-    end
-  end
-
-  def edit<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.find(params[:id])
-    render :layout => false
-  end
-
-  def update
-    @<%= singular_name %> = <%= model_name %>.find(params[:id])
-    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
-      render :partial => '<%= singular_name %><%= suffix %>', :layout => false
-    else
-      render :partial => 'form_errors', :layout => false, :status => 500
-    end
-  end
-
-  def destroy<%= suffix %>
-    <%= model_name %>.find(params[:id]).destroy
-    render :nothing => true
-  end
-end
+class <%= controller_class_name %>Controller < ApplicationController
+
+<% unless suffix -%>
+  def index
+
+  end
+<% end -%>
+
+<% for action in unscaffolded_actions -%>
+  def <%= action %><%= suffix %>
+  end
+<% end -%>
+
+  def list<%= suffix %>
+    @<%= plural_name %> = <%= model_name %>.find :all
+    render :layout => false
+  end
+
+  def new<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new
+    
+    @temp_id = Time.new.to_i
+    @headers['<%= singular_name %>-id'] = @temp_id
+    @headers['Content-Type'] = 'text/html; charset=utf-8'
+    
+    render :layout => false
+    
+    # If you want to send an error message:
+    # render :inline => "Error text goes here", :layout => false, :status => 500
+  end
+
+  def create<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+      @headers['<%= singular_name %>-id'] = @<%= singular_name %>.id
+      @headers['Content-Type'] = 'text/html; charset=utf-8'
+      render :partial => '<%= singular_name %><%= suffix %>', :layout => false, :locals => { :hidden => true }
+    else
+      render :partial => 'form_errors', :layout => false, :status => 500
+    end
+  end
+
+  def edit<%= suffix %>
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+    render :layout => false
+  end
+
+  def update
+    @<%= singular_name %> = <%= model_name %>.find(params[:id])
+    if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+      render :partial => '<%= singular_name %><%= suffix %>', :layout => false, :locals => { :hidden => true }
+    else
+      render :partial => 'form_errors', :layout => false, :status => 500
+    end
+  end
+
+  def destroy<%= suffix %>
+    <%= model_name %>.find(params[:id]).destroy
+    render :nothing => true
+  end
+end

data/templates/form.rhtml

@@ -1,5 +1,5 @@
-<fieldset>
-	<div class="row">
-		<%= template_for_inclusion %>
-	</div>
+<fieldset>
+	<div class="row">
+		<%= template_for_inclusion %>
+	</div>
 </fieldset>

data/templates/functional_test.rb

@@ -1,88 +1,88 @@
-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
-
-<% for action in unscaffolded_actions -%>
-  def test_<%= action %>
-    get :<%= action %>
-    assert_response :success
-    assert_template '<%= action %>'
-  end
-
-<% end -%>
-<% unless suffix -%>
-  def test_index
-    get :index
-    assert_response :success
-    assert_template 'list'
-  end
-
-<% end -%>
-  def test_list<%= suffix %>
-    get :list<%= suffix %>
-
-    assert_response :success
-    assert_template 'list<%= suffix %>'
-
-    assert_not_nil assigns(:<%= plural_name %>)
-  end
-
-  def test_new<%= suffix %>
-    get :new<%= suffix %>
-
-    assert_response :success
-    assert_template 'new<%= suffix %>'
-
-    assert_not_nil assigns(:<%= singular_name %>)
-  end
-
-  def test_create
-    num_<%= plural_name %> = <%= model_name %>.count
-
-    post :create<%= suffix %>, :<%= singular_name %> => {}
-
-    assert_response :redirect
-    assert_redirected_to :action => 'list<%= suffix %>'
-
-    assert_equal num_<%= plural_name %> + 1, <%= model_name %>.count
-  end
-
-  def test_edit<%= suffix %>
-    get :edit<%= suffix %>, :id => 1
-
-    assert_response :success
-    assert_template 'edit<%= suffix %>'
-
-    assert_not_nil assigns(:<%= singular_name %>)
-    assert assigns(:<%= singular_name %>).valid?
-  end
-
-  def test_update<%= suffix %>
-    post :update<%= suffix %>, :id => 1
-    assert_response :redirect
-    assert_redirected_to :action => 'show<%= suffix %>', :id => 1
-  end
-
-  def test_destroy<%= suffix %>
-    assert_not_nil <%= model_name %>.find(1)
-
-    post :destroy, :id => 1
-    assert_response :redirect
-    assert_redirected_to :action => 'list<%= suffix %>'
-
-    assert_raise(ActiveRecord::RecordNotFound) {
-      <%= model_name %>.find(1)
-    }
-  end
-end
+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
+
+<% for action in unscaffolded_actions -%>
+  def test_<%= action %>
+    get :<%= action %>
+    assert_response :success
+    assert_template '<%= action %>'
+  end
+
+<% end -%>
+<% unless suffix -%>
+  def test_index
+    get :index
+    assert_response :success
+    assert_template 'list'
+  end
+
+<% end -%>
+  def test_list<%= suffix %>
+    get :list<%= suffix %>
+
+    assert_response :success
+    assert_template 'list<%= suffix %>'
+
+    assert_not_nil assigns(:<%= plural_name %>)
+  end
+
+  def test_new<%= suffix %>
+    get :new<%= suffix %>
+
+    assert_response :success
+    assert_template 'new<%= suffix %>'
+
+    assert_not_nil assigns(:<%= singular_name %>)
+  end
+
+  def test_create
+    num_<%= plural_name %> = <%= model_name %>.count
+
+    post :create<%= suffix %>, :<%= singular_name %> => {}
+
+    assert_response :redirect
+    assert_redirected_to :action => 'list<%= suffix %>'
+
+    assert_equal num_<%= plural_name %> + 1, <%= model_name %>.count
+  end
+
+  def test_edit<%= suffix %>
+    get :edit<%= suffix %>, :id => 1
+
+    assert_response :success
+    assert_template 'edit<%= suffix %>'
+
+    assert_not_nil assigns(:<%= singular_name %>)
+    assert assigns(:<%= singular_name %>).valid?
+  end
+
+  def test_update<%= suffix %>
+    post :update<%= suffix %>, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => 'show<%= suffix %>', :id => 1
+  end
+
+  def test_destroy<%= suffix %>
+    assert_not_nil <%= model_name %>.find(1)
+
+    post :destroy, :id => 1
+    assert_response :redirect
+    assert_redirected_to :action => 'list<%= suffix %>'
+
+    assert_raise(ActiveRecord::RecordNotFound) {
+      <%= model_name %>.find(1)
+    }
+  end
+end