ajax_scaffold_plugin 3.2.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+3.2.0 ==========
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +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.

data/README

@@ -0,0 +1,13 @@
+********************************************************************************
+** For all documentation see the project website: http://www.ajaxscaffold.com **
+********************************************************************************
+
+Ajax Scaffold plugin by Scott Rutherford (scott@caronsoftware.com) & Richard White (rrwhite@gmail.com)
+
+Uses DhtmlHistory by Brad Neuberg (bkn3@columbia.edu)
+http://codinginparadise.org
+
+Uses Querystringby by Adam Vandenberg
+http://adamv.com/dev/javascript/querystring
+
+Released under the MIT license (included)

data/app/views/ajax_scaffold/_column_headings.rhtml

@@ -0,0 +1,20 @@
+<% for scaffold_column in @scaffold_columns %>
+  <% column_sort_direction = column_sort_direction(scaffold_column.name, params) %>  
+  <% sort_params = params.merge(:controller => @scaffold_controller, :action => 'update_'+@prefix+'table', 
+                                :sort => scaffold_column.name, :sort_direction => column_sort_direction, :page => 1) %>
+  <% column_header_id = scaffold_column_header_id(sort_params.merge(:column_name => scaffold_column.name)) %>
+  <th id="<%= column_header_id %>" <%= "class=\"sorted #{current_sort_direction(params)}\"" if scaffold_column.name == current_sort(params) %>>
+  <% if scaffold_column.sortable? %>
+    <% href = url_for(sort_params) %> 
+    <%= link_to_remote scaffold_column.label, 
+      { :url => sort_params,
+	    :before => "addAjaxTableUrlToHistory('#{href}')",
+        :loading => "Element.addClassName('#{column_header_id}','loading');",
+        :update => scaffold_content_id(sort_params) },
+      { :href => href } %>
+   <% else %>
+     <p><%= scaffold_column.label %></p>
+   <% end %>
+ </th>
+<% end %>
+<th></th>

data/app/views/ajax_scaffold/_column_totals.rhtml

@@ -0,0 +1,10 @@
+<tr class="ajax-scaffold-totals">
+	<% for scaffold_column in @scaffold_columns %>
+  		<td>
+     		<% if show_totals_for_column?(scaffold_column.name) %><p><%= scaffold_column.total %></p><% else %>&nbsp;<% end %>
+  		</td>
+	<% end %>
+  	<% unless @no_edit && @no_delete %>
+		<td class="actions">&nbsp;</td>
+	<% end %>
+</tr>

data/app/views/ajax_scaffold/_form.rhtml

@@ -0,0 +1,5 @@
+<fieldset>
+	<div class="row">
+		 <%= all_input_tags(scaffold_class, scaffold_name, { :exclude => %w(created_on created_at updated_on updated_at) }) %>
+	</div>
+</fieldset>

data/app/views/ajax_scaffold/_form_messages.rhtml

@@ -0,0 +1,5 @@
+<%= render :partial => scaffold_partial_path('messages') %>
+
+<% unless eval("@"+params[:scaffold_id]+".nil?") %>
+    <%= error_messages_for "#{params[:scaffold_id]}" %>
+<% end %>

data/app/views/ajax_scaffold/_messages.rhtml

@@ -0,0 +1,10 @@
+<% for name in [:info, :warning, :error] %>
+  <% if @flash[name] %>
+    <p class="<%= "#{name}-message message" %>" >
+      <%= @flash[name] %> 
+      <% if request.xhr? %>
+        <a href="#" onclick="Element.remove(this.parentNode); return false;">Close</a>
+      <% end %>
+    </p>
+  <% end %>
+<% end %>

data/app/views/ajax_scaffold/_new_edit.rhtml

