Puppet Function: unique

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

Overview

unique()Any

This function will remove duplicates from strings and arrays.

Examples:

unique("aabbcc")

Will return:

abc

You can also use this with arrays:

unique(["a","a","b","b","c","c"])

This returns:

["a","b","c"]

Returns:

  • (Any)


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
44
45
46
47
48
# File 'modules/stdlib/lib/puppet/parser/functions/unique.rb', line 5

newfunction(:unique, :type => :rvalue, :doc => <<-DOC
  This function will remove duplicates from strings and arrays.

  *Examples:*

      unique("aabbcc")

  Will return:

      abc

  You can also use this with arrays:

      unique(["a","a","b","b","c","c"])

  This returns:

      ["a","b","c"]
  DOC
           ) do |arguments|

  if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0
    function_deprecation([:unique, 'This method is deprecated, please use the core puppet unique function. There is further documentation for the function in the release notes of Puppet 5.0.'])
  end

  raise(Puppet::ParseError, "unique(): 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, 'unique(): Requires either array or string to work with')
  end

  result = value.clone

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

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

  return result
end