puppet 5.4.0 → 5.5.0

data/lib/puppet/functions/next.rb

@@ -1,4 +1,4 @@
-# Make iteration continue with the next value optionally given a value for this iteration.
+# Makes iteration continue with the next value, optionally with a given value for this iteration.
 # If a value is not given it defaults to `undef`
 #
 # @since 4.7.0

data/lib/puppet/functions/notice.rb

@@ -1,4 +1,4 @@
-# Log a message on the server at level notice.
+# Logs a message on the server at level `notice`.
 Puppet::Functions.create_function(:notice, Puppet::Functions::InternalFunction) do
   # @param values The values to log.
   # @return [Undef]

data/lib/puppet/functions/reduce.rb

@@ -47,7 +47,7 @@
 #
 # @example Using the `reduce` function
 #
-# ~~~ puppet
+# ```puppet
 # # Reduce the array $data, returning the sum of all values in the array.
 # $data = [1, 2, 3]
 # $sum = $data.reduce |$memo, $value| { $memo + $value }
@@ -68,11 +68,11 @@
 #   [$string, $number]
 # }
 # # $combine contains [abc, 6]
-# ~~~
+# ```
 #
 # @example Using the `reduce` function with a start memo and two-parameter lambda
 #
-# ~~~ puppet
+# ```puppet
 # # Reduce the array $data, returning the sum of all values in the array and starting
 # # with $memo set to an arbitrary value instead of $data's first value.
 # $data = [1, 2, 3]
@@ -92,11 +92,11 @@
 # # At the start of the lambda's first iteration, $memo contains [d, 4] and $value
 # # contains [a, 1].
 # # $combine contains [dabc, 10]
-# ~~~
+# ```
 #
 # @example Using the `reduce` function to reduce a hash of hashes
 #
-# ~~~ puppet
+# ```puppet
 # # Reduce a hash of hashes $data, merging defaults into the inner hashes.
 # $data = {
 #   'connection1' => {
@@ -123,7 +123,7 @@
 # # the first [key, value] tuple. The key in $data is, therefore, given by $x[0]. In
 # # subsequent rounds, $memo retains the value returned by the expression, i.e.
 # # $memo + { $x[0] => $defaults + $data[$x[0]] }.
-# ~~~
+# ```
 #
 # @since 4.0.0
 #

data/lib/puppet/functions/regsubst.rb

@@ -1,4 +1,4 @@
-# Perform regexp replacement on a string or array of strings.
+# Performs regexp replacement on a string or array of strings.
 #
 # @param target [String, Array[String]]
 #      The string or array of strings to operate on.  If an array, the replacement will be
@@ -27,10 +27,16 @@
 # @return [Array[String], String] The result of the substitution. Result type is the same as for the target parameter.
 #
 # @example Get the third octet from the node's IP address:
-#     $i3 = regsubst($ipaddress,'^(\\d+)\\.(\\d+)\\.(\\d+)\\.(\\d+)$','\\3')
+#
+# ```puppet
+# $i3 = regsubst($ipaddress,'^(\\d+)\\.(\\d+)\\.(\\d+)\\.(\\d+)$','\\3')
+# ```
 #
 # @example Put angle brackets around each octet in the node's IP address:
-#     $x = regsubst($ipaddress, /([0-9]+)/, '<\\1>', 'G')
+#
+# ```puppet
+# $x = regsubst($ipaddress, /([0-9]+)/, '<\\1>', 'G')
+# ```
 #
 Puppet::Functions.create_function(:regsubst) do
   dispatch :regsubst_string do

data/lib/puppet/functions/require.rb

@@ -1,5 +1,39 @@
-# Requires the specified classes
-# For documentation see the 3.x function stub
+# Requires the specified classes.
+# Evaluate one or more classes, adding the required class as a dependency.
+#
+# The relationship metaparameters work well for specifying relationships
+# between individual resources, but they can be clumsy for specifying
+# relationships between classes.  This function is a superset of the
+# 'include' function, adding a class relationship so that the requiring
+# class depends on the required class.
+#
+# Warning: using require in place of include can lead to unwanted dependency cycles.
+#
+# For instance the following manifest, with 'require' instead of 'include' would produce a nasty
+# dependence cycle, because notify imposes a before between File[/foo] and Service[foo]:
+#
+# ```puppet
+# class myservice {
+#   service { foo: ensure => running }
+# }
+#
+# class otherstuff {
+#    include myservice
+#    file { '/foo': notify => Service[foo] }
+# }
+# ```
+#
+# Note that this function only works with clients 0.25 and later, and it will
+# fail if used with earlier clients.
+#
+# You must use the class's full name;
+# relative names are not allowed. In addition to names in string form,
+# you may also directly use Class and Resource Type values that are produced when evaluating
+# resource and relationship expressions.
+#
+# - Since 4.0.0 Class and Resource types, absolute names
+# - Since 4.7.0 Returns an Array[Type[Class]] with references to the required classes
+#
 Puppet::Functions.create_function(:require, Puppet::Functions::InternalFunction) do
   dispatch :require_impl do
     scope_param

