Module: JqGridRails::Controller

Defined in:
lib/jqgrid_rails/jqgrid_rails_controller.rb

Constant Summary collapse

SEARCH_OPERS =

These are the valid search operators jqgrid uses and the database translations for them. We use closures for the value so we can modify the string if we see fit

{
  'eq' => ['= ?', lambda{|v|v}],
  'ne' => ['!= ?', lambda{|v|v}],
  'lt' => ['< ?', lambda{|v|v}],
  'le' => ['<= ?', lambda{|v|v}],
  'gt' => ['> ?', lambda{|v|v}],
  'ge' => ['>= ?', lambda{|v|v}],
  'bw' => ['ilike ?', lambda{|v| "#{v}%"}],
  'bn' => ['not ilike ?', lambda{|v| "#{v}%"}],
  'in' => ['in ?', lambda{|v| v.split(',').map(&:strip)}],
  'ni' => ['not in ?', lambda{|v| v.split(',').map(&:strip)}],
  'ew' => ['ilike ?', lambda{|v| "%#{v}"}],
  'en' => ['not ilike ?', lambda{|v| "%#{v}"}],
  'cn' => ['ilike ?', lambda{|v| "%#{v}%"}],
  'nc' => ['not ilike ?', lambda{|v| "%#{v}%"}]
}

Instance Method Summary collapse

Instance Method Details

#apply_filtering(klass, params, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

params

Request params

fields

Fields used within grid

Applies any filter restrictions to result set

TODO: Currently this only supports AND’ing the filters. Need to add support for grabbing groupOp from parameters and using it for joining query parameters.



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 185

def apply_filtering(klass, params, fields)
  rel = klass
  havings = []
  unless(params[:filters].blank?)
    filters = JSON.load(params[:filters])
    filters['rules'].each do |filter|
      field = discover_field(filter['field'].gsub('___', '.'), fields)
      oper = filter['op']
      raise ArgumentError.new("Invalid search operator received: #{oper}") unless SEARCH_OPERS.keys.include?(oper)
      data = filter['data']
      if(fields.is_a?(Hash) && fields[field][:having])
        havings << ["#{fields[field][:having]} #{SEARCH_OPERS[oper].first}", SEARCH_OPERS[oper].last.call(data)]
      end
      if(defined?(ActiveRecord::Relation) && rel.is_a?(ActiveRecord::Relation))
        if(!fields.is_a?(Hash) || fields[field][:having].blank? || fields[field][:where])
          rel = rel.where([
            "#{database_name_by_string(field, klass, fields)} #{SEARCH_OPERS[oper].first}",
            SEARCH_OPERS[oper].last.call(data)
          ])
        end
      else
        if(!fields.is_a?(Hash) || fields[field][:having].blank? || fields[field][:where])
          rel = rel.scoped(
            :conditions => [
              "#{database_name_by_string(field, klass, fields)} #{SEARCH_OPERS[oper].first}",
              SEARCH_OPERS[oper].last.call(data)
            ]
          )
        end
      end
    end
  end
  unless(havings.blank?)
    ary = ["(#{havings.map(&:first).join(') AND (')})", *havings.map(&:last)]
    rel = defined?(ActiveRecord::Relation) && rel.is_a?(ActiveRecord::Relation) ? rel.having(ary) : rel.scoped(:having => ary)
  end
  rel
end

#apply_searching(klass, params, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

params

Request params

fields

Fields used within grid

Applies any search restrictions to result set TODO: DRY out #apply_filtering and #apply_searching



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 137

