ajax_scaffold_generator 2.2.1 → 3.0.0

data/templates/ajax_scaffold.js

@@ -0,0 +1,126 @@
+/*  
+ AjaxScaffoldGenerator version 3.0.0
+ (c) 2006 Richard White <rrwhite@gmail.com>
+ 
+ AjaxScaffoldGenerator is freely distributable under the terms of an MIT-style license.
+ 
+ For details, see the AjaxScaffoldGenerator web site: http://www.ajaxscaffold.com/
+*/
+
+/*
+ * The following is a cross browser way to move around <tr> elements in a <table> or <tbody>
+ */
+ 
+var Abstract = new Object();
+Abstract.Table = function() {};
+Abstract.Table.prototype = {
+  tagTest: function(element, tagName) {
+    return $(element).tagName.toLowerCase() == tagName.toLowerCase();
+  }		
+};	
+
+Abstract.TableRow = function() {};
+Abstract.TableRow.prototype = Object.extend(new Abstract.Table(), {
+  initialize: function(targetTableRow, sourceTableRow) {
+    try {
+      var sourceTableRow = $(sourceTableRow);
+      var targetTableRow = $(targetTableRow);
+      
+      if (targetTableRow == null || !this.tagTest(targetTableRow,'tr') 
+      	|| sourceTableRow == null || !this.tagTest(sourceTableRow,'tr')) {
+        throw("TableRow: both parameters must be a <tr> tag.");
+      }
+      
+      var tableOrTbody = this.findParentTableOrTbody(targetTableRow);
+      
+      var newRow = tableOrTbody.insertRow(this.getNewRowIndex(targetTableRow) - this.getRowOffset(tableOrTbody));
+      newRow.parentNode.replaceChild(sourceTableRow, newRow);
+
+    } catch (e) {
+      alert(e);
+    }
+  },
+  getRowOffset: function(tableOrTbody) {
+    //If we are inserting into a tablebody we would need figure out the rowIndex of the first
+    // row in that tbody and subtract that offset from the new row index  
+    var rowOffset = 0;
+    if (this.tagTest(tableOrTbody,'tbody')) {
+      rowOffset = tableOrTbody.rows[0].rowIndex;
+    }
+    return rowOffset;
+  },
+  findParentTableOrTbody: function(element) {
+    var element = $(element);
+    // Completely arbitrary value
+    var maxSearchDepth = 3;
+    var currentSearchDepth = 1;
+    var current = element;
+    while (currentSearchDepth <= maxSearchDepth) {
+      current = current.parentNode;
+      if (this.tagTest(current, 'tbody') || this.tagTest(current, 'table')) {
+        return current;
+      }
+      currentSearchDepth++;
+    }
+  }		
+});
+
+var TableRow = new Object();
+
+TableRow.MoveBefore = Class.create();
+TableRow.MoveBefore.prototype = Object.extend(new Abstract.TableRow(), {
+  getNewRowIndex: function(target) {
+    return target.rowIndex;
+  }
+});
+
+TableRow.MoveAfter = Class.create();
+TableRow.MoveAfter.prototype = Object.extend(new Abstract.TableRow(), {
+  getNewRowIndex: function(target) {
+    return target.rowIndex+1;
+  }
+});
+
+/*
+ * The following are simple utility methods
+ */
+ 
+var AjaxScaffold = {  
+  stripe: function(tableBody) {
+    var even = false;
+    var tableBody = $(tableBody);
+    var tableRows = tableBody.getElementsByTagName("tr");
+    var length = tableBody.rows.length;
+      
+    for (var i = 0; i < length; i++) {
+      var tableRow = tableBody.rows[i];
+      //Make sure to skip rows that are create or edit rows or messages
+      if (!Element.hasClassName(tableRow, "create") 
+        && !Element.hasClassName(tableRow, "update")) {
+      	
+        if (even) {
+          Element.addClassName(tableRow, "even");
+        } else {
+          Element.removeClassName(tableRow, "even");
+        }
+        even = !even;
+      }
+    }
+  },
+  displayMessageIfEmpty: function(tableBody, emptyMessageElement) {
+    // Check to see if this was the last element in the list
+    if ($(tableBody).rows.length == 0) {
+      Element.show($(emptyMessageElement));
+    }
+  },
+  removeSortClasses: function(scaffoldId) {
+    $$('#' + scaffoldId + ' td.sorted').each(function(element) {
+      Element.removeClassName(element, "sorted");
+    });
+    $$('#' + scaffoldId + ' th.sorted').each(function(element) {
+      Element.removeClassName(element, "sorted");
+      Element.removeClassName(element, "asc");
+      Element.removeClassName(element, "desc");
+    });
+  }
+}

data/templates/ajax_scaffold_helper.rb