@@ -0,0 +1,40 @@
+<% if not request.xhr? %>
+<table class="ajax-scaffold" cellpadding="0" cellspacing="0">
+  <tbody>
+<% end %>
+<tr id="<%= element_row_id(@options) %>" <%= "style=\"display:none;\"" if request.xhr? %>>
+  <td id="<%= element_cell_id(@options) %>" class="<%= @options[:action] %>" colspan="<%= num_columns %>">
+
+    <%= form_remote_tag :url => @options.merge(:controller => @scaffold_controller),
+    			:loading => "Element.show('#{loading_indicator_id(@options)}'); Form.disable('#{element_form_id(@options)}');",
+    			:html => { :href => url_for(@options.merge(:controller => @scaffold_controller)),
+                           :id => element_form_id(@options) } %>
+
+      <%= hidden_field_tag "scaffold_id", @options[:scaffold_id] %>
+
+      <h4><%= Inflector.titleize(@options[:action]) %> <%= @scaffold_singular_name.titleize if @suffix.empty? %></h4>
+
+      <% if request.xhr? %>
+        <div id="<%= element_messages_id(@options) %>" class="messages-container"></div>
+      <% else %>
+        <%= render :partial => scaffold_partial_path('form_messages') %>
+      <% end %>
+
+      <%= render :partial => scaffold_partial_path('form'), :locals => { :scaffold_class => @scaffold_class, :scaffold_name => @scaffold_singular_name } %>
+
+      <p class="form-footer">
+      	<%= submit_tag Inflector.titleize(@options[:action]), :class => "submit" %>
+      	<% cancel_params = @options.merge(:controller => @scaffold_controller, :action => 'cancel'+@suffix, :referring_action => @options[:action]) %>
+      	<%= link_to_remote "Cancel",
+      	  { :url => cancel_params,
+      	    :loading => "Element.show('#{loading_indicator_id(@options)}');" },
+	      { :href => url_for(cancel_params) } %>
+      	<%= loading_indicator_tag @options %>
+    	</p>
+    <%= end_form_tag %>
+  </td>
+</tr>
+<% if not request.xhr? %>
+  </tbody>
+</table>
+<% end %>

data/app/views/ajax_scaffold/_pagination_links.rhtml

@@ -0,0 +1,26 @@
+<% pagination_params = params.merge(:controller => @scaffold_controller, :action => 'update_'+@prefix+'table') %>
+<% indicator_params = pagination_params.merge(:action => 'pagination') %>
+<% previous_url = url_for(pagination_params.merge(:page => paginator.current.previous)) %>
+<% next_url = url_for(pagination_params.merge(:page => paginator.current.next)) %>
+<% current_url = url_for(pagination_params.merge(:page => paginator.current)) %>
+
+<script>
+  addAjaxTableUrlToHistory('<%= current_url %>')
+</script>
+
+<%= loading_indicator_tag indicator_params %>
+<%= link_to_remote('Previous', 
+        { :url => pagination_params.merge(:page => paginator.current.previous),
+	      :before => "addAjaxTableUrlToHistory('#{previous_url}')",
+	      :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
+          :update => scaffold_content_id(pagination_params) },
+        { :href => previous_url,
+          :class => "previous"}) if @paginator.current.previous %>
+<%= pagination_ajax_links @paginator, pagination_params %>
+<%= link_to_remote('Next', 
+        { :url => pagination_params.merge(:page => paginator.current.next),
+	      :before => "addAjaxTableUrlToHistory('#{next_url}')",
+          :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
+          :update => scaffold_content_id(pagination_params) },
+        { :href => next_url,
+          :class => "next"}) if @paginator.current.next %>

data/app/views/ajax_scaffold/_row.rhtml

@@ -0,0 +1,46 @@
+<% # The following is used when the browser doesn't have javascript enabled %>
+<% eval("#{Inflector.underscore(@scaffold_class)} = row") %>
+<% classAttr = cycle("", "class=\"even\"") %>
+<% @options = params.merge(:controller => @scaffold_controller, :action => "view", :id => row.send("#{@scaffold_class.primary_key}")) %>
+
+<tr <%= classAttr %> id="<%= element_row_id(@options) %>" <%= "style=\"display: none;\"" if hidden %>>
+	<% for scaffold_column in @scaffold_columns %>
+	  <% column_value = eval(scaffold_column.eval) rescue nil %>
+	  <% if show_totals_for_column?(scaffold_column.name) %>
+	  	<% scaffold_column.add_to_total(column_value) %>
+	  <% end %>
+	  <td class="<%= column_class(scaffold_column.name, column_value, current_sort(params), scaffold_column.class_name) %>" >
+	    <%= format_column(column_value, scaffold_column.sanitize?) %>
+	  </td>
+	<% end %>
+  <% unless @no_edit && @no_delete %>
+  <td class="actions">
+    <table cellpadding="0" cellspacing="0">
+      <tr>
+        <td class="indicator-container">
+          <%= loading_indicator_tag(@options) %>
+        </td>
+        <% unless @no_edit %>
+          <td>
+            <% edit_options = @options.merge(:action => 'edit'+@suffix) %>
+ 	          <%= link_to_remote "Edit",
+   	                      { :url => edit_options,
+                            :loading => "Element.show('#{loading_indicator_id(@options)}');" },
+   	                      { :href => url_for(edit_options) } %>
+   	      </td>
+        <% end %>
+        <% unless @no_delete %>
+   	      <td>
+   	         <% delete_options = @options.merge(:action => 'destroy'+@suffix) %>
+ 	           <%= link_to_remote "Delete",
+   	                      { :url => delete_options,
+   	                        :confirm => 'Are you sure?',
+                            :loading => "Element.show('#{loading_indicator_id(@options)}');" },
+   	                      { :href => url_for( delete_options ) } %>
+   	      </td>
+        <% end %>
+   	    </tr>
+   	  </table>
+  </td>
+  <% end %>
+</tr>