data/lib/puppet/functions/return.rb

@@ -1,4 +1,4 @@
-# Make iteration continue with the next value optionally given a value for this iteration.
+# Makes iteration continue with the next value, optionally with a given value for this iteration.
 # If a value is not given it defaults to `undef`
 #
 # @since 4.7.0

data/lib/puppet/functions/reverse_each.rb

@@ -1,5 +1,74 @@
-# Reverses the order of the elements of something that is iterable.
-# (Documentation in 3.x stub)
+# 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
+# element.
+#
+# This function takes one to two arguments:
+#
+# 1. An `Iterable` that the function will iterate over.
+# 2. An optional lambda, which the function calls for each element in the first argument. It must
+#    request one parameter.
+#
+# @example Using the `reverse_each` function
+#
+# ```puppet
+# $data.reverse_each |$parameter| { <PUPPET CODE BLOCK> }
+# ```
+#
+# or
+#
+# ```puppet
+# $reverse_data = $data.reverse_each
+# ```
+#
+# or
+#
+# ```puppet
+# reverse_each($data) |$parameter| { <PUPPET CODE BLOCK> }
+# ```
+#
+# or
+#
+# ```puppet
+# $reverse_data = reverse_each($data)
+# ```
+#
+# When no second argument is present, Puppet returns an `Iterable` that represents the reverse
+# order of its first argument. This allows methods on `Iterable` to be chained.
+#
+# When a lambda is given as the second argument, Puppet iterates the first argument in reverse
+# order and passes each value in turn to the lambda, then returns `undef`.
+#
+# @example Using the `reverse_each` function with an array and a one-parameter lambda
+#
+# ```puppet
+# # Puppet will log a notice for each of the three items
+# # in $data in reverse order.
+# $data = [1,2,3]
+# $data.reverse_each |$item| { notice($item) }
+# ```
+#
+# When no second argument is present, Puppet returns a new `Iterable` which allows it to
+# be directly chained into another function that takes an `Iterable` as an argument.
+#
+# @example Using the `reverse_each` function chained with a `map` function.
+#
+# ```puppet
+# # For the array $data, return an array containing each
+# # value multiplied by 10 in reverse order
+# $data = [1,2,3]
+# $transformed_data = $data.reverse_each.map |$item| { $item * 10 }
+# # $transformed_data is set to [30,20,10]
+# ```
+#
+# @example Using `reverse_each` function chained with a `map` in alternative syntax
+#
+# ```puppet
+# # For the array $data, return an array containing each
+# # value multiplied by 10 in reverse order
+# $data = [1,2,3]
+# $transformed_data = map(reverse_each($data)) |$item| { $item * 10 }
+# # $transformed_data is set to [30,20,10]
+# ```
 #
 # @since 4.4.0
 #

data/lib/puppet/functions/slice.rb

@@ -1,24 +1,34 @@
+# Slices an array or hash into pieces of a given size.
+#
 # This function takes two mandatory arguments: the first should be an array or hash, and the second specifies
 # the number of elements to include in each slice.
 #
 # When the first argument is a hash, each key value pair is counted as one. For example, a slice size of 2 will produce
 # an array of two arrays with key, and value.
 #
-#     $a.slice(2) |$entry|          { notice "first ${$entry[0]}, second ${$entry[1]}" }
-#     $a.slice(2) |$first, $second| { notice "first ${first}, second ${second}" }
+# @example Slicing a Hash
 #
+# ```puppet
+# $a.slice(2) |$entry|          { notice "first ${$entry[0]}, second ${$entry[1]}" }
+# $a.slice(2) |$first, $second| { notice "first ${first}, second ${second}" }
+# ```
 # The function produces a concatenated result of the slices.
 #
-#     slice([1,2,3,4,5,6], 2) # produces [[1,2], [3,4], [5,6]]
-#     slice(Integer[1,6], 2)  # produces [[1,2], [3,4], [5,6]]
-#     slice(4,2)              # produces [[0,1], [2,3]]
-#     slice('hello',2)        # produces [[h, e], [l, l], [o]]
+# @example Slicing an Array
 #
+# ```puppet
+# slice([1,2,3,4,5,6], 2) # produces [[1,2], [3,4], [5,6]]
+# slice(Integer[1,6], 2)  # produces [[1,2], [3,4], [5,6]]
+# slice(4,2)              # produces [[0,1], [2,3]]
+# slice('hello',2)        # produces [[h, e], [l, l], [o]]
+# ```
 #
-# You can also optionally pass a lambda to slice.
+# @example Passing a lambda to a slice (optional)
 #
-#     $a.slice($n) |$x| { ... }
-#     slice($a) |$x| { ... }
+# ```puppet
+#  $a.slice($n) |$x| { ... }
+#  slice($a) |$x| { ... }
+# ```
 #
 # The lambda should have either one parameter (receiving an array with the slice), or the same number
 # of parameters as specified by the slice size (each parameter receiving its part of the slice).
@@ -26,7 +36,11 @@
 # elements. If the lambda has multiple parameters, excess parameters are set to undef for an array, or
 # to empty arrays for a hash.
 #
+# @example Getting individual values of a slice
+#
+# ```puppet
 #     $a.slice(2) |$first, $second| { ... }
+# ```
 #
 # @since 4.0.0
 #

data/lib/puppet/functions/split.rb

@@ -1,19 +1,21 @@
-# Split a string variable into an array using the specified pattern.
+# Splits a string into an array using a given pattern.
 # The pattern can be a string, regexp or regexp type.
 #
-# @example
+# @example Splitting a String value
 #
-#     $string     = 'v1.v2:v3.v4'
-#     $array_var1 = split($string, /:/)
-#     $array_var2 = split($string, '[.]')
-#     $array_var3 = split($string, Regexp['[.:]'])
+# ```puppet
+# $string     = 'v1.v2:v3.v4'
+# $array_var1 = split($string, /:/)
+# $array_var2 = split($string, '[.]')
+# $array_var3 = split($string, Regexp['[.:]'])
 #
-# `$array_var1` now holds the result `['v1.v2', 'v3.v4']`,
-# while `$array_var2` holds `['v1', 'v2:v3', 'v4']`, and
-# `$array_var3` holds `['v1', 'v2', 'v3', 'v4']`.
+# #`$array_var1` now holds the result `['v1.v2', 'v3.v4']`,
+# # while `$array_var2` holds `['v1', 'v2:v3', 'v4']`, and
+# # `$array_var3` holds `['v1', 'v2', 'v3', 'v4']`.
+# ```
 #
 # Note that in the second example, we split on a literal string that contains
-# a regexp meta-character (.), which must be escaped.  A simple
+# a regexp meta-character (`.`), which must be escaped.  A simple
 # way to do that for a single character is to enclose it in square
 # brackets; a backslash will also escape a single character.
 #

data/lib/puppet/functions/step.rb