def apply_searching(klass, params, fields)
  unless(params[:searchField].blank?)
    field = discover_field(params[:searchField], fields)
    search_oper = params[:searchOper]
    search_string = params[:searchString]
    raise ArgumentError.new("Invalid search operator received: #{search_oper}") unless SEARCH_OPERS.keys.include?(search_oper)
    if(defined?(ActiveRecord::Relation) && klass.is_a?(ActiveRecord::Relation))
      if(fields.is_a?(Hash) && fields[field][:having])
        rel = rel.having([
          "#{fields[field][:having]} #{SEARCH_OPERS[oper].first}", SEARCH_OPERS[oper].last.call(data)
        ])
      end
      if(!fields.is_a?(Hash) || fields[field][:having].blank? || fields[field][:where])
        klass.where([
          "#{database_name_by_string(field, klass, fields)} #{SEARCH_OPERS[search_oper].first}",
          SEARCH_OPERS[search_oper].last.call(search_string)
        ])
      end
    else
      if(fields.is_a?(Hash) && fields[field][:having])
        rel = rel.scoped(
          :conditions => [
            "#{fields[field][:having]} #{SEARCH_OPERS[oper].first}", SEARCH_OPERS[oper].last.call(data)
          ]
        )
      end
      if(!fields.is_a?(Hash) || fields[field][:having].blank? || fields[field][:where])
        klass.scoped(
          :conditions => [
            "#{database_name_by_string(field, klass, fields)} #{SEARCH_OPERS[search_oper].first}",
            SEARCH_OPERS[search_oper].last.call(search_string)
          ]
        )
      end
    end
  else
    klass
  end
end

#apply_sorting(klass, params, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

params

Request params

fields

Fields used within grid

Applies any sorting to result set



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 107

def apply_sorting(klass, params, fields)
  sort_col = params[[:sidx, :searchField].find{|sym| !params[sym].blank?}]
  unless(sort_col)
    begin
      sort_col = discover_field(sort_col, fields)
    rescue NameError
      # continue on and let the sort_col be set to default below
    end
  end
  unless(sort_col)
    sort_col = (fields.is_a?(Hash) ? fields.keys : fields).first
  end
  sorter = discover_sorter(klass, sort_col, fields)
  sort_ord = params[:sord] == 'asc' ? 'ASC' : 'DESC'
  if(sorter.present?)
    if(defined?(ActiveRecord::Relation) && klass.is_a?(ActiveRecord::Relation))
      klass.order("#{sorter} #{sort_ord}")
    else
      klass.scoped(:order => "#{sorter} #{sort_ord}")
    end
  else
    klass
  end
end

#create_result_hash(unsorted, klass, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

fields

Fields used within grid

Creates a result Hash in the structure the grid is expecting TODO: Calling #length is less than ideal on large datasets, but it is needed for cases where we are grouping items up for results. Perhaps set an optional flag to enable #length usage and use #count by default



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 230

def create_result_hash(unsorted, klass, fields)
  if(defined?(ActiveRecord::Relation) && klass.is_a?(ActiveRecord::Relation))
    dbres = klass.limit(params[:rows].to_i).offset(params[:rows].to_i * (params[:page].to_i - 1)).all
    if(unsorted.respond_to?(:group_values) && unsorted.group_values.size > 0)
      total = klass.connection.execute("SELECT COUNT(*) as count from (#{unsorted.to_sql}) AS countable_query").map.first['count'].to_i
    end
  else
    dbres = klass.find(:all, :limit => params[:rows], :offset => (params[:rows].to_i * (params[:page].to_i - 1)))
    if(unsorted.respond_to?(:proxy_options) && unsorted.proxy_options[:group].present?)
      total = klass.connection.execute("SELECT COUNT(*) as count from (#{unsorted.send(:construct_finder_sql, {})}) AS countable_query").map.first['count'].to_i
    end
  end
  total = unsorted.count unless total
  rows = params[:rows].to_i
  total_pages = rows > 0 ? (total.to_f / rows).ceil : 0
  res = {'total' => total_pages, 'page' => params[:page], 'records' => total}
  calls = fields.is_a?(Array) ? fields : fields.is_a?(Hash) ? fields.keys : nil
  maps = fields.is_a?(Hash) ? fields : nil
  res['rows'] = dbres.map do |row|
    hsh = {}
    calls.each do |method|
      value = method.to_s.split('.').inject(row) do |result,meth|
        if(result.try(:respond_to?, meth))
          result.send(meth)
        else
          nil
        end
      end
      if(fields.is_a?(Hash) && fields[method][:formatter].is_a?(Proc))
        value = fields[method][:formatter].call(value, row)
      end
      hsh[method] = value
    end
    hsh
  end
  res
