Class: ActiveScaffold::DataStructures::ActionColumns

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

Overview

A set of columns. These structures can be nested for organization.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Configurable

#configure, #method_missing

Methods inherited from Set

#add, #empty?, #exclude, #find_by_name, #find_by_names, #initialize, #set_values

Constructor Details

This class inherits a constructor from ActiveScaffold::DataStructures::Set

Dynamic Method Handling

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

Instance Attribute Details

#action ⇒ Object

this lets us refer back to the action responsible for this link, if it exists. the immediate need here is to get the crud_type so we can dynamically filter columns from the set.



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

def action
  @action
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/action_columns.rb', line 20

def collapsed
  @collapsed
end

#constraint_columns ⇒ Object 



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

def constraint_columns
  @constraint_columns ||= []
end

#label ⇒ Object 



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

def label
  as_(@label) if @label
end

#unauthorized_columns ⇒ Object 



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

def unauthorized_columns
  @unauthorized_columns ||= []
end

Instance Method Details

#add_subgroup(label, &proc) ⇒ Object

nests a subgroup in the column set



23
24
25
26
27
28
29
30
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 23

def add_subgroup(label, &proc)
  columns = ActiveScaffold::DataStructures::ActionColumns.new
  columns.label = label
  columns.action = self.action
  columns.configure &proc
  self.exclude columns.collect_columns
  self.add columns
end

#collect_visible(options = {}, &proc) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 77

def collect_visible(options = {}, &proc)
  columns = []
  options[:for] ||= @columns.active_record_class
  self.unauthorized_columns = []
  @set.each do |item|
    unless item.is_a? ActiveScaffold::DataStructures::ActionColumns
      item = (@columns[item] || ActiveScaffold::DataStructures::Column.new(item.to_sym, @columns.active_record_class))
      next if self.skip_column?(item, options)
    end
    if item.is_a? ActiveScaffold::DataStructures::ActionColumns and options.has_key?(:flatten) and options[:flatten]
      columns = columns + item.collect(options, &proc)
    else
      columns << item
    end
  end
  columns
end

#css_class ⇒ Object 



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

def css_class
  @label.to_s.underscore
end

#each(options = {}, &proc) ⇒ Object

Redefine the each method to yield actual Column objects. It will skip constrained and unauthorized columns.

Options:

* :flatten - whether to recursively iterate on nested sets. default is false.
* :for - the record (or class) being iterated over. used for column-level security. default is the class.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 61

def each(options = {}, &proc)
  options[:for] ||= @columns.active_record_class unless @columns.nil?
  self.unauthorized_columns = []
  @set.each do |item|
    unless item.is_a?(ActiveScaffold::DataStructures::ActionColumns) || @columns.nil?
      item = (@columns[item] || ActiveScaffold::DataStructures::Column.new(item.to_sym, @columns.active_record_class))
      next if self.skip_column?(item, options)
    end
    if item.is_a? ActiveScaffold::DataStructures::ActionColumns and options.has_key?(:flatten) and options[:flatten]
      item.each(options, &proc)
    else
      yield item
    end
  end
end

#include?(item) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
36
37
38
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 32

def include?(item)
  @set.each do |c|
    return true if !c.is_a? Symbol and c.include? item
    return true if c == item.to_sym
  end
  return false
end

#length ⇒ Object 



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

def length
  ((@set - self.constraint_columns) - self.unauthorized_columns).length
end

#names ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 40

def names
  if @columns
    self.collect(&:name)
  else
    names_without_auth_check
  end
end

#names_without_auth_check ⇒ Object 



48
49
50
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 48

def names_without_auth_check
  Array(@set)
end

#set_columns(columns) ⇒ Object

registers a set of column objects (recursively, for all nested ActionColumns)



108
109
110
111
112
113
114
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 108

def set_columns(columns)
  @columns = columns
  # iterate over @set instead of self to avoid dealing with security queries
  @set.each do |item|
    item.set_columns(columns) if item.respond_to? :set_columns
  end
end

#skip_column?(column, options) ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 95

def skip_column?(column, options)
  result = false
  # skip if this matches a constrained column
  result = true if constraint_columns.include?(column.name.to_sym)
  # skip this field if it's not authorized
  unless options[:for].authorized_for?(:action => options[:action], :crud_type => options[:crud_type] || self.action.crud_type, :column => column.name)
    self.unauthorized_columns << column.name.to_sym
    result = true
  end
  return result
end