g_already_grid 1.0.6 → 1.0.7

data/History.txt

@@ -1,9 +1,16 @@
-1.0.5 2009-10-27
+== 1.0.7 2009-10-27
+
+* Added a use_polymorphic_path option to the grid view helper to enable the polymorphic path helper to determine the path of
+  each object in the collection to use as the link for each grid record.  Used when the AR object is STI'ed and one would like
+  to generate show links that are correctly pathed to the specific type (not the base class).
+
+
+== 1.0.5 2009-10-27
 
 * Added :clickable option to avoid creating link to show from table rows.
 
 
-1.0.4 2009-03-26
+== 1.0.4 2009-03-26
 
 * Refactored to utilize the REST path helper resolution available in Guilded 0.1.9
 * Added multi level scoped by option

data/README.rdoc

@@ -56,6 +56,11 @@ Add namespace option for namespacing:
   <%= g_already_grid @items, :id => "items-grid", :cols => [:name, :is_active], :sort => [:name], 
         :namespace => :admin %>
 
+Add use polymorphic path option for STI'ed models:
+
+  <%= g_already_grid @items, :id => "items-grid", :cols => [:name, :is_active], :sort => [:name], 
+        :namespace => :admin, :use_polymorphic_path => true %>
+
 
 == OPTIONS:
 
@@ -68,6 +73,7 @@ actions:: Action links to include in the action column of grid.  A boolean or Ar
 paginate:: A boolean indicating whether to output pagination controls.  Defaults to true.  Utilizes will_paginate plugin features.
 polymorphic_type:: The type of this polymorphic record.  Should be a string representing the class name.
 polymorphic_as:: The as used for the polymorphic type.  Can be a symbol or string.
+use_polymorphic_path:: When true, uses hte polymorphic path helper to determine the AR objects path from it's type (STI), otherwise, does not.  Defaults to false.
 namespace:: A string or symbol that is the namespace this collection is under.
 scoped_by:: The active record object that the objects in the ar_col is scoped by.
 shallow:: True if this collection is nested shallow, otherwise, false.
@@ -78,7 +84,7 @@ adaptable_url:: True in order to make the index url automagically adapt to :get
 == REQUIREMENTS:
 
 * Rails >= 2.2.0
