Class: ActiveScaffold::DataStructures::Column

Inherits:
Object
  • Object
show all
Includes:
Configurable, OrmChecks
Defined in:
lib/active_scaffold/data_structures/column.rb

Constant Summary collapse

NO_PARAMS = 
Set.new.freeze
NO_OPTIONS = 
{}.freeze
@@associated_limit = 
3
@@associated_number = 
true
@@show_blank_record = 
true
%i[new edit show]
@@association_form_ui = 
nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OrmChecks

active_record?, cast, column_type, columns, columns_hash, content_columns, default_value, mongoid?, quoted_table_name, reflect_on_all_associations, table_name, tableless?, type_for_attribute

Methods included from Configurable

#configure, #method_missing, #respond_to_missing?

Constructor Details

#initialize(name, active_record_class, delegated_association = nil) ⇒ Column

instantiation is handled internally through the DataStructures::Columns object



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
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
 
# File 'lib/active_scaffold/data_structures/column.rb', line 373

def initialize(name, active_record_class, delegated_association = nil) #:nodoc:
  @name = name.to_sym
  @active_record_class = active_record_class
  @column = _columns_hash[name.to_s]
  if @column.nil? && active_record? && active_record_class._default_attributes.key?(name.to_s)
    @column = active_record_class._default_attributes[name.to_s]
  end
  @delegated_association = delegated_association
  @cache_key = [@active_record_class.name, name].compact.map(&:to_s).join('#')
  setup_association_info

  @link = nil
  @autolink = association.present?
  @table = _table_name
  @associated_limit = self.class.associated_limit
  @associated_number = self.class.associated_number
  @show_blank_record = self.class.show_blank_record
  @send_form_on_update_column = self.class.send_form_on_update_column
  @actions_for_association_links = self.class.actions_for_association_links.dup if association
  @select_columns = default_select_columns

  @text = @column.nil? || [:string, :text, :citext, String].include?(column_type)
  @number = false
  setup_defaults_for_column if @column
  @allow_add_existing = true
  @form_ui = self.class.association_form_ui if @association && self.class.association_form_ui

  self.includes = [association.name] if association&.allow_join?
  if delegated_association
    self.includes = includes ? [delegated_association.name => includes] : [delegated_association.name]
  end

  # default all the configurable variables
  self.css_class = ''
  validators_force_require_on = active_record_class.validators_on(name)
                                                   .map { |val| validator_force_required?(val) }
                                                   .select(&:present?)
  self.required = validators_force_require_on.any? { |opt| opt == true } ||
                  validators_force_require_on.reject { |opt| opt == true }.flatten.presence
  self.sort = true
  self.search_sql = true

  @weight = estimate_weight
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActiveScaffold::Configurable

Instance Attribute Details

Returns the value of attribute actions_for_association_links.



323
324
325
 
# File 'lib/active_scaffold/data_structures/column.rb', line 323

def actions_for_association_links
  @actions_for_association_links
end

#active_record_class ⇒ Object (readonly) Also known as: model

Returns the value of attribute active_record_class.



8
9
10
 
# File 'lib/active_scaffold/data_structures/column.rb', line 8

def active_record_class
  @active_record_class
end

#allow_add_existing ⇒ Object

Whether to enable add_existing for this column



29
30
31
 
# File 'lib/active_scaffold/data_structures/column.rb', line 29

def allow_add_existing
  @allow_add_existing
end

#associated_limit ⇒ Object

Returns the value of attribute associated_limit.



297
298
299
 
# File 'lib/active_scaffold/data_structures/column.rb', line 297

def associated_limit
  @associated_limit
end

#associated_number=(value) ⇒ Object (writeonly)

Sets the attribute associated_number

Parameters:

  • value —

    the value to set the attribute associated_number to.



302
303
304
 
# File 'lib/active_scaffold/data_structures/column.rb', line 302

def associated_number=(value)
  @associated_number = value
end

#association ⇒ Object (readonly)

the association from the ActiveRecord class



