strftime.rb

#
#  strftime.rb
#  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
#
module Puppet::Parser::Functions
  newfunction(:strftime, :type => :rvalue, :doc => <<-DOC
    @summary
      This function returns formatted time.

    @return
      converted time according to the directives in the given format string

    > *Note:* that since Puppet 4.8.0 the function with the same name in Puppet will be used instead of this
    function. It also supports the Timestamp and Timespan data types in the Puppet language.

    @example **Usage**

      To return the time since epoch: strftime("%s")
      To return the date: strftime("%Y-%m-%d")

    **Format meaning:**

        %a - The abbreviated weekday name (``Sun'')
        %A - The  full  weekday  name (``Sunday'')
        %b - The abbreviated month name (``Jan'')
        %B - The  full  month  name (``January'')
        %c - The preferred local date and time representation
        %C - Century (20 in 2009)
        %d - Day of the month (01..31)
        %D - Date (%m/%d/%y)
        %e - Day of the month, blank-padded ( 1..31)
        %F - Equivalent to %Y-%m-%d (the ISO 8601 date format)
        %h - Equivalent to %b
        %H - Hour of the day, 24-hour clock (00..23)
        %I - Hour of the day, 12-hour clock (01..12)
        %j - Day of the year (001..366)
        %k - hour, 24-hour clock, blank-padded ( 0..23)
        %l - hour, 12-hour clock, blank-padded ( 0..12)
        %L - Millisecond of the second (000..999)
        %m - Month of the year (01..12)
        %M - Minute of the hour (00..59)
        %n - Newline (\n)
        %N - Fractional seconds digits, default is 9 digits (nanosecond)
                %3N  millisecond (3 digits)
                %6N  microsecond (6 digits)
                %9N  nanosecond (9 digits)
        %p - Meridian indicator (``AM''  or  ``PM'')
        %P - Meridian indicator (``am''  or  ``pm'')
        %r - time, 12-hour (same as %I:%M:%S %p)
        %R - time, 24-hour (%H:%M)
        %s - Number of seconds since 1970-01-01 00:00:00 UTC.
        %S - Second of the minute (00..60)
        %t - Tab character (\t)
        %T - time, 24-hour (%H:%M:%S)
        %u - Day of the week as a decimal, Monday being 1. (1..7)
        %U - Week  number  of the current year,
                starting with the first Sunday as the first
                day of the first week (00..53)
        %v - VMS date (%e-%b-%Y)
        %V - Week number of year according to ISO 8601 (01..53)
        %W - Week  number  of the current year,
                starting with the first Monday as the first
                day of the first week (00..53)
        %w - Day of the week (Sunday is 0, 0..6)
        %x - Preferred representation for the date alone, no time
        %X - Preferred representation for the time alone, no date
        %y - Year without a century (00..99)
        %Y - Year with century
        %z - Time zone as  hour offset from UTC (e.g. +0900)
        %Z - Time zone name
        %% - Literal ``%'' character
    DOC
             ) do |arguments|

    # Technically we support two arguments but only first is mandatory ...
    raise(Puppet::ParseError, "strftime(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

    format = arguments[0]

    raise(Puppet::ParseError, 'strftime(): You must provide format for evaluation') if format.empty?

    # The Time Zone argument is optional ...
    time_zone = arguments[1] if arguments[1]

    time = Time.new

    # There is probably a better way to handle Time Zone ...
    if time_zone && !time_zone.empty?
      original_zone = ENV['TZ']

      local_time = time.clone
      local_time = local_time.utc

      ENV['TZ'] = time_zone

      time = local_time.localtime

      ENV['TZ'] = original_zone
    end

    result = time.strftime(format)

    return result
  end
end

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