enhance bool2str function

Author: mmckinst

README.markdown

@@ -170,6 +170,22 @@ Converts a boolean to a number. Converts values:
   * 'true', 't', '1', 'y', and 'yes' to 1.
   Requires a single boolean or string as an input. *Type*: rvalue.
 
+#### `bool2str`
+
+Converts a boolean to a string using an optionally supplied two
+element array of strings. The first and second element
+of the optional array represent what true and false will be converted
+to respectively.
+
+*Examples:*
+~~~
+bool2str(true)                   => 'true'
+bool2str(true, ['yes', 'no'])    => 'yes'
+bool2str(false, ['t', 'f'])      => 'f'
+~~~
+
+  Requires a single boolean as input. *Type*: rvalue.
+
 #### `capitalize`
 
 Capitalizes the first letter of a string or array of strings. Requires either a single string or an array as an input. *Type*: rvalue.

lib/puppet/parser/functions/bool2str.rb

@@ -4,23 +4,39 @@
 
 module Puppet::Parser::Functions
   newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS
-    Converts a boolean to a string.
+    Converts a boolean to a string using an optionally supplied two element
+    array of strings. The first and second element of the optional
+    array represent what true and false will be converted to respectively.
+
     Requires a single boolean as an input.
     EOS
   ) do |arguments|
 
     raise(Puppet::ParseError, "bool2str(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+      "given (#{arguments.size} for 2)") if arguments.size > 2
 
     value = arguments[0]
+    conversion_names = arguments[1] || ['true', 'false']
     klass = value.class
 
     # We can have either true or false, and nothing else
     unless [FalseClass, TrueClass].include?(klass)
       raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with')
     end
 
-    return value.to_s
+    unless conversion_names.kind_of?(Array)
+      raise(Puppet::ParseError, 'bool2str(): Requires an array to work with')
+    end
+
+    unless conversion_names.count == 2
+      raise(Puppet::ParseError, 'bool2str(): Requires a two element array to work with')
+    end
+
+    unless conversion_names.all?{|name| name.kind_of?(String)}
+      raise(Puppet::ParseError, "bool2str(): Requires strings to convert to" )
+    end
+
+    return value ? conversion_names[0] : conversion_names[1]
   end
 end
 

spec/functions/bool2str_spec.rb

@@ -6,6 +6,12 @@
   [ 'true', 'false', nil, :undef, ''].each do |invalid|
     it { is_expected.to run.with_params(invalid).and_raise_error(Puppet::ParseError) }
   end
+  it { is_expected.to run.with_params(true, false, ['yes', 'no']).and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params(true, [0, 1]).and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params(true, ['yes', 'no', 'maybe']).and_raise_error(Puppet::ParseError) }
   it { is_expected.to run.with_params(true).and_return("true") }
   it { is_expected.to run.with_params(false).and_return("false") }
+  it { is_expected.to run.with_params(true, ['yes', 'no']).and_return("yes") }
+  it { is_expected.to run.with_params(false, ['yes', 'no']).and_return("no") }
+
 end