336
337
338
 
# File 'lib/active_scaffold/data_structures/column.rb', line 336

def association
  @association
end

#association_join_text ⇒ Object

what string to use to join records from plural associations



308
309
310
 
# File 'lib/active_scaffold/data_structures/column.rb', line 308

def association_join_text
  @association_join_text
end

#cache_key ⇒ Object (readonly)

cache key to cache column info



370
371
372
 
# File 'lib/active_scaffold/data_structures/column.rb', line 370

def cache_key
  @cache_key
end

#calculate ⇒ Object

define a calculation for the column. anything that ActiveRecord::Calculations::ClassMethods#calculate accepts will do.



236
237
238
 
# File 'lib/active_scaffold/data_structures/column.rb', line 236

def calculate
  @calculate
end

#collapsed ⇒ Object

Whether this column set is collapsed by default in contexts where collapsing is supported



26
27
28
 
# File 'lib/active_scaffold/data_structures/column.rb', line 26

def collapsed
  @collapsed
end

#column ⇒ Object (readonly)

the ConnectionAdapter::*Column object from the ActiveRecord class



333
334
335
 
# File 'lib/active_scaffold/data_structures/column.rb', line 333

def column
  @column
end

#css_class ⇒ Object

this will be /joined/ to the :name for the td’s class attribute. useful if you want to style columns on different ActiveScaffolds the same way, but the columns have different names.



77
78
79
 
# File 'lib/active_scaffold/data_structures/column.rb', line 77

def css_class
  @css_class
end

#delegated_association ⇒ Object (readonly)

the singular association which this column belongs to



339
340
341
 
# File 'lib/active_scaffold/data_structures/column.rb', line 339

def delegated_association
  @delegated_association
end

#description(record = nil, scope = nil) ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'lib/active_scaffold/data_structures/column.rb', line 60

def description(record = nil, scope = nil)
  if @description&.respond_to?(:call)
    @description.call(record, self, scope)
  elsif @description
    @description
  else
    I18n.t name, :scope => [:activerecord, :description, active_record_class.to_s.underscore.to_sym], :default => ''
  end
end

#form_ui ⇒ Object

supported options:

* for association columns
  * :select - displays a simple <select> or a collection of checkboxes to (dis)associate records



147
148
149
 
# File 'lib/active_scaffold/data_structures/column.rb', line 147

def form_ui
  @form_ui
end

#form_ui_options ⇒ Object (readonly)

Returns the value of attribute form_ui_options.



149
150
151
 
# File 'lib/active_scaffold/data_structures/column.rb', line 149

def form_ui_options
  @form_ui_options
end

#hide_form_column_if ⇒ Object

add a custom attr_accessor that can contain a Proc (or boolean or symbol) that will be called when the column renders, such that we can dynamically hide or show the column with an element that can be replaced by update_columns, but won’t affect the form submission. The value can be set in the scaffold controller as follows to dynamically hide the column based on a Proc’s output: config.columns.hide_form_column_if = Proc.new { |record, column, scope| record.vehicle_type == ‘tractor’ } OR to always hide the column: config.columns.hide_form_column_if = true OR to call a method on the record to determine whether to hide the column: config.columns.hide_form_column_if = :hide_tractor_fields?



114
115
116
 
# File 'lib/active_scaffold/data_structures/column.rb', line 114

def hide_form_column_if
  @hide_form_column_if
end

#includes ⇒ Object

a collection of associations to pre-load when finding the records on a page



244
245
246
 
# File 'lib/active_scaffold/data_structures/column.rb', line 244

def includes
  @includes
end

#inplace_edit ⇒ Object

Whether to enable inplace editing for this column. Currently works for text columns, in the List.



15
16
17
 
# File 'lib/active_scaffold/data_structures/column.rb', line 15

def inplace_edit
  @inplace_edit
end

#inplace_edit_update ⇒ Object

:table to refresh list true or :row to refresh row



23
24
25
 
# File 'lib/active_scaffold/data_structures/column.rb', line 23

