puppet 8.3.1 → 8.4.0

data/lib/puppet/pops/parser/lexer_support.rb

@@ -2,17 +2,16 @@
 
 module Puppet::Pops
 module Parser
-
 require_relative '../../../puppet/util/multi_match'
 
 # This is an integral part of the Lexer. It is broken out into a separate module
 # for maintainability of the code, and making the various parts of the lexer focused.
 #
 module LexerSupport
-
   # Returns "<eof>" if at end of input, else the following 5 characters with \n \r \t escaped
   def followed_by
     return "<eof>" if @scanner.eos?
+
     result = @scanner.rest[0,5] + "..."
     result.gsub!("\t", '\t')
     result.gsub!("\n", '\n')
@@ -54,13 +53,13 @@ module LexerSupport
 
   def lex_warning(issue, args = {}, pos=nil)
     Puppet::Util::Log.create({
-        :level => :warning,
-        :message => issue.format(args),
-        :issue_code => issue.issue_code,
-        :file => filename,
-        :line => line(pos),
-        :pos => position(pos),
-      })
+                               :level => :warning,
+                               :message => issue.format(args),
+                               :issue_code => issue.issue_code,
+                               :file => filename,
+                               :line => line(pos),
+                               :pos => position(pos),
+                             })
   end
 
   # @param issue [Issues::Issue] the issue
@@ -69,13 +68,13 @@ module LexerSupport
   # @return [Puppet::ParseErrorWithIssue] the created error
   def create_lex_error(issue, args = {}, pos = nil)
     Puppet::ParseErrorWithIssue.new(
-        issue.format(args),
-        filename,
-        line(pos),
-        position(pos),
-        nil,
-        issue.issue_code,
-        args)
+      issue.format(args),
+      filename,
+      line(pos),
+      position(pos),
+      nil,
+      issue.issue_code,
+      args)
   end
 
   # Asserts that the given string value is a float, or an integer in decimal, octal or hex form.
@@ -147,7 +146,6 @@ module LexerSupport
     #
   end
 
-
   MM = Puppet::Util::MultiMatch
   MM_ANY = MM::NOT_NIL
 
@@ -167,40 +165,40 @@ module LexerSupport
 
   def assert_not_bom(content)
     name, size =
-    case bom = get_bom(content)
+      case bom = get_bom(content)
 
-    when BOM_UTF_32_1, BOM_UTF_32_2
-      ['UTF-32', 4]
+      when BOM_UTF_32_1, BOM_UTF_32_2
+        ['UTF-32', 4]
 
-    when BOM_GB_18030
-      ['GB-18030', 4]
+      when BOM_GB_18030
+        ['GB-18030', 4]
 
-    when BOM_UTF_EBCDIC
-      ['UTF-EBCDIC', 4]
+      when BOM_UTF_EBCDIC
+        ['UTF-EBCDIC', 4]
 
-    when BOM_SCSU
-      ['SCSU', 3]
+      when BOM_SCSU
+        ['SCSU', 3]
 
-    when BOM_UTF_8
-      ['UTF-8', 3]
+      when BOM_UTF_8
+        ['UTF-8', 3]
 
-    when BOM_UTF_1
-      ['UTF-1', 3]
+      when BOM_UTF_1
+        ['UTF-1', 3]
 
-    when BOM_BOCU
-      ['BOCU', 3]
+      when BOM_BOCU
+        ['BOCU', 3]
 
-    when BOM_UTF_16_1, BOM_UTF_16_2
-      ['UTF-16', 2]
+      when BOM_UTF_16_1, BOM_UTF_16_2
+        ['UTF-16', 2]
 
-    else
-      return
-    end
+      else
+        return
+      end
 
     lex_error_without_pos(
       Puppet::Pops::Issues::ILLEGAL_BOM,
-      { :format_name   => name,
-        :bytes  => "[#{bom.values[0,size].map {|b| "%X" % b}.join(" ")}]"
+      { :format_name => name,
+        :bytes => "[#{bom.values[0,size].map {|b| "%X" % b}.join(" ")}]"
       })
   end
 
@@ -214,9 +212,8 @@ module LexerSupport
       (content.getbyte(1) || ' '),
       (content.getbyte(2) || ' '),
       (content.getbyte(3) || ' ')
-      )
+    )
   end
-
 end
 end
 end

