Puppet Function: shuffle

Defined in:
modules/stdlib/lib/puppet/parser/functions/shuffle.rb
Function type:
Ruby 3.x API

Overview

shuffle()Any

@summary

Randomizes the order of a string or array elements.

Returns:

  • (Any)

    randomized string or array



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'modules/stdlib/lib/puppet/parser/functions/shuffle.rb', line 5

newfunction(:shuffle, :type => :rvalue, :doc => <<-DOC
@summary
  Randomizes the order of a string or array elements.

 @return
   randomized string or array
DOC
           ) do |arguments|

  raise(Puppet::ParseError, "shuffle(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  value = arguments[0]

  unless value.is_a?(Array) || value.is_a?(String)
    raise(Puppet::ParseError, 'shuffle(): Requires either array or string to work with')
  end

  result = value.clone

  string = value.is_a?(String) ? true : false

  # Check whether it makes sense to shuffle ...
  return result if result.size <= 1

  # We turn any string value into an array to be able to shuffle ...
  result = string ? result.split('') : result

  elements = result.size

  # Simple implementation of Fisher–Yates in-place shuffle ...
  elements.times do |i|
    j = rand(elements - i) + i
    result[j], result[i] = result[i], result[j]
  end

  result = string ? result.join : result

  return result
end