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

   1 #
   2 # str2bool.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:str2bool, :type => :rvalue, :doc => <<-DOC
   6     @summary
   7       This converts a string to a boolean.
   8
   9     @return
  10       This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things
  11       like: 0, F,f, N,n, false, FALSE, no to 'false'.
  12
  13     > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value.
  14     See the function new() in Puppet for details what the Boolean data type supports.
  15   DOC
  16              ) do |arguments|
  17
  18     raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
  19
  20     string = arguments[0]
  21
  22     # If string is already Boolean, return it
  23     if !!string == string # rubocop:disable Style/DoubleNegation : No viable alternative
  24       return string
  25     end
  26
  27     unless string.is_a?(String)
  28       raise(Puppet::ParseError, 'str2bool(): Requires string to work with')
  29     end
  30
  31     # We consider all the yes, no, y, n and so on too ...
  32     result = case string
  33              #
  34              # This is how undef looks like in Puppet ...
  35              # We yield false in this case.
  36              #
  37              when %r{^$}, '' then false # Empty string will be false ...
  38              when %r{^(1|t|y|true|yes)$}i  then true
  39              when %r{^(0|f|n|false|no)$}i  then false
  40              when %r{^(undef|undefined)$} then false # This is not likely to happen ...
  41              else
  42                raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given')
  43              end
  44
  45     return result
  46   end
  47 end
  48
  49 # vim: set ts=2 sw=2 et :