data/lib/puppet/pops/parser/locatable.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 # Interface for something that is "locatable" (holds offset and length).
 class Puppet::Pops::Parser::Locatable
-
   # The offset in the locator's content
   def offset
   end
@@ -20,5 +20,4 @@ class Puppet::Pops::Parser::Locatable
       @length = length
     end
   end
-
 end

data/lib/puppet/pops/parser/locator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Pops
 module Parser
 # Helper class that keeps track of where line breaks are located and can answer questions about positions.
@@ -58,6 +59,7 @@ class Locator
     last = first + ast.length
     ast._pcore_all_contents([]) do |m|
       next unless m.is_a?(Model::Positioned)
+
       m_offset = m.offset
       m_last = m_offset + m.length
       first = m_offset if m_offset < first
@@ -140,26 +142,27 @@ class Locator
       v = nil
 
       while low < high do
-          mid = low + ((high - low) / 2)
-          v = (ary[mid] > value)
-          if v == true
-            satisfied = true
-            smaller = true
-          elsif !v
-            smaller = false
-          else
-            raise TypeError, "wrong argument, must be boolean or nil, got '#{v.class}'"
-          end
-
-          if smaller
-            high = mid
-          else
-            low = mid + 1;
-          end
+        mid = low + ((high - low) / 2)
+        v = (ary[mid] > value)
+        if v == true
+          satisfied = true
+          smaller = true
+        elsif !v
+          smaller = false
+        else
+          raise TypeError, "wrong argument, must be boolean or nil, got '#{v.class}'"
+        end
+
+        if smaller
+          high = mid
+        else
+          low = mid + 1;
+        end
       end
 
       return nil if low == ary.length
       return nil if !satisfied
+
       return low
     end
 
@@ -178,6 +181,7 @@ class Locator
         # use cache
         return @prev_line
       end
+
       line_nbr = ary_bsearch_i(line_index, offset)
       if line_nbr
         # cache
@@ -283,11 +287,9 @@ class Locator
     def char_length(offset, end_offset)
       raise "Should not be called"
     end
-
   end
 
   class LocatorForChars < AbstractLocator
-
     def offset_on_line(offset)
       line_offset = line_index[ line_for_offset(offset)-1 ]
       offset - line_offset
@@ -306,7 +308,6 @@ class Locator
     def extract_text(offset, length)
       string.slice(offset, length)
     end
-
   end
 
   # This implementation is for Ruby19 and Ruby20. It uses byteslice to get strings from byte based offsets.
@@ -316,18 +317,20 @@ class Locator
   class Locator19 < AbstractLocator
     include Types::PuppetObject
 
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def self._pcore_type
       @type ||= Types::PObjectType.new('Puppet::AST::Locator', {
-        'attributes' => {
-          'string' => Types::PStringType::DEFAULT,
-          'file' => Types::PStringType::DEFAULT,
-          'line_index' => {
-            Types::KEY_TYPE => Types::POptionalType.new(Types::PArrayType.new(Types::PIntegerType::DEFAULT)),
-            Types::KEY_VALUE => nil
-          }
-        }
-      })
+                                         'attributes' => {
+                                           'string' => Types::PStringType::DEFAULT,
+                                           'file' => Types::PStringType::DEFAULT,
+                                           'line_index' => {
+                                             Types::KEY_TYPE => Types::POptionalType.new(Types::PArrayType.new(Types::PIntegerType::DEFAULT)),
+                                             Types::KEY_VALUE => nil
+                                           }
+                                         }
+                                       })
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # Returns the offset on line (first offset on a line is 0).
     # Ruby 19 is multibyte but has no character position methods, must use byteslice

data/lib/puppet/pops/parser/parser_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/parser/functions'
 require_relative '../../../puppet/parser/files'
 require_relative '../../../puppet/resource/type_collection'
@@ -28,6 +29,7 @@ class Parser
   # Returns the token text of the given lexer token, or nil, if token is nil
   def token_text t
     return t if t.nil?
+
     if t.is_a?(Factory) && t.model_class <= Model::QualifiedName
       t['value']
     elsif t.is_a?(Model::QualifiedName)

data/lib/puppet/pops/parser/pn_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Puppet::Pops
 module Parser
-
 class PNParser
   LIT_TRUE = 'true'
   LIT_FALSE = 'false'

data/lib/puppet/pops/parser/slurp_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Pops
 module Parser
 # This module is an integral part of the Lexer.
