Class: Connect::ValuesTable

Inherits:
Object
  • Object
show all
Defined in:
lib/connect/values_table.rb

Overview

A list of values that are indexed by a key name. The list can contain different kind of elements

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ValuesTable

Returns a new instance of ValuesTable.



15
16
17
 
# File 'lib/connect/values_table.rb', line 15

def initialize
  @values_table = {}
end

Class Method Details

.object_reference_entry(name, object_type, object_name, selector = nil, xref = nil) ⇒ Hash

Create a object reference entry for the value table.

Parameters:

  • name (String) —

    the name of the entry

  • object_type (String) —

    the object type to be referenced

  • object_name (String) —

    the object name to be referenced

  • selector (String) (defaults to: nil) —

    the selector to be applied

Returns:

  • (Hash) —

    a Hash containing the name and the entry for the table



162
163
164
 
# File 'lib/connect/values_table.rb', line 162

def self.object_reference_entry(name, object_type, object_name, selector = nil, xref = nil)
  { name => Entry::ObjectReference.new(object_type, object_name, selector, xref) }
end

.reference_entry(name, reference, selector = nil, xref = nil) ⇒ Hash

Create a reference entry for the value table.

Parameters:

  • name (String) —

    the name of the entry

  • reference (Any) —

    the value to be referenced

  • selector (String) (defaults to: nil) —

    the selector to be applied

Returns:

  • (Hash) —

    a Hash containing the name and the entry for the table



148
149
150
 
# File 'lib/connect/values_table.rb', line 148

def self.reference_entry(name, reference, selector = nil, xref = nil)
  { name => Entry::Reference.new(reference, selector, xref) }
end

.value_entry(name, value, selector = nil, xref = nil) ⇒ Hash

Create a value entry for the value table.

Parameters:

  • name (String) —

    the name/ket of the entry

  • value (Any) —

    the value to be stored

  • selector (String) (defaults to: nil) —

    the selector to be applied

Returns:

  • (Hash) —

    a Hash containing the name and the entry for the table



135
136
137
 
# File 'lib/connect/values_table.rb', line 135

def self.value_entry(name, value, selector = nil, xref = nil)
  { name => Entry::Value.new(value, selector, xref) }
end

Instance Method Details

#add(entry) ⇒ Object

Add an entry to the values tables

Parameters:

  • entry (Connect::Entries::Base) —

    an entry to add to the tabke



71
72
73
74
75
76
77
 
# File 'lib/connect/values_table.rb', line 71

def add(entry)
  if exists?(entry)
    @values_table[entry.keys.first].merge!(entry.values.first)
  else
    @values_table.merge!(entry)
  end
end

#definitions(parameter) ⇒ Object

return the array of defintions for the specfied parameter



36
37
38
39
 
# File 'lib/connect/values_table.rb', line 36

def definitions(parameter)
  entry = @values_table.fetch(parameter) { fail "internal error. Parameter entry #{parameter} not found" }
  entry.xref.collect {|e| e.class == Connect::Xdef ? [e.file_name, e.lineno] : nil}.compact
end

#dump ⇒ Object

return the content of the values table in human readable format



85
86
87
88
89
90
91
92
93
 
# File 'lib/connect/values_table.rb', line 85

def dump
  output = ''
  @values_table.keys.sort.each do |key|
    #
    # Use inspect, to make ruby 1.8.7 and ruby 1.8 and higher compatible
    output << "#{key} = #{lookup(key).inspect}\n"
  end
  output
end

#entries(name = /.*/) ⇒ Array

Give all entries in the values table based on the specfied name. As name, you can specify a regular expression.

Returns:

  • (Array) 


26
27
28
 
# File 'lib/connect/values_table.rb', line 26

def entries( name = /.*/)
  @values_table.keys.select{| k| Regexp.new(name).match(k) }.sort
end

#internal_lookup(name) ⇒ Object

Lookup an entry in the values table

Parameters:

  • name (String) —

    the name/key to lookup in the list

Returns:

  • the internal representation of the value in the table



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/connect/values_table.rb', line 113

def internal_lookup(name)
  name = name.to_s
  # TODO: Check if name is a valid name
  if Gem::Version.new(::Hiera.version) > Gem::Version.new('2.0.0')
    @values_table.fetch(name) do
      Connect.debug("looked up '#{name}' but found nothing")
      throw :no_such_key  
    end
  else
    @values_table.fetch(name) { Entry::Value.new(nil) }
  end
end

#lookup(name) ⇒ Object

Finds an entry in the lookup table and translates it to the external representationof it.

Parameters:

  • name (String) —

    the key/name of the entry in the list

Returns:

  • the value



102
103
104
 
# File 'lib/connect/values_table.rb', line 102

def lookup(name)
  internal_lookup(name).final
end

#references(parameter) ⇒ Object

return the array of references for the specfied parameter



47
48
49
50
 
# File 'lib/connect/values_table.rb', line 47

def references(parameter)
  entry = @values_table.fetch(parameter) { fail "internal error. Parameter entry #{parameter} not found" }
  entry.xref.collect {|e| e.class == Connect::Xref ? [e.file_name, e.lineno] : nil}.compact
end

#register_reference(parameter, xref) ⇒ Object

Register a cross reference in the entry for the specfied parameter



56
57
58
59
60
61
62
63
 
# File 'lib/connect/values_table.rb', line 56

def register_reference(parameter, xref)
  entry = @values_table.fetch(parameter) do
    value = Entry::Value.new(nil)
    add( parameter => value)
    value
  end
  entry.add_reference(xref)
end