puppet 8.4.0 → 8.5.0

data/lib/puppet/parser/functions/binary_file.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :binary_file,
   :type => :rvalue,
   :arity => 1,
   :doc => <<~DOC
     Loads a binary file from a module or file system and returns its contents as a Binary.
-    
+
     The argument to this function should be a `<MODULE NAME>/<FILE>`
     reference, which will load `<FILE>` from a module's `files`
     directory. (For example, the reference `mysql/mysqltuner.pl` will load the
     file `<MODULES DIRECTORY>/mysql/files/mysqltuner.pl`.)
-    
+
     This function also accepts an absolute file path that allows reading
     binary file content from anywhere on disk.
-    
+
     An error is raised if the given file does not exists.
-    
+
     To search for the existence of files, use the `find_file()` function.
-    
+
     - since 4.8.0
   DOC
 ) do |_args|

data/lib/puppet/parser/functions/break.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :break,
   :arity => 0,
   :doc => <<~DOC
     Breaks the innermost iteration as if it encountered an end of input.
     This function does not return to the caller.
-    
+
     The signal produced to stop the iteration bubbles up through
     the call stack until either terminating the innermost iteration or
     raising an error if the end of the call stack is reached.
-    
+
     The break() function does not accept an argument.
-    
+
     **Example:** Using `break`
-    
+
     ```puppet
     $data = [1,2,3]
     notice $data.map |$x| { if $x == 3 { break() } $x*10 }
     ```
-    
+
     Would notice the value `[10, 20]`
-    
+
     **Example:** Using a nested `break`
-    
+
     ```puppet
     function break_if_even($x) {
       if $x % 2 == 0 { break() }
@@ -32,7 +32,7 @@ Puppet::Parser::Functions::newfunction(
     notice $data.map |$x| { break_if_even($x); $x*10 }
     ```
     Would notice the value `[10]`
-    
+
     * Also see functions `next` and `return`
     * Since 4.8.0
   DOC

data/lib/puppet/parser/functions/contain.rb

@@ -3,7 +3,7 @@
 # Called within a class definition, establishes a containment
 # relationship with another class
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :contain,
   :arity => -2,
   :doc => "Contain one or more classes inside the current class. If any of

data/lib/puppet/parser/functions/create_resources.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(:create_resources, :arity => -3, :doc => <<-'ENDHEREDOC') do |args|
+Puppet::Parser::Functions.newfunction(:create_resources, :arity => -3, :doc => <<-'ENDHEREDOC') do |args|
     Converts a hash into a set of resources and adds them to the catalog.
-    
+
     **Note**: Use this function selectively. It's generally better to write resources in
      [Puppet](https://puppet.com/docs/puppet/latest/lang_resources.html), as
      resources created with `create_resource` are difficult to read and troubleshoot.
@@ -56,7 +56,8 @@ ENDHEREDOC
   if Puppet[:tasks]
     raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
       Puppet::Pops::Issues::CATALOG_OPERATION_NOT_SUPPORTED_WHEN_SCRIPTING,
-      {:operation => 'create_resources'})
+      { :operation => 'create_resources' }
+    )
   end
 
   raise ArgumentError, (_("create_resources(): wrong number of arguments (%{count}; must be 2 or 3)") % { count: args.length }) if args.length > 3
@@ -99,7 +100,7 @@ ENDHEREDOC
       virtual, exported,
       type_name,
       resource_titles,
-      defaults.merge(params).map do |name, value|
+      defaults.merge(params).filter_map do |name, value|
         value = nil if value == :undef
         Puppet::Parser::Resource::Param.new(
           :name => name,
@@ -107,7 +108,7 @@ ENDHEREDOC
           :source => self.source, # TODO: support :line => line, :file => file,
           :add => false
         )
-      end.compact
+      end
     )
   end.flatten.compact
 end

data/lib/puppet/parser/functions/defined.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :defined,
   :type => :rvalue,
   :arity => -2,