def inplace_edit_update
  @inplace_edit_update
end

#label(record = nil, scope = nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/active_scaffold/data_structures/column.rb', line 43

def label(record = nil, scope = nil)
  if @label.respond_to?(:call)
    if record
      @label.call(record, self, scope)
    else
      # sometimes label is called without a record in context (ie, from table
      # headers).  In this case fall back to the humanized attribute name
      # instead of the Proc
      active_record_class.human_attribute_name(name.to_s)
    end
  else
    as_(@label) || active_record_class.human_attribute_name(name.to_s)
  end
end

#name ⇒ Object (readonly)

this is the name of the getter on the ActiveRecord model. it is the only absolutely required attribute … all others will be inferred from this name.



12
13
14
 
# File 'lib/active_scaffold/data_structures/column.rb', line 12

def name
  @name
end

#number=(value) ⇒ Object (writeonly)

Sets the attribute number

Parameters:

  • value —

    the value to set the attribute number to.



346
347
348
 
# File 'lib/active_scaffold/data_structures/column.rb', line 346

def number=(value)
  @number = value
end

#options ⇒ Object 



201
202
203
204
 
# File 'lib/active_scaffold/data_structures/column.rb', line 201

def options
  return @options || NO_OPTIONS if frozen?
  @options ||= NO_OPTIONS.dup
end

#placeholder ⇒ Object 



72
73
74
 
# File 'lib/active_scaffold/data_structures/column.rb', line 72

def placeholder
  @placeholder || I18n.t(name, :scope => [:activerecord, :placeholder, active_record_class.to_s.underscore.to_sym], :default => '')
end

#required=(value) ⇒ Object (writeonly)

whether the field is required or not. used on the form for visually indicating the fact to the user. TODO: move into predicate



81
82
83
 
# File 'lib/active_scaffold/data_structures/column.rb', line 81

def required=(value)
  @required = value
end

#select_associated_columns ⇒ Object

a collection of columns to load when eager loading is disabled, if it’s nil all columns will be loaded



267
268
269
 
# File 'lib/active_scaffold/data_structures/column.rb', line 267

def select_associated_columns
  @select_associated_columns
end

#select_columns ⇒ Object

What columns load from main table



32
33
34
 
# File 'lib/active_scaffold/data_structures/column.rb', line 32

def select_columns
  @select_columns
end

#send_form_on_update_column ⇒ Object

Returns the value of attribute send_form_on_update_column.



101
102
103
 
# File 'lib/active_scaffold/data_structures/column.rb', line 101

def send_form_on_update_column
  @send_form_on_update_column
end

#show_blank_record=(value) ⇒ Object (writeonly)

Sets the attribute show_blank_record

Parameters:

  • value —

    the value to set the attribute show_blank_record to.



313
314
315
 
# File 'lib/active_scaffold/data_structures/column.rb', line 313

def show_blank_record=(value)
  @show_blank_record = value
end

#update_columns ⇒ Object

Returns the value of attribute update_columns.



90
91
92
 
# File 'lib/active_scaffold/data_structures/column.rb', line 90

def update_columns
  @update_columns
end

#weight ⇒ Object

to modify the default order of columns



292
293
294
 
# File 'lib/active_scaffold/data_structures/column.rb', line 292

def weight
  @weight
end

Instance Method Details

#<=>(other) ⇒ Object 



424
425
426
427
 
# File 'lib/active_scaffold/data_structures/column.rb', line 424

def <=>(other)
  order_weight = weight <=> other.weight
  order_weight.nonzero? ? order_weight : name.to_s <=> other.name.to_s
end

#==(other) ⇒ Object

this is so that array.delete and array.include?, etc., will work by column name



356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/active_scaffold/data_structures/column.rb', line 356

def ==(other) #:nodoc:
  # another column
  if other.respond_to?(:name) && other.class == self.class
    name == other.name.to_sym
  elsif other.is_a? Symbol
    name == other
  elsif other.is_a? String
    name.to_s == other # avoid creating new symbols
  else # unknown
    eql? other
  end