@@ -43,20 +44,20 @@ module SlurpSupport
     [str[0..(-1 - terminator.length)], terminator]
   end
 
-   # Copy from old lexer - can do much better
-   def slurp_uqstring
-     scn = @scanner
-     str = slurp(scn, @lexing_context[:uq_slurp_pattern], @lexing_context[:escapes], :ignore_invalid_escapes)
+  # Copy from old lexer - can do much better
+  def slurp_uqstring
+    scn = @scanner
+    str = slurp(scn, @lexing_context[:uq_slurp_pattern], @lexing_context[:escapes], :ignore_invalid_escapes)
 
-     # Terminator may be a single char '$', two characters '${', or empty string '' at the end of intput.
-     # Group match 1 holds this.
-     # The exceptional case is found by looking at the subgroup 1 of the most recent match made by the scanner (i.e. @scanner[1]).
-     # This is the last match made by the slurp method (having called scan_until on the scanner).
-     # If there is a terminating character is must be stripped and returned separately.
-     #
-     terminator = scn[1]
-     [str[0..(-1 - terminator.length)], terminator]
-   end
+    # Terminator may be a single char '$', two characters '${', or empty string '' at the end of intput.
+    # Group match 1 holds this.
+    # The exceptional case is found by looking at the subgroup 1 of the most recent match made by the scanner (i.e. @scanner[1]).
+    # This is the last match made by the slurp method (having called scan_until on the scanner).
+    # If there is a terminating character is must be stripped and returned separately.
+    #
+    terminator = scn[1]
+    [str[0..(-1 - terminator.length)], terminator]
+  end
 
   # Slurps a string from the given scanner until the given pattern and then replaces any escaped
   # characters given by escapes into their control-character equivalent or in case of line breaks, replaces the
@@ -81,26 +82,26 @@ module SlurpSupport
     end
 
     begin
-    str.gsub!(/\\([^\r\n]|(?:\r?\n))/m) {
-      ch = $1
-      if escapes.include? ch
-        case ch
-        when 'r'   ; "\r"
-        when 'n'   ; "\n"
-        when 't'   ; "\t"
-        when 's'   ; ' '
-        when 'u'
-          lex_warning(Issues::ILLEGAL_UNICODE_ESCAPE)
-          "\\u"
-        when "\n"  ; ''
-        when "\r\n"; ''
-        else      ch
+      str.gsub!(/\\([^\r\n]|(?:\r?\n))/m) {
+        ch = $1
+        if escapes.include? ch
+          case ch
+          when 'r'   ; "\r"
+          when 'n'   ; "\n"
+          when 't'   ; "\t"
+          when 's'   ; ' '
+          when 'u'
+            lex_warning(Issues::ILLEGAL_UNICODE_ESCAPE)
+            "\\u"
+          when "\n"  ; ''
+          when "\r\n"; ''
+          else ch
+          end
+        else
+          lex_warning(Issues::UNRECOGNIZED_ESCAPE, :ch => ch) unless ignore_invalid_escapes
+          "\\#{ch}"
         end
-      else
-        lex_warning(Issues::UNRECOGNIZED_ESCAPE, :ch => ch) unless ignore_invalid_escapes
-        "\\#{ch}"
-      end
-    }
+      }
     rescue ArgumentError => e
       # A invalid byte sequence may be the result of faulty input as well, but that could not possibly
       # have reached this far... Unfortunately there is no more specific error and a match on message is

data/lib/puppet/pops/patterns.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 # The Patterns module contains common regular expression patters for the Puppet DSL language
 module Puppet::Pops::Patterns
-
   # NUMERIC matches hex, octal, decimal, and floating point and captures several parts
   # 0 = entire matched number, leading and trailing whitespace and sign included
   # 1 = sign, +, - or nothing
@@ -45,7 +45,7 @@ module Puppet::Pops::Patterns
   CLASSREF_DECL = %r{\A[a-z][\w]*(?:::[a-z][\w]*)*\z}
 
   # DOLLAR_VAR matches a variable name including the initial $ character
-  DOLLAR_VAR     = %r{\$(::)?(\w+::)*\w+}
+  DOLLAR_VAR = %r{\$(::)?(\w+::)*\w+}
 
   # VAR_NAME matches the name part of a variable (The $ character is not included)
   # Note, that only the final segment may start with an underscore.