@@ -1,4 +1,76 @@
-# (Documentation in 3.x stub)
+# 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
+# element.
+#
+# This function takes two to three arguments:
+#
+# 1. An 'Iterable' that the function will iterate over.
+# 2. An `Integer` step factor. This must be a positive integer.
+# 3. An optional lambda, which the function calls for each element in the interval. It must
+#    request one parameter.
+#
+# @example Using the `step` function
+#
+# ```puppet
+# $data.step(<n>) |$parameter| { <PUPPET CODE BLOCK> }
+# ```
+#
+# or
+#
+# ```puppet
+# $stepped_data = $data.step(<n>)
+# ```
+#
+# or
+#
+# ```puppet
+# step($data, <n>) |$parameter| { <PUPPET CODE BLOCK> }
+# ```
+#
+# or
+#
+# ```puppet
+# $stepped_data = step($data, <n>)
+# ```
+#
+# When no block is given, Puppet returns an `Iterable` that yields the first element and every nth successor
+# element, from its first argument. This allows functions on iterables to be chained.
+# When a block is given, Puppet iterates and calls the block with the first element and then with
+# every nth successor element. It then returns `undef`.
+#
+# @example Using the `step` function with an array, a step factor, and a one-parameter block
+#
+# ```puppet
+# # For the array $data, call a block with the first element and then with each 3rd successor element
+# $data = [1,2,3,4,5,6,7,8]
+# $data.step(3) |$item| {
+#  notice($item)
+# }
+# # Puppet notices the values '1', '4', '7'.
+# ```
+
+# When no block is given, Puppet returns a new `Iterable` which allows it to be directly chained into
+# another function that takes an `Iterable` as an argument.
+#
+# @example Using the `step` function chained with a `map` function.
+#
+# ```puppet
+# # For the array $data, return an array, set to the first element and each 5th successor element, in reverse
+# # order multiplied by 10
+# $data = Integer[0,20]
+# $transformed_data = $data.step(5).map |$item| { $item * 10 }
+# $transformed_data contains [0,50,100,150,200]
+# ```
+#
+# @example The same example using `step` function chained with a `map` in alternative syntax
+#
+# ```puppet
+# # For the array $data, return an array, set to the first and each 5th
+# # successor, in reverse order, multiplied by 10
+# $data = Integer[0,20]
+# $transformed_data = map(step($data, 5)) |$item| { $item * 10 }
+# $transformed_data contains [0,50,100,150,200]
+# ```
 #
 # @since 4.4.0
 #

data/lib/puppet/functions/strftime.rb

@@ -1,7 +1,181 @@
-# (Documentation in 3.x stub)
+# Formats timestamp or timespan according to the directives in the given format string. The directives begins with a percent (%) character.
+# Any text not listed as a directive will be passed through to the output string.
 #
-# @since 4.8.0
+# A third optional timezone argument can be provided. The first argument will then be formatted to represent a local time in that
+# timezone. The timezone can be any timezone that is recognized when using the '%z' or '%Z' formats, or the word 'current', in which
+# case the current timezone of the evaluating process will be used. The timezone argument is case insensitive.
 #
