Class: Wice::WiceGrid

Inherits:
Object show all
Defined in:
lib/wice_grid.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass_or_relation, controller, opts = {}) ⇒ WiceGrid

core workflow methods START

Raises:



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/wice_grid.rb', line 70

def initialize(klass_or_relation, controller, opts = {})  #:nodoc:
  @controller = controller

  @relation = klass_or_relation
  @klass = @relation.kind_of?(Class) && @relation.ancestors.index(ActiveRecord::Base) ?
    klass_or_relation :
    klass_or_relation.klass

  unless @klass.kind_of?(Class) && @klass.ancestors.index(ActiveRecord::Base)
    raise WiceGridArgumentError.new("ActiveRecord model class (second argument) must be a Class derived from ActiveRecord::Base")
  end

  # validate :with_resultset & :with_paginated_resultset
  [:with_resultset, :with_paginated_resultset].each do |callback_symbol|
    unless [NilClass, Symbol, Proc].index(opts[callback_symbol].class)
      raise WiceGridArgumentError.new(":#{callback_symbol} must be either a Proc or Symbol object")
    end
  end

  opts[:order_direction].downcase! if opts[:order_direction].kind_of?(String)

  # validate :order_direction
  if opts[:order_direction] && ! (opts[:order_direction] == 'asc'  ||
                                  opts[:order_direction] == :asc   ||
                                  opts[:order_direction] == 'desc' ||
                                  opts[:order_direction] == :desc)
    raise WiceGridArgumentError.new(":order_direction must be either 'asc' or 'desc'.")
  end

  begin
    # options that are understood
    @options = {
      conditions:                 nil,
      csv_file_name:              nil,
      csv_field_separator:        Defaults::CSV_FIELD_SEPARATOR,
      custom_order:               {},
      enable_export_to_csv:       Defaults::ENABLE_EXPORT_TO_CSV,
      group:                      nil,
      include:                    nil,
      joins:                      nil,
      name:                       Defaults::GRID_NAME,
      order:                      nil,
      order_direction:            Defaults::ORDER_DIRECTION,
      page:                       1,
      page_method_name:           Defaults::PAGE_METHOD_NAME,
      per_page:                   Defaults::PER_PAGE,
      saved_query:                nil,
      total_entries:              nil,
      with_paginated_resultset:   nil,
      with_resultset:             nil
    }
  rescue NameError
    raise NameError.new('A constant is missing in wice_grid_config.rb: ' + $!.message +
      '. This can happen when you upgrade the WiceGrid to a newer version with a new configuration constant. ' +
      'Add the constant manually or re-run `bundle exec rails g wice_grid:install`.')
  end
  # validate parameters
  opts.assert_valid_keys(@options.keys)

  @options.merge!(opts)
  @export_to_csv_enabled = @options[:enable_export_to_csv]
  @csv_file_name = @options[:csv_file_name]
  @csv_field_separator = @options[:csv_field_separator]

  case @name = @options[:name]
  when String
  when Symbol
    @name = @name.to_s
  else
    raise WiceGridArgumentError.new("name of the grid should be a string or a symbol")
  end
  raise WiceGridArgumentError.new("name of the grid can only contain alphanumeruc characters") unless @name =~ /^[a-zA-Z\d_]*$/

  @table_column_matrix = TableColumnMatrix.new
  @table_column_matrix.default_model_class = @klass

  @ar_options = {}
  @status = HashWithIndifferentAccess.new

  if @options[:order]
    @options[:order] = @options[:order].to_s
    @options[:order_direction] = @options[:order_direction].to_s

    @status[:order_direction] = @options[:order_direction]
    @status[:order] = @options[:order]

  end
  @status[:total_entries] = @options[:total_entries]
  @status[:per_page] = @options[:per_page]
  @status[:page] = @options[:page]
  @status[:conditions] = @options[:conditions]
  @status[:f] = @options[:f]

  process_loading_query
  process_params

  @ar_options_formed = false

end

Instance Attribute Details

#ar_options ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def ar_options
  @ar_options
end

#csv_field_separator ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def csv_field_separator
  @csv_field_separator
end

#csv_file_name ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def csv_file_name
  @csv_file_name
end

#csv_tempfile ⇒ Object

:nodoc:



66
67
68
 
# File 'lib/wice_grid.rb', line 66

def csv_tempfile
  @csv_tempfile
end

#custom_order ⇒ Object (readonly)

:nodoc:



63
64
65
 
# File 'lib/wice_grid.rb', line 63

def custom_order
  @custom_order
end

#export_to_csv_enabled ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def export_to_csv_enabled
  @export_to_csv_enabled
end

#klass ⇒ Object (readonly)

:nodoc:



63
64
65
 
# File 'lib/wice_grid.rb', line 63

def klass
  @klass
end

#name ⇒ Object (readonly)

:nodoc:



63
64
65
 
# File 'lib/wice_grid.rb', line 63

def name
  @name
end

#output_buffer ⇒ Object

:nodoc:



66
67
68
 
# File 'lib/wice_grid.rb', line 66

def output_buffer
  @output_buffer
end

#query_store_model ⇒ Object (readonly)

:nodoc:



63
64
65
 
# File 'lib/wice_grid.rb', line 63

def query_store_model
  @query_store_model
end

#renderer=(value) ⇒ Object (writeonly)

:nodoc:



65
66
67
 
# File 'lib/wice_grid.rb', line 65

def renderer=(value)
  @renderer = value
end

#resultset ⇒ Object (readonly)

:nodoc:



63
64
65
 
# File 'lib/wice_grid.rb', line 63

def resultset
  @resultset
end

#saved_query ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def saved_query
  @saved_query
end

#status ⇒ Object (readonly)

:nodoc:



64
65
66
 
# File 'lib/wice_grid.rb', line 64

def status
  @status
end

#view_helper_finished ⇒ Object

:nodoc:



66
67
68
 
# File 'lib/wice_grid.rb', line 66

def view_helper_finished
  @view_helper_finished
end

Instance Method Details

#add_references(relation) ⇒ Object 



294
295
296
297
298
299
300
 
# File 'lib/wice_grid.rb', line 294

def add_references relation
  if @ar_options[:include] && relation.respond_to?(:references)
    refs = [@ar_options[:include]] unless @ar_options[:include].is_a?(Array)
    relation =  relation.references(* @ar_options[:include])
  end
  relation
end

#all_pages_records ⇒ Object

Returns the list of objects browsable through all pages with the current filters. Should only be called after the grid helper.

Raises:



482
483
484
485
 
# File 'lib/wice_grid.rb', line 482

def all_pages_records
  raise WiceGridException.new("all_pages_records can only be called only after the grid view helper") unless self.view_helper_finished
  resultset_without_paging_with_user_filters
end

#all_record_mode? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


469
470
471
 
# File 'lib/wice_grid.rb', line 469

def all_record_mode? #:nodoc:
  @status[:pp]
end

#count ⇒ Object Also known as: size

:nodoc:



419
420
421
422
423
424
425
426
427
 
# File 'lib/wice_grid.rb', line 419

def count  #:nodoc:
  form_ar_options(skip_ordering: true, forget_generated_options: true)
  @relation.count(
    conditions: @ar_options[:conditions],
    joins:      @ar_options[:joins],
    include:    @ar_options[:include],
    group:      @ar_options[:group]
  )
end

#current_page_records ⇒ Object

Returns the list of objects displayed on current page. Should only be called after the grid helper.

Raises:



488
489
490
491
 
# File 'lib/wice_grid.rb', line 488

def current_page_records
  raise WiceGridException.new("current_page_records can only be called only after the grid view helper") unless self.view_helper_finished
  @resultset
end

#declare_column(column_name, model, custom_filter_active, table_alias, filter_type) ⇒ Object

:nodoc:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/wice_grid.rb', line 217

def declare_column(column_name, model, custom_filter_active, table_alias, filter_type)  #:nodoc:
  if model # this is an included table
    column = @table_column_matrix.get_column_by_model_class_and_column_name(model, column_name)
    raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{model.table_name}'!") if column.nil?
    main_table = false
    table_name = model.table_name
  else
    column = @table_column_matrix.get_column_in_default_model_class_by_column_name(column_name)
    if column.nil?
      raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{@klass.table_name}'! " +
        "If '#{column_name}' belongs to another table you should declare it in :include or :join when initialising " +
        "the grid, and specify :model in column declaration.")
    end
    main_table = true
    table_name = @table_column_matrix.default_model_class.table_name
  end

  if column
    conditions_generator = ActiveRecordColumnWrapper.new(column, @status[:f], main_table, table_alias, custom_filter_active, filter_type)
    conditions, current_parameter_name = conditions_generator.wg_initialize_request_parameters

    if @status[:f] && conditions.blank?
      @status[:f].delete(current_parameter_name)
    end

    @table_column_matrix.add_condition(column, conditions)
    [column, table_name , main_table]
  else
    nil
  end
end

#distinct_values_for_column(column) ⇒ Object

with this variant we get even those values which do not appear in the resultset



436
437
438
439
440
 
# File 'lib/wice_grid.rb', line 436

def distinct_values_for_column(column)  #:nodoc:
  res = column.model.select("distinct #{column.name}").order("#{column.name} asc").collect{|ar|
    ar[column.name]
  }.reject{|e| e.blank?}.map{|i|[i,i]}
end

#distinct_values_for_column_in_resultset(messages) ⇒ Object

:nodoc:



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/wice_grid.rb', line 443

def distinct_values_for_column_in_resultset(messages)  #:nodoc:
  uniq_vals = Set.new

  resultset_without_paging_without_user_filters.each do |ar|
    v = ar.deep_send(*messages)
    uniq_vals << v unless v.nil?
  end
  return uniq_vals.to_a.map{|i|
    if i.is_a?(Array) && i.size == 2
      i
    elsif i.is_a?(Hash) && i.size == 1
      i.to_a.flatten
    else
      [i,i]
    end
  }.sort{|a,b| a[0]<=>b[0]}
end

#dump_status ⇒ Object

:nodoc:



473
474
475
476
477
 
# File 'lib/wice_grid.rb', line 473

def dump_status #:nodoc:
  "   params: #{params[name].inspect}\n"  +
  "   status: #{@status.inspect}\n" +
  "   ar_options #{@ar_options.inspect}\n"
end

#each ⇒ Object

:nodoc:



354
355
356
357
358
359
 
# File 'lib/wice_grid.rb', line 354

def each   #:nodoc:
  self.read unless @resultset # database querying is late!
  @resultset.each do |r|
    yield r
  end
end

#empty? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


431
432
433
 
# File 'lib/wice_grid.rb', line 431

def empty?  #:nodoc:
  self.count == 0
end

#filter_params(view_column) ⇒ Object

Getters



340
341
342
343
344
345
346
347
 
# File 'lib/wice_grid.rb', line 340

def filter_params(view_column)  #:nodoc:
  column_name = view_column.attribute_name_fully_qualified_for_all_but_main_table_columns
  if @status[:f] && @status[:f][column_name]
    @status[:f][column_name]
  else
    {}
  end
end

#filtered_by ⇒ Object

:nodoc:



383
384
385
 
# File 'lib/wice_grid.rb', line 383

def filtered_by  #:nodoc:
  @status[:f].nil? ? [] : @status[:f].keys
end

#filtered_by?(view_column) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


387
388
389
 
# File 'lib/wice_grid.rb', line 387

def filtered_by?(view_column)  #:nodoc:
  @status[:f].nil? ? false : @status[:f].has_key?(view_column.attribute_name_fully_qualified_for_all_but_main_table_columns)
end

#filtering_on? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


379
380
381
 
# File 'lib/wice_grid.rb', line 379

def filtering_on?  #:nodoc:
  not @status[:f].blank?
end

#form_ar_options(opts = {}) ⇒ Object

:nodoc:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/wice_grid.rb', line 249

def form_ar_options(opts = {})  #:nodoc:

  return if @ar_options_formed
  @ar_options_formed = true unless opts[:forget_generated_options]

  # validate @status[:order_direction]
  @status[:order_direction] = case @status[:order_direction]
  when /desc/i
    'desc'
  when /asc/i
    'asc'
  else
    ''
  end

  # conditions
  # do not delete for a while
  # https://github.com/leikind/wice_grid/issues/144
  # if @table_column_matrix.generated_conditions.size == 0
  #   @status.delete(:f)
  # end

  @ar_options[:conditions] = klass.send(:merge_conditions, @status[:conditions], * @table_column_matrix.conditions )

  # conditions processed

  if (! opts[:skip_ordering]) && ! @status[:order].blank?
    @ar_options[:order] = add_custom_order_sql(complete_column_name(@status[:order]))

    @ar_options[:order] += ' ' + @status[:order_direction]
  end

  @ar_options[:joins]   = @options[:joins]
  @ar_options[:include] = @options[:include]
  @ar_options[:group]   = @options[:group]

  if self.output_html?
    @ar_options[:per_page] = @status[:per_page]
    @ar_options[:page] = @status[:page]
    @ar_options[:total_entries] = @status[:total_entries] if @status[:total_entries]
  end

end

#get_state_as_parameter_value_pairs(including_saved_query_request = false) ⇒ Object

:nodoc:



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/wice_grid.rb', line 391

def get_state_as_parameter_value_pairs(including_saved_query_request = false) #:nodoc:
  res = []
  unless status[:f].blank?
    Wice::WgHash.parameter_names_and_values(status[:f], [name, 'f']).collect do |param_name, value|
      if value.is_a?(Array)
        param_name_ar = param_name + '[]'
        value.each do |v|
          res << [param_name_ar, v]
        end
      else
        res << [param_name, value]
      end
    end
  end

  if including_saved_query_request && @saved_query
    res << ["#{name}[q]", @saved_query.id ]
  end

  [:order, :order_direction].select{|parameter|
    status[parameter]
  }.collect do |parameter|
    res << ["#{name}[#{parameter}]", status[parameter] ]
  end

  res
end

#order_direction ⇒ Object

:nodoc:



375
376
377
 
# File 'lib/wice_grid.rb', line 375

def order_direction  #:nodoc:
  @status[:order_direction]
end

#ordered_by ⇒ Object

:nodoc:



370
371
372
 
# File 'lib/wice_grid.rb', line 370

def ordered_by  #:nodoc:
  @status[:order]
end

#ordered_by?(column) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


361
362
363
364
365
366
367
368
 
# File 'lib/wice_grid.rb', line 361

def ordered_by?(column)  #:nodoc:
  return nil if @status[:order].blank?
  if column.main_table && ! offs = @status[:order].index('.')
    @status[:order] == column.attribute
  else
    @status[:order] == column.table_alias_or_table_name + '.' + column.attribute
  end
end

#output_csv? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


461
462
463
 
# File 'lib/wice_grid.rb', line 461

def output_csv? #:nodoc:
  @status[:export] == 'csv'
end

#output_html? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


465
466
467
 
# File 'lib/wice_grid.rb', line 465

def output_html? #:nodoc:
  @status[:export].blank?
end

#process_loading_query ⇒ Object

:nodoc:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/wice_grid.rb', line 183

def process_loading_query #:nodoc:
  @saved_query = nil
  if params[name] && params[name][:q]
    @saved_query = load_query(params[name][:q])
    params[name].delete(:q)
  elsif @options[:saved_query]
    if @options[:saved_query].is_a? ActiveRecord::Base
      @saved_query = @options[:saved_query]
    else
      @saved_query = load_query(@options[:saved_query])
    end
  else
    return
  end

  unless @saved_query.nil?
    params[name] = HashWithIndifferentAccess.new if params[name].blank?
    [:f, :order, :order_direction].each do |key|
      if @saved_query.query[key].blank?
        params[name].delete(key)
      else
        params[name][key] = @saved_query.query[key]
      end
    end
  end
end

#process_params ⇒ Object

:nodoc:



210
211
212
213
214
215
 
# File 'lib/wice_grid.rb', line 210

def process_params  #:nodoc:
  if this_grid_params
    @status.merge!(this_grid_params)
    @status.delete(:export) unless self.export_to_csv_enabled
  end
end

#read ⇒ Object

TO DO: what to do with other @ar_options values?



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/wice_grid.rb', line 303

def read  #:nodoc:
  form_ar_options
  @klass.unscoped do
    @resultset = if self.output_csv? || all_record_mode?
      relation = @relation.
        includes(@ar_options[:include]).
        joins(   @ar_options[:joins]).
        order(   @ar_options[:order]).
        group(   @ar_options[:group]).
        where(   @ar_options[:conditions])
      relation = add_references relation
      
      relation
    else
      # p @ar_options
      relation = @relation.
        send(    @options[:page_method_name], @ar_options[:page]).
        per(     @ar_options[:per_page]).
        includes(@ar_options[:include]).
        joins(   @ar_options[:joins]).
        order(   @ar_options[:order]).
        group(   @ar_options[:group]).
        where(   @ar_options[:conditions])

      relation = add_references relation

      relation
    end
  end
  invoke_resultset_callbacks
end

#with_paginated_resultset(&callback) ⇒ Object

A block executed from within the plugin to process records of the current page. The argument to the callback is the array of the records. See the README for more details.



172
173
174
 
# File 'lib/wice_grid.rb', line 172

def with_paginated_resultset(&callback)
  @options[:with_paginated_resultset] = callback
end

#with_resultset(&callback) ⇒ Object

A block executed from within the plugin to process all records browsable through all pages with the current filters. The argument to the callback is a lambda object which returns the list of records when called. See the README for the explanation.



179
180
181
 
# File 'lib/wice_grid.rb', line 179

def with_resultset(&callback)
  @options[:with_resultset] = callback
end