@@ -57,5 +57,4 @@ module Puppet::Pops::Patterns
 
   # A Numeric var name must be the decimal number 0, or a decimal number not starting with 0
   NUMERIC_VAR_NAME = %r{\A(?:0|(?:[1-9][0-9]*))\z}
-
 end

data/lib/puppet/pops/pcore.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 require 'uri'
 
 module Puppet::Pops
 module Pcore
   include Types::PuppetObject
 
-  TYPE_URI_RX = Types::TypeFactory.regexp(URI.regexp)
+  TYPE_URI_RX = Types::TypeFactory.regexp(URI::DEFAULT_PARSER.make_regexp)
   TYPE_URI = Types::TypeFactory.pattern(TYPE_URI_RX)
   TYPE_URI_ALIAS = Types::PTypeAliasType.new('Pcore::URI', nil, TYPE_URI)
   TYPE_SIMPLE_TYPE_NAME = Types::TypeFactory.pattern(/\A[A-Z]\w*\z/)
@@ -83,7 +84,6 @@ module Pcore
         }
       }
     PUPPET
-
   end
 
   # Create and register a new `Object` type in the Puppet Type System and map it to an implementation class

data/lib/puppet/pops/pn.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Puppet::Pops
 module PN
   KEY_PATTERN = /^[A-Za-z_-][0-9A-Za-z_-]*$/
@@ -69,6 +70,7 @@ module PN
 
   class Indent
     attr_reader :current
+
     def initialize(indent = '  ', current = '')
       @indent = indent
       @current = current
@@ -120,6 +122,7 @@ module PN
 
   class Entry
     attr_reader :key, :value
+
     def initialize(key, value)
       @key = key
       @value = value

data/lib/puppet/pops/puppet_stack.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/thread_local'
 
 module Puppet

data/lib/puppet/pops/resource/param.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # An implementation of the interface Puppet::Resource
 # that adapts the 3.x compiler and catalog expectations on
 # a resource instance. This instance is backed by a
@@ -21,16 +22,16 @@ class Param
 
   def self.register_ptype(loader, ir)
     @ptype = Pcore::create_object_type(loader, ir, self, 'Puppet::Resource::Param', nil,
-      {
-        Types::KEY_TYPE => Types::PTypeType::DEFAULT,
-        Types::KEY_NAME => Types::PStringType::NON_EMPTY,
-        'name_var' => {
-          Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
-          Types::KEY_VALUE => false
-        }
-      },
-      EMPTY_HASH,
-      [Types::KEY_NAME]
+                                       {
+                                         Types::KEY_TYPE => Types::PTypeType::DEFAULT,
+                                         Types::KEY_NAME => Types::PStringType::NON_EMPTY,
+                                         'name_var' => {
+                                           Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
+                                           Types::KEY_VALUE => false
+                                         }
+                                       },
+                                       EMPTY_HASH,
+                                       [Types::KEY_NAME]
     )
   end
 

data/lib/puppet/pops/resource/resource_type_impl.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require_relative 'param'
 
 module Puppet::Pops
 module Resource
-
 def self.register_ptypes(loader, ir)
   types = [Param, ResourceTypeImpl].map do |c|
     c.register_ptype(loader, ir)