end

#associated_number? ⇒ Boolean

Returns:

  • (Boolean) 


303
304
305
 
# File 'lib/active_scaffold/data_structures/column.rb', line 303

def associated_number?
  @associated_number
end

#attributes=(opts) ⇒ Object 



494
495
496
497
498
 
# File 'lib/active_scaffold/data_structures/column.rb', line 494

def attributes=(opts)
  opts.each do |setting, value|
    send "#{setting}=", value
  end
end

#autolink? ⇒ Boolean

set an action_link to nested list or inline form in this column

Returns:

  • (Boolean) 


225
226
227
 
# File 'lib/active_scaffold/data_structures/column.rb', line 225

def autolink?
  @autolink
end

#calculation? ⇒ Boolean

get whether to run a calculation on this column

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/active_scaffold/data_structures/column.rb', line 239

def calculation?
  !(@calculate == false || @calculate.nil?)
end

#cast(value) ⇒ Object 



500
501
502
 
# File 'lib/active_scaffold/data_structures/column.rb', line 500

def cast(value)
  ActiveScaffold::OrmChecks.cast active_record_class, name, value
end

#clear_link ⇒ Object

this should not only delete any existing link but also prevent column links from being automatically added by later routines



230
231
232
233
 
# File 'lib/active_scaffold/data_structures/column.rb', line 230

def clear_link
  @link = nil
  @autolink = false
end

#column_type ⇒ Object 



486
487
488
 
# File 'lib/active_scaffold/data_structures/column.rb', line 486

def column_type
  ActiveScaffold::OrmChecks.column_type active_record_class, name
end

#convert_to_native? ⇒ Boolean

Returns:

  • (Boolean) 


429
430
431
 
# File 'lib/active_scaffold/data_structures/column.rb', line 429

def convert_to_native?
  number? && options[:format] && form_ui != :number
end

#default_for_empty_value ⇒ Object 



454
455
456
457
458
459
460
461
462
463
 
# File 'lib/active_scaffold/data_structures/column.rb', line 454

def default_for_empty_value
  return nil unless column
  if column.is_a?(ActiveModel::Attribute)
    column.value
  elsif active_record?
    null? ? nil : column.default
  elsif mongoid?
    column.default_val
  end
end

#default_value ⇒ Object 



490
491
492
 
# File 'lib/active_scaffold/data_structures/column.rb', line 490

def default_value
  ActiveScaffold::OrmChecks.column_type active_record_class, name
end

#field ⇒ Object

the table.field name for this column, if applicable



474
475
476
 
# File 'lib/active_scaffold/data_structures/column.rb', line 474

def field
  @field ||= quoted_field(field_name)
end

#field_name ⇒ Object

just the field (not table.field)



419
420
421
422
 
# File 'lib/active_scaffold/data_structures/column.rb', line 419

def field_name
  return nil if virtual?
  @field_name ||= column ? quoted_field_name(column.name) : quoted_field_name(association.foreign_key)
end

#link ⇒ Object 



206
207
208
209
210
 
# File 'lib/active_scaffold/data_structures/column.rb', line 206

def link
  return @link.call(self) if frozen? && @link.is_a?(Proc)
  @link = @link.call(self) if @link.is_a? Proc
  @link
end

#list_ui ⇒ Object 



163
164
165
 
# File 'lib/active_scaffold/data_structures/column.rb', line 163

def list_ui
  @list_ui || form_ui
end

#list_ui=(value) ⇒ Object

value must be a Symbol, or an Array of list_ui and options hash which will be used with list_ui only



158
159
160
161
 
# File 'lib/active_scaffold/data_structures/column.rb', line 158

def list_ui=(value)
  check_valid_action_ui_params(value)
  @list_ui, @list_ui_options = *value
end

#list_ui_options ⇒ Object 



167
168
169
 
# File 'lib/active_scaffold/data_structures/column.rb', line 167

