ajax_scaffold_generator 3.1.5 → 3.1.6

data/templates/lib_ajax_scaffold.rb

@@ -1,218 +1,218 @@
-module AjaxScaffold
-
-  class ScaffoldColumn
-   
-    attr_reader :name, :eval, :sort_sql, :label
-    
-    # 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? ?  "h(#{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? ? Inflector.tableize(klass.to_s) + "." + @name : options[:sort_sql] unless !@sortable
-      @class = options[:class] unless options[:class].nil?
-    end
-    
-    def sortable? 
-      @sortable
-    end
-  
-  end
-  
-  module Model
-    module ClassMethods
-  
-    def build_scaffold_columns
-      scaffold_columns = Array.new
-      content_columns.each do |column|
-        scaffold_columns << ScaffoldColumn.new(self, { :name => column.name })
-      end 
-      scaffold_columns
-    end    
-    
-    def build_scaffold_columns_hash
-      scaffold_columns_hash = Hash.new
-      scaffold_columns.each do |scaffold_column|
-        scaffold_columns_hash[scaffold_column.name] = scaffold_column
-      end
-        scaffold_columns_hash
-      end
-    end
-  end
-
-  module Common
-    def current_sort(params)
-      session[params[:scaffold_id]][:sort]
-    end
-  
-    def current_sort_direction(params)
-      session[params[:scaffold_id]][:sort_direction]
-    end  
-  end 
-  
-  module Controller
-    include AjaxScaffold::Common
-  
-    # Filters
- 
-    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
-  
-    # Helper Methods
-
-    def default_per_page
-      5
-    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
-  
-  module Helper
-    include AjaxScaffold::Common
-    
-    def format_column(column_value) 
-      if column_empty?(column_value) 
-        empty_column_text  
-      elsif column_value.instance_of? Time
-        format_time(column_value)
-      elsif column_value.instance_of? Date
-        format_date(column_value)
-      else 
-        column_value.to_s
-      end
-    end
-
-    def format_time(time)
-      time.strftime("%m/%d/%Y %I:%M %p")
-    end 
-  
-    def format_date(date) 
-      date.strftime("%m/%d/%Y")
-    end 
-  
-    def column_empty?(column_value)
-      column_value.nil? || (column_value.empty? rescue false)
-    end
-    
-    def empty_column_text
-      "-"
-    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)
-      pagination_links_each(paginator, {}) do |n|
-        link_to_remote n, 
-           { :url => params.merge(:page => n ),
-           :loading => "Element.show('#{loading_indicator_id(params.merge(:action => 'pagination'))}');",
-           :update => scaffold_content_id(params) },
-           { :href => url_for(params.merge(:page => n )) }
-      end 
-    end
-  
-    def column_sort_direction(column_name, params)
-      column_name && current_sort_direction(params) == "asc" ? "desc" : "asc"
-      
-      if column_name && column_name == current_sort(params)
-        current_sort_direction(params) == "asc" ? "desc" : "asc"
-      else
-        "asc"
-      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 loading_indicator_tag(options)
-      image_tag "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_column_header_id(options)
-      "#{options[:scaffold_id]}-#{options[:column_name]}-column"
-    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]}-row"
-    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
-end
-
-class ActiveRecord::Base
-  extend AjaxScaffold::Model::ClassMethods
-  
-  @scaffold_columns = nil
-  def self.scaffold_columns
-    @scaffold_columns ||= build_scaffold_columns
-  end
-     
-  @scaffold_columns_hash = nil
-  def self.scaffold_columns_hash
-    @scaffold_columns_hash ||= build_scaffold_columns_hash
-  end
-end
+module AjaxScaffold # :nodoc:
+  class ScaffoldColumn
+    attr_reader :name, :eval, :sort_sql, :label, :class_name, :sanitize
+
+    # 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]
+    end
+
+    def sanitize?
+      @sanitize
+    end
+
+    def sortable?
+      @sortable
+    end
+
+  end
+
+  module Common
+    def current_sort(params)
+      session[params[:scaffold_id]][:sort]
+    end
+
+    def current_sort_direction(params)
+      session[params[:scaffold_id]][:sort_direction]
+    end
+
+    def current_page(params)
+      session[params[:scaffold_id]][:page]
+    end
+  end
+
+  module Controller
+
+    def clear_flashes
+      if request.xhr?
+        flash.keys.each do |flash_key|
+          flash[flash_key] = nil
+        end
+      end
+    end
+
+    def default_per_page
+      25
+    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
+
+  module Helper
+    include AjaxScaffold::Common
+
+    def format_column(column_value, sanitize = true)
+      if column_empty?(column_value)
+        empty_column_text
+      elsif column_value.instance_of? Time
+        format_time(column_value)
+      elsif column_value.instance_of? Date
+        format_date(column_value)
+      else
+        sanitize ? h(column_value.to_s) : column_value.to_s
+      end
+    end
+
+    def format_time(time)
+      time.strftime("%m/%d/%Y %I:%M %p")
+    end
+
+    def format_date(date)
+      date.strftime("%m/%d/%Y")
+    end
+
+    def column_empty?(column_value)
+      column_value.nil? || (column_value.empty? rescue false)
+    end
+
+    def empty_column_text
+      "-"
+    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)
+      pagination_links_each(paginator, {}) do |n|
+        link_to_remote n,
+           { :url => params.merge(:page => n ),
+           :loading => "Element.show('#{loading_indicator_id(params.merge(:action => 'pagination'))}');",
+           :update => scaffold_content_id(params) },
+           { :href => url_for(params.merge(:page => n )) }
+      end
+    end
+
+    def column_sort_direction(column_name, params)
+      if column_name && column_name == current_sort(params)
+        current_sort_direction(params) == "asc" ? "desc" : "asc"
+      else
+        "asc"
+      end
+    end
+
+    def column_class(column_name, column_value, sort_column, class_name = nil)
+      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 += "#{class_name} " unless class_name.nil?
+      class_name
+    end
+
+    def loading_indicator_tag(options)
+      image_tag "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_column_header_id(options)
+      "#{options[:scaffold_id]}-#{options[:column_name]}-column"
+    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]}-row"
+    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
+
+  module Model
+    module ClassMethods
+
+    def build_scaffold_columns
+      scaffold_columns = Array.new
+      content_columns.each do |column|
+        scaffold_columns << ScaffoldColumn.new(self, { :name => column.name })
+      end
+      scaffold_columns
+    end
+
+    def build_scaffold_columns_hash
+      scaffold_columns_hash = Hash.new
+      scaffold_columns.each do |scaffold_column|
+        scaffold_columns_hash[scaffold_column.name] = scaffold_column
+      end
+        scaffold_columns_hash
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  extend AjaxScaffold::Model::ClassMethods
+
+  @scaffold_columns = nil
+  def self.scaffold_columns
+    @scaffold_columns ||= build_scaffold_columns
+  end
+
+  @scaffold_columns_hash = nil
+  def self.scaffold_columns_hash
+    @scaffold_columns_hash ||= build_scaffold_columns_hash
+  end
+end

