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


125
126
127
128
129
130
 
# File 'lib/puppet/pops/utils.rb', line 125

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.



136
137
138
139
140
 
# File 'lib/puppet/pops/utils.rb', line 136

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) 


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

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

.match_to_fp(match) ⇒ Object

Convert a match from Puppet::Pops::Patterns::NUMERIC to floating point value if possible



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/puppet/pops/utils.rb', line 19

def self.match_to_fp(match)
  if match[5].to_s.length > 0
    # Use default radix (default is decimal == 10) for floats
    # Do not convert a value that is 0 raised to 10^somevalue to float - the value is always 0
    # i.e. 0000.0e1, 0e1, 0.0000e1
    if Integer(match[4]) == 0 && match[5] =~ /\A\.?0*[eE].*\z/
      nil
    else
      fp_value = Float(match[2])
      if fp_value != Puppet::Pops::Types::TypeCalculator::TheInfinity
        match[1] == '-' ? -fp_value : fp_value
      else
        nil
      end
    end
  end
end

.name_to_segments(name) ⇒ Object 



110
111
112
 
# File 'lib/puppet/pops/utils.rb', line 110

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

.relativize_name(name) ⇒ Object 



114
115
116
 
# File 'lib/puppet/pops/utils.rb', line 114

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)



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/puppet/pops/utils.rb', line 83

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_to_fp(match)
      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



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
71
72
73
74
75
76
 
# File 'lib/puppet/pops/utils.rb', line 44

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
        fp_value = match_to_fp(match)
        fp_value.nil? ? nil : [fp_value, 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