data/app/views/ajax_scaffold/cancel.rjs

@@ -0,0 +1,12 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => params[:referring_action], :id => params[:id] }
+
+if @successful
+  page.remove element_row_id(@options)
+  if @options[:action] == "update"+@suffix
+    page.show element_row_id(@options.merge(:action => "view"))
+  elsif @options[:action] == "create"+@suffix
+    page << "AjaxScaffold.displayMessageIfEmpty('#{scaffold_tbody_id(@options)}','#{empty_message_id(@options)}');"
+  end
+else
+  page.hide loading_indicator_id(@options)
+end

data/app/views/ajax_scaffold/create.rjs

@@ -0,0 +1,20 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => "view" }
+@create_options = @options.merge(:action => "create"+@suffix, :id => params[:id])
+
+if @successful
+  @options[:id] = eval("@"+params[:scaffold_id]+".id")
+  page.insert_html :bottom, scaffold_tbody_id(@options), :partial => scaffold_partial_path('row'), 
+                   :object => eval("@"+params[:scaffold_id]), :locals => { :hidden => true }
+  page << "new TableRow.MoveAfter('#{element_row_id(@create_options)}', '#{element_row_id(@options)}');"
+  page.remove element_row_id(@create_options)
+  page.show element_row_id(@options)
+  page << "AjaxScaffold.stripe('#{scaffold_tbody_id(@options)}');" 
+  page << "AjaxScaffold.removeSortClasses('#{@options[:scaffold_id]}');"
+  page.replace_html scaffold_messages_id(@options), :partial => scaffold_partial_path('messages')
+else
+  page.replace_html element_messages_id(@create_options), :partial => scaffold_partial_path('form_messages')
+  page << "Form.enable('#{element_form_id(@create_options)}');"
+  page.hide loading_indicator_id(@create_options)
+end
+
+

data/app/views/ajax_scaffold/destroy.rjs

@@ -0,0 +1,11 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => "view", :id => params[:id] }
+
+if @successful
+  page.remove element_row_id(@options)
+  page << "AjaxScaffold.displayMessageIfEmpty('#{scaffold_tbody_id(@options)}','#{empty_message_id(@options)}');"   
+  page << "AjaxScaffold.stripe('#{scaffold_tbody_id(@options)}');" 
+else
+  page.hide loading_indicator_id(@options)
+end
+
+page.replace_html scaffold_messages_id(@options), :partial => scaffold_partial_path('messages')

data/app/views/ajax_scaffold/edit.rjs

@@ -0,0 +1,16 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => "update"+@suffix, :id => params[:id] }
+@view_options = @options.merge(:action => "view")
+
+if @successful
+  page.hide element_row_id(@view_options)
+  page.insert_html :bottom, scaffold_tbody_id(@options), :partial => scaffold_partial_path('new_edit')
+  page << "new TableRow.MoveAfter('#{element_row_id(@view_options)}', '#{element_row_id(@options)}');"  
+  page.show element_row_id(@options)
+  page << "Form.focusFirstElement('#{element_form_id(@options)}');"
+  page.visual_effect :highlight, element_cell_id(@options)
+  page.replace_html element_messages_id(@options), :partial => scaffold_partial_path('form_messages')
+else
+  page.replace_html scaffold_messages_id(@options), :partial => scaffold_partial_path('messages')
+end
+
+page.hide loading_indicator_id(@view_options)

data/app/views/ajax_scaffold/list.rhtml

@@ -0,0 +1 @@
+<%= render_component :controller => @scaffold_controller, :action => @prefix+'table', :params => params %>

data/app/views/ajax_scaffold/new.rjs

