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



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

def collapsed
  @collapsed
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 



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

def unauthorized_columns
  @unauthorized_columns ||= []
end

Instance Method Details

#==(other) ⇒ Object

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



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

def ==(other) #:nodoc:
  # another ActionColumns
  if other.class == self.class
    self.label == other.label
  else
    @label.to_s == other.to_s
  end
end

#action_name ⇒ Object 



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

def action_name
  @action.class.name.demodulize.underscore
end

#add_subgroup(label, &proc) ⇒ Object

nests a subgroup in the column set



36
37
38
39
40
41
42
43
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 36

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 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 91

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 || @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]
      columns += item.collect_visible(options, &proc)
    else
      columns << (block_given? ? yield(item) : item)
    end
  end
  columns
end

#constraint_columns ⇒ Object 



143
144
145
146
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 143

def constraint_columns
  constraints = Thread.current[:constraint_columns]
  (constraints[constraint_columns_key] if constraints) || []
end

#constraint_columns=(columns) ⇒ Object 



138
139
140
141
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 138

def constraint_columns=(columns)
  Thread.current[:constraint_columns] ||= {}
  Thread.current[:constraint_columns][constraint_columns_key] = columns
end

#constraint_columns_key ⇒ Object 



134
135
136
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 134

def constraint_columns_key
  "#{@action.core.model_id.to_s.underscore}-#{action_name}"
end

#css_class ⇒ Object 



18
19
20
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 18

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.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 71

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
      if options[:flatten]
        item.each(options, &proc)
      elsif !options[:skip_groups]
        yield item
      end
    else
      yield item
    end
  end
end

#include?(item) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
48
49
50
51
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 45

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 



153
154
155
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 153

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

#name ⇒ Object 



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

def name
  @label.to_s.underscore
end

#names ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 53

def names
  if @columns
    self.collect_visible(:flatten => true) { |c| c.name }
  else
    names_without_auth_check
  end
end

#names_without_auth_check ⇒ Object 



61
62
63
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 61

def names_without_auth_check
  Array(@set)
end

#set_columns(columns) ⇒ Object

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



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

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) 


109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/active_scaffold/data_structures/action_columns.rb', line 109

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.try(:crud_type) || :read, :column => column.name)
    self.unauthorized_columns << column.name.to_sym
    result = true
  end
  return result
end