bolt 0.20.3 → 0.20.5

data/vendored/puppet/lib/puppet/functions/min.rb

@@ -0,0 +1,182 @@
+# Returns the lowest value among a variable number of arguments.
+# Takes at least one argument.
+#
+# This function is (with one exception) compatible with the stdlib function
+# with the same name and performs deprecated type conversion before
+# comparison as follows:
+#
+# * If a value converted to String is an optionally '-' prefixed,
+#   string of digits, one optional decimal point, followed by optional
+#   decimal digits - then the comparison is performed on the values
+#   converted to floating point.
+# * If a value is not considered convertible to float, it is converted
+#   to a `String` and the comparison is a lexical compare where min is
+#   the lexicographical earlier value.
+# * A lexicographical compare is performed in a system locale - international
+#   characters may therefore not appear in what a user thinks is the correct order.
+# * The conversion rules apply to values in pairs - the rule must hold for both
+#   values - a value may therefore be compared using different rules depending
+#   on the "other value".
+# * The returned result found to be the "lowest" is the original unconverted value.
+#
+# The above rules have been deprecated in Puppet 6.0.0 as they produce strange results when
+# given values of mixed data types. In general, either convert values to be
+# all `String` or all `Numeric` values before calling the function, or call the
+# function with a lambda that performs type conversion and comparison. This because one
+# simply cannot compare `Boolean` with `Regexp` and with any arbitrary `Array`, `Hash` or
+# `Object` and getting a meaningful result.
+#
+# The one change in the function's behavior is when the function is given a single
+# array argument. The stdlib implementation would return that array as the result where
+# it now instead returns the max value from that array.
+#
+# @example 'min of values - stdlib compatible'
+#
+# ```puppet
+# notice(min(1)) # would notice 1
+# notice(min(1,2)) # would notice 1
+# notice(min("1", 2)) # would notice 1
+# notice(min("0777", 512)) # would notice 512, since "0777" is not converted from octal form
+# notice(min(0777, 512)) # would notice 511, since 0777 is decimal 511
+# notice(min('aa', 'ab')) # would notice 'aa'
+# notice(min(['a'], ['b'])) # would notice ['a'], since "['a']" is before "['b']"
+# ```
+#
+# @example find 'min' value in an array
+#
+# ```puppet
+# $x = [1,2,3,4]
+# notice(min(*$x)) # would notice 1
+# ```
+#
+# @example find 'min' value in an array directly - since Puppet 6.0.0
+#
+# ```puppet
+# $x = [1,2,3,4]
+# notice(min($x)) # would notice 1
+# notice($x.min) # would notice 1
+# ```
+# This example shows that a single array argument is used as the set of values
+# as opposed to being a single returned value.
+#
+# When calling with a lambda, it must accept two variables and it must return
+# one of -1, 0, or 1 depending on if first argument is before/lower than, equal to,
+# or higher/after the second argument.
+#
+# @example 'min of values using a lambda'
+#
+# ```puppet
+# notice(min("2", "10", "100") |$a, $b| { compare($a, $b) })
+# ```
+#
+# Would notice "10" as lower since it is lexicographically lower/before the other values. Without the
+# lambda the stdlib compatible (deprecated) behavior would have been to return "2" since number conversion kicks in.
+#
+Puppet::Functions.create_function(:min) do
+  dispatch :on_numeric do
+    repeated_param 'Numeric', :values
+  end
+
+  dispatch :on_string do
+    repeated_param 'String', :values
+  end
+
+  dispatch :on_single_numeric_array do
+    param 'Array[Numeric]', :values
+    optional_block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :on_single_string_array do
+    param 'Array[String]', :values
+    optional_block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :on_single_any_array do
+    param 'Array', :values
+    optional_block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :on_any_with_block do
+    repeated_param 'Any', :values
+    block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :on_any do
+    repeated_param 'Any', :values
+  end
+
+
+  # All are Numeric - ok now, will be ok later
+  def on_numeric(*args)
+    assert_arg_count(args)
+    args.min
+  end
+
+  # All are String, may convert to numeric (which is deprecated)
+  def on_string(*args)
+    assert_arg_count(args)
+
+    args.min do|a,b|
+      if a.to_s =~ %r{\A^-?\d+([._eE]\d+)?\z} && b.to_s =~ %r{\A-?\d+([._eE]\d+)?\z}
+        Puppet.warn_once('deprecations', 'min_function_numeric_coerce_string',
+          _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+        a.to_f <=> b.to_f
+      else
+        # case sensitive as in the stdlib function
+        a <=> b
+      end
+    end
+  end
+
+  def on_any_with_block(*args, &block)
+    args.min {|x,y| block.call(x,y) }
+  end
+
+  def on_single_numeric_array(array, &block)
+    if block_given?
+      on_any_with_block(*array, &block)
+    else
+      on_numeric(*array)
+    end
+  end
+
+  def on_single_string_array(array, &block)
+    if block_given?
+      on_any_with_block(*array, &block)
+    else
+      on_string(*array)
+    end
+  end
+
+  def on_single_any_array(array, &block)
+    if block_given?
+      on_any_with_block(*array, &block)
+    else
+      on_any(*array)
+    end
+  end
+
+  # Mix of data types - while only some compares are actually bad it will deprecate
+  # the entire call
+  #
+  def on_any(*args)
+    assert_arg_count(args)
+    args.min do |a, b|
+      as = a.to_s
+      bs = b.to_s
+      if as =~ %r{\A^-?\d+([._eE]\d+)?\z} && bs =~ %r{\A-?\d+([._eE]\d+)?\z}
+        Puppet.warn_once('deprecations', 'min_function_numeric_coerce_string',
+          _("The min() function's auto conversion of String to Numeric is deprecated - change to convert input before calling, or use lambda"))
+        a.to_f <=> b.to_f
+      else
+        Puppet.warn_once('deprecations', 'min_function_string_coerce_any',
+          _("The min() function's auto conversion of Any to String is deprecated - change to convert input before calling, or use lambda"))
+        as <=> bs
+      end
+    end
+  end
+
+  def assert_arg_count(args)
+    raise(ArgumentError, 'min(): Wrong number of arguments need at least one') if args.empty?
+  end
+end

data/vendored/puppet/lib/puppet/functions/next.rb

@@ -9,14 +9,7 @@ Puppet::Functions.create_function(:next) do
   end
 
   def next_impl(value = nil)
-    stacktrace = Puppet::Pops::PuppetStack.stacktrace()
-    if stacktrace.size > 0
-      file, line = stacktrace[0]
-    else
-      file = nil
-      line = nil
-    end
-
+    file, line = Puppet::Pops::PuppetStack.top_of_stack
     exc = Puppet::Pops::Evaluator::Next.new(value, file, line)
     raise exc
   end

data/vendored/puppet/lib/puppet/functions/reduce.rb

@@ -1,4 +1,4 @@
-# Applies a [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html)
+# Applies a [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html)
 # to every value in a data structure from the first argument, carrying over the returned
 # value of each iteration, and returns the result of the lambda's final iteration. This
 # lets you create a new value or data structure by combining values from the first

data/vendored/puppet/lib/puppet/functions/return.rb

@@ -9,14 +9,7 @@ Puppet::Functions.create_function(:return, Puppet::Functions::InternalFunction)
   end
 
   def return_impl(value = nil)
-    stacktrace = Puppet::Pops::PuppetStack.stacktrace()
-    if stacktrace.size > 0
-      file, line = stacktrace[0]
-    else
-      file = nil
-      line = nil
-    end
-
+    file, line = Puppet::Pops::PuppetStack.top_of_stack
     raise Puppet::Pops::Evaluator::Return.new(value, file, line)
   end
 end

data/vendored/puppet/lib/puppet/functions/reverse_each.rb

@@ -1,5 +1,5 @@
 # Reverses the order of the elements of something that is iterable and optionally runs a
-# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) for each
+# [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html) for each
 # element.
 #
 # This function takes one to two arguments:

data/vendored/puppet/lib/puppet/functions/round.rb

@@ -0,0 +1,24 @@
+# Returns an `Integer` value rounded to the nearest value.
+# Takes a single `Numeric` value as an argument.
+#
+# @example 'rounding a value'
+#
+# ```puppet
+# notice(round(2.9)) # would notice 3
+# notice(round(2.1)) # would notice 2
+# notice(round(-2.9)) # would notice -3
+# ```
+#
+Puppet::Functions.create_function(:round) do
+  dispatch :on_numeric do
+    param 'Numeric', :val
+  end
+
+  def on_numeric(x)
+    if x > 0
+      Integer(x + 0.5)
+    else
+      Integer(x - 0.5)
+    end
+  end
+end

data/vendored/puppet/lib/puppet/functions/rstrip.rb

@@ -0,0 +1,58 @@
+# Strips trailing spaces from a String
+#
+# This function is compatible with the stdlib function with the same name.
+#
+# The function does the following:
+# * For a `String` the conversion removes all trailing ASCII white space characters such as space, tab, newline, and return.
+#   It does not remove other space-like characters like hard space (Unicode U+00A0). (Tip, `/^[[:space:]]/` regular expression
+#   matches all space-like characters).
+# * For an `Iterable[Variant[String, Numeric]]` (for example an `Array`) each value is processed and the conversion is not recursive.
+# * If the value is `Numeric` it is simply returned (this is for backwards compatibility).
+# * An error is raised for all other data types.
+#
+# @example Removing trailing space from a String
+# ```puppet
+# "hello\n\t".lstrip()
+# camelcase("hello\n\t")
+# ```
+# Would both result in `"hello"`
+#
+# @example Removing trailing space from strings in an Array
+# ```puppet
+# ["hello\n\t", "hi\n\t"].lstrip()
+# lstrip(["hello\n\t", "hi\n\t"])
+# ```
+# Would both result in `['hello', 'hi']`
+#
+Puppet::Functions.create_function(:rstrip) do
+
+  dispatch :on_numeric do
+    param 'Numeric', :arg
+  end
+
+  dispatch :on_string do
+    param 'String', :arg
+  end
+
+  dispatch :on_iterable do
+    param 'Iterable[Variant[String, Numeric]]', :arg
+  end
+
+  # unit function - since the old implementation skipped Numeric values
+  def on_numeric(n)
+    n
+  end
+
+  def on_string(s)
+    s.rstrip
+  end
+
+  def on_iterable(a)
+    a.map {|x| do_rstrip(x) }
+  end
+
+  def do_rstrip(x)
+    # x can only be a String or Numeric because type constraints have been automatically applied
+    x.is_a?(String) ? x.rstrip : x
+  end
+end

data/vendored/puppet/lib/puppet/functions/size.rb

@@ -0,0 +1,15 @@
+# The same as length() - returns the size of an Array, Hash, String, or Binary value.
+#
+# @since 6.0.0 - also supporting Binary
+#
+Puppet::Functions.create_function(:size) do
+  dispatch :generic_size do
+    param 'Variant[Collection, String, Binary]', :arg
+  end
+
+
+  def generic_size(arg)
+    call_function('length', arg)
+  end
+
+end

data/vendored/puppet/lib/puppet/functions/sort.rb

@@ -0,0 +1,74 @@
+# Sorts an Array numerically or lexicographically or the characters of a String lexicographically.
+# Please note: This function is based on Ruby String comparison and as such may not be entirely UTF8 compatible.
+# To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
+#
+# This function is compatible with the function sort() in stdlib.
+# * Comparison of characters in a string always uses a system locale and may not be what is expected for a particular locale
+# * Sorting is based on Ruby's <=> operator unless a lambda is given that performs the comparison.
+#   * comparison of strings is case dependent (use lambda with `compare($a,$b)` to ignore case)
+#   * comparison of mixed data types raises an error (if there is the need to sort mixed data types use a lambda)
+#
+# Also see the `compare()` function for information about comparable data types in general.
+#
+# @example Sorting a String
+#
+# ```puppet
+# notice(sort("xadb")) # notices 'abdx'
+# ```
+#
+# @example Sorting an Array
+#
+# ```puppet
+# notice(sort([3,6,2])) # notices [2, 3, 6]
+# ```
+#
+# @example Sorting with a lambda
+#
+# ```puppet
+# notice(sort([3,6,2]) |$a,$b| { compare($a, $b) }) # notices [2, 3, 6]
+# notice(sort([3,6,2]) |$a,$b| { compare($b, $a) }) # notices [6, 3, 2]
+# ```
+#
+# @example Case independent sorting with a lambda
+#
+# ```puppet
+# notice(sort(['A','b','C']))                                    # notices ['A', 'C', 'b']
+# notice(sort(['A','b','C']) |$a,$b| { compare($a, $b) })        # notices ['A', 'b', 'C']
+# notice(sort(['A','b','C']) |$a,$b| { compare($a, $b, true) })  # notices ['A', 'b', 'C']
+# notice(sort(['A','b','C']) |$a,$b| { compare($a, $b, false) }) # notices ['A','C', 'b']
+# ```
+#
+# @example Sorting Array with Numeric and String so that numbers are before strings
+#
+# ```puppet
+# notice(sort(['b', 3, 'a', 2]) |$a, $b| {
+#   case [$a, $b] {
+#     [String, Numeric] : { 1 }
+#     [Numeric, String] : { -1 }
+#     default:            { compare($a, $b) }
+#   }
+# })
+# ```
+# Would notice [2,3,'a','b']
+#
+# @since 6.0.0 - supporting a lambda to do compare
+#
+Puppet::Functions.create_function(:sort) do
+  dispatch :sort_string do
+    param 'String', :string_value
+    optional_block_param 'Callable[2,2]', :block
+  end
+
+  dispatch :sort_array do
+    param 'Array', :array_value
+    optional_block_param 'Callable[2,2]', :block
+  end
+
+  def sort_string(s, &block)
+    sort_array(s.split(''), &block).join('')
+  end
+
+  def sort_array(a, &block)
+    a.sort(&block)
+  end
+end

data/vendored/puppet/lib/puppet/functions/step.rb

@@ -1,5 +1,5 @@
 # Provides stepping with given interval over elements in an iterable and optionally runs a
-# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) for each
+# [lambda](https://puppet.com/docs/puppet/latest/lang_lambdas.html) for each
 # element.
 #
 # This function takes two to three arguments:

data/vendored/puppet/lib/puppet/functions/strftime.rb

@@ -202,13 +202,7 @@ Puppet::Functions.create_function(:strftime) do
   end
 
   def legacy_strftime(format, timezone = nil)
-    stacktrace = Puppet::Pops::PuppetStack.stacktrace()
-    if stacktrace.size > 0
-      file, line = stacktrace[0]
-    else
-      file = nil
-      line = nil
-    end
+    file, line = Puppet::Pops::PuppetStack.top_of_stack
     Puppet.warn_once('deprecations', 'legacy#strftime',
       _('The argument signature (String format, [String timezone]) is deprecated for #strftime. See #strftime documentation and Timespan type for more info'),
       file, line)

data/vendored/puppet/lib/puppet/functions/strip.rb

@@ -0,0 +1,58 @@
+# Strips leading and trailing spaces from a String
+#
+# This function is compatible with the stdlib function with the same name.
+#
+# The function does the following:
+# * For a `String` the conversion removes all leading and trailing ASCII white space characters such as space, tab, newline, and return.
+#   It does not remove other space-like characters like hard space (Unicode U+00A0). (Tip, `/^[[:space:]]/` regular expression
+#   matches all space-like characters).
+# * For an `Iterable[Variant[String, Numeric]]` (for example an `Array`) each value is processed and the conversion is not recursive.
+# * If the value is `Numeric` it is simply returned (this is for backwards compatibility).
+# * An error is raised for all other data types.
+#
+# @example Removing leading and trailing space from a String
+# ```puppet
+# " hello\n\t".lstrip()
+# camelcase(" hello\n\t")
+# ```
+# Would both result in `"hello"`
+#
+# @example Removing trailing space from strings in an Array
+# ```puppet
+# [" hello\n\t", " hi\n\t"].lstrip()
+# lstrip([" hello\n\t", " hi\n\t"])
+# ```
+# Would both result in `['hello', 'hi']`
+#
+Puppet::Functions.create_function(:strip) do
+
+  dispatch :on_numeric do
+    param 'Numeric', :arg
+  end
+
+  dispatch :on_string do
+    param 'String', :arg
+  end
+
+  dispatch :on_iterable do
+    param 'Iterable[Variant[String, Numeric]]', :arg
+  end
+
+  # unit function - since the old implementation skipped Numeric values
+  def on_numeric(n)
+    n
+  end
+
+  def on_string(s)
+    s.strip
+  end
+
+  def on_iterable(a)
+    a.map {|x| do_strip(x) }
+  end
+
+  def do_strip(x)
+    # x can only be a String or Numeric because type constraints have been automatically applied
+    x.is_a?(String) ? x.strip : x
+  end
+end