module Jekyll::DurationFilter

This module contains a filter for converting a duration string into a human readable string.

Public Instance Methods

duration_to_human(duration) click to toggle source

This function converts a duration string into a human readable string. Params:

duration: The duration string to convert (e.g. 1H30M, RFC 3339 formatted minus the leading P/T)

Returns:

String: The human readable string

Example:

{{ "T1H30M" | duration_to_human }}
=> "1 hour 30 minutes"

# File _plugins/jekyll-duration.rb, line 16
def duration_to_human(duration)
  # Match the different parts of the string, must match entire string or it will fail.
  match = /^(?:([0-9]*)[Hh])*(?:([0-9]*)[Mm])*(?:([0-9.]*)[Ss])*$/.match(duration)

  # If it doesn't match, pass through unedited so we don't cause unexpected issues.
  if match.nil?
    puts "Could not parse time: #{duration}"
    return duration
  end

  # Otherwise append english terms for the various parts
  duration_parts = []

  hour = 'hour'
  hours = 'hours'
  minutes = 'minutes'
  if @context.registers[:page]&.key?('lang') && (@context.registers[:page]['lang'] != 'en')
    lang = @context.registers[:page]['lang']
    hour = @context.registers[:site].data['lang'][lang]['hour']
    hours = @context.registers[:site].data['lang'][lang]['hours']
    minutes = @context.registers[:site].data['lang'][lang]['minutes']
  end

  # Hours
  if !match[1].nil?
    if match[1] == '1'
      duration_parts.push("#{match[1]} " + hour)
    else
      duration_parts.push("#{match[1]} " + hours)
    end
  end

  # Minutes - assuming no one uses `1 minute`
  duration_parts.push("#{match[2]} " + minutes) if !match[2].nil?

  # Hopefully no one uses seconds
  duration_parts.push("#{match[3]} seconds") if !match[3].nil?

  duration_parts.join(' ')
end