File: any2bool.rb

package info (click to toggle)
puppet-module-puppetlabs-stdlib 9.4.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,448 kB
  • sloc: ruby: 3,522; sh: 46; makefile: 2
file content (54 lines) | stat: -rw-r--r-- 1,654 bytes parent folder | download
1
2
3
4
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
49
50
51
52
53
54
# frozen_string_literal: true

#
# any2bool.rb
#
module Puppet::Parser::Functions
  newfunction(:any2bool, type: :rvalue, doc: <<-DOC
    @summary
      Converts 'anything' to a boolean.

    In practise it does the following:
    * Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true
    * Strings such as 0,F,f,N,n,FALSE,no,'false' will return false
    * Booleans will just return their original value
    * Number (or a string representation of a number) > 0 will return true, otherwise false
    * undef will return false
    * Anything else will return true

    Also see the built-in [`Boolean.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-boolean)
    function.

    @return [Boolean] The boolean value of the object that was given
  DOC
  ) do |arguments|
    raise(Puppet::ParseError, "any2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

    # If argument is already Boolean, return it
    return arguments[0] if !!arguments[0] == arguments[0] # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean

    arg = arguments[0]

    return false if arg.nil?

    return false if arg == :undef

    valid_float = begin
      !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean
    rescue StandardError
      false
    end

    return function_num2bool([arguments[0]]) if arg.is_a?(Numeric)

    if arg.is_a?(String)
      return function_num2bool([arguments[0]]) if valid_float

      return function_str2bool([arguments[0]])
    end

    return true
  end
end

# vim: set ts=2 sw=2 et :