end

#discover_field(given, fields) ⇒ Object

given

Field for searching

fields

Array or Hash map of fields

Returns proper field if mapped and ensures field is valid



73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 73

def discover_field(given, fields)
  given = JqGridRails.unescape(given)
  col = nil
  case fields
    when Hash
      col = fields.keys.detect{|key| key.to_s == given}
    when Array
      col = given if fields.map(&:to_s).include?(given)
    else
      raise TypeError.new "Expecting fields to be Array or Hash. Received: #{fields.class.name}"
  end
  raise NameError.new "Requested field was not found in provided fields list. Given: #{given}" unless col
  col
end

#discover_sorter(klass, col, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

col

Sort column

fields

Aray or Hash map of fields

Returns proper sorter based on inference or user defined



92
93
94
95
96
97
98
99
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 92

def discover_sorter(klass, col, fields)
  col = JqGridRails.unescape(col)
  if(fields.is_a?(Hash) && fields[col].try(:[], :order).present?)
    fields[col][:order]
  else
    database_name_by_string(col, klass, fields)
  end
end

#grid_response(klass, params, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

params

Request params

fields

Fields used within grid. Can be an array of attribute names or a Hash with keys of attributes and Hash values with options

Array: [col1, col2, col3]
Hash: {'col1' => {:fomatter => lambda{|v|v.to_s.upcase}, :order => 'other_table.col1'}}

Provides generic JSON response for jqGrid requests (sorting/searching)



30
31
32
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 30

def grid_response(klass, params, fields)
  raw_response(klass, params, fields).to_json
end

#raw_response(klass, params, fields) ⇒ Object

klass

ActiveRecord::Base class or ActiveRecord::Relation

params

Request params

fields

Fields used within grid. Can be an array of attribute names or a Hash with keys of attributes and Hash values with options

Array: [col1, col2, col3]
Hash: {'col1' => {:fomatter => lambda{|v|v.to_s.upcase}, :order => 'other_table.col1'}}

Provides hash result for jqGrid requests (sorting/searching)



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 40

def raw_response(klass, params, fields)
  allowed_consts = %w(ActiveRecord::Base ActiveRecord::Relation ActiveRecord::NamedScope::Scope)
  unless(allowed_consts.detect{|const| klass.ancestors.detect{|c| c.to_s == const}})
    raise TypeError.new "Unexpected type received. Allowed types are Class or ActiveRecord::Relation. Received: #{klass.class.name}"
  end
  clean_fields = scrub_fields(fields)
  rel = apply_searching(klass, params, clean_fields)
  unsorted = apply_filtering(rel, params, clean_fields)
  rel = apply_sorting(unsorted, params, clean_fields)
  create_result_hash(unsorted, rel, clean_fields)
end

#scrub_fields(fields) ⇒ Object

fields

Fields used within grid

Scrubs out fields to ensure in proper state



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/jqgrid_rails/jqgrid_rails_controller.rb', line 54

def scrub_fields(fields)
  clean_fields = nil
  if(fields.is_a?(Hash))
    clean_fields = ActiveSupport::OrderedHash.new
    fields.each_pair do |k,v|
      clean_fields[k.to_s] = v.nil? ? {} : v
    end
  else
    clean_fields = fields.map(&:to_s)
  end
  if(clean_fields.is_a?(Hash))
    raise TypeError.new 'Hash values must be of Hash type or nil' if fields.values.detect{|v| !v.is_a?(Hash)}
  end
  clean_fields
end