def list_ui_options
  @list_ui ? @list_ui_options : form_ui_options
end

#null? ⇒ Boolean

Returns:

  • (Boolean) 


465
466
467
468
469
470
471
 
# File 'lib/active_scaffold/data_structures/column.rb', line 465

def null?
  if active_record? && !column.is_a?(ActiveModel::Attribute)
    column&.null
  else
    true
  end
end

#number? ⇒ Boolean

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/active_scaffold/data_structures/column.rb', line 347

def number?
  @number
end

#number_to_native(value) ⇒ Object 



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/active_scaffold/data_structures/column.rb', line 433

def number_to_native(value)
  return value if value.blank? || !value.is_a?(String)
  native = '.' # native ruby separator
  format = {:separator => '', :delimiter => ''}.merge! I18n.t('number.format', :default => {})
  specific =
    case options[:format]
    when :currency
      I18n.t('number.currency.format', :default => nil)
    when :size
      I18n.t('number.human.format', :default => nil)
    when :percentage
      I18n.t('number.percentage.format', :default => nil)
    end
  format.merge! specific unless specific.nil?
  if format[:separator].blank? || !value.include?(format[:separator]) && value.include?(native) && (format[:delimiter] != native || value !~ /\.\d{3}$/)
    value
  else
    value.gsub(/[^0-9\-#{format[:separator]}]/, '').gsub(format[:separator], native)
  end
end

#params ⇒ Object

Any extra parameters this particular column uses. This is for create/update purposes.



35
36
37
38
 
# File 'lib/active_scaffold/data_structures/column.rb', line 35

def params
  return @params || NO_PARAMS if frozen?
  @params ||= NO_PARAMS.dup
end

#quoted_foreign_type ⇒ Object 



478
479
480
 
# File 'lib/active_scaffold/data_structures/column.rb', line 478

def quoted_foreign_type
  quoted_field(quoted_field_name(association.foreign_type))
end

#required?(action = nil) ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
85
86
87
88
 
# File 'lib/active_scaffold/data_structures/column.rb', line 82

def required?(action = nil)
  if action && @required
    @required == true || @required.include?(action)
  else
    @required
  end
end

#search_joins ⇒ Object

a collection of associations to do left join when this column is included on search



254
255
256
 
# File 'lib/active_scaffold/data_structures/column.rb', line 254

def search_joins
  @search_joins || @includes
end

#search_joins=(value) ⇒ Object 



258
259
260
261
262
263
264
 
# File 'lib/active_scaffold/data_structures/column.rb', line 258

def search_joins=(value)
  @search_joins =
    case value
    when Array then value
    else [value] # automatically convert to an array
    end
end

#search_sql ⇒ Object 



282
283
284
285
 
# File 'lib/active_scaffold/data_structures/column.rb', line 282

def search_sql
  initialize_search_sql if @search_sql == true
  @search_sql
end

#search_sql=(value) ⇒ Object

describes how to search on a column

search = true           default, uses intelligent search sql
search = "CONCAT(a, b)" define your own sql for searching. this should be the "left-side" of a WHERE condition. the operator and value will be supplied by ActiveScaffold.
search = [:a, :b]       searches in both fields



273
274
275
276
277
278
279
280
 
# File 'lib/active_scaffold/data_structures/column.rb', line 273

def search_sql=(value)
  @search_sql =
    if value
      value == true || value.is_a?(Proc) ? value : Array(value)
    else
      value
    end
end

#search_ui ⇒ Object 



191
192
193
 
# File 'lib/active_scaffold/data_structures/column.rb', line 191

def search_ui
  @search_ui || @form_ui || (:select if association && !association.polymorphic?)
end

#search_ui=(value) ⇒ Object

value must be a Symbol, or an Array of search_ui and options hash which will be used with search_ui only



186
187
188
189
 
# File 'lib/active_scaffold/data_structures/column.rb', line 186

def search_ui=(value)
  check_valid_action_ui_params(value)
  @search_ui, @search_ui_options = *value
end

#search_ui_options ⇒ Object 



195
196
197
 
# File 'lib/active_scaffold/data_structures/column.rb', line 195

def search_ui_options
  @search_ui ? @search_ui_options : form_ui_options
end

#searchable? ⇒ Boolean

Returns:

  • (Boolean) 


287
288
289
 
# File 'lib/active_scaffold/data_structures/column.rb', line 287

def searchable?
  search_sql.present?
end

#set_link(action, options = {}) ⇒ Object

associate an action_link with this column



213
214
215
216
217
218
219
220
221
222
 
# File 'lib/active_scaffold/data_structures/column.rb', line 213

def set_link(action, options = {})
  if action.is_a?(ActiveScaffold::DataStructures::ActionLink) || (action.is_a? Proc)
    @link = action
  else
    options[:label] ||= label
    options[:position] ||= :after unless options.key?(:position)
    options[:type] ||= :member
    @link = ActiveScaffold::DataStructures::ActionLink.new(action, options)
  end
end

#show_blank_record?(associated) ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
317
318
 
# File 'lib/active_scaffold/data_structures/column.rb', line 314

def show_blank_record?(associated)
  return false unless @show_blank_record
  return false unless association.klass.authorized_for?(:crud_type => :create) && !association.readonly?
  association.collection? || (association.singular? && associated.blank?)
end

#show_ui ⇒ Object 



177
178
179
 
# File 'lib/active_scaffold/data_structures/column.rb', line 177

def show_ui
  @show_ui || list_ui
end

#show_ui=(value) ⇒ Object

value must be a Symbol, or an Array of show_ui and options hash which will be used with show_ui only



172
173
174
175
 
# File 'lib/active_scaffold/data_structures/column.rb', line 172

def show_ui=(value)
  check_valid_action_ui_params(value)
  @show_ui, @show_ui_options = *value
end

#show_ui_options ⇒ Object 



181
182
183
 
# File 'lib/active_scaffold/data_structures/column.rb', line 181

def show_ui_options
  @show_ui ? @show_ui_options : list_ui_options
end

#sort ⇒ Object 



130
131
132
133
 
# File 'lib/active_scaffold/data_structures/column.rb', line 130

def sort
  initialize_sort if @sort == true
  @sort
end

#sort=(value) ⇒ Object

sorting on a column can be configured four ways:

sort = true               default, uses intelligent sorting sql default
sort = false              sometimes sorting doesn't make sense
sort = {:sql => ""}       define your own sql for sorting. this should be result in a sortable value in SQL. ActiveScaffold will handle the ascending/descending.
sort = {:method => ""}    define ruby-side code for sorting. this is SLOW with large recordsets!



121
122
123
124
125
126
127
128
 
# File 'lib/active_scaffold/data_structures/column.rb', line 121

def sort=(value)
  if value.is_a? Hash
    value.assert_valid_keys(:sql, :method)
    @sort = value
  else
    @sort = value ? true : false # force true or false
  end
end

#sort_by(options) ⇒ Object

a configuration helper for the self.sort property. simply provides a method syntax instead of setter syntax.



140
141
142
 
# File 'lib/active_scaffold/data_structures/column.rb', line 140

def sort_by(options)
  self.sort = options
end

#sortable? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/active_scaffold/data_structures/column.rb', line 135

def sortable?
  sort != false && !sort.nil?
end

#text? ⇒ Boolean

Returns:

  • (Boolean) 


351
352
353
 
# File 'lib/active_scaffold/data_structures/column.rb', line 351

def text?
  @text
end

#type_for_attribute ⇒ Object 



482
483
484
 
# File 'lib/active_scaffold/data_structures/column.rb', line 482

def type_for_attribute
  ActiveScaffold::OrmChecks.type_for_attribute active_record_class, name
end

#virtual? ⇒ Boolean

an interpreted property. the column is virtual if it isn’t from the active record model or any associated models

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/active_scaffold/data_structures/column.rb', line 342

def virtual?
  column.nil? && association.nil?
end