@@ -29,32 +29,32 @@ class ResourceTypeImpl
   def self.register_ptype(loader, ir)
     param_ref = Types::PTypeReferenceType.new('Puppet::Resource::Param')
     @ptype = Pcore::create_object_type(loader, ir, self, 'Puppet::Resource::ResourceType3', nil,
-      {
-        Types::KEY_NAME => Types::PStringType::NON_EMPTY,
-        'properties' => {
-          Types::KEY_TYPE => Types::PArrayType.new(param_ref),
-          Types::KEY_VALUE => EMPTY_ARRAY
-        },
-        'parameters' => {
-          Types::KEY_TYPE => Types::PArrayType.new(param_ref),
-          Types::KEY_VALUE => EMPTY_ARRAY
-        },
-        'title_patterns_hash' => {
-          Types::KEY_TYPE => Types::POptionalType.new(
-            Types::PHashType.new(Types::PRegexpType::DEFAULT, Types::PArrayType.new(Types::PStringType::NON_EMPTY))),
-          Types::KEY_VALUE => nil
-        },
-        'isomorphic' => {
-          Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
-          Types::KEY_VALUE => true
-        },
-        'capability' => {
-          Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
-          Types::KEY_VALUE => false
-        },
-      },
-      EMPTY_HASH,
-      [Types::KEY_NAME]
+                                       {
+                                         Types::KEY_NAME => Types::PStringType::NON_EMPTY,
+                                         'properties' => {
+                                           Types::KEY_TYPE => Types::PArrayType.new(param_ref),
+                                           Types::KEY_VALUE => EMPTY_ARRAY
+                                         },
+                                         'parameters' => {
+                                           Types::KEY_TYPE => Types::PArrayType.new(param_ref),
+                                           Types::KEY_VALUE => EMPTY_ARRAY
+                                         },
+                                         'title_patterns_hash' => {
+                                           Types::KEY_TYPE => Types::POptionalType.new(
+                                             Types::PHashType.new(Types::PRegexpType::DEFAULT, Types::PArrayType.new(Types::PStringType::NON_EMPTY))),
+                                           Types::KEY_VALUE => nil
+                                         },
+                                         'isomorphic' => {
+                                           Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
+                                           Types::KEY_VALUE => true
+                                         },
+                                         'capability' => {
+                                           Types::KEY_TYPE => Types::PBooleanType::DEFAULT,
+                                           Types::KEY_VALUE => false
+                                         },
+                                       },
+                                       EMPTY_HASH,
+                                       [Types::KEY_NAME]
     )
   end
 
@@ -73,6 +73,7 @@ class ResourceTypeImpl
     # Order is only maintained against other types, not arbitrary objects.
     # The natural order is based on the reference name used when comparing
     return nil unless other.is_a?(Puppet::CompilableResourceType)
+
     # against other type instances.
     self.ref <=> other.ref
   end
@@ -89,7 +90,7 @@ class ResourceTypeImpl
     :before,
     :notify,
     :stage
-    ].freeze
+  ].freeze
 
   # Speed up lookup
   METAPARAMSET = Set.new(METAPARAMS).freeze
@@ -165,6 +166,7 @@ class ResourceTypeImpl
           #
           raise Puppet::DevError, _("you must specify title patterns when there are two or more key attributes")
         end
+
         @title_patterns_hash.nil? ? [] : @title_patterns_hash.map { |k,v| [ k, v.map { |n| [ n.to_sym] } ] }
       end
   end
@@ -202,16 +204,16 @@ class ResourceTypeImpl
     # This is what the Puppet::Type implementation does
     # None of this should be needed
 
-      #    # Make sure our parent class has been evaluated, if we have one.
-      #    if parent && !scope.catalog.resource(resource.type, parent)
-      #      parent_type(scope).ensure_in_catalog(scope)
-      #    end
+    #    # Make sure our parent class has been evaluated, if we have one.
+    #    if parent && !scope.catalog.resource(resource.type, parent)
+    #      parent_type(scope).ensure_in_catalog(scope)
+    #    end
 
     # This will never happen
 
-      #    if ['Class', 'Node'].include? resource.type
-      #      scope.catalog.tag(*resource.tags)
-      #    end
+    #    if ['Class', 'Node'].include? resource.type
+    #      scope.catalog.tag(*resource.tags)
+    #    end
   end
 
   # Being isomorphic in puppet means that the resource is managing a state
@@ -289,7 +291,6 @@ class ResourceTypeImpl
   def can_apply_to_target(target)
     raise NotImplementedError, "can_apply_to_target() - probably used when selecting a provider (device/host support)"
   end
-
 end
 end
 end

data/lib/puppet/pops/semantic_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Error that is used to raise an Issue. See {Puppet::Pops::Issues}.
 #
 class Puppet::Pops::SemanticError < RuntimeError

data/lib/puppet/pops/serialization/abstract_reader.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'extension'
 require_relative 'time_factory'
 
@@ -115,7 +116,7 @@ class AbstractReader
     end
 
     register_type(Extension::DEFAULT) do |data|
-      read_payload(data) { |ep| Extension::Default::INSTANCE }
+      read_payload(data) { |_ep| Extension::Default::INSTANCE }
     end
 
     register_type(Extension::COMMENT) do |data|
@@ -123,7 +124,7 @@ class AbstractReader
     end
 
     register_type(Extension::SENSITIVE_START) do |data|
-      read_payload(data) { |ep| Extension::SensitiveStart::INSTANCE }
+      read_payload(data) { |_ep| Extension::SensitiveStart::INSTANCE }
     end
 
     register_type(Extension::REGEXP) do |data|