Class: ActiveScaffold::DataStructures::Column

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

Constant Summary collapse

@@associated_limit = 
3
@@associated_number = 
true
@@show_blank_record = 
true
[:new, :edit, :show]
@@association_form_ui = 
nil

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Configurable

#configure, #method_missing

Constructor Details

#initialize(name, active_record_class) ⇒ Column

instantiation is handled internally through the DataStructures::Columns object



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
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/active_scaffold/data_structures/column.rb', line 321

def initialize(name, active_record_class) #:nodoc:
  self.name = name.to_sym
  @tableless = active_record_class < ActiveScaffold::Tableless
  @column = active_record_class.columns_hash[self.name.to_s]
  @association = active_record_class.reflect_on_association(self.name)
  @autolink = !@association.nil?
  @active_record_class = active_record_class
  @table = active_record_class.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 @association
  @select_columns = default_select_columns

  @text = @column.nil? || [:string, :text].include?(@column.type)
  if @column
    @form_ui = case @column.type
      when :boolean then :checkbox
      when :text then :textarea
    end
    if @column.number?
      @number = true
      @form_ui = :number
      @options = {:format => :i18n_number}
    end
  end
  @allow_add_existing = true
  @form_ui = self.class.association_form_ui if @association && self.class.association_form_ui

  if association && !polymorphic_association?
    self.includes = [association.name]
    self.search_joins = includes.clone
  end

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



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

def actions_for_association_links
  @actions_for_association_links
end

#active_record_class ⇒ Object (readonly)

Returns the value of attribute active_record_class.



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

def active_record_class
  @active_record_class
end

#allow_add_existing ⇒ Object

Whether to enable add_existing for this column



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

def allow_add_existing
  @allow_add_existing
end

#associated_limit ⇒ Object

Returns the value of attribute associated_limit.



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

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.



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

def associated_number=(value)
  @associated_number = value
end

#association ⇒ Object (readonly)

the association from the ActiveRecord class



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

def association
  @association
end

#calculate ⇒ Object

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



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

def calculate
  @calculate
end

#collapsed ⇒ Object

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



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

def collapsed
  @collapsed
end

#column ⇒ Object (readonly)

the ConnectionAdapter::*Column object from the ActiveRecord class



263
264
265
 
# File 'lib/active_scaffold/data_structures/column.rb', line 263

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.



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

def css_class
  @css_class
end

#description ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/active_scaffold/data_structures/column.rb', line 43

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.



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

def form_ui
  @form_ui
end

#includes ⇒ Object

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



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

def includes
  @includes
end

#inplace_edit ⇒ Object

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



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

def inplace_edit
  @inplace_edit
end

#inplace_edit_update ⇒ Object

Returns the value of attribute inplace_edit_update.



17
18
19
 
# File 'lib/active_scaffold/data_structures/column.rb', line 17

def inplace_edit_update
  @inplace_edit_update
end

#label ⇒ Object 



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

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



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

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.



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

def name
  @name
end

#number=(value) ⇒ Object (writeonly)

Sets the attribute number

Parameters:

  • value —

    the value to set the attribute number to.



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

def number=(value)
  @number = value
end

#numerical_constraints ⇒ Object

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



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

def numerical_constraints
  @numerical_constraints
end

#options ⇒ Object

a place to store dev’s column specific options



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

def options
  @options
end

#placeholder ⇒ Object 



53
54
55
 
# File 'lib/active_scaffold/data_structures/column.rb', line 53

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



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

def required=(value)
  @required = value
end

#search_ui ⇒ Object 



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

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



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

def select_associated_columns
  @select_associated_columns
end

#select_columns ⇒ Object

What columns load from main table



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

def select_columns
  @select_columns
end

#send_form_on_update_column ⇒ Object

Returns the value of attribute send_form_on_update_column.



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

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.



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

def show_blank_record=(value)
  @show_blank_record = value
end

#show_ui ⇒ Object 



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

