Class: ActiveScaffold::DataStructures::ActionLinks

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/active_scaffold/data_structures/action_links.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ActionLinks

Returns a new instance of ActionLinks.



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

def initialize
  @set = []
  @name = :root
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 160

def method_missing(name, *args, &block)
  class_eval %{
    def #{name}
      @#{name} ||= subgroup('#{name}'.to_sym)
      yield @#{name} if block_given?
      @#{name}
    end
  }
  send(name, &block)
end

Instance Attribute Details

#label ⇒ Object 



156
157
158
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 156

def label
  as_(@label) if @label
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

Instance Method Details

#[](val) ⇒ Object

finds an ActionLink by matching the action



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 45

def [](val)
  links = []
  @set.each do |item|
    if item.is_a?(ActiveScaffold::DataStructures::ActionLinks)
      collected = item[val]
      links << collected unless collected.nil?
    else
      links << item if item.action == val.to_s
    end
  end
  links.first
end

#add(action, options = {}) ⇒ Object Also known as: <<

adds an ActionLink, creating one from the arguments if need be



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 11

def add(action, options = {})
  link = if action.is_a?(ActiveScaffold::DataStructures::ActionLink) || action.is_a?(ActiveScaffold::DataStructures::ActionLinks)
    action
  else
    ActiveScaffold::DataStructures::ActionLink.new(action, options)
  end
  # NOTE: this duplicate check should be done by defining the comparison operator for an Action data structure
  existing = find_duplicate(link)
  unless existing
    # That s for backwards compatibility if we are in root of action_links
    # we have to move actionlink into members or collection subgroup
    group = (name == :root ? subgroup(link.type, link.type) : self)
    group.add_to_set(link)
    link
  else
    existing
  end
end

#add_to_group(link, group = nil) ⇒ Object

adds a link to a specific group groups are represented as a string separated by a dot eg member.crud



38
39
40
41
42
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 38

def add_to_group(link, group = nil)
  add_to = root
  add_to = group.split('.').inject(root){|group, group_name| group.send(group_name)} if group
  add_to << link unless link.nil?
end

#add_to_set(link) ⇒ Object 



31
32
33
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 31

def add_to_set(link)
  @set << link
end

#collect ⇒ Object 



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

def collect
  @set
end

#collect_by_type(type = nil) ⇒ Object 



104
105
106
107
108
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 104

def collect_by_type(type = nil)
  links = []
  subgroup(type).each(type) {|link| links << link}
  links
end

#delete(val) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 71

def delete(val)
  self.each({:include_set => true}) do |link, set|
    if link.action == val.to_s
      set.delete_if {|item| item.is_a?(ActiveScaffold::DataStructures::ActionLink) && item.action == val.to_s}
    end
  end
end

#delete_group(name) ⇒ Object 



79
80
81
82
83
84
85
86
87
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 79

def delete_group(name)
  @set.each do |group|
    if group.name == name
      @set.delete_if {|item| item.is_a?(ActiveScaffold::DataStructures::ActionLinks) && item.name == name}
    else
      group.delete_group(name)
    end if group.is_a?(ActiveScaffold::DataStructures::ActionLinks)
  end
end

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

iterates over the links, possibly by type



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 90

def each(options = {}, &block)
  @set.each {|item|
    if item.is_a?(ActiveScaffold::DataStructures::ActionLinks)
      item.each(options, &block)
    else
      if options[:include_set]
        yield item, @set
      else
        yield item
      end
    end
  }
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


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

def empty?
  @set.size == 0
end

#find_duplicate(link) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 58

def find_duplicate(link)
  links = []
  @set.each do |item|
    if item.is_a?(ActiveScaffold::DataStructures::ActionLinks)
      collected = item.find_duplicate(link)
      links << collected unless collected.nil?
    else
      links << item if item.action == link.action and item.static_controller? && item.controller == link.controller and item.parameters == link.parameters
    end
  end
  links.first
end

#subgroup(name, label = nil) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 140

def subgroup(name, label = nil)
  group = self if name == self.name
  group ||= @set.find do |item|
    name == item.name if item.is_a?(ActiveScaffold::DataStructures::ActionLinks)
  end

  if group.nil?
    group = ActiveScaffold::DataStructures::ActionLinks.new
    group.label = label || name
    group.name = name
    add_to_set group
  end
  group
end

#traverse(controller, options = {}, &block) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 110

def traverse(controller, options = {}, &block)
  traverse_method = options.delete(:reverse).nil? ? :each : :reverse_each
  options[:level] ||= -1
  options[:level] += 1
  first_action = true
  @set.send(traverse_method) do |link|
    if link.is_a?(ActiveScaffold::DataStructures::ActionLinks)
      unless link.empty?
        yield(link, nil, {:node => :start_traversing, :first_action => first_action, :level => options[:level]})
        link.traverse(controller,options, &block)
        yield(link, nil, {:node => :finished_traversing, :first_action => first_action, :level => options[:level]})
        first_action = false
      end
    elsif controller.nil? || !skip_action_link(controller, link, *(Array(options[:for])))
      authorized = options[:for].nil? ? true : options[:for].authorized_for?(:crud_type => link.crud_type, :action => link.action)
      yield(self, link, {:authorized => authorized, :first_action => first_action, :level => options[:level]})
      first_action = false
    end
  end
  options[:level] -= 1
end