data/templates/partial_column_headings.rhtml

@@ -1,17 +1,17 @@
-      <%% for scaffold_column in scaffold_columns %>
-        <%% column_sort_direction = column_sort_direction(scaffold_column.name, params) %>  
-        <%% sort_params = params.merge(:controller => '<%= controller_file_path %>', :action => 'component_update', :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? %>
-            <%%= link_to_remote scaffold_column.label, 
-                { :url => sort_params,
-                :loading => "Element.addClassName('#{column_header_id}','loading');",
-                :update => scaffold_content_id(sort_params) },
-                { :href => url_for(sort_params) } %>
-          <%% else %>
-            <p><%%= scaffold_column.label %></p>
-          <%% end %>
-        </th>
-      <%% end %>
+      <%% for scaffold_column in scaffold_columns %>
+        <%% column_sort_direction = column_sort_direction(scaffold_column.name, params) %>  
+        <%% sort_params = params.merge(:controller => '<%= controller_file_path %>', :action => 'component_update', :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? %>
+            <%%= link_to_remote scaffold_column.label, 
+                { :url => sort_params,
+                :loading => "Element.addClassName('#{column_header_id}','loading');",
+                :update => scaffold_content_id(sort_params) },
+                { :href => url_for(sort_params) } %>
+          <%% else %>
+            <p><%%= scaffold_column.label %></p>
+          <%% end %>
+        </th>
+      <%% end %>
       <th></th>

data/templates/partial_item.rhtml

@@ -3,34 +3,34 @@
 <%% @options = params.merge(:controller => '<%= controller_file_path %>', :action => "view", :id => <%= singular_name %>.send("#{<%= model_name %>.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 %>
-	  <td class="<%%= column_class(scaffold_column.name, column_value, current_sort(params)) %>" >
-	    <%%= format_column(column_value) %>
-	  </td>
-	<%% end %>
+  <%% for scaffold_column in scaffold_columns %>
+    <%% column_value = eval(scaffold_column.eval) rescue nil %>
+    <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 %>
   <td class="actions">
     <table cellpadding="0" cellspacing="0">
       <tr>
         <td class="indicator-container">
           <%%= loading_indicator_tag(@options) %>
         </td>
-        <td> 
+        <td>
           <%% edit_options = @options.merge(:action => 'edit') %>
- 	        <%%= link_to_remote "Edit", 
-   	                    { :url => edit_options, 
-                          :loading => "Element.show('#{loading_indicator_id(@options)}');" },
-   	                    { :href => url_for(edit_options) } %>
-   	     </td>
-   	     <td>
-   	       <%% delete_options = @options.merge(:action => 'destroy') %>
- 	         <%%= link_to_remote "Delete", 
-   	                    { :url => delete_options, 
-   	                      :confirm => 'Are you sure?',
-                          :loading => "Element.show('#{loading_indicator_id(@options)}');" },
-   	                    { :href => url_for( delete_options ) } %>
-   	      </td>
-   	    </tr>
-   	  </table>
+          <%%= link_to_remote "Edit",
+                         { :url => edit_options,
+                           :loading => "Element.show('#{loading_indicator_id(@options)}');" },
+                         { :href => url_for(edit_options) } %>
+        </td>
+        <td>
+          <%% delete_options = @options.merge(:action => 'destroy') %>
+          <%%= link_to_remote "Delete",
+                         { :url => delete_options,
+                           :confirm => 'Are you sure?',
+                           :loading => "Element.show('#{loading_indicator_id(@options)}');" },
+                         { :href => url_for( delete_options ) } %>
+        </td>
+      </tr>
+    </table>
   </td>
 </tr>

data/templates/partial_new_edit.rhtml

@@ -1,40 +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 => '<%= controller_file_path %>'), 
-    			:loading => "Element.show('#{loading_indicator_id(@options)}'); Form.disable('#{element_form_id(@options)}');",
-    			:html => { :href => url_for(@options.merge(:controller => '<%= controller_file_path %>')),
-                     :id => element_form_id(@options) } %>
-      
-      <%%= hidden_field_tag "scaffold_id", @options[:scaffold_id] %>
-         
-      <h4><%%= Inflector.titleize(@options[:action]) %> <%= Inflector.titleize(singular_name) %></h4>
-
-      <%% if request.xhr? %>
-        <div id="<%%= element_messages_id(@options) %>" class="messages-container"></div>
-      <%% else %>
-        <%%= render :partial => 'form_messages' %>
-      <%% end %>
-            
-      <%%= render :partial => 'form' %>
-      
-      <p class="form-footer">
-      	<%%= submit_tag Inflector.titleize(@options[:action]), :class => "submit" %>
-      	<%% cancel_params = @options.merge(:controller => '<%= controller_file_path %>', :action => 'cancel', :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>
+<%% 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 => '<%= controller_file_path %>'),
+          :loading => "Element.show('#{loading_indicator_id(@options)}'); Form.disable('#{element_form_id(@options)}');",
+          :html => { :href => url_for(@options.merge(:controller => '<%= controller_file_path %>')),
+          :id => element_form_id(@options) } %>
+
+      <%%= hidden_field_tag "scaffold_id", @options[:scaffold_id] %>
+
+      <h4><%%= Inflector.titleize(@options[:action]) %> <%= Inflector.titleize(singular_name) %></h4>
+
+      <%% if request.xhr? %>
+        <div id="<%%= element_messages_id(@options) %>" class="messages-container"></div>
+      <%% else %>
+        <%%= render :partial => 'form_messages' %>
+      <%% end %>
+
+      <%%= render :partial => 'form' %>
+
+      <p class="form-footer">
+        <%%= submit_tag Inflector.titleize(@options[:action]), :class => "submit" %>
+        <%% cancel_params = @options.merge(:controller => '<%= controller_file_path %>', :action => 'cancel', :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/templates/partial_pagination_links.rhtml

@@ -1,16 +1,16 @@
-   <%% pagination_params = params.merge(:controller => '<%= controller_file_path %>', :action => 'component_update') %>
-   <%% indicator_params = pagination_params.merge(:action => 'pagination') %>
-   <%%= loading_indicator_tag indicator_params %>
-   <%%= link_to_remote('Previous', 
-           { :url => pagination_params.merge(:page => paginator.current.previous),
-           :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
-           :update => scaffold_content_id(pagination_params) },
-           { :href => url_for(pagination_params.merge(:page => paginator.current.previous)),
-           :class => "previous"}) if @paginator.current.previous %>
-   <%%= pagination_ajax_links @paginator, pagination_params %>
-   <%%= link_to_remote('Next', 
-           { :url => pagination_params.merge(:page => paginator.current.next),
-           :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
-           :update => scaffold_content_id(pagination_params) },
-           { :href => url_for(pagination_params.merge(:page => paginator.current.next)),
+   <%% pagination_params = params.merge(:controller => '<%= controller_file_path %>', :action => 'component_update') %>
+   <%% indicator_params = pagination_params.merge(:action => 'pagination') %>
+   <%%= loading_indicator_tag indicator_params %>
+   <%%= link_to_remote('Previous',
+           { :url => pagination_params.merge(:page => paginator.current.previous),
+           :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
+           :update => scaffold_content_id(pagination_params) },
+           { :href => url_for(pagination_params.merge(:page => paginator.current.previous)),
+           :class => "previous"}) if @paginator.current.previous %>
+   <%%= pagination_ajax_links @paginator, pagination_params %>
+   <%%= link_to_remote('Next',
+           { :url => pagination_params.merge(:page => paginator.current.next),
+           :loading => "Element.show('#{loading_indicator_id(indicator_params)}');",
+           :update => scaffold_content_id(pagination_params) },
+           { :href => url_for(pagination_params.merge(:page => paginator.current.next)),
            :class => "next"}) if @paginator.current.next %>