@@ -0,0 +1,95 @@
+module AjaxScaffoldHelper
+
+  def column_value(data_object, column)
+    column_value = data_object.send(column.name)
+    
+    if column_value.instance_of? Time
+        column_value = format_time(column_value)
+    elsif column_value.instance_of? Date
+        column_value = format_date(column_value)
+    end
+    
+    column_value
+  end
+
+  def format_time(time)
+    time.strftime("%m/%d/%Y %I:%M %p")
+  end 
+  
+  def format_date(date) 
+    date.strftime("%m/%d/%Y")
+  end 
+  
+  # Generates a temporary id for creating a new element
+  def generate_temporary_id
+    (Time.now.to_f*1000).to_i.to_s
+  end 
+  
+  def pagination_ajax_links(paginator, params)
+    params = params.merge(:controller => 'widgets', :action => 'list')
+    pagination_links_each(paginator, {}) do |n|
+      link_to_remote n, 
+           { :url => params.merge(:page => n ),
+           :update => scaffold_content_id(params) },
+           { :href => url_for(params.merge(:page => n )) }
+    end 
+  end
+  
+  def column_class(column_name, column_value, sort_column)
+    class_name = String.new
+    class_name += "empty " if column_empty?(column_value)
+    class_name += "sorted " if (!sort_column.nil? && column_name == sort_column)
+    class_name
+  end
+  
+  def column_empty?(column_value)
+    column_value.nil? || (column_value.empty? rescue false)
+  end
+  
+  def loading_indicator_tag(options)
+    "<img src=\"/images/indicator.gif\" style=\"display: none;\" id=\"#{loading_indicator_id(options)}\" alt=\"loading indicator\" class=\"loading-indicator\" />"
+  end  
+  
+  # The following are a bunch of helper methods to produce the common scaffold view id's
+  
+  def scaffold_content_id(options)
+    "#{options[:scaffold_id]}-content"
+  end
+  
+  def scaffold_tbody_id(options)
+    "#{options[:scaffold_id]}-tbody"
+  end
+
+  def scaffold_messages_id(options)
+    "#{options[:scaffold_id]}-messages"
+  end 
+  
+  def empty_message_id(options)
+    "#{options[:scaffold_id]}-empty-message"
+  end 
+  
+  def element_row_id(options)
+    "#{options[:scaffold_id]}-#{options[:action]}-#{options[:id]}"
+  end
+  
+  def element_cell_id(options)
+    "#{options[:scaffold_id]}-#{options[:action]}-#{options[:id]}-cell"
+  end
+  
+  def element_form_id(options)
+    "#{options[:scaffold_id]}-#{options[:action]}-#{options[:id]}-form"
+  end 
+
+  def loading_indicator_id(options)
+    if options[:id].nil?
+      "#{options[:scaffold_id]}-#{options[:action]}-loading-indicator"
+    else
+      "#{options[:scaffold_id]}-#{options[:action]}-#{options[:id]}-loading-indicator"
+    end
+  end
+
+  def element_messages_id(options)
+    "#{options[:scaffold_id]}-#{options[:action]}-#{options[:id]}-messages"
+  end 
+  
+end

data/templates/controller.rb

@@ -1,8 +1,11 @@
 class <%= controller_class_name %>Controller < ApplicationController
-
+  include AjaxScaffoldUtil
+  
+  after_filter :clear_flashes
+  
 <% unless suffix -%>
   def index
-
+    redirect_to :action => 'list'
   end
 <% end -%>
 
@@ -15,64 +18,112 @@ class <%= controller_class_name %>Controller < ApplicationController
     # If you have multiple scaffolds on the same view then you will want to change this to
     # to whatever controller/action shows all the views 
     # (ex: redirect_to :controller => 'AdminConsole', :action => 'index')
-    redirect_to :action => 'index'
+    redirect_to :action => 'list'
   end
 
-  def list<%= suffix %>
-    @<%= plural_name %> = <%= model_name %>.find :all
-    render :layout => false
+  def list
   end
-
-  def new<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.new
-
+  
+  # All posts to change scaffold level variables like sort values or page changes go through this action
+  def component_update  
     if request.xhr?
-      @temp_id = Time.new.to_i
-      @headers['<%= singular_name %>-id'] = @temp_id
-      @headers['Content-Type'] = 'text/html; charset=utf-8'
+      # If this is an AJAX request then we just want to delegate to the component to rerender itself
+      component
+    else
+      # If this is from a client without javascript we want to update the session parameters and then delegate
+      # back to whatever page is displaying the scaffold, which will then rerender all scaffolds with these update parameters
+      update_params :default_scaffold_id => "<%= singular_name %>", :default_sort => "id", :default_sort_direction => "asc"
+      return_to_main
+    end
+  end
+
+  def component
+    update_params :default_scaffold_id => "<%= singular_name %>", :default_sort => "id", :default_sort_direction => "asc"
     
-      render :layout => false
+    @sort_by = session[params[:scaffold_id]][:sort] + " " + session[params[:scaffold_id]][:sort_direction] 
+    @paginator, @<%= plural_name %> = paginate(:<%= plural_name %>, :order_by => @sort_by, :per_page => 25)
     
-      # If you want to send an error message:
-      # render :inline => "Error text goes here", :layout => false, :status => 500
-    end
+    render :action => "component", :layout => false
   end
 
