Class: LeapCli::Config::ObjectList

Inherits:
Hash
  • Object
show all
Includes:
TSort
Defined in:
lib/leap_cli/config/object_list.rb

Overview

A list of Config::Object instances (internally stored as a hash)

Instance Method Summary collapse

Methods inherited from Hash

#deep_merge, #deep_merge!, #pick

Constructor Details

#initialize(config = nil) ⇒ ObjectList

Returns a new instance of ObjectList.



11
12
13
14
15
 
# File 'lib/leap_cli/config/object_list.rb', line 11

def initialize(config=nil)
  if config
    self.add(config['name'], config)
  end
end

Instance Method Details

#[](key) ⇒ Object

If the key is a string, the Config::Object it references is returned.

If the key is a hash, we treat it as a condition and filter all the Config::Objects using the condition. A new ObjectList is returned.

Examples:

nodes

node named 'vpn1'

nodes[:public_dns => true]

all nodes with public dns

nodes[:services => ‘openvpn’, :services => ‘tor’]

nodes with openvpn OR tor service

nodes[:services => ‘openvpn’][:tags => ‘production’]

nodes with openvpn AND are production



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/leap_cli/config/object_list.rb', line 37

def [](key)
  if key.is_a? Hash
    results = Config::ObjectList.new
    key.each do |field, match_value|
      field = field.is_a?(Symbol) ? field.to_s : field
      match_value = match_value.is_a?(Symbol) ? match_value.to_s : match_value
      if match_value.is_a?(String) && match_value =~ /^!/
        operator = :not_equal
        match_value = match_value.sub(/^!/, '')
      else
        operator = :equal
      end
      each do |name, config|
        value = config[field]
        if value.is_a? Array
          if operator == :equal && value.include?(match_value)
            results[name] = config
          elsif operator == :not_equal && !value.include?(match_value)
            results[name] = config
          end
        else
          if operator == :equal && value == match_value
            results[name] = config
          elsif operator == :not_equal && value != match_value
            results[name] = config
          end
        end
      end
    end
    results
  else
    super key.to_s
  end
end

#add(name, object) ⇒ Object

def <<(object)

if object.is_a? Config::ObjectList
  self.merge!(object)
elsif object['name']
  self[object['name']] = object
else
  raise ArgumentError.new('argument must be a Config::Object or a Config::ObjectList')
end

end



94
95
96
 
# File 'lib/leap_cli/config/object_list.rb', line 94

def add(name, object)
  self[name] = object
end

#each_node(&block) ⇒ Object 



78
79
80
81
82
 
# File 'lib/leap_cli/config/object_list.rb', line 78

def each_node(&block)
  self.keys.sort.each do |node_name|
    yield self[node_name]
  end
end

#exclude(node) ⇒ Object 



72
73
74
75
76
 
# File 'lib/leap_cli/config/object_list.rb', line 72

def exclude(node)
  list = self.dup
  list.delete(node.name)
  return list
end

#field(field) ⇒ Object

like fields(), but returns an array of values instead of an array of hashes.



112
113
114
115
116
117
118
119
 
# File 'lib/leap_cli/config/object_list.rb', line 112

def field(field)
  field = field.to_s
  result = []
  keys.sort.each do |name|
    result << self[name].get(field)
  end
  result
end

#fields(*fields) ⇒ Object

converts the hash of configs into an array of hashes, with ONLY the specified fields



101
102
103
104
105
106
107
 
# File 'lib/leap_cli/config/object_list.rb', line 101

def fields(*fields)
  result = []
  keys.sort.each do |name|
    result << self[name].pick(*fields)
  end
  result
end

#inherit_from!(object_list) ⇒ Object

applies inherit_from! to all objects.



167
168
169
170
171
172
173
174
175
 
# File 'lib/leap_cli/config/object_list.rb', line 167

def inherit_from!(object_list)
  object_list.each do |name, object|
    if self[name]
      self[name].inherit_from!(object)
    else
      self[name] = object.dup
    end
  end
end

#names_in_test_dependency_order ⇒ Object 



188
189
190
 
# File 'lib/leap_cli/config/object_list.rb', line 188

def names_in_test_dependency_order
  self.tsort
end

#pick_fields(*fields) ⇒ Object

pick_fields(field1, field2, …)

generates a Hash from the object list, but with only the fields that are picked.

If there are more than one field, then the result is a Hash of Hashes. If there is just one field, it is a simple map to the value.

For example:

"neighbors" = "= nodes_like_me[:services => :couchdb].pick_fields('domain.full', 'ip_address')"

generates this:

neighbors:
  couch1:
    domain_full: couch1.bitmask.net
    ip_address: "10.5.5.44"
  couch2:
    domain_full: couch2.bitmask.net
    ip_address: "10.5.5.52"

But this:

"neighbors": "= nodes_like_me[:services => :couchdb].pick_fields('domain.full')"

will generate this:

neighbors:
  couch1: couch1.bitmask.net
  couch2: couch2.bitmask.net



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/leap_cli/config/object_list.rb', line 153

def pick_fields(*fields)
  self.values.inject({}) do |hsh, node|
    value = self[node.name].pick(*fields)
    if fields.size == 1
      value = value.values.first
    end
    hsh[node.name] = value
    hsh
  end
end

#tsort_each_child(node_name, &block) ⇒ Object 



184
185
186
 
# File 'lib/leap_cli/config/object_list.rb', line 184

def tsort_each_child(node_name, &block)
  self[node_name].test_dependencies.each(&block)
end

#tsort_each_node(&block) ⇒ Object

topographical sort based on test dependency



180
181
182
 
# File 'lib/leap_cli/config/object_list.rb', line 180

def tsort_each_node(&block)
  self.each_key(&block)
end