Class: ActiveScaffold::DataStructures::Column

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

Constant Summary collapse

@@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?, column_type, columns, columns_hash, content_columns, mongoid?, quoted_table_name, reflect_on_all_associations, table_name, tableless?, type_for_attribute

Methods included from Configurable

#configure, #method_missing

Constructor Details

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

instantiation is handled internally through the DataStructures::Columns object



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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/active_scaffold/data_structures/column.rb', line 304

def initialize(name, active_record_class, delegated_association = nil) #:nodoc:
  self.name = name.to_sym
  @active_record_class = active_record_class
  @column = _columns_hash[self.name.to_s]
  @delegated_association = delegated_association
  setup_association_info

  @autolink = self.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.clone if self.association
  @select_columns = default_select_columns

  @text = @column.nil? || [:string, :text, String].include?(column_type)
  @number = false
  if @column
    if active_record_class.respond_to?(:defined_enums) && active_record_class.defined_enums[name.to_s]
      @form_ui = :select
      @options = {:options => active_record_class.send(name.to_s.pluralize).keys.map(&:to_sym)}
    elsif column_number?
      @number = true
      @form_ui = :number
      @options = {:format => :i18n_number}
    else
      @form_ui = case @column.type
                 when :boolean then :checkbox
                 when :text then :textarea
      end
    end
  end
  @allow_add_existing = true
  @form_ui = self.class.association_form_ui if @association && self.class.association_form_ui

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

  # default all the configurable variables
  self.css_class = ''
  self.required = active_record_class.validators_on(self.name).any? do |val|
    validator_force_required?(val)
  end
  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.



257
258
259
 
# File 'lib/active_scaffold/data_structures/column.rb', line 257

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.



6
7
8
 
# File 'lib/active_scaffold/data_structures/column.rb', line 6

def active_record_class
  @active_record_class
end

#allow_add_existing ⇒ Object

Whether to enable add_existing for this column



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

def allow_add_existing
  @allow_add_existing
end

#associated_limit ⇒ Object

Returns the value of attribute associated_limit.



234
235
236
 
# File 'lib/active_scaffold/data_structures/column.rb', line 234

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.



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

def associated_number=(value)
  @associated_number = value
end

#association ⇒ Object (readonly)

the association from the ActiveRecord class



270
271
272
 
# File 'lib/active_scaffold/data_structures/column.rb', line 270

def association
  @association
end

#calculate ⇒ Object

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



175
176
177
 
# File 'lib/active_scaffold/data_structures/column.rb', line 175

def calculate
  @calculate
end

#collapsed ⇒ Object

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



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

def collapsed
  @collapsed
end

#column ⇒ Object (readonly)

the ConnectionAdapter::*Column object from the ActiveRecord class



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

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.



62
63
64
 
# File 'lib/active_scaffold/data_structures/column.rb', line 62

def css_class
  @css_class
end

#delegated_association ⇒ Object (readonly)

the singular association which this column belongs to



273
274
275
 
# File 'lib/active_scaffold/data_structures/column.rb', line 273

def delegated_association
  @delegated_association
end

#description ⇒ Object 



47
48
49
50
51
52
53
 
# File 'lib/active_scaffold/data_structures/column.rb', line 47

def description
  if @description
    @description
  else
    I18n.t name, :scope => [:activerecord, :description, active_record_class.to_s.underscore.to_sym], :default => ''
  end
end

#form_ui ⇒ Object

Returns the value of attribute form_ui.



119
120
121
 
# File 'lib/active_scaffold/data_structures/column.rb', line 119

def form_ui
  @form_ui
end

#includes ⇒ Object

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



183
184
185
 
# File 'lib/active_scaffold/data_structures/column.rb', line 183

def includes
  @includes
end

#inplace_edit ⇒ Object

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



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

def inplace_edit
  @inplace_edit
end

#inplace_edit_update ⇒ Object

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



21
22
23
 
# File 'lib/active_scaffold/data_structures/column.rb', line 21

def inplace_edit_update
  @inplace_edit_update
end

#label ⇒ Object 



41
42
43
 
# File 'lib/active_scaffold/data_structures/column.rb', line 41

def label
  as_(@label) || active_record_class.human_attribute_name(name.to_s)
end

#list_method ⇒ Object

to cache method to get value in list



389
390
391
 
# File 'lib/active_scaffold/data_structures/column.rb', line 389

def list_method
  @list_method
end

#name ⇒ Object

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.



10
11
12
 
# File 'lib/active_scaffold/data_structures/column.rb', line 10

def name
  @name
end

#number=(value) ⇒ Object (writeonly)

Sets the attribute number

Parameters:

  • value —

    the value to set the attribute number to.



280
281
282
 
# File 'lib/active_scaffold/data_structures/column.rb', line 280

def number=(value)
  @number = value
end

#numerical_constraints ⇒ Object

cache constraints for numeric columns (get in ActiveScaffold::Helpers::FormColumnHelpers::numerical_constraints_for_column)



392
393
394
 
