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.



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

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 146

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

Instance Attribute Details

#default_type ⇒ Object

Returns the value of attribute default_type.



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

def default_type
  @default_type
end

#label ⇒ Object 



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

def label
  as_(@label) if @label
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#weight ⇒ Object

Returns the value of attribute weight.



158
159
160
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 158

def weight
  @weight
end

Instance Method Details

#[](val) ⇒ Object

finds an ActionLink by matching the action



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 48

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.to_s == 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



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

def add(action, options = {})
  link = if action.is_a?(ActiveScaffold::DataStructures::ActionLink) || action.is_a?(ActiveScaffold::DataStructures::ActionLinks)
    action
  else
    options[:type] ||= default_type if default_type
    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



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

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 



34
35
36
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 34

def add_to_set(link)
  @set << link
end

#collect ⇒ Object 



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

def collect
  @set
end

#collect_by_type(type = nil) ⇒ Object 



111
112
113
114
115
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 111

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

#delete(val) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 74

def delete(val)
  self.each({:include_set => true}) do |link, set|
    if link.action.to_s == val.to_s
      set.delete link
      break
    end
  end
end

#delete_group(name) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 83

def delete_group(name)
  @set.each do |group|
    if group.name == name
      @set.delete group
      break
    else
      group.delete_group(name)
      break
    end if group.is_a?(ActiveScaffold::DataStructures::ActionLinks)
  end
end

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

iterates over the links, possibly by type



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 96

def each(options = {}, &block)
  method = options[:reverse] ? :reverse_each : :each
  @set.sort_by(&:weight).send(method) do |item|
    if item.is_a?(ActiveScaffold::DataStructures::ActionLinks) && !options[:groups]
      item.each(options, &block)
    else
      if options[:include_set]
        yield item, @set
      else
        yield item
      end
    end
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


121
122
123
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 121

def empty?
  @set.size == 0
end

#find_duplicate(link) ⇒ Object 



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

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 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/active_scaffold/data_structures/action_links.rb', line 125

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
    group.default_type = self.name == :root ? (name.to_sym if %w(member collection).include?(name.to_s)) : default_type
    add_to_set group
  end
  group
end