-  def create<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
-    if @<%= singular_name %>.save
-      if request.xhr?                                                    
-        @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
-        return_to_main
-      end
+  def new
+    @<%= singular_name %> = <%= model_name %>.new
+    @successful = true
+
+    return if request.xhr?
+
+    # Javascript disabled fallback
+    if @successful
+      @options = { :action => "create" }
+      render :partial => "new_edit", :layout => true
+    else 
+      return_to_main
+    end
+  end
+  
+  def create
+    begin
+      @<%= singular_name %> = <%= model_name %>.new(params[:<%= singular_name %>])
+      @successful = @<%= singular_name %>.save
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    return if request.xhr?
+    if @successful
+      return_to_main
     else
-      render :partial => 'form_errors', :layout => false, :status => 500 if request.xhr?
-      render :action => 'new' if not request.xhr?
+      @options = { :scaffold_id => params[:scaffold_id], :action => "create" }
+      render :partial => 'new_edit', :layout => true
     end
   end
 
-  def edit<%= suffix %>
-    @<%= singular_name %> = <%= model_name %>.find(params[:id])
-    render :layout => false if request.xhr?
+  def edit
+    begin
+      @<%= singular_name %> = <%= model_name %>.find(params[:id])
+      @successful = !@<%= singular_name %>.nil?
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    return if request.xhr?
+
+    if @successful
+      @options = { :scaffold_id => params[:scaffold_id], :action => "update", :id => params[:id] }
+      render :partial => 'new_edit', :layout => true
+    else
+      return_to_main
+    end    
   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 } if request.xhr?
-      return_to_main if not request.xhr?
+    begin
+      @<%= singular_name %> = <%= model_name %>.find(params[:id])
+      @successful = @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    return if request.xhr?
+
+    if @successful
+      return_to_main
     else
-      render :partial => 'form_errors', :layout => false, :status => 500 if request.xhr?
-      render :action => 'edit' if not request.xhr?
+      @options = { :action => "update" }
+      render :partial => 'new_edit', :layout => true
     end
   end
 
-  def destroy<%= suffix %>
-    <%= model_name %>.find(params[:id]).destroy
-    render :nothing => true if request.xhr?
-    return_to_main if not request.xhr?
+  def destroy
+    begin
+      @successful = <%= model_name %>.find(params[:id]).destroy
+    rescue
+      flash[:error], @successful  = $!.to_s, false
+    end
+    
+    return if request.xhr?
+    
+    # Javascript disabled fallback
+    return_to_main
   end
 end

data/templates/form_scaffolding.rhtml

@@ -1 +1 @@
-<%= all_input_tags(@model_instance, @singular_name, {}) %>
+<%= all_input_tags(@model_instance, @singular_name, { :exclude => %w(created_on created_at updated_on updated_at) }) %>

data/templates/helper.rb

@@ -1,12 +1,8 @@
 module <%= controller_class_name %>Helper
-
+  include AjaxScaffoldHelper
+  
   def num_columns
     <%= model_name %>.content_columns.length + 1 
   end
-  
-  # This can be moved into application_helper.rb
-  def loading_indicator_tag(scope,id)
-    "<img src=\"/images/indicator.gif\" style=\"display: none;\" id=\"#{scope}-#{id}-loading-indicator\" alt=\"loading indicator\" class=\"loading-indicator\" />"
-  end
 
 end

data/templates/layout.rhtml

@@ -5,7 +5,8 @@
 <head>
   <title><%= Inflector.titleize(plural_name) %></title>
   <%%= stylesheet_link_tag 'ajax_scaffold', :media => 'all' %>
-  <%%= javascript_include_tag 'prototype', 'effects', 'rico_corner', 'ajax_scaffold' %>
+  <%%= javascript_include_tag :defaults %>
+  <%%= javascript_include_tag 'rico_corner', 'ajax_scaffold' %>
 </head>
 <body>
 

data/templates/lib_ajax_scaffold_util.rb

@@ -0,0 +1,26 @@
+module AjaxScaffoldUtil
+
+  def clear_flashes 
+    #We want to clear flashes so they don't appear on a page reload
+    if request.xhr? 
+      flash.keys.each do |flash_key|
+       flash[flash_key] = nil
+      end
+    end
+  end
+  
+  def store_or_get_from_session(id_key, value_key)
+    session[id_key][value_key] = params[value_key] if !params[value_key].nil?
+    params[value_key] ||= session[id_key][value_key]
+  end
+  
+  def update_params(options)
+    @scaffold_id = params[:scaffold_id] ||= options[:default_scaffold_id]
+    session[@scaffold_id] ||= {:sort => options[:default_sort], :sort_direction => options[:default_sort_direction], :page => 1}
+    
+    store_or_get_from_session(@scaffold_id, :sort)
+    store_or_get_from_session(@scaffold_id, :sort_direction)
+    store_or_get_from_session(@scaffold_id, :page)
+  end
+  
+end