Update puppetlabs/stdlib module
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / pick_default.rb
1 #
2 # pick_default.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:pick_default, :type => :rvalue, :doc => <<-DOC
6     This function is similar to a coalesce function in SQL in that it will return
7     the first value in a list of values that is not undefined or an empty string
8     If no value is found, it will return the last argument.
9
10     Typically, this function is used to check for a value in the Puppet
11     Dashboard/Enterprise Console, and failover to a default value like the
12     following:
13
14       $real_jenkins_version = pick_default($::jenkins_version, '1.449')
15
16     The value of $real_jenkins_version will first look for a top-scope variable
17     called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
18     Enterprise Console are brought into Puppet as top-scope variables), and,
19     failing that, will use a default value of 1.449.
20
21     Note that, contrary to the pick() function, the pick_default does not fail if
22     all arguments are empty. This allows pick_default to use an empty value as
23     default.
24 DOC
25              ) do |args|
26     raise 'Must receive at least one argument.' if args.empty?
27     default = args.last
28     args = args[0..-2].compact
29     args.delete(:undef)
30     args.delete(:undefined)
31     args.delete('')
32     args << default
33     return args[0]
34   end
35 end