Module IceCube::TimeUtil
In: lib/ice_cube/time_util.rb

Methods

beginning_of_date   build_in_zone   day_of_month   days_in_month   days_in_n_months   days_in_n_years   days_in_next_month   days_in_year   days_to_next_month   deserialize_time   dst_change   end_of_date   ensure_date   ensure_time   hash   ical_day_to_symbol   match_zone   normalize_wday   now   restore_deserialized_offset   serialize_time   subsec   sym_to_month   sym_to_wday   wday_to_sym   which_occurrence_in_month  

Classes and Modules

Class IceCube::TimeUtil::TimeWrapper

Constants

DAYS = { :sunday => 0, :monday => 1, :tuesday => 2, :wednesday => 3, :thursday => 4, :friday => 5, :saturday => 6
ICAL_DAYS = { 'SU' => :sunday, 'MO' => :monday, 'TU' => :tuesday, 'WE' => :wednesday, 'TH' => :thursday, 'FR' => :friday, 'SA' => :saturday
MONTHS = { :january => 1, :february => 2, :march => 3, :april => 4, :may => 5, :june => 6, :july => 7, :august => 8, :september => 9, :october => 10, :november => 11, :december => 12
CLOCK_VALUES = [:year, :month, :day, :hour, :min, :sec]

Public Class methods

day_of_month(value, date)

Get a day of the month in the month of a given time without overflowing into the next month. Accepts days from positive (start of month forward) or negative (from end of month)

days_in_month(time)

Get the days in the month for +time

days_in_n_months(time, month_distance)

The number of days in n months

days_in_n_years(time, year_distance)

Number of days to n years

days_in_next_month(time)

Get the days in the following month for +time

days_in_year(time)

Number of days in a year

days_to_next_month(time)

Count the number of days to the same day of the next month without overflowing shorter months

deserialize_time(time_or_hash)

Deserialize a time serialized with serialize_time or in ISO8601 string format

ensure_date(date)

Ensure that this is either nil, or a date

ensure_time(time, reference = nil, date_eod = false)

Ensure that this is either nil, or a time

hash(time)

Get a more precise equality for time objects Ruby provides a Time#hash method, but it fails to account for UTC offset (so the current date may be different) or DST rules (so the hour may be wrong for different schedule occurrences)

normalize_wday(wday, week_start)

Convert weekday from base sunday to the schedule‘s week start.

now(reference=Time.now)

Provides a Time.now without the usec, in the reference zone or utc offset

restore_deserialized_offset(time, orig_offset_str)

Check the deserialized time offset string against actual local time offset to try and preserve the original offset for plain Ruby Time. If the offset is the same as local we can assume the same original zone and keep it. If it was serialized with a different offset than local TZ it will lose the zone and not support DST.

serialize_time(time)

Serialize a time appropriate for storing

subsec(time)

Handle discrepancies between various time types

  • Time has subsec
  • DateTime does not
  • ActiveSupport::TimeWithZone can wrap either type, depending on version or if `parse` or `now`/`local` was used to build it.
sym_to_month(sym)

Convert a symbol to a numeric month

sym_to_wday(sym)

Convert a symbol to a wday number

wday_to_sym(wday)

Convert wday number to day symbol

which_occurrence_in_month(time, wday)

Return the count of the number of times wday appears in the month, and which of those time falls on

[Validate]