# File 'lib/active_scaffold/data_structures/column.rb', line 392

def numerical_constraints
  @numerical_constraints
end

#options ⇒ Object 



142
143
144
 
# File 'lib/active_scaffold/data_structures/column.rb', line 142

def options
  @options ||= {}
end

#placeholder ⇒ Object 



57
58
59
 
# File 'lib/active_scaffold/data_structures/column.rb', line 57

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



66
67
68
 
# File 'lib/active_scaffold/data_structures/column.rb', line 66

def required=(value)
  @required = value
end

#search_ui ⇒ Object 



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

def search_ui
  @search_ui || @form_ui || (:select if association && !association.polymorphic?)
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



204
205
206
 
# File 'lib/active_scaffold/data_structures/column.rb', line 204

def select_associated_columns
  @select_associated_columns
end

#select_columns ⇒ Object

What columns load from main table



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

def select_columns
  @select_columns
end

#send_form_on_update_column ⇒ Object

Returns the value of attribute send_form_on_update_column.



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

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.



247
248
249
 
# File 'lib/active_scaffold/data_structures/column.rb', line 247

def show_blank_record=(value)
  @show_blank_record = value
end

#show_ui ⇒ Object 



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

def show_ui
  @show_ui || list_ui
end

#update_columns ⇒ Object

Returns the value of attribute update_columns.



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

def update_columns
  @update_columns
end

#weight ⇒ Object

to modify the default order of columns



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

def weight
  @weight
end

Instance Method Details

#<=>(other) ⇒ Object 



363
364
365
366
 
# File 'lib/active_scaffold/data_structures/column.rb', line 363

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



290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/active_scaffold/data_structures/column.rb', line 290

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) 


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

def associated_number?
  @associated_number
end

#autolink? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def autolink?
  @autolink
end

#calculation? ⇒ Boolean

get whether to run a calculation on this column

Returns:

  • (Boolean) 


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

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

#clear_link ⇒ Object

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



169
170
171
172
 
# File 'lib/active_scaffold/data_structures/column.rb', line 169

def clear_link
  @link = nil
  @autolink = false
end

#column_type ⇒ Object 



403
404
405
 
# File 'lib/active_scaffold/data_structures/column.rb', line 403

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

#field ⇒ Object

the table.field name for this column, if applicable



395
396
397
 
# File 'lib/active_scaffold/data_structures/column.rb', line 395

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

#field_name ⇒ Object

just the field (not table.field)



358
359
360
361
 
# File 'lib/active_scaffold/data_structures/column.rb', line 358

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

#link ⇒ Object 



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

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

#list_ui ⇒ Object 



126
127
128
 
# File 'lib/active_scaffold/data_structures/column.rb', line 126

def list_ui
  @list_ui || form_ui
end

#list_ui=(value) ⇒ Object 



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

def list_ui=(value)
  self.list_method = nil if value != @list_ui
  @list_ui = value
end

#number? ⇒ Boolean

Returns:

  • (Boolean) 


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

def number?
  @number
end

#number_to_native(value) ⇒ Object 



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/active_scaffold/data_structures/column.rb', line 368

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.



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

def params
  # lazy initialize
  @params ||= Set.new
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/active_scaffold/data_structures/column.rb', line 67

def required?
  @required
end

#search_joins ⇒ Object

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



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

def search_joins
  @search_joins || @includes
end

#search_joins=(value) ⇒ Object 



196
197
198
199
200
201
 
# File 'lib/active_scaffold/data_structures/column.rb', line 196

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

#search_sql ⇒ Object 



219
220
221
222
 
# File 'lib/active_scaffold/data_structures/column.rb', line 219

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



210
211
212
213
214
215
216
217
 
# File 'lib/active_scaffold/data_structures/column.rb', line 210

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

#searchable? ⇒ Boolean

Returns:

  • (Boolean) 


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

def searchable?
  search_sql.present?
end

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

associate an action_link with this column



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/active_scaffold/data_structures/column.rb', line 152

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) 


248
249
250
251
252
 
# File 'lib/active_scaffold/data_structures/column.rb', line 248

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

#sort ⇒ Object 



98
99
100
101
 
# File 'lib/active_scaffold/data_structures/column.rb', line 98

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!



89
90
91
92
93
94
95
96
 
# File 'lib/active_scaffold/data_structures/column.rb', line 89

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.



108
109
110
 
# File 'lib/active_scaffold/data_structures/column.rb', line 108

def sort_by(options)
  self.sort = options
end

#sortable? ⇒ Boolean

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/active_scaffold/data_structures/column.rb', line 103

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

#text? ⇒ Boolean

Returns:

  • (Boolean) 


285
286
287
 
# File 'lib/active_scaffold/data_structures/column.rb', line 285

def text?
  @text
end

#type_for_attribute ⇒ Object 



399
400
401
 
# File 'lib/active_scaffold/data_structures/column.rb', line 399

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) 


276
277
278
 
# File 'lib/active_scaffold/data_structures/column.rb', line 276

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