class ActiveScaffold::DataStructures::ActionColumns
A set of columns. These structures can be nested for organization.
Attributes
action[RW]
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.
collapsed[RW]
Whether this column set is collapsed by default in contexts where collapsing is supported
label[W]
labels are useful for the Create/Update forms, when we display columns in a grouped fashion and want to name them separately
Public Instance Methods
action_name()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 101 def action_name @action.user_settings_key end
add_subgroup(label, &proc)
click to toggle source
nests a subgroup in the column set
# File lib/active_scaffold/data_structures/action_columns.rb, line 38 def add_subgroup(label, &proc) columns = ActiveScaffold::DataStructures::ActionColumns.new columns.label = label columns.action = action columns.configure(&proc) exclude columns.collect_columns add columns end
columns_key()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 105 def columns_key "#{@action.core.model_id.to_s.underscore}-#{action_name}" end
constraint_columns()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 113 def constraint_columns ActiveScaffold::Registry.constraint_columns[columns_key] end
constraint_columns=(columns)
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 109 def constraint_columns=(columns) ActiveScaffold::Registry.constraint_columns[columns_key] = columns end
css_class()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 20 def css_class @label.to_s.underscore.gsub(/[^-_0-9a-zA-Z]/, '-') end
each_column(options = {}) { |item| ... }
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 70 def each_column(options = {}, &proc) columns = options[:core_columns] || action.core.columns self.unauthorized_columns = [] options[:for] ||= columns.active_record_class each do |item| if item.is_a? ActiveScaffold::DataStructures::ActionColumns if options[:flatten] item.each_column(options, &proc) elsif !options[:skip_groups] yield item end else next if skip_column?(item, options) yield columns[item] || ActiveScaffold::DataStructures::Column.new(item.to_sym, columns.active_record_class) end end end
include?(item)
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 47 def include?(item) @set.each do |c| return true if !c.is_a?(Symbol) && c.include?(item) return true if c == item.to_sym end false end
label()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 12 def label as_(@label) if @label end
length()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 125 def length ((@set - constraint_columns) - unauthorized_columns).length end
name()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 16 def name @label.to_s.underscore end
skip_column?(column_name, options)
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 59 def skip_column?(column_name, options) # skip if this matches a constrained column return 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] || action&.crud_type || :read, column: column_name) unauthorized_columns << column_name.to_sym return true end false end
to_a()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 55 def to_a Array(@set) end
visible_columns(options = {})
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 89 def visible_columns(options = {}) columns = [] each_column(options) do |column| columns << column end columns end
visible_columns_names(options = {})
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 97 def visible_columns_names(options = {}) visible_columns(options.reverse_merge(flatten: true)).map(&:name) end
Protected Instance Methods
collect_columns()
click to toggle source
# File lib/active_scaffold/data_structures/action_columns.rb, line 131 def collect_columns @set.collect { |col| col.is_a?(ActiveScaffold::DataStructures::ActionColumns) ? col.collect_columns : col } end
initialize_copy(from)
click to toggle source
called during clone or dup. makes the clone/dup deeper.
# File lib/active_scaffold/data_structures/action_columns.rb, line 136 def initialize_copy(from) @set = from.instance_variable_get('@set').clone end