-* Guilded >= 0.1.4 (http://github.com/midas/guilded/tree/master)
+* Guilded >= 1.0.0 (http://github.com/midas/guilded/tree/master)
 * will_paginate
 
 

data/VERSION

@@ -1 +1 @@
-1.0.6
+1.0.7

data/g_already_grid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{g_already_grid}
-  s.version = "1.0.6"
+  s.version = "1.0.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["C. Jason Harrelson (midas)"]
-  s.date = %q{2009-12-09}
+  s.date = %q{2010-01-28}
   s.description = %q{A Guilded Rails component that generates a rich grid control from an ActiveRecord.}
   s.email = %q{jason@lookforwardenterprises.com}
   s.extra_rdoc_files = [

data/lib/g_already_grid.rb

@@ -4,7 +4,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 require 'g_already_grid/view_helpers'
 
 module GAlreadyGrid
-  VERSION = '1.0.6'
+  VERSION = '1.0.7'
 end
 
 if defined?( ActionView::Base )

data/lib/g_already_grid/templates/guilded.already_grid.html.erb

@@ -47,7 +47,12 @@
           <td>
 						<% cell_args = path_helpers[:show_rest_args] + record_array %>
 						<% if options[:actions].empty? && options[:clickable] == true %>
-							<%= link_to( record_val, @controller.send( path_helpers[:show_rest_helper], *cell_args ) ) %>
+                            <% if options[:use_polymorphic_path] == true
+                                cell_args.insert( 0, options[:namespace] ) -%>
+                                <%= link_to record_val, @controller.polymorphic_path( cell_args ) %>
+                            <% else -%>
+							  <%= link_to( record_val, @controller.send( path_helpers[:show_rest_helper], *cell_args ) ) %>
+                            <% end -%>
 						<% else %>
 							<%= link_to( record_val, "javascript:void(0)" ) %>
 						<% end %>

data/lib/g_already_grid/view_helpers.rb

@@ -1,57 +1,68 @@
 module GAlreadyGrid
   module ViewHelpers
-    
+
     # GUIlded element.  This is a grid that is utilizing the already grid jQuery plugin.  It is
     # a progressively enhanced table.
-    # 
+    #
     # *parameters*
-    # ar_col:: (required) An ActiveRecord collection.
-    # options:: As follows.
-    # 
+    # +ar_col+ (required) An ActiveRecord collection.
+    # +options+ As follows.
+    #
     # *options*
-    # id:: (required) The id of the element.  Must be unique on the page.
-    # cols:: (required) An array of column names to include in the table.  Each position of
+    # +id+ (required) The id of the element.  Must be unique on the page.
+    # +cols+ (required) An array of column names to include in the table.  Each position of
     #   the array can be a symbol, string, or hash with 1 entry.  The hash entry is the
     #   database field name as a key and the name to use in the gird as the value.  Each
     #   key and value in the hash can be a symbol or string.
-    # skin:: The name of the skin to use for this Guilded element.  Defaults to default => which is default.css.
-    # exclude_css:: A boolean indicating if Guilded should create a stylesheet inlcude tag for 
+    # +skin+ The name of the skin to use for this Guilded element.  Defaults to default => which is default.css.
+    # +exclude_css+ A boolean indicating if Guilded should create a stylesheet inlcude tag for
     #   this element.  Defaults to false.
-    # empty_msg:: a message to display when the ar_col is empty or nil.  Defaults to 'No matching records'.
-    # actions:: Action links to include in the action column of grid.  A boolean or Array of symbols.  When 
-    #   boolean, if true, add show, edit and delete actions.  When boolean, if false, hide actions column.  
+    # +empty_msg+ a message to display when the ar_col is empty or nil.  Defaults to 'No matching records'.
+    # +actions+ Action links to include in the action column of grid.  A boolean or Array of symbols.  When 
+    #   boolean, if true, add show, edit and delete actions.  When boolean, if false, hide actions column.
     #   When Array of symbols, add only actions present in array.
-    # paginate:: A boolean indicating whether to output pagination controls.  Defaults to 
+    # +paginate+ A boolean indicating whether to output pagination controls.  Defaults to
     #   true.  Utilizes will_paginate plugin features.
-    # polymorphic_type:: The type of this polymorphic record.  Should be a string representing the class name.
-    # polymorphic_as:: The as used for the polymorphic type.  Can be a symbol or string.
-    # namespace:: A string or symbol that is the namespace this collection is under.
-    # scoped_by:: The active record object that the objects in the ar_col is scoped by.
-    # shallow:: True if this collection is nested shallow, otherwise, false.
-    # clickable:: Set to false in order to avoid rows linking to show action.  Defaults to true.
-    # adaptable_url:: True in order to make the index url automagically adapt to :get collection routes, otherwise false.
+    # +polymorphic_type+ The type of this polymorphic record.  Should be a string representing the class name.
+    # +polymorphic_as+ The as used for the polymorphic type.  Can be a symbol or string.
+    # +use_polymorphic_path+ When true, uses hte polymorphic path helper to determine the AR objects path from it's type (STI),
+    #   otherwise, does not.  Defaults to false.
+    # +namespace+ A string or symbol that is the namespace this collection is under.
+    # +scoped_by+ The active record object that the objects in the ar_col is scoped by.
+    # +shallow+ True if this collection is nested shallow, otherwise, false.
+    # +clickable+ Set to false in order to avoid rows linking to show action.  Defaults to true.
+    # +adaptable_url+ True in order to make the index url automagically adapt to :get collection routes, otherwise false.
     #
     def g_already_grid( ar_col, *args )
       options = args.extract_options!
       raise ArgumentError, "'cols' option required" unless options.include?( :cols )
       raise ArgumentError, "'cols' option must be an array of columns" unless options[:cols].is_a? Array
-      
+
       Guilded::Guilder.instance.add( :already_grid, options, [ 'jquery/jquery-already_grid-0.1.min.js' ] )
 
       return "<span class=\"list-empty-msg\">#{options[:empty_msg] || 'No matching records'}</span>" if ar_col.nil? || ar_col.empty?
-      
+
       options[:grid_class] ||= 'already-grid'
       options[:checkbox_class] ||= "chk"
       options[:check_all_class] ||= "checkAll"
       options[:date_format] ||= :default
       options[:del_confirmation] ||= 'Are you sure you would like to delete this record?'
       options[:clickable] = true if options[:clickable].nil?
-      
+
       options[:cols], options[:col_titles] = Guilded::Rails::Helpers.resolve_field_methods_and_titles( options[:cols], ar_col[0] )
       path_helpers = Guilded::Rails::Helpers.resolve_rest_path_helpers( ar_col, options )
+
+      if options[:use_sti_base_index] == true
+        specific_name = ar_col.first.class.name.tableize
+        unless ar_col.first.class.superclass.is_a?( ActiveRecord::Base )
+          base_class = ar_col.first.class.superclass
+          base_name = base_class.name.tableize
+          path_helpers[:index_rest_helper] = path_helpers[:index_rest_helper].gsub( /#{specific_name}/, base_name ) unless base_name.nil?
+        end
+      end
       
       scoped_by = options.delete( :scoped_by )
-      
+
       # Resolve sorting
       if options[:sort]
         if options[:sort].is_a?( Array )
@@ -63,7 +74,7 @@ module GAlreadyGrid
         end
       end
       sort_by = Array.new unless sort_by
-      
+
       if options[:actions].is_a?( TrueClass )
         options[:actions] = [ :show, :edit, :delete ]
       elsif options[:actions].nil?
@@ -85,13 +96,13 @@ module GAlreadyGrid
       end
 
       options[:checkboxes] = true if options[:checkboxes].nil?
-      
+
       total_columns = options[:cols].size
       total_columns = total_columns + 1 if options[:checkboxes]
       total_columns = total_columns + 1 unless options[:actions].empty?
       options[:total_columns] = total_columns
-      
-      vars = { 
+
+      vars = {
         :options => options, :ar_col => ar_col, :do_paginate => do_paginate, :sort_by => sort_by, :path_helpers => path_helpers
       }
 
@@ -100,19 +111,19 @@ module GAlreadyGrid
       full_path = "#{path}/templates/guilded.already_grid.html.erb"
       self.render( :file => full_path, :use_full_path => false, :locals => vars )
     end
-    
+
   private
-  
-    # Creates a link to sort this column of a table.  Utilizes the link_to helper, 
-    # but resolves sort by, direction and adds correct CSS classes for UI elements to 
+
+    # Creates a link to sort this column of a table.  Utilizes the link_to helper,
+    # but resolves sort by, direction and adds correct CSS classes for UI elements to
     # be displayed.
-    # 
+    #
     # *parameters*
-    # name:: The text to use for the link
-    # method:: The actual name of this column's field.
-    # path:: (Symbol) The name of the path method to call from routing.
-    # already_grid_options:: The options hash from the already grid view helper.
-    # options:: see link_to helper.
+    # +name+ The text to use for the link
+    # +method+ The actual name of this column's field.
+    # +path+ (Symbol) The name of the path method to call from routing.
+    # +already_grid_options+ The options hash from the already grid view helper.
+    # +options+ see link_to helper.
     #
     def sortable_header( name, method, path, scoping_args, already_grid_options, options={} )
       is_sorted_link = ( method.to_s == params[:order].to_s )
@@ -132,21 +143,21 @@ module GAlreadyGrid
       sort_options.merge!( :filter => params[:filter] ) if params[:filter]
       unsorted_options = { :order => method, :direction => 'ASC' } # always sort ascending on first sort
       unsorted_options.merge!( :filter => params[:filter] ) if params[:filter]
-      
+
       path = path.to_sym unless path.is_a?( Symbol )
       path_args = [] + scoping_args
-      
+
       if is_sorted_link
         # Handle the currently sorted by link
         path_args << sort_options
         path = @controller.send( path, *path_args )
       else
-        # Handle the the other currently unsorted by links (we will always sort in 
+        # Handle the the other currently unsorted by links (we will always sort in
         # an ASC direction the first time)
         path_args << unsorted_options
         path = @controller.send( path, *path_args )
       end
-      
+
       # Try to adapt to get collection rest methods
       if already_grid_options[:adaptable_url]
         path_parts = path.split( '?' )
@@ -156,13 +167,13 @@ module GAlreadyGrid
           path = "#{request.path_info}?#{path_parts[1]}"  # path.gsub( /#path_parts[0]/, request.request_uri )
         end
       end
-      
+
       # Load the params to an args array to send to the link_to helper
       args = []
       args << name << path << options
 
       link_to( *args )
     end
-    
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: g_already_grid
 version: !ruby/object:Gem::Version 
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors: 
 - C. Jason Harrelson (midas)
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-09 00:00:00 -06:00
+date: 2010-01-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency