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, controller, opts = {}) ⇒ WiceGrid

core workflow methods START


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

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

  # check for will_paginate
  # raise WiceGridException.new("Plugin will_paginate not found! wice_grid requires will_paginate.")
  unless klass.respond_to?(:paginate)
    raise Wice::WiceGridException.new('will_paginate not found, WiceGrid cannot proceed. Please install gem mislav-will_paginate. ' +
                                      'You might need to add github.com as the gem source before you install the gem: ' +
                                      'gem sources -a http://gems.github.com')
  end

  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

  Wice.deprecated_call(:after, :with_resultset, opts)

  # 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

  # options that are understood
  @options = {
    :conditions           => nil,
    :csv_file_name        => nil,
    :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,
    :per_page             => Defaults::PER_PAGE,
    :saved_query          => nil,
    :select               => nil,
    :total_entries        => nil,
    :with_paginated_resultset  => nil,
    :with_resultset       => nil
  }

  # 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]

  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_]*$/

  @klass = klass

  @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

  @method_scoping = @klass.send(:scoped_methods)[-1]
end

Instance Attribute Details

#ar_optionsObject (readonly)

Returns the value of attribute ar_options


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

def ar_options
  @ar_options
end

#csv_file_nameObject (readonly)

Returns the value of attribute csv_file_name


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

def csv_file_name
  @csv_file_name
end

#csv_tempfileObject

Returns the value of attribute csv_tempfile


32
33
34
# File 'lib/wice_grid.rb', line 32

def csv_tempfile
  @csv_tempfile
end

#custom_orderObject (readonly)

Returns the value of attribute custom_order


29
30
31
# File 'lib/wice_grid.rb', line 29

def custom_order
  @custom_order
end

#export_to_csv_enabledObject (readonly)

Returns the value of attribute export_to_csv_enabled


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

def export_to_csv_enabled
  @export_to_csv_enabled
end

#klassObject (readonly)

Returns the value of attribute klass


29
30
31
# File 'lib/wice_grid.rb', line 29

def klass
  @klass
end

#nameObject (readonly)

Returns the value of attribute name


29
30
31
# File 'lib/wice_grid.rb', line 29

def name
  @name
end

#output_bufferObject

Returns the value of attribute output_buffer


32
33
34
# File 'lib/wice_grid.rb', line 32

def output_buffer
  @output_buffer
end

#query_store_modelObject (readonly)

Returns the value of attribute query_store_model


29
30
31
# File 'lib/wice_grid.rb', line 29

def query_store_model
  @query_store_model
end

#renderer=(value) ⇒ Object (writeonly)

Sets the attribute renderer

Parameters:

  • value

    the value to set the attribute renderer to.


31
32
33
# File 'lib/wice_grid.rb', line 31

def renderer=(value)
  @renderer = value
end

#resultsetObject (readonly)

:nodoc:


285
286
287
# File 'lib/wice_grid.rb', line 285

def resultset
  @resultset
end

#saved_queryObject (readonly)

Returns the value of attribute saved_query


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

def saved_query
  @saved_query
end

#statusObject (readonly)

Returns the value of attribute status


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

def status
  @status
end

#view_helper_finishedObject

Returns the value of attribute view_helper_finished


32
33
34
# File 'lib/wice_grid.rb', line 32

def view_helper_finished
  @view_helper_finished
end

Instance Method Details

#all_pages_recordsObject

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

Raises:


421
422
423
424
# File 'lib/wice_grid.rb', line 421

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)

403
404
405
# File 'lib/wice_grid.rb', line 403

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

#countObject Also known as: size

:nodoc:


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

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

#current_page_recordsObject

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

Raises:


427
428
429
430
# File 'lib/wice_grid.rb', line 427

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_class, custom_filter_active, table_alias) ⇒ Object

:nodoc:


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
209
210
211
212
# File 'lib/wice_grid.rb', line 184

def declare_column(column_name, model_class, custom_filter_active, table_alias)  #:nodoc:
  if model_class # this is an included table
    column = @table_column_matrix.get_column_by_model_class_and_column_name(model_class, column_name)
    raise WiceGridArgumentError.new("Column '#{column_name}' is not found in table '#{model_class.table_name}'!") if column.nil?
    main_table = false
    table_name = model_class.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_class in column declaration.")
    end
    main_table = true
    table_name = @table_column_matrix.default_model_class.table_name
  end

  if column
    conditions, current_parameter_name = column.wg_initialize_request_parameters(@status[:f], main_table, table_alias, custom_filter_active)
    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


367
368
369
370
371
372
373
374
# File 'lib/wice_grid.rb', line 367

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

#distinct_values_for_column_in_resultset(messages) ⇒ Object

:nodoc:


377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/wice_grid.rb', line 377

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_statusObject

:nodoc:


407
408
409
410
411
# File 'lib/wice_grid.rb', line 407

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

#eachObject

:nodoc:


290
291
292
293
294
295
# File 'lib/wice_grid.rb', line 290

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

#empty?Boolean

:nodoc:

Returns:

  • (Boolean)

362
363
364
# File 'lib/wice_grid.rb', line 362

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

#filter_params(view_column) ⇒ Object

Getters


276
277
278
279
280
281
282
283
# File 'lib/wice_grid.rb', line 276

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_byObject

:nodoc:


319
320
321
# File 'lib/wice_grid.rb', line 319

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

#filtered_by?(view_column) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

323
324
325
# File 'lib/wice_grid.rb', line 323

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)

315
316
317
# File 'lib/wice_grid.rb', line 315

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

#form_ar_options(opts = {}) ⇒ Object

:nodoc:


214
215
216
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
# File 'lib/wice_grid.rb', line 214

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
  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]
    @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]
  @ar_options[:select]  = @options[:select]


  if self.output_html?
    @ar_options[:per_page] = if all_record_mode?
      # reset the :pp value in all records mode
      @status[:pp] = count_resultset_without_paging_without_user_filters
    else
      @status[:per_page]
    end

    @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:


327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
# File 'lib/wice_grid.rb', line 327

def get_state_as_parameter_value_pairs(including_saved_query_request = false) #:nodoc:
  res = []
  unless status[:f].blank?
    status[:f].parameter_names_and_values([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_directionObject

:nodoc:


311
312
313
# File 'lib/wice_grid.rb', line 311

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

#ordered_byObject

:nodoc:


306
307
308
# File 'lib/wice_grid.rb', line 306

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

#ordered_by?(column) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

297
298
299
300
301
302
303
304
# File 'lib/wice_grid.rb', line 297

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

#output_csv?Boolean

:nodoc:

Returns:

  • (Boolean)

395
396
397
# File 'lib/wice_grid.rb', line 395

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

#output_html?Boolean

:nodoc:

Returns:

  • (Boolean)

399
400
401
# File 'lib/wice_grid.rb', line 399

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

#process_loading_queryObject

:nodoc:


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/wice_grid.rb', line 150

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_paramsObject

:nodoc:


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

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

#readObject

:nodoc:


263
264
265
266
267
268
269
# File 'lib/wice_grid.rb', line 263

def read  #:nodoc:
  form_ar_options
  with_exclusive_scope do
    @resultset = self.output_csv? ?  @klass.find(:all, @ar_options) : @klass.paginate(@ar_options)
  end
  invoke_resultset_callbacks
end

#selected_recordsObject

:nodoc:


414
415
416
417
# File 'lib/wice_grid.rb', line 414

def selected_records #:nodoc:
  STDERR.puts "WiceGrid: Parameter :#{selected_records} is deprecated, use :#{all_pages_records} or :#{current_page_records} instead!"
  all_pages_records
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.


139
140
141
# File 'lib/wice_grid.rb', line 139

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.


146
147
148
# File 'lib/wice_grid.rb', line 146

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