3rdparty/modules/stdlib/lib/puppet/parser/functions/unique.rb

   1 #
   2 # unique.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:unique, :type => :rvalue, :doc => <<-DOC
   6     @summary
   7       This function will remove duplicates from strings and arrays.
   8
   9     @return
  10       String or array with duplicates removed
  11
  12     @example **Usage**
  13
  14       unique("aabbcc")
  15       Will return: abc
  16
  17       You can also use this with arrays:
  18
  19       unique(["a","a","b","b","c","c"])
  20       This returns: ["a","b","c"]
  21
  22     DOC
  23              ) do |arguments|
  24
  25     if Puppet::Util::Package.versioncmp(Puppet.version, '5.0.0') >= 0
  26       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.'])
  27     end
  28
  29     raise(Puppet::ParseError, "unique(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
  30
  31     value = arguments[0]
  32
  33     unless value.is_a?(Array) || value.is_a?(String)
  34       raise(Puppet::ParseError, 'unique(): Requires either array or string to work with')
  35     end
  36
  37     result = value.clone
  38
  39     string = value.is_a?(String) ? true : false
  40
  41     # We turn any string value into an array to be able to shuffle ...
  42     result = string ? result.split('') : result
  43     result = result.uniq # Remove duplicates ...
  44     result = string ? result.join : result
  45
  46     return result
  47   end
  48 end
  49
  50 # vim: set ts=2 sw=2 et :