Module: Puppet::Pops::Utils

Included in:
Evaluator::CompareOperator, Evaluator::EvaluatorImpl
Defined in:
lib/puppet/pops/utils.rb

Overview

Provides utility methods

Class Method Summary collapse

Class Method Details

.find_adapter(o, adapter) ⇒ Object

Finds an existing adapter for o or for one of its containers, or nil, if none of the containers was adapted with the given adapter. This method can only be used with objects that respond to ‘:eContainer`. with true.

See Also:

  • #find_closest_positioned


105
106
107
108
109
110
 
# File 'lib/puppet/pops/utils.rb', line 105

def self.find_adapter(o, adapter)
  return nil if o.nil? || (o.is_a?(Array) && o.empty?)
  a = adapter.get(o)
  return a if a
  return find_adapter(o.eContainer, adapter)
end

.find_closest_positioned(o) ⇒ Object

Finds the closest positioned Puppet::Pops::Model::Positioned object, or object decorated with a SourcePosAdapter, and returns a SourcePosAdapter for the first found, or nil if not found.



116
117
118
119
120
 
# File 'lib/puppet/pops/utils.rb', line 116

def self.find_closest_positioned(o)
  return nil if o.nil? || o.is_a?(Puppet::Pops::Model::Program) || (o.is_a?(Array) && o.empty?)
  return find_adapter(o, Puppet::Pops::Adapters::SourcePosAdapter) unless o.is_a?(Puppet::Pops::Model::Positioned)
  o.offset.nil? ? find_closest_positioned(o.eContainer) : Puppet::Pops::Adapters::SourcePosAdapter.adapt(o)
end

.is_absolute?(name) ⇒ Boolean

is the name absolute (i.e. starts with ::)

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/puppet/pops/utils.rb', line 86

def self.is_absolute? name
  name.start_with? "::"
end

.is_numeric?(o) ⇒ Boolean

Can the given o be converted to numeric? (or is numeric already) Accepts a leading ‘::’ Returns a boolean if the value is numeric If testing if value can be converted it is more efficient to call #to_n or #to_n_with_radix directly and check if value is nil.

Returns:

  • (Boolean) 


8
9
10
11
12
13
14
15
 
# File 'lib/puppet/pops/utils.rb', line 8

def self.is_numeric?(o)
  case o
  when Numeric
    true
  else
    !!Puppet::Pops::Patterns::NUMERIC.match(relativize_name(o.to_s))
  end
end

.name_to_segments(name) ⇒ Object 



90
91
92
 
# File 'lib/puppet/pops/utils.rb', line 90

def self.name_to_segments name
  name.split("::")
end

.relativize_name(name) ⇒ Object 



94
95
96
 
# File 'lib/puppet/pops/utils.rb', line 94

def self.relativize_name name
  is_absolute?(name) ? name[2..-1] : name
end

.to_n(o) ⇒ Object

To Numeric (or already numeric) Returns nil if value is not numeric, else an Integer or Float. A String may have an optional sign.

A leading ‘::’ is accepted (and ignored)



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/puppet/pops/utils.rb', line 63

def self.to_n o
  begin
    case o
    when String
      match = Puppet::Pops::Patterns::NUMERIC.match(relativize_name(o))
      if !match
        nil
      elsif match[5].to_s.length > 0
        match[1] == '-' ? -Float(match[2]) : Float(match[2])
      else
        match[1] == '-' ? -Integer(match[2]) : Integer(match[2])
      end
    when Numeric
      o
    else
      nil
    end
  rescue ArgumentError
    nil
  end
end

.to_n_with_radix(o) ⇒ Array<Number, Integer>?

To Numeric with radix, or nil if not a number. If the value is already Numeric it is returned verbatim with a radix of 10.

Parameters:

  • o (String, Number) —

    a string containing a number in octal, hex, integer (decimal) or floating point form with optional sign +/-

Returns:

  • (Array<Number, Integer>, nil) —

    array with converted number and radix, or nil if not possible to convert



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/puppet/pops/utils.rb', line 24

def self.to_n_with_radix o
  begin
    case o
    when String
      match = Puppet::Pops::Patterns::NUMERIC.match(relativize_name(o))
      if !match
        nil
      elsif match[5].to_s.length > 0
        # Use default radix (default is decimal == 10) for floats
        match[1] == '-' ? [-Float(match[2]), 10] : [Float(match[2]), 10]
      else
        # Set radix (default is decimal == 10)
        radix = 10
        if match[3].to_s.length > 0
          radix = 16
        elsif match[4].to_s.length > 1 && match[4][0,1] == '0'
          radix = 8
        end
        # Ruby 1.8.7 does not have a second argument to Kernel method that creates an
        # integer from a string, it relies on the prefix 0x, 0X, 0 (and unsupported in puppet binary 'b')
        # We have the correct string here, match[2] is safe to parse without passing on radix
        match[1] == '-' ? [-Integer(match[2]), radix] : [Integer(match[2]), radix]
      end
    when Numeric
      # Impossible to calculate radix, assume decimal
      [o, 10]
    else
      nil
    end
  rescue ArgumentError
    nil
  end
end