@@ -9,84 +9,84 @@ Puppet::Parser::Functions::newfunction(
     value. You can also use `defined` to determine whether a specific resource is defined,
     or whether a variable has a value (including `undef`, as opposed to the variable never
     being declared or assigned).
-    
+
     This function takes at least one string argument, which can be a class name, type name,
     resource reference, or variable reference of the form `'$name'`.
-    
+
     The `defined` function checks both native and defined types, including types
     provided by modules. Types and classes are matched by their names. The function matches
     resource declarations by using resource references.
-    
+
     **Examples**: Different types of `defined` function matches
-    
+
     ~~~ puppet
     # Matching resource types
     defined("file")
     defined("customtype")
-    
+
     # Matching defines and classes
     defined("foo")
     defined("foo::bar")
-    
+
     # Matching variables
     defined('$name')
-    
+
     # Matching declared resources
     defined(File['/tmp/file'])
     ~~~
-    
+
     Puppet depends on the configuration's evaluation order when checking whether a resource
     is declared.
-    
+
     **Example**: Importance of evaluation order when using `defined`
-    
+
     ~~~ puppet
     # Assign values to $is_defined_before and $is_defined_after using identical `defined`
     # functions.
-    
+
     $is_defined_before = defined(File['/tmp/file'])
-    
+
     file { "/tmp/file":
       ensure => present,
     }
-    
+
     $is_defined_after = defined(File['/tmp/file'])
-    
+
     # $is_defined_before returns false, but $is_defined_after returns true.
     ~~~
-    
+
     This order requirement only refers to evaluation order. The order of resources in the
     configuration graph (e.g. with `before` or `require`) does not affect the `defined`
     function's behavior.
-    
+
     > **Warning:** Avoid relying on the result of the `defined` function in modules, as you
     > might not be able to guarantee the evaluation order well enough to produce consistent
     > results. This can cause other code that relies on the function's result to behave
     > inconsistently or fail.
-    
+
     If you pass more than one argument to `defined`, the function returns `true` if _any_
     of the arguments are defined. You can also match resources by type, allowing you to
     match conditions of different levels of specificity, such as whether a specific resource
     is of a specific data type.
-    
+
     **Example**: Matching multiple resources and resources by different types with `defined`
-    
+
     ~~~ puppet
     file { "/tmp/file1":
       ensure => file,
     }
-    
+
     $tmp_file = file { "/tmp/file2":
       ensure => file,
     }
-    
+
     # Each of these statements return `true` ...
     defined(File['/tmp/file1'])
     defined(File['/tmp/file1'],File['/tmp/file2'])
     defined(File['/tmp/file1'],File['/tmp/file2'],File['/tmp/file3'])
     # ... but this returns `false`.
     defined(File['/tmp/file3'])
-    
+
     # Each of these statements returns `true` ...
     defined(Type[Resource['file','/tmp/file2']])
     defined(Resource['file','/tmp/file2'])
@@ -98,7 +98,7 @@ Puppet::Parser::Functions::newfunction(
     defined(File['/tmp/file3'])
     defined('$tmp_file2')
     ~~~
-    
+
     - Since 2.7.0
     - Since 3.6.0 variable reference and future parser types
     - Since 3.8.1 type specific requests with future parser

data/lib/puppet/parser/functions/dig.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :dig,
   :type => :rvalue,
   :arity => -1,
@@ -10,29 +10,29 @@ Puppet::Parser::Functions::newfunction(
     This function is used to "dig into" a complex data structure by
     using a sequence of keys / indexes to access a value from which
     the next key/index is accessed recursively.
-    
+
     The first encountered `undef` value or key stops the "dig" and `undef` is returned.
-    
+
     An error is raised if an attempt is made to "dig" into
     something other than an `undef` (which immediately returns `undef`), an `Array` or a `Hash`.
-    
-    
-    
+
+
+
     **Example:** Using `dig`
-    
+
     ```puppet
     $data = {a => { b => [{x => 10, y => 20}, {x => 100, y => 200}]}}
     notice $data.dig('a', 'b', 1, 'x')
     ```
-    
+
     Would notice the value 100.
-    
+
     This is roughly equivalent to `$data['a']['b'][1]['x']`. However, a standard
     index will return an error and cause catalog compilation failure if any parent
     of the final key (`'x'`) is `undef`. The `dig` function will return undef,
     rather than failing catalog compilation. This allows you to check if data
     exists in a structure without mandating that it always exists.
-    
+
     * Since 4.5.0
   DOC
 ) do |_args|

data/lib/puppet/parser/functions/digest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../../puppet/util/checksums'
-Puppet::Parser::Functions::newfunction(:digest, :type => :rvalue, :arity => 1, :doc => "Returns a hash value from a provided string using the digest_algorithm setting from the Puppet config file.") do |args|
+Puppet::Parser::Functions.newfunction(:digest, :type => :rvalue, :arity => 1, :doc => "Returns a hash value from a provided string using the digest_algorithm setting from the Puppet config file.") do |args|
   algo = Puppet[:digest_algorithm]
   Puppet::Util::Checksums.method(algo.intern).call args[0]
 end

data/lib/puppet/parser/functions/each.rb

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :each,
   :type => :rvalue,
   :arity => -3,
   :doc => <<~DOC
     Runs a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
     repeatedly using each value in a data structure, then returns the values unchanged.
-    
+
     This function takes two mandatory arguments, in this order:
-    
+
     1. An array or hash the function will iterate over.
     2. A lambda, which the function calls for each element in the first argument. It can
     request one or two parameters.
-    
+
     **Example**: Using the `each` function
-    
+
     `$data.each |$parameter| { <PUPPET CODE BLOCK> }`
-    
+
     or
-    
+
     `each($data) |$parameter| { <PUPPET CODE BLOCK> }`
-    
+
     When the first argument (`$data` in the above example) is an array, Puppet passes each
     value in turn to the lambda, then returns the original values.
-    
+
     **Example**: Using the `each` function with an array and a one-parameter lambda
-    
+
     ~~~ puppet
     # For the array $data, run a lambda that creates a resource for each item.
     $data = ["routers", "servers", "workstations"]
@@ -38,12 +38,12 @@ Puppet::Parser::Functions::newfunction(
     # Puppet creates one resource for each of the three items in $data. Each resource is
     # named after the item's value and uses the item's value in a parameter.
     ~~~
-    
+
     When the first argument is a hash, Puppet passes each key and value pair to the lambda
     as an array in the form `[key, value]` and returns the original hash.
-    
+
     **Example**: Using the `each` function with a hash and a one-parameter lambda
-    
+
     ~~~ puppet
     # For the hash $data, run a lambda using each item as a key-value array that creates a
     # resource for each item.
@@ -56,13 +56,13 @@ Puppet::Parser::Functions::newfunction(
     # Puppet creates one resource for each of the three items in $data, each named after the
     # item's key and containing a parameter using the item's value.
     ~~~
-    
+
     When the first argument is an array and the lambda has two parameters, Puppet passes the
     array's indexes (enumerated from 0) in the first parameter and its values in the second
     parameter.
-    
+
     **Example**: Using the `each` function with an array and a two-parameter lambda
-    
+
     ~~~ puppet
     # For the array $data, run a lambda using each item's index and value that creates a
     # resource for each item.
@@ -75,12 +75,12 @@ Puppet::Parser::Functions::newfunction(
     # Puppet creates one resource for each of the three items in $data, each named after the
     # item's value and containing a parameter using the item's index.
     ~~~
-    
+
     When the first argument is a hash, Puppet passes its keys to the first parameter and its
     values to the second parameter.
-    
+
     **Example**: Using the `each` function with a hash and a two-parameter lambda
-    
+
     ~~~ puppet
     # For the hash $data, run a lambda using each item's key and value to create a resource
     # for each item.
@@ -93,12 +93,12 @@ Puppet::Parser::Functions::newfunction(
     # Puppet creates one resource for each of the three items in $data, each named after the
     # item's key and containing a parameter using the item's value.
     ~~~
-    
+
     For an example that demonstrates how to create multiple `file` resources using `each`,
     see the Puppet
     [iteration](https://puppet.com/docs/puppet/latest/lang_iteration.html)
     documentation.
-    
+
     - Since 4.0.0
   DOC
 ) do |_args|

data/lib/puppet/parser/functions/epp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(:epp, :type => :rvalue, :arity => -2, :doc =>
+Puppet::Parser::Functions.newfunction(:epp, :type => :rvalue, :arity => -2, :doc =>
 "Evaluates an Embedded Puppet (EPP) template file and returns the rendered text
 result as a String.
 

data/lib/puppet/parser/functions/fail.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :fail,
   :arity => -1,
   :doc => <<~DOC

data/lib/puppet/parser/functions/file.rb

@@ -2,7 +2,7 @@
 
 require_relative '../../../puppet/file_system'
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :file, :arity => -2, :type => :rvalue,
          :doc => "Loads a file from a module and returns its contents as a string.
 

data/lib/puppet/parser/functions/filter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :filter,
   :type => :rvalue,
   :arity => -3,
@@ -8,51 +8,51 @@ Puppet::Parser::Functions::newfunction(
     Applies a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
     to every value in a data structure and returns an array or hash containing any elements
     for which the lambda evaluates to a truthy value (not `false` or `undef`).
-    
+
     This function takes two mandatory arguments, in this order:
-    
+
     1. An array or hash the function will iterate over.
     2. A lambda, which the function calls for each element in the first argument. It can
     request one or two parameters.
-    
+
     **Example**: Using the `filter` function
-    
+
     `$filtered_data = $data.filter |$parameter| { <PUPPET CODE BLOCK> }`
-    
+
     or
-    
+
     `$filtered_data = filter($data) |$parameter| { <PUPPET CODE BLOCK> }`
-    
+
     When the first argument (`$data` in the above example) is an array, Puppet passes each
     value in turn to the lambda and returns an array containing the results.
-    
+
     **Example**: Using the `filter` function with an array and a one-parameter lambda
-    
+
     ~~~ puppet
     # For the array $data, return an array containing the values that end with "berry"
     $data = ["orange", "blueberry", "raspberry"]
     $filtered_data = $data.filter |$items| { $items =~ /berry$/ }
     # $filtered_data = [blueberry, raspberry]
     ~~~
-    
+
     When the first argument is a hash, Puppet passes each key and value pair to the lambda
     as an array in the form `[key, value]` and returns a hash containing the results.
-    
+
     **Example**: Using the `filter` function with a hash and a one-parameter lambda
-    
+
     ~~~ puppet
     # For the hash $data, return a hash containing all values of keys that end with "berry"
     $data = { "orange" => 0, "blueberry" => 1, "raspberry" => 2 }
     $filtered_data = $data.filter |$items| { $items[0] =~ /berry$/ }
     # $filtered_data = {blueberry => 1, raspberry => 2}
     ~~~
-    
+
     When the first argument is an array and the lambda has two parameters, Puppet passes the
     array's indexes (enumerated from 0) in the first parameter and its values in the second
     parameter.
-    
+
     **Example**: Using the `filter` function with an array and a two-parameter lambda
-    
+
     ~~~ puppet
     # For the array $data, return an array of all keys that both end with "berry" and have
     # an even-numbered index
@@ -60,12 +60,12 @@ Puppet::Parser::Functions::newfunction(
     $filtered_data = $data.filter |$indexes, $values| { $indexes % 2 == 0 and $values =~ /berry$/ }
     # $filtered_data = [raspberry]
     ~~~
-    
+
     When the first argument is a hash, Puppet passes its keys to the first parameter and its
     values to the second parameter.
-    
+
     **Example**: Using the `filter` function with a hash and a two-parameter lambda
-    
+
     ~~~ puppet
     # For the hash $data, return a hash of all keys that both end with "berry" and have
     # values less than or equal to 1
@@ -73,7 +73,7 @@ Puppet::Parser::Functions::newfunction(
     $filtered_data = $data.filter |$keys, $values| { $keys =~ /berry$/ and $values <= 1 }
     # $filtered_data = {blueberry => 1}
     ~~~
-    
+
     - Since 4.0.0
   DOC
 ) do |_args|

data/lib/puppet/parser/functions/find_file.rb

@@ -1,30 +1,29 @@
 # frozen_string_literal: true
 
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :find_file,
   :type => :rvalue,
   :arity => -2,
   :doc => <<~DOC
     Finds an existing file from a module and returns its path.
-    
+
     The argument to this function should be a String as a `<MODULE NAME>/<FILE>`
     reference, which will search for `<FILE>` relative to a module's `files`
     directory. (For example, the reference `mysql/mysqltuner.pl` will search for the
     file `<MODULES DIRECTORY>/mysql/files/mysqltuner.pl`.)
-    
+
     This function can also accept:
-    
+
     * An absolute String path, which will check for the existence of a file from anywhere on disk.
     * Multiple String arguments, which will return the path of the **first** file
       found, skipping non existing files.
     * An array of string paths, which will return the path of the **first** file
       found from the given paths in the array, skipping non existing files.
-    
+
     The function returns `undef` if none of the given paths were found
-    
+
     - since 4.8.0
   DOC
 ) do |_args|
   Puppet::Parser::Functions::Error.is4x('find_file')
 end
-

data/lib/puppet/parser/functions/fqdn_rand.rb

@@ -3,7 +3,7 @@
 require 'digest/md5'
 require 'digest/sha2'
 
-Puppet::Parser::Functions::newfunction(:fqdn_rand, :arity => -2, :type => :rvalue, :doc =>
+Puppet::Parser::Functions.newfunction(:fqdn_rand, :arity => -2, :type => :rvalue, :doc =>
   "Usage: `fqdn_rand(MAX, [SEED], [DOWNCASE])`. MAX is required and must be a positive
   integer; SEED is optional and may be any number or string; DOWNCASE is optional
   and should be a boolean true or false.
@@ -37,10 +37,10 @@ Puppet::Parser::Functions::newfunction(:fqdn_rand, :arity => -2, :type => :rvalu
   # when running on a non-FIPS enabled platform and only using SHA256 on FIPS enabled
   # platforms.
   if Puppet::Util::Platform.fips_enabled?
-    seed = Digest::SHA256.hexdigest([fqdn,max,initial_seed].join(':')).hex
+    seed = Digest::SHA256.hexdigest([fqdn, max, initial_seed].join(':')).hex
   else
-    seed = Digest::MD5.hexdigest([fqdn,max,initial_seed].join(':')).hex
+    seed = Digest::MD5.hexdigest([fqdn, max, initial_seed].join(':')).hex
   end
 
-  Puppet::Util.deterministic_rand_int(seed,max)
+  Puppet::Util.deterministic_rand_int(seed, max)
 end

data/lib/puppet/parser/functions/generate.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Runs an external command and returns the results
-Puppet::Parser::Functions::newfunction(:generate, :arity => -2, :type => :rvalue,
-                                                  :doc => "Calls an external command on the Puppet master and returns
+Puppet::Parser::Functions.newfunction(:generate, :arity => -2, :type => :rvalue,
+                                                 :doc => "Calls an external command on the Puppet master and returns
     the results of the command. Any arguments are passed to the external command as
     arguments. If the generator does not exit with return code of 0,
     the generator is considered to have failed and a parse error is