Module: GAlreadyGrid::ViewHelpers

Defined in:
lib/g_already_grid/view_helpers.rb

Instance Method Summary collapse

Instance Method Details

#g_already_grid(ar_col, *args) ⇒ Object

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.

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

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

this element.  Defaults to false.

empty_msg a message to display when the ar_col is empty or nil. Defaults to ‘No matching records’. 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_sti_base_index When true, use the STI base class’ index path instead of the specific descendant AR object’s. 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.

Raises:

  • (ArgumentError) 


32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/g_already_grid/view_helpers.rb', line 32

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 g_already_grid_empty_message( options ) 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 )
      sort_by = options[:sort].map { |a| a.to_sym }
    elsif options[:sort].is_a?( Symbol ) || options[:sort].is_a?( String )
      sort_by = Array.new << options[:sort].to_sym
    else
      throw "Option 'sort' must be a string, symbol or an array of strings or symbols."
    end
  end
  sort_by = Array.new unless sort_by

  # Resolve pagination
  do_paginate = true
  begin
    if options[:paginate] == false || options[:paginate] == 'false'
      do_paginate = false
    end
  rescue => e
    if e.is_a? NoMethodError # This just means no will_paginate methods are present.
      do_paginate = false
    else
      raise e
    end
  end

  options[:checkboxes] = true if options[:checkboxes].nil?

  if options[:path_proc]
    path_proc = options[:path_proc]
  else
    path_proc = Proc.new { |*args| controller.polymorphic_path( args ) }
  end

  total_columns = options[:cols].size
  total_columns = total_columns + 1 if options[:checkboxes]
  options[:total_columns] = total_columns
  options[:do_paginate] = do_paginate
  options[:path_helpers] = path_helpers

  vars = {
    :options => options, :ar_col => ar_col, :sort_by => sort_by, :path_helpers => path_helpers,
    :controller => controller, :path_proc => path_proc
  }

  @g_already_grid_options = options
  path = File.dirname(__FILE__)
  full_path = "#{path}/templates/guilded.already_grid.html.erb"
  self.render( :file => full_path, :use_full_path => false, :locals => vars )
end