@@ -0,0 +1,14 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => "create"+@suffix, :id => generate_temporary_id }
+@new_options = @options.merge(:action => "new"+@suffix, :id => nil)
+
+if @successful
+  page.insert_html :top, scaffold_tbody_id(@options), :partial => scaffold_partial_path('new_edit')
+  page.show element_row_id(@options)
+  page << "Form.focusFirstElement('#{element_form_id(@options)}');"
+  page.visual_effect :highlight, element_cell_id(@options)
+  page.replace_html element_messages_id(@options), :partial => scaffold_partial_path('form_messages')
+else
+  page.replace_html scaffold_messages_id(@options), :partial => scaffold_partial_path('messages')
+end
+
+page.hide loading_indicator_id(@new_options), empty_message_id(@options)

data/app/views/ajax_scaffold/table.rhtml

@@ -0,0 +1,63 @@
+<% unless @width.empty? %>
+<style>
+.ajax-scaffold-<%= params[:scaffold_id] %> {
+width: <%= @width %>;
+}
+</style>
+<% end %>
+
+<% if @show_wrapper %>
+<div id="<%= params[:scaffold_id] %>" class="ajax-scaffold ajax-scaffold-<%= params[:scaffold_id] %>">
+  <div id="<%= scaffold_content_id(params) %>">
+<% end %>
+    <div class="ajax-scaffold-header">
+	  <% unless @no_create %>
+        <div class="actions">
+          <% new_params = params.merge(:controller => @scaffold_controller, :action => "new"+@suffix) %>
+          <%= loading_indicator_tag(new_params) %>
+          <%= link_to_remote "Create New",
+            { :url => new_params,
+              :loading => "Element.show('#{loading_indicator_id(new_params)}');" },
+            { :href => url_for(new_params), :class => "create" } %>
+        </div>
+      <% end %>
+    <h2><%= @scaffold_plural_name.titleize %></h2>
+  </div>
+  <table cellpadding="0" cellspacing="0">
+  <thead>
+    <tr>
+      <%= render :partial => scaffold_partial_path('column_headings') %>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td colspan="<%= num_columns %>" class="messages-container">
+        <div id="<%= scaffold_messages_id(params) %>">
+          <%= render :partial => scaffold_partial_path('messages') %>
+        </div>
+        <p id="<%= empty_message_id(params) %>" class="empty-message" <%= " style=\"display:none;\" " if !@collection.empty? %>>
+          No Entries
+        </p>
+      </td>
+    </tr>
+  </tbody>
+  <tbody id="<%= scaffold_tbody_id(params) %>">
+    <% if !@collection.empty? %>
+  	  <%= render :partial => scaffold_partial_path('row'), :collection => @collection, :locals => { :hidden => false } %>
+	  <% if show_column_totals? %>
+  	  	<%= render :partial => scaffold_partial_path('column_totals') %>
+	  <% end %>
+    <% end %>
+  </tbody>
+</table>
+<div class="ajax-scaffold-footer">
+  <%= render :partial => scaffold_partial_path('pagination_links'), :locals => { :paginator => @paginator } %>
+</div>
+<% if @show_wrapper %>
+</div>
+</div>
+
+<script type="text/javascript">
+Rico.Corner.round('<%= params[:scaffold_id] %>', {color: '#005CB8', bgColor: '#fff', compact: true});
+</script>
+<% end %>

data/app/views/ajax_scaffold/update.rjs

@@ -0,0 +1,19 @@
+@options = { :scaffold_id => params[:scaffold_id], :action => "view", :id => params[:id] }
+@update_options = @options.merge(:action => "update"+@suffix)
+
+if @successful
+  page.remove element_row_id(@options)
+  page.insert_html :bottom, scaffold_tbody_id(@options), :partial => scaffold_partial_path('row'), 
+                   :object => eval("@"+params[:scaffold_id]), :locals => { :hidden => true }
+  page << "new TableRow.MoveAfter('#{element_row_id(@update_options)}', '#{element_row_id(@options)}');"                                
+  page.remove element_row_id(@update_options)
+  page.show element_row_id(@options)
+  page << "AjaxScaffold.stripe('#{scaffold_tbody_id(@options)}');" 
+  page << "AjaxScaffold.removeSortClasses('#{@options[:scaffold_id]}');"
+  page.replace_html scaffold_messages_id(@options), :partial => scaffold_partial_path('messages')
+else
+  page.replace_html element_messages_id(@update_options), :partial => scaffold_partial_path('form_messages')
+  page << "Form.enable('#{element_form_id(@update_options)}');"
+  page.hide loading_indicator_id(@update_options)
+end
+ 

data/init.rb

@@ -0,0 +1,27 @@
+# Include hook code here
+require 'ajax_scaffold_plugin'
+
+ActionController::Base.send(:include, AjaxScaffold)
+ActionView::Base.send(:include, AjaxScaffold::Helper)
+
+# copy all the files over to the main rails app, want to avoid .svn
+source = File.join(directory,'/app/views/ajax_scaffold')
+dest = File.join(RAILS_ROOT, '/app/views/ajax_scaffold')
+FileUtils.mkdir(dest) unless File.exist?(dest)
+FileUtils.cp_r(Dir.glob(source+'/*.*'), dest)
+
+source = File.join(directory,'/public')
+dest = RAILS_ROOT + '/public'
+FileUtils.cp_r(Dir.glob(source+'/*.*'), dest)
+
+source = File.join(directory,'/public/stylesheets')
+dest = RAILS_ROOT + '/public/stylesheets'
+FileUtils.cp_r(Dir.glob(source+'/*.*'), dest)
+
+source = File.join(directory,'/public/javascripts')
+dest = RAILS_ROOT + '/public/javascripts'
+FileUtils.cp_r(Dir.glob(source+'/*.*'), dest)
+
+source = File.join(directory,'/public/images')
+dest = RAILS_ROOT + '/public/images'
+FileUtils.cp_r(Dir.glob(source+'/*.*'), dest)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/ajax_scaffold_plugin.rb

