Class/Module Index [+]

Quicksearch

ActiveSupport::CoreExtensions::Time::Calculations

Enables the use of time calculations within Time itself

Public Instance Methods

advance(options) click to toggle source

Uses Date to provide precise Time calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.

# File lib/active_support/core_ext/time/calculations.rb, line 102
def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = (options[:days] || 0) + 7 * partial_weeks
  end
  
  unless options[:days].nil?
    options[:days], partial_days = options[:days].divmod(1)
    options[:hours] = (options[:hours] || 0) + 24 * partial_days
  end
  
  d = to_date.advance(options)
  time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
  seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
  seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance)
end
ago(seconds) click to toggle source

Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension

# File lib/active_support/core_ext/time/calculations.rb, line 120
def ago(seconds)
  self.since(-seconds)
end
at_beginning_of_day() click to toggle source
Alias for: beginning_of_day
at_beginning_of_month() click to toggle source
Alias for: beginning_of_month
at_beginning_of_quarter() click to toggle source
at_beginning_of_week() click to toggle source
Alias for: beginning_of_week
at_beginning_of_year() click to toggle source
Alias for: beginning_of_year
at_end_of_month() click to toggle source
Alias for: end_of_month
at_end_of_quarter() click to toggle source
Alias for: end_of_quarter
at_end_of_week() click to toggle source
Alias for: end_of_week
at_end_of_year() click to toggle source
Alias for: end_of_year
at_midnight() click to toggle source
Alias for: beginning_of_day
beginning_of_day() click to toggle source

Returns a new Time representing the start of the day (0:00)

# File lib/active_support/core_ext/time/calculations.rb, line 212
def beginning_of_day
  #(self - seconds_since_midnight).change(:usec => 0)
  change(:hour => 0, :min => 0, :sec => 0, :usec => 0)
end
beginning_of_month() click to toggle source

Returns a new Time representing the start of the month (1st of the month, 0:00)

# File lib/active_support/core_ext/time/calculations.rb, line 226
def beginning_of_month
  #self - ((self.mday-1).days + self.seconds_since_midnight)
  change(:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
end
Also aliased as: at_beginning_of_month
beginning_of_quarter() click to toggle source

Returns a new Time representing the start of the quarter (1st of january, april, july, october, 0:00)

# File lib/active_support/core_ext/time/calculations.rb, line 241
def beginning_of_quarter
  beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
end
Also aliased as: at_beginning_of_quarter
beginning_of_week() click to toggle source

Returns a new Time representing the "start" of this week (Monday, 0:00)

# File lib/active_support/core_ext/time/calculations.rb, line 191
def beginning_of_week
  days_to_monday = self.wday!=0 ? self.wday-1 : 6
  (self - days_to_monday.days).midnight
end
Also aliased as: monday, at_beginning_of_week
beginning_of_year() click to toggle source

Returns a new Time representing the start of the year (1st of january, 0:00)

# File lib/active_support/core_ext/time/calculations.rb, line 253
def beginning_of_year
  change(:month => 1,:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
end
Also aliased as: at_beginning_of_year
change(options) click to toggle source

Returns a new Time where one or more of the elements have been changed according to the options parameter. The time options (hour, minute, sec, usec) reset cascadingly, so if only the hour is passed, then minute, sec, and usec is set to 0. If the hour and minute is passed, then sec and usec is set to 0.

# File lib/active_support/core_ext/time/calculations.rb, line 85
def change(options)
  ::Time.send(
    self.utc? ? :utc_time : :local_time,
    options[:year]  || self.year,
    options[:month] || self.month,
    options[:day]   || self.day,
    options[:hour]  || self.hour,
    options[:min]   || (options[:hour] ? 0 : self.min),
    options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
    options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : self.usec)
  )
end
compare_with_coercion(other) click to toggle source

Layers additional behavior on Time#<=> so that DateTime and ActiveSupport::TimeWithZone instances can be chronologically compared with a Time

# File lib/active_support/core_ext/time/calculations.rb, line 300
def compare_with_coercion(other)
  # if other is an ActiveSupport::TimeWithZone, coerce a Time instance from it so we can do <=> comparison
  other = other.comparable_time if other.respond_to?(:comparable_time)
  if other.acts_like?(:date)
    # other is a Date/DateTime, so coerce self #to_datetime and hand off to DateTime#<=>
    to_datetime.compare_without_coercion(other)
  else
    compare_without_coercion(other)
  end
end
end_of_day() click to toggle source

Returns a new Time representing the end of the day, 23:59:59.999999 (.999999999 in ruby1.9)

# File lib/active_support/core_ext/time/calculations.rb, line 221
def end_of_day
  change(:hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
end
end_of_month() click to toggle source

Returns a new Time representing the end of the month (end of the last day of the month)

# File lib/active_support/core_ext/time/calculations.rb, line 233
def end_of_month
  #self - ((self.mday-1).days + self.seconds_since_midnight)
  last_day = ::Time.days_in_month( self.month, self.year )
  change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
end
Also aliased as: at_end_of_month
end_of_quarter() click to toggle source

Returns a new Time representing the end of the quarter (end of the last day of march, june, september, december)

# File lib/active_support/core_ext/time/calculations.rb, line 247
def end_of_quarter
  beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
end
Also aliased as: at_end_of_quarter
end_of_week() click to toggle source

Returns a new Time representing the end of this week (Sunday, 23:59:59)

# File lib/active_support/core_ext/time/calculations.rb, line 199
def end_of_week
  days_to_sunday = self.wday!=0 ? 7-self.wday : 0
  (self + days_to_sunday.days).end_of_day
end
Also aliased as: at_end_of_week
end_of_year() click to toggle source

Returns a new Time representing the end of the year (end of the 31st of december)

# File lib/active_support/core_ext/time/calculations.rb, line 259
def end_of_year
  change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
end
Also aliased as: at_end_of_year
future?() click to toggle source

Tells whether the Time object's time lies in the future

# File lib/active_support/core_ext/time/calculations.rb, line 73
def future?
  self > ::Time.current
end
in(seconds) click to toggle source
Alias for: since
midnight() click to toggle source
Alias for: beginning_of_day
minus_with_coercion(other) click to toggle source

Time#- can also be used to determine the number of seconds between two Time instances. We're layering on additional behavior so that ActiveSupport::TimeWithZone instances are coerced into values that Time#- will recognize

# File lib/active_support/core_ext/time/calculations.rb, line 293
def minus_with_coercion(other)
  other = other.comparable_time if other.respond_to?(:comparable_time)
  other.is_a?(::DateTime) ? to_f - other.to_f : minus_without_coercion(other)
end
monday() click to toggle source
Alias for: beginning_of_week
months_ago(months) click to toggle source

Returns a new Time representing the time a number of specified months ago

# File lib/active_support/core_ext/time/calculations.rb, line 141
def months_ago(months)
  advance(:months => -months)
end
months_since(months) click to toggle source

Returns a new Time representing the time a number of specified months in the future

# File lib/active_support/core_ext/time/calculations.rb, line 146
def months_since(months)
  advance(:months => months)
end
next_month() click to toggle source

Short-hand for months_since(1)

# File lib/active_support/core_ext/time/calculations.rb, line 186
def next_month
  months_since(1)
end
next_week(day = :monday) click to toggle source

Returns a new Time representing the start of the given day in next week (default is Monday).

# File lib/active_support/core_ext/time/calculations.rb, line 206
def next_week(day = :monday)
  days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
  since(1.week).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
end
next_year() click to toggle source

Short-hand for years_since(1)

# File lib/active_support/core_ext/time/calculations.rb, line 171
def next_year
  years_since(1)
end
past?() click to toggle source

Tells whether the Time object's time lies in the past

# File lib/active_support/core_ext/time/calculations.rb, line 63
def past?
  self < ::Time.current
end
prev_month() click to toggle source

Short-hand for months_ago(1)

# File lib/active_support/core_ext/time/calculations.rb, line 181
def prev_month
  months_ago(1)
end
prev_year() click to toggle source

Short-hand for years_ago(1)

# File lib/active_support/core_ext/time/calculations.rb, line 166
def prev_year
  years_ago(1)
end
seconds_since_midnight() click to toggle source

Seconds since midnight: Time.now.seconds_since_midnight

# File lib/active_support/core_ext/time/calculations.rb, line 78
def seconds_since_midnight
  self.to_i - self.change(:hour => 0).to_i + (self.usec/1.0e+6)
end
since(seconds) click to toggle source

Returns a new Time representing the time a number of seconds since the instance time, this is basically a wrapper around the Numeric extension.

# File lib/active_support/core_ext/time/calculations.rb, line 126
def since(seconds)
  f = seconds.since(self)
  if ActiveSupport::Duration === seconds
    f
  else
    initial_dst = self.dst? ? 1 : 0
    final_dst   = f.dst? ? 1 : 0
    (seconds.abs >= 86400 && initial_dst != final_dst) ? f + (initial_dst - final_dst).hours : f
  end
rescue
  self.to_datetime.since(seconds)
end
Also aliased as: in
today?() click to toggle source

Tells whether the Time object's time is today

# File lib/active_support/core_ext/time/calculations.rb, line 68
def today?
  self.to_date == ::Date.current
end
tomorrow() click to toggle source

Convenience method which returns a new Time representing the time 1 day since the instance time

# File lib/active_support/core_ext/time/calculations.rb, line 270
def tomorrow
  advance(:days => 1)
end
years_ago(years) click to toggle source

Returns a new Time representing the time a number of specified years ago

# File lib/active_support/core_ext/time/calculations.rb, line 151
def years_ago(years)
  advance(:years => -years)
end
years_since(years) click to toggle source

Returns a new Time representing the time a number of specified years in the future

# File lib/active_support/core_ext/time/calculations.rb, line 156
def years_since(years)
  advance(:years => years)
end
yesterday() click to toggle source

Convenience method which returns a new Time representing the time 1 day ago

# File lib/active_support/core_ext/time/calculations.rb, line 265
def yesterday
  advance(:days => -1)
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.