puppet-retrospec 1.5.0 → 1.6.0

data/vendor/pup410/lib/puppet/parser/functions/slice.rb

@@ -0,0 +1,39 @@
+Puppet::Parser::Functions::newfunction(
+  :slice,
+  :type => :rvalue,
+  :arity => -3,
+  :doc => <<-DOC
+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}" }
+
+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]]
+
+You can also optionally pass a lambda to slice.
+
+    $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).
+If there are fewer remaining elements than the slice size for the last slice, it will contain the remaining
+elements. If the lambda has multiple parameters, excess parameters are set to undef for an array, or
+to empty arrays for a hash.
+
+    $a.slice(2) |$first, $second| { ... }
+
+- Since 4.0.0
+DOC
+) do |args|
+  Puppet::Parser::Functions::Error.is4x('slice')
+end

data/vendor/pup410/lib/puppet/parser/functions/split.rb

@@ -0,0 +1,28 @@
+module Puppet::Parser::Functions
+
+  newfunction(
+  :split, :type => :rvalue,
+  :arity => 2,
+
+    :doc => "\
+Split a string variable into an array using the specified split regexp.
+
+*Example:*
+
+    $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']`.
+
+Note that in the second example, we split on a literal string that contains
+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.") do |args|
+
+    Error.is4x('split')
+  end
+end

data/vendor/pup410/lib/puppet/parser/functions/step.rb

@@ -0,0 +1,84 @@
+Puppet::Parser::Functions::newfunction(
+  :step,
+  :type => :rvalue,
+  :arity => -1,
+  :doc => <<-DOC
+Provides stepping with given interval over elements in an iterable and optionally runs a
+[lambda](http://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
+
+DOC
+) do |args|
+  Puppet::Parser::Functions::Error.is4x('step')
+end

data/vendor/pup410/lib/puppet/parser/functions/strftime.rb

@@ -0,0 +1,185 @@
+Puppet::Parser::Functions::newfunction(
+  :strftime,
+  :type => :rvalue,
+  :arity => -3,
+  :doc => <<DOC
+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.
+
+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
+DOC
+) do |args|
+  Puppet::Parser::Functions::Error.is4x('strftime')
+end

data/vendor/pup410/lib/puppet/parser/functions/then.rb

@@ -0,0 +1,73 @@
+Puppet::Parser::Functions::newfunction(
+  :then,
+  :type => :rvalue,
+  :arity => -2,
+  :doc => <<-DOC
+Call a [lambda](https://docs.puppet.com/puppet/latest/reference/lang_lambdas.html)
+with the given argument unless the argument is undef. Return `undef` if argument is
+`undef`, and otherwise the result of giving the argument to the lambda.
+
+This is useful to process a sequence of operations where an intermediate
+result may be `undef` (which makes the entire sequence `undef`).
+The `then` function is especially useful with the function `dig` which
+performs in a similar way "digging out" a value in a complex structure.
+
+**Example:** Using `dig` and `then`
+
+```puppet
+$data = {a => { b => [{x => 10, y => 20}, {x => 100, y => 200}]}}
+notice $data.dig(a, b, 1, x).then |$x| { $x * 2 }
+```
+
+Would notice the value 200
+
+Contrast this with:
+
+```puppet
+$data = {a => { b => [{x => 10, y => 20}, {ex => 100, why => 200}]}}
+notice $data.dig(a, b, 1, x).then |$x| { $x * 2 }
+```
+
+Which would notice `undef` since the last lookup of 'x' results in `undef` which
+is returned (without calling the lambda given to the `then` function).
+
+As a result there is no need for conditional logic or a temporary (non local)
+variable as the result is now either the wanted value (`x`) multiplied
+by 2 or `undef`.
+
+Calls to `then` can be chained. In the next example, a structure is using an offset based on
+using 1 as the index to the first element (instead of 0 which is used in the language).
+We are not sure if user input actually contains an index at all, or if it is
+outside the range of available names.args.
+
+**Example:** Chaining calls to the `then` function
+
+```puppet
+# Names to choose from
+$names = ['Ringo', 'Paul', 'George', 'John']
+
+# Structure where 'beatle 2' is wanted (but where the number refers
+# to 'Paul' because input comes from a source using 1 for the first
+# element).
+
+$data = ['singer', { beatle => 2 }]
+$picked = assert_type(String,
+  # the data we are interested in is the second in the array,
+  # a hash, where we want the value of the key 'beatle'
+  $data.dig(1, 'beatle')
+    # and we want the index in $names before the given index
+    .then |$x| { $names[$x-1] }
+    # so we can construct a string with that beatle's name
+    .then |$x| { "Picked Beatle '${x}'" }
+)
+```
+
+Would notice "Picked Beatle 'Paul'", and would raise an error if the result
+was not a String.
+
+* Since 4.5.0
+
+DOC
+) do |args|
+  Puppet::Parser::Functions::Error.is4x('then')
+end

data/vendor/pup410/lib/puppet/parser/functions/type.rb

@@ -0,0 +1,53 @@
+Puppet::Parser::Functions::newfunction(
+  :type,
+  :type => :rvalue,
+  :arity => -1,
+  :doc => <<-DOC
+Returns the data type of a given value with a given degree of generality.
+
+```puppet
+type InferenceFidelity = Enum[generalized, reduced, detailed]
+
+function type(Any $value, InferenceFidelity $fidelity = 'detailed') # returns Type
+```
+
+ **Example:** Using `type`
+
+ ``` puppet
+ notice type(42) =~ Type[Integer]
+ ```
+
+ Would notice `true`.
+
+ By default, the best possible inference is made where all details are retained.
+ This is good when the type is used for further type calculations but is overwhelmingly
+ rich in information if it is used in a error message.
+
+ The optional argument `$fidelity` may be given as (from lowest to highest fidelity):
+
+ * `generalized` - reduces to common type and drops size constraints
+ * `reduced` - reduces to common type in collections
+ * `detailed` - (default) all details about inferred types is retained
+
+ **Example:** Using `type()` with different inference fidelity:
+
+ ``` puppet
+ notice type([3.14, 42], 'generalized')
+ notice type([3.14, 42], 'reduced'')
+ notice type([3.14, 42], 'detailed')
+ notice type([3.14, 42])
+ ```
+
+ Would notice the four values:
+
+ 1. 'Array[Numeric]'
+ 2. 'Array[Numeric, 2, 2]'
+ 3. 'Tuple[Float[3.14], Integer[42,42]]]'
+ 4. 'Tuple[Float[3.14], Integer[42,42]]]'
+
+ * Since 4.4.0
+
+DOC
+) do |args|
+  Puppet::Parser::Functions::Error.is4x('type')
+end