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

   1 #
   2 # convert_base.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:convert_base, :type => :rvalue, :arity => 2, :doc => <<-'DOC') do |args|
   6     @summary
   7       Converts a given integer or base 10 string representing an integer to a
   8       specified base, as a string.
   9
  10     @return
  11       converted value as a string
  12
  13     @example Example usage
  14
  15     convert_base(5, 2)` results in: `'101'`
  16     convert_base('254', '16')` results in: `'fe'`
  17
  18     > *Note:*
  19       Since Puppet 4.5.0 this can be done with the built-in
  20       [`String.new`](https://puppet.com/docs/puppet/latest/function.html#integer-to-string)
  21       function and its many formatting options:
  22
  23       `$binary_repr = String(5, '%b')` return `"101"`
  24       `$hex_repr = String(254, "%x")`  return `"fe"`
  25       `$hex_repr = String(254, "%#x")` return `"0xfe"`
  26
  27       @return [String] The converted value as a String
  28     DOC
  29
  30     raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String)
  31     raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String)
  32
  33     if args[0].is_a?(String)
  34       raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[0] =~ %r{^[0-9]+$}
  35     end
  36
  37     if args[1].is_a?(String)
  38       raise Puppet::ParseError, 'convert_base(): First argument must be an integer or a string corresponding to an integer in base 10' unless args[1] =~ %r{^[0-9]+$}
  39     end
  40
  41     number_to_convert = args[0]
  42     new_base = args[1]
  43
  44     number_to_convert = number_to_convert.to_i
  45     new_base = new_base.to_i
  46
  47     raise Puppet::ParseError, 'convert_base(): base must be at least 2 and must not be greater than 36' unless new_base >= 2 && new_base <= 36
  48
  49     return number_to_convert.to_s(new_base)
  50   end
  51 end