+# The default timezone, when no argument is provided, or when using the keyword `default`, is 'UTC'.
+#
+# The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
+# a conversion specifier as follows:
+#
+# ```
+# %[Flags][Width]Conversion
+# ```
+#
+# ### Flags that controls padding
+#
+# | Flag  | Meaning
+# | ----  | ---------------
+# | -     | Don't pad numerical output
+# | _     | Use spaces for padding
+# | 0     | Use zeros for padding
+#
+# ### `Timestamp` specific flags
+#
+# | Flag  | Meaning
+# | ----  | ---------------
+# | #     | Change case
+# | ^     | Use uppercase
+# | :     | Use colons for %z
+#
+# ### Format directives applicable to `Timestamp` (names and padding can be altered using flags):
+#
+# **Date (Year, Month, Day):**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | Y | Year with century, zero-padded to at least 4 digits |
+# | C | year / 100 (rounded down such as 20 in 2009) |
+# | y | year % 100 (00..99) |
+# | m | Month of the year, zero-padded (01..12) |
+# | B | The full month name ("January") |
+# | b | The abbreviated month name ("Jan") |
+# | h | Equivalent to %b |
+# | d | Day of the month, zero-padded (01..31) |
+# | e | Day of the month, blank-padded ( 1..31) |
+# | j | Day of the year (001..366) |
+#
+# **Time (Hour, Minute, Second, Subsecond):**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | H | Hour of the day, 24-hour clock, zero-padded (00..23) |
+# | k | Hour of the day, 24-hour clock, blank-padded ( 0..23) |
+# | I | Hour of the day, 12-hour clock, zero-padded (01..12) |
+# | l | Hour of the day, 12-hour clock, blank-padded ( 1..12) |
+# | P | Meridian indicator, lowercase ("am" or "pm") |
+# | p | Meridian indicator, uppercase ("AM" or "PM") |
+# | M | Minute of the hour (00..59) |
+# | S | Second of the minute (00..60) |
+# | L | Millisecond of the second (000..999). Digits under millisecond are truncated to not produce 1000 |
+# | N | Fractional seconds digits, default is 9 digits (nanosecond). Digits under a specified width are truncated to avoid carry up |
+#
+# **Time (Hour, Minute, Second, Subsecond):**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | z   | Time zone as hour and minute offset from UTC (e.g. +0900) |
+# | :z  | hour and minute offset from UTC with a colon (e.g. +09:00) |
+# | ::z | hour, minute and second offset from UTC (e.g. +09:00:00) |
+# | Z   | Abbreviated time zone name or similar information.  (OS dependent) |
+#
+# **Weekday:**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | A | The full weekday name ("Sunday") |
+# | a | The abbreviated name ("Sun") |
+# | u | Day of the week (Monday is 1, 1..7) |
+# | w | Day of the week (Sunday is 0, 0..6) |
+#
+# **ISO 8601 week-based year and week number:**
+#
+# The first week of YYYY starts with a Monday and includes YYYY-01-04.
+# The days in the year before the first week are in the last week of
+# the previous year.
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | G | The week-based year |
+# | g | The last 2 digits of the week-based year (00..99) |
+# | V | Week number of the week-based year (01..53) |
+#
+# **Week number:**
+#
+# The first week of YYYY that starts with a Sunday or Monday (according to %U
+# or %W). The days in the year before the first week are in week 0.
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | U | Week number of the year. The week starts with Sunday. (00..53) |
+# | W | Week number of the year. The week starts with Monday. (00..53) |
+#
+# **Seconds since the Epoch:**
+#
+# | Format | Meaning |
+# | s | Number of seconds since 1970-01-01 00:00:00 UTC. |
+#
+# **Literal string:**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | n | Newline character (\n) |
+# | t | Tab character (\t) |
+# | % | Literal "%" character |
+#
+# **Combination:**
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | c | date and time (%a %b %e %T %Y) |
+# | D | Date (%m/%d/%y) |
+# | F | The ISO 8601 date format (%Y-%m-%d) |
+# | v | VMS date (%e-%^b-%4Y) |
+# | x | Same as %D |
+# | X | Same as %T |
+# | r | 12-hour time (%I:%M:%S %p) |
+# | R | 24-hour time (%H:%M) |
+# | T | 24-hour time (%H:%M:%S) |
+#
+# @example Using `strftime` with a `Timestamp`:
+#
+# ```puppet
+# $timestamp = Timestamp('2016-08-24T12:13:14')
+#
+# # Notice the timestamp using a format that notices the ISO 8601 date format
+# notice($timestamp.strftime('%F')) # outputs '2016-08-24'
+#
+# # Notice the timestamp using a format that notices weekday, month, day, time (as UTC), and year
+# notice($timestamp.strftime('%c')) # outputs 'Wed Aug 24 12:13:14 2016'
+#
+# # Notice the timestamp using a specific timezone
+# notice($timestamp.strftime('%F %T %z', 'PST')) # outputs '2016-08-24 04:13:14 -0800'
+#
+# # Notice the timestamp using timezone that is current for the evaluating process
+# notice($timestamp.strftime('%F %T', 'current')) # outputs the timestamp using the timezone for the current process
+# ```
+#
+# ### Format directives applicable to `Timespan`:
+#
+# | Format | Meaning |
+# | ------ | ------- |
+# | D | Number of Days |
+# | H | Hour of the day, 24-hour clock |
+# | M | Minute of the hour (00..59) |
+# | S | Second of the minute (00..59) |
+# | L | Millisecond of the second (000..999). Digits under millisecond are truncated to not produce 1000. |
+# | N | Fractional seconds digits, default is 9 digits (nanosecond). Digits under a specified length are truncated to avoid carry up |
+#
+# The format directive that represents the highest magnitude in the format will be allowed to overflow.
+# I.e. if no "%D" is used but a "%H" is present, then the hours will be more than 23 in case the
+# timespan reflects more than a day.
+#
+# @example Using `strftime` with a Timespan and a format
+#
+# ```puppet
+# $duration = Timespan({ hours => 3, minutes => 20, seconds => 30 })
+#
+# # Notice the duration using a format that outputs <hours>:<minutes>:<seconds>
+# notice($duration.strftime('%H:%M:%S')) # outputs '03:20:30'
+#
+# # Notice the duration using a format that outputs <minutes>:<seconds>
+# notice($duration.strftime('%M:%S')) # outputs '200:30'
+# ```
+#
+# - Since 4.8.0
+# 
 Puppet::Functions.create_function(:strftime) do
   dispatch :format_timespan do
     param 'Timespan', :time_object