@@ -0,0 +1,505 @@
+require 'base/ajax_scaffold'
+
+module AjaxScaffold # :nodoc:
+
+  class ScaffoldColumn
+    attr_reader :name, :eval, :sort_sql, :label, :class_name, :sort, :total
+
+    # Only options[:name] is required. It will infer the eval and sort values
+    # based on the given class.
+    def initialize(klass, options)
+      @name = options[:name]
+      @eval = options[:eval].nil? ? "#{Inflector.underscore(klass.to_s)}.#{@name}" : options[:eval]
+      @label = options[:label].nil? ? Inflector.titleize(@name) : options[:label]
+      @sortable = options[:sortable].nil? ? true : options[:sortable]
+      @sort_sql = options[:sort_sql].nil? ? "#{klass.table_name}.#{@name}" : options[:sort_sql] unless !@sortable
+      @class_name = options[:class_name].nil? ? "" : options[:class_name]
+      @sanitize = options[:sanitize].nil? ? true : options[:sanitize]
+
+      #Plugin Specific Below
+      @sort = options[:sort]
+      @total = 0
+    end
+
+    def add_to_total(value)
+      @total += value.to_f
+    end
+  end
+
+  module Common
+    def current_page(params)
+      session[params[:scaffold_id]][:page]
+    end
+  end
+
+  # extend the class that include this with the methods in ClassMethods
+  def self.included(base)
+    super
+    base.extend(ClassMethods)
+  end
+
+  # Start Helper module
+  module Helper
+    include AjaxScaffold::Common
+
+    # default html for an input tag
+    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, { :class => 'text-input' } )}\n</div>\n" }
+    end
+
+    # create input tags for each field in a model
+    def all_input_tags(record, record_name, options)
+      input_block = options[:input_block] || default_input_block
+
+      if !options[:exclude].blank?
+        filtered_content_columns = record.content_columns.reject { |column| options[:exclude].include?(column.name) }
+      else
+        filtered_content_columns = record.content_columns
+      end
+
+      filtered_content_columns.collect{ |column| input_block.call(record_name, column) }.join("\n")
+    end
+  end
+
+  module Controller
+
+    def sort_collection_by_method(collection, column, order)
+      # sort in place (sort!) using block
+      collection.sort!{|line1, line2| sort_lines_by_column(line1, line2, column, order)}
+    end
+
+    def sort_lines_by_column(line1, line2, column, sort_order)
+      # Compare each lines column values with <=>
+      value1 = eval_method_string(line1, column)
+      value2 = eval_method_string(line2, column)
+      if (value1.nil?)
+        res = -1
+      elsif (value2.nil?)
+        res = 1
+      else
+        res = (value1 != nil ? value1 : "") <=> (value2 != nil ? value2 : "")
+      end
+      # Reverse result if not asc
+      sort_order == 'asc' ? res : res * -1
+    end
+
+    def eval_method_string(object, method_str)
+      # need to eval each section of the method string as this could return nil
+      # at any point.
+      methods = method_str.split('.')
+      methods.each do |m|
+        object = eval("object.#{m}") rescue nil
+        return object if object.nil?
+      end
+      object
+    end
+
+  end
+
+  module Helper
+    include AjaxScaffold::Common
+
+    def show_totals_for_column?(column)
+      @scaffold_column_totals.include?(column)
+    end
+
+    def show_column_totals?
+      @scaffold_column_totals.size > 0
+    end
+
+    # return the base path to search for a partial
+    def scaffold_partial_path(partial)
+      @scaffold_plural_name+'/'+partial
+    end
+
+    # number of columns in a table
+    def num_columns
+      @scaffold_columns.length + 1
+    end
+
+  end
+
+  module ClassMethods
+
+    # Adds a swath of actions to the controller.
+    def ajax_scaffold(model_id, options = {})
+      options.assert_valid_keys(:class_name, :except, :rows_per_page, :suffix, :totals, :width, :rel_width)
+
+      # set up a few variables for use in the code generation
+      singular_name   = model_id.to_s
+      class_name      = options[:class_name] || singular_name.camelize
+      plural_name     = singular_name.pluralize
+      rows_per_page   = options[:rows_per_page] || 25
+      suffix          = options[:suffix] ? "_#{singular_name}" : ""
+      prefix          = options[:suffix] ? "#{plural_name}_" : ""
+      totals          = options[:totals].nil? ? nil : options[:totals].join(',').to_s
+      width           = options[:width].nil? ? (options[:rel_width].nil? ? nil : options[:rel_width]*100 ) : options[:width]
+
+      if (!width.nil?)
+         dimensions = options[:width].nil? ? "%" : "px"
+         width = width.to_s + dimensions
+      end
+
+      no_create, no_edit, no_delete = false, false, false
+      if (options[:except])
+        no_create     = options[:except].include?('create')
+        no_edit       = options[:except].include?('edit')
+        no_delete     = options[:except].include?('delete')
+      end
+
+      module_eval <<-"end_eval", __FILE__, __LINE__
+        include AjaxScaffold::Common
+        include AjaxScaffold::Controller
+
+        verify :method => :post, :only => [ :destroy#{suffix}, :create#{suffix}, :update#{suffix} ],
+               :redirect_to => { :action => :#{prefix}table }
+
+        after_filter :clear_flashes
+
+        @@#{prefix}scaffold_columns = nil
+        @@#{prefix}scaffold_total_columns = nil
+        @@#{prefix}scaffold_columns_hash = nil
+
+        def #{prefix}scaffold_total_columns
+          csv_array = "#{totals}".length >= 1 ? CSV.parse_line("#{totals}") : []
+          @@#{prefix}scaffold_total_columns ||= csv_array
+        end
+
+        def #{prefix}scaffold_columns
+          @@#{prefix}scaffold_columns ||= build_#{prefix}scaffold_columns
+        end
+
+        def #{prefix}scaffold_columns_hash
+          @@#{prefix}scaffold_columns_hash ||= build_#{prefix}scaffold_columns_hash
+        end
+
+        def #{prefix}table
+          self.#{prefix}table_setup
+
+          render#{suffix}_template(:action => 'table')
+        end
+
+        def #{prefix}table_setup
+          update_params :default_scaffold_id => "#{singular_name}", :default_sort => nil, :default_sort_direction => default_#{prefix}sort_direction
+
+          @show_wrapper = true if @show_wrapper.nil?
+          @width = "#{width}"
+          sort_sql = #{prefix}scaffold_columns_hash[current_sort(params)].sort_sql rescue default_#{prefix}sort
+          sort = #{prefix}scaffold_columns_hash[current_sort(params)].sort rescue nil
+          sort_direction = current_sort_direction(params)
+
+          klass = Inflector.camelize("#{singular_name}").constantize
+          order = sort.nil? ? sort_sql : sort
+          order += " " + sort_direction
+          options = { :order => order,
+                      :conditions => conditions_for_#{plural_name}_collection,
+                      :direction => current_sort_direction(params),
+                      :per_page => #{rows_per_page} }
+
+          count = count_#{plural_name}_collection(klass, options)
+          @paginator = Paginator.new(self, count, #{rows_per_page}, current_page(params))
+
+          if (sort.nil?)
+            @collection = page_and_sort_#{plural_name}_collection(klass, options, @paginator)
+          else
+            @collection = page_and_sort_#{plural_name}_collection_with_method(klass, options, @paginator)
+          end
+        end
+
+        # if multiple tables (suffix) then return to index (can be changed by overriding)
+        # if single table return to list
+        def #{prefix}return_to_main
+          action = "#{suffix}" == "" ? "#{prefix}list" : "index"
+          redirect_to :action => action
+        end
+
+        def update_#{prefix}table
+          @show_wrapper = false # don't show the outer wrapper elements if we are just updating an existing scaffold
+          if request.xhr?
+            #{prefix}table_setup
+            render#{suffix}_template(:action => 'table')
+          else
+            #{prefix}return_to_main
+          end
+        end
+
+        def #{prefix}list
+          render#{suffix}_template(:action => 'list.rhtml', :layout => true)
+        end
+      end_eval
+
+      if(suffix=="")
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def index
+            redirect_to(:action => :list)
+          end
+        end_eval
+      end
+
+      # now only create these methods if not excluded
+      unless (no_create)
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def new#{suffix}
+            @#{singular_name} = #{class_name}.new
+            @successful = true
+
+            return render#{suffix}_template(:action => 'new.rjs') if request.xhr?
+
+            # Javascript disabled fallback
+            if @successful
+              @options = { :action => "create" }
+              render#{suffix}_template(:action => "_new_edit.rhtml", :layout => true)
+            else
+              #{prefix}return_to_main
+            end
+          end
+
+          def create#{suffix}
+            begin
+              do_create#{suffix}
+            rescue
+              flash[:error], @successful  = $!.to_s, false
+            end
+
+            return render#{suffix}_template(:action => 'create.rjs') if request.xhr?
+
+            if @successful
+              #{prefix}return_to_main
+            else
+              @options = { :scaffold_id => params[:scaffold_id], :action => "create" }
+              render#{suffix}_template(:action => "_new_edit.rhtml", :layout => true)
+            end
+          end
+
+          def do_create#{suffix}
+              @#{singular_name} = #{class_name}.new(params[:#{singular_name}])
+              @successful = @#{singular_name}.save
+          end
+        end_eval
+      end
+
+      unless (no_edit)
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def edit#{suffix}
+            begin
+              @#{singular_name} = #{class_name}.find(params[:id])
+              @successful = !@#{singular_name}.nil?
+            rescue
+              flash[:error], @successful  = $!.to_s, false
+            end
+
+            return render#{suffix}_template(:action => 'edit.rjs') if request.xhr?
+
+            if @successful
+              @options = { :scaffold_id => params[:scaffold_id], :action => "update", :id => params[:id] }
+              render#{suffix}_template(:action => "_new_edit.rhtml", :layout => true)
+            else
+              #{prefix}return_to_main
+            end
+          end
+
+          def update#{suffix}
+            begin
+              do_update#{suffix}
+            rescue
+              flash[:error], @successful  = $!.to_s, false
+            end
+
+            return render#{suffix}_template(:action => 'update.rjs') if request.xhr?
+
+            if @successful
+              #{prefix}return_to_main
+            else
+              @options = { :action => "update" }
+              render#{suffix}_template(:action => "_new_edit.rhtml", :layout => true)
+            end
+          end
+
+          def do_update#{suffix}
+              @#{singular_name} = #{class_name}.find(params[:id])
+              @successful = @#{singular_name}.update_attributes(params[:#{singular_name}])
+          end
+        end_eval
+      end
+
+      unless (no_delete)
+        module_eval <<-"end_eval", __FILE__, __LINE__
+          def destroy#{suffix}
+            begin
+              @successful = #{class_name}.find(params[:id]).destroy
+            rescue
+              flash[:error], @successful  = $!.to_s, false
+            end
+
+            return render#{suffix}_template(:action => 'destroy.rjs') if request.xhr?
+
+            # Javascript disabled fallback
+            #{prefix}return_to_main
+          end
+        end_eval
+      end
+
+      module_eval <<-"end_eval", __FILE__, __LINE__
+        def cancel#{suffix}
+          @successful = true
+
+          return render#{suffix}_template(:action => 'cancel.rjs') if request.xhr?
+
+           # Javascript disabled fallback
+          #{prefix}return_to_main
+        end
+
+        protected
+          # Override this for custom selection conditions
+          def conditions_for_#{plural_name}_collection
+            nil
+          end
+
+          # Override to change the default sort from plural_name.id
+          def default_#{prefix}sort
+            "#{plural_name}.id"
+          end
+
+          # Override to change the default sort direction
+          def default_#{prefix}sort_direction
+            "asc"
+          end
+
+          # Returns the total number of items in the collection
+          def count_#{plural_name}_collection(model, options)
+            count_collection_for_pagination(model, options)
+          end
+
+          # Per model collection method, using sort_collection_by_method
+          def page_and_sort_#{plural_name}_collection_with_method(model, options, paginator)
+            # call: sort_collection_by_method(collection, column, order)
+            order_parts = options[:order].split(' ')
+            collection = model.find(:all, :conditions => options[:conditions],
+                                    :joins => options[:join] || options[:joins],
+                                    :include => options[:include],
+                                    :select => options[:select])
+
+            sort_collection_by_method(collection, order_parts[0], order_parts[1]).slice(paginator.current.offset,options[:per_page])
+          end
+
+          # Per model collection method delegates to Rails as default
+          def page_and_sort_#{plural_name}_collection(model, options, paginator)
+            find_collection_for_pagination(model, options, paginator)
+          end
+
+        private
+          def render#{suffix}_template( options = {} )
+            @scaffold_columns ||= #{prefix}scaffold_columns
+            @scaffold_column_totals = #{prefix}scaffold_total_columns
+            @scaffold_class = #{class_name}
+            @scaffold_singular_name, @scaffold_plural_name = "#{singular_name}", "#{plural_name}"
+            @scaffold_controller = "/" + self.class.to_s.sub(/Controller/, "").underscore
+            @no_create = #{no_create}
+            @no_edit   = #{no_edit}
+            @no_delete = #{no_delete}
+            @suffix    = "#{suffix}"
+            @prefix    = "#{prefix}"
+
+            # check for template in  following order:
+            # views/scaffold_class/template
+            # views/controller_class/template
+            # views/ajax_scaffold/template
+
+            action = options[:action]
+            layout = options[:layout] || false
+            if template_exists?("#{plural_name}/\#{action}")
+              render(:action => "../#{plural_name}/\#{action}", :layout => layout)
+
+            elsif template_exists?("\#{self.class.controller_path}/\#{action}")
+              render(:action => action, :layout => layout)
+
+            else
+              render(:template => "ajax_scaffold/\#{action}", :layout => layout)
+            end
+          end
+
+          def build_#{prefix}scaffold_columns
+            scaffold_columns = Array.new
+            #{class_name}.content_columns.each do |column|
+              scaffold_columns << ScaffoldColumn.new(#{class_name}, { :name => column.name })
+            end
+            scaffold_columns
+          end
+
+          def build_#{prefix}scaffold_columns_hash
+            scaffold_columns_hash = Hash.new
+            #{prefix}scaffold_columns.each do |scaffold_column|
+              scaffold_columns_hash[scaffold_column.name] = scaffold_column
+            end
+            scaffold_columns_hash
+          end
+
+      end_eval
+
+    # end ajax_scaffold method
+    end
+  # end ClassMethods
+  end
+
+end
+
+# override render here to ensure that the correct partial is picked up
+module ::ActionView #:nodoc:
+  class Base
+
+    # Renders the template present at <tt>template_path</tt> (relative to the template_root).
+    # The hash in <tt>local_assigns</tt> is made available as local variables.
+    def render(options = {}, old_local_assigns = {}, &block) #:nodoc:
+      if options.is_a?(String)
+        render_file(options, true, old_local_assigns)
+      elsif options == :update
+        update_page(&block)
+      elsif options.is_a?(Hash)
+        options[:locals] ||= {}
+        options[:use_full_path] = options[:use_full_path].nil? ? true : options[:use_full_path]
+
+        if options[:file]
+          render_file(options[:file], options[:use_full_path], options[:locals])
+        elsif options[:partial] && options[:collection]
+          partial = parse_partial_path(options[:partial])
+          render_partial_collection(partial, options[:collection], options[:spacer_template], options[:locals])
+        elsif options[:partial]
+          partial = parse_partial_path(options[:partial])
+          render_partial(partial, ActionView::Base::ObjectWrapper.new(options[:object]), options[:locals])
+        elsif options[:inline]
+          render_template(options[:type] || :rhtml, options[:inline], nil, options[:locals] || {})
+        end
+      end
+    end
+
+    def parse_partial_path(partial_path)
+      path, partial_name = partial_pieces(partial_path)
+
+      if partial_path.include?('/')
+        unless (erb_template_exists?("#{path}/_#{partial_name}"))
+          path, partial_name = partial_pieces(partial_name)
+          partial_path = "#{path}/#{partial_name}"
+        end
+      end
+
+      unless (erb_template_exists?("#{path}/_#{partial_name}"))
+        partial_path = "ajax_scaffold/#{partial_name}"
+      end
+
+      partial_path
+    end
+  end
+
+  module Helpers
+    module AssetTagHelper
+      # produces all the includes in one shot
+      def ajax_scaffold_includes
+        js = javascript_include_tag(:defaults, 'dhtml_history', 'rico_corner', 'ajax_scaffold')
+        css = stylesheet_link_tag('ajax_scaffold')
+        js + "\n" + css
+      end
+    end
+  end
+end