def show_ui
  @show_ui || list_ui
end

#update_columns ⇒ Object

Returns the value of attribute update_columns.



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

def update_columns
  @update_columns
end

#weight ⇒ Object

to modify the default order of columns



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

def weight
  @weight
end

Instance Method Details

#<=>(other) ⇒ Object 



373
374
375
376
 
# File 'lib/active_scaffold/data_structures/column.rb', line 373

def <=>(other)
  order_weight = weight <=> other.weight
  order_weight != 0 ? 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



307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/active_scaffold/data_structures/column.rb', line 307

def ==(other) #:nodoc:
  # another column
  if other.respond_to?(:name) && other.class == self.class
    name == other.name.to_sym
  # a string or symbol
  elsif other.respond_to? :to_sym
    name == other.to_sym rescue false # catch "interning empty string"
  # unknown
  else
    self.eql? other
  end
end

#associated_number? ⇒ Boolean

Returns:

  • (Boolean) 


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

def associated_number?
  @associated_number
end

#autolink? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

def autolink?
  @autolink
end

#calculation? ⇒ Boolean

get whether to run a calculation on this column

Returns:

  • (Boolean) 


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

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



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

def clear_link
  @link = nil
  @autolink = false
end

#field ⇒ Object

the table.field name for this column, if applicable



405
406
407
 
# File 'lib/active_scaffold/data_structures/column.rb', line 405

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

#field_name ⇒ Object

just the field (not table.field)



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

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

#link ⇒ Object 



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

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

#list_ui ⇒ Object 



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

def list_ui
  @list_ui || form_ui
end

#list_ui=(value) ⇒ Object 



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

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

#number? ⇒ Boolean

Returns:

  • (Boolean) 


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

def number?
  @number
end

#number_to_native(value) ⇒ Object 



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/active_scaffold/data_structures/column.rb', line 378

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.



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

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

#plural_association? ⇒ Boolean

Returns:

  • (Boolean) 


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

def plural_association?
  association && association.collection?
end

#polymorphic_association? ⇒ Boolean

Returns:

  • (Boolean) 


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

def polymorphic_association?
  association && association.options[:polymorphic]
end

#readonly_association? ⇒ Boolean

Returns:

  • (Boolean) 


283
284
285
286
287
288
289
290
 
# File 'lib/active_scaffold/data_structures/column.rb', line 283

def readonly_association?
  return false unless association
  if association.options.key? :readonly
    association.options[:readonly]
  else
    self.through_association?
  end
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


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

def required?
  @required
end

#search_joins ⇒ Object

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



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

def search_joins
  @search_joins || @includes
end

#search_joins=(value) ⇒ Object 



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

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

#search_sql ⇒ Object 



215
216
217
218
 
# File 'lib/active_scaffold/data_structures/column.rb', line 215

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



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

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) 


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

def searchable?
  search_sql.present?
end

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

associate an action_link with this column



148
149
150
151
152
153
154
155
156
157
 
# File 'lib/active_scaffold/data_structures/column.rb', line 148

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) 


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

def show_blank_record?(associated)
  return false unless @show_blank_record
  return false unless association.klass.authorized_for?(:crud_type => :create) && !association.options[:readonly]
  self.plural_association? || (self.singular_association? && associated.blank?)
end

#singular_association? ⇒ Boolean

Returns:

  • (Boolean) 


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

def singular_association?
  association && !association.collection?
end

#sort ⇒ Object 



94
95
96
97
 
# File 'lib/active_scaffold/data_structures/column.rb', line 94

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!



85
86
87
88
89
90
91
92
 
# File 'lib/active_scaffold/data_structures/column.rb', line 85

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.



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

def sort_by(options)
  self.sort = options
end

#sortable? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#text? ⇒ Boolean

Returns:

  • (Boolean) 


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

def text?
  @text
end

#through_association? ⇒ Boolean

Returns:

  • (Boolean) 


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

def through_association?
  association && association.options[:through]
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) 


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

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