Class: Time

Inherits:
Object show all
Includes:
DateAndTime::Calculations
Defined in:
motion/_stdlib/time.rb,
motion/core_ext/time/acts_like.rb,
motion/core_ext/time/conversions.rb,
motion/core_ext/time/calculations.rb

Constant Summary collapse

DATE_FORMATS =
{
  :db           => '%Y-%m-%d %H:%M:%S',
  :number       => '%Y%m%d%H%M%S',
  :nsec         => '%Y%m%d%H%M%S%9N',
  :time         => '%H:%M',
  :short        => '%d %b %H:%M',
  :long         => '%B %d, %Y %H:%M',
  :long_ordinal => lambda { |time|
    day_format = MotionSupport::Inflector.ordinalize(time.day)
    time.strftime("%B #{day_format}, %Y %H:%M")
  },
  :rfc822       => lambda { |time|
    offset_format = time.formatted_offset(false)
    time.strftime("%a, %d %b %Y %H:%M:%S #{offset_format}")
  }
}
COMMON_YEAR_DAYS_IN_MONTH =
[nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]

Constants included from DateAndTime::Calculations

DateAndTime::Calculations::DAYS_INTO_WEEK

Class Method Summary collapse

Instance Method Summary collapse

Methods included from DateAndTime::Calculations

#beginning_of_month, #beginning_of_quarter, #beginning_of_week, #beginning_of_year, #days_ago, #days_since, #days_to_week_start, #end_of_month, #end_of_quarter, #end_of_week, #end_of_year, #future?, #monday, #months_ago, #months_since, #next_month, #next_quarter, #next_week, #next_year, #past?, #prev_month, #prev_quarter, #prev_week, #prev_year, #sunday, #today?, #tomorrow, #weeks_ago, #weeks_since, #years_ago, #years_since, #yesterday

Class Method Details

.currentObject

Alias for Time.now.


20
21
22
# File 'motion/core_ext/time/calculations.rb', line 20

def current
  ::Time.now
end

.days_in_month(month, year = now.year) ⇒ Object

Return the number of days in the given month. If no year is specified, it will use the current year.


11
12
13
14
15
16
17
# File 'motion/core_ext/time/calculations.rb', line 11

def days_in_month(month, year = now.year)
  if month == 2 && ::Date.gregorian_leap?(year)
    29
  else
    COMMON_YEAR_DAYS_IN_MONTH[month]
  end
end

Instance Method Details

#==(other) ⇒ Object


10
11
12
13
14
15
16
17
18
# File 'motion/_stdlib/time.rb', line 10

def ==(other)
  other &&
  year == other.year &&
  month == other.month &&
  day == other.day &&
  hour == other.hour &&
  min == other.min &&
  sec == other.sec
end

#acts_like_time?Boolean

Duck-types as a Time-like class. See Object#acts_like?.

Returns:

  • (Boolean)

5
6
7
# File 'motion/core_ext/time/acts_like.rb', line 5

def acts_like_time?
  true
end

#advance(options) ⇒ Object

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.


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'motion/core_ext/time/calculations.rb', line 72

def advance(options)
  unless options[:weeks].nil?
    options[:weeks], partial_weeks = options[:weeks].divmod(1)
    options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
  end

  unless options[:days].nil?
    options[:days], partial_days = options[:days].divmod(1)
    options[:hours] = options.fetch(: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.fetch(:seconds, 0) +
    options.fetch(:minutes, 0) * 60 +
    options.fetch(:hours, 0) * 3600

  if seconds_to_advance.zero?
    time_advanced_by_date
  else
    time_advanced_by_date.since(seconds_to_advance)
  end
end

#ago(seconds) ⇒ Object

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


98
99
100
# File 'motion/core_ext/time/calculations.rb', line 98

def ago(seconds)
  since(-seconds)
end

#all_dayObject

Returns a Range representing the whole day of the current time.


162
163
164
# File 'motion/core_ext/time/calculations.rb', line 162

def all_day
  beginning_of_day..end_of_day
end

#all_monthObject

Returns a Range representing the whole month of the current time.


173
174
175
# File 'motion/core_ext/time/calculations.rb', line 173

def all_month
  beginning_of_month..end_of_month
end

#all_quarterObject

Returns a Range representing the whole quarter of the current time.


178
179
180
# File 'motion/core_ext/time/calculations.rb', line 178

def all_quarter
  beginning_of_quarter..end_of_quarter
end

#all_week(start_day = Date.beginning_of_week) ⇒ Object

Returns a Range representing the whole week of the current time. Week starts on start_day, default is Date.week_start or config.week_start when set.


168
169
170
# File 'motion/core_ext/time/calculations.rb', line 168

def all_week(start_day = Date.beginning_of_week)
  beginning_of_week(start_day)..end_of_week(start_day)
end

#all_yearObject

Returns a Range representing the whole year of the current time.


183
184
185
# File 'motion/core_ext/time/calculations.rb', line 183

def all_year
  beginning_of_year..end_of_year
end

#beginning_of_dayObject Also known as: midnight, at_midnight, at_beginning_of_day

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


111
112
113
114
# File 'motion/core_ext/time/calculations.rb', line 111

def beginning_of_day
  #(self - seconds_since_midnight).change(usec: 0)
  change(:hour => 0)
end

#beginning_of_hourObject Also known as: at_beginning_of_hour

Returns a new Time representing the start of the hour (x:00)


131
132
133
# File 'motion/core_ext/time/calculations.rb', line 131

def beginning_of_hour
  change(:min => 0)
end

#beginning_of_minuteObject Also known as: at_beginning_of_minute

Returns a new Time representing the start of the minute (x:xx:00)


147
148
149
# File 'motion/core_ext/time/calculations.rb', line 147

def beginning_of_minute
  change(:sec => 0)
end

#change(options) ⇒ Object

Returns a new Time where one or more of the elements have been changed according to the options parameter. The time options (:hour, :min, :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. The options parameter takes a hash with any of these keys: :year, :month, :day, :hour, :min, :sec, :usec.

Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'motion/core_ext/time/calculations.rb', line 50

def change(options)
  new_year  = options.fetch(:year, year)
  new_month = options.fetch(:month, month)
  new_day   = options.fetch(:day, day)
  new_hour  = options.fetch(:hour, hour)
  new_min   = options.fetch(:min, options[:hour] ? 0 : min)
  new_sec   = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)
  new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))

  if utc?
    ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  elsif zone
    ::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
  else
    ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec + (new_usec.to_r / 1000000), utc_offset)
  end
end

#compare_with_coercion(other) ⇒ Object Also known as: <=>

Layers additional behavior on Time#<=> so that Date instances can be chronologically compared with a Time


209
210
211
# File 'motion/core_ext/time/calculations.rb', line 209

def compare_with_coercion(other)
  compare_without_coercion(other.to_time)
end

#end_of_dayObject Also known as: at_end_of_day

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


120
121
122
123
124
125
126
127
# File 'motion/core_ext/time/calculations.rb', line 120

def end_of_day
  change(
    :hour => 23,
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#end_of_hourObject Also known as: at_end_of_hour

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


137
138
139
140
141
142
143
# File 'motion/core_ext/time/calculations.rb', line 137

def end_of_hour
  change(
    :min => 59,
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#end_of_minuteObject Also known as: at_end_of_minute

Returns a new Time representing the end of the minute, x:xx:59.999999 (.999999999 in ruby1.9)


153
154
155
156
157
158
# File 'motion/core_ext/time/calculations.rb', line 153

def end_of_minute
  change(
    :sec => 59,
    :usec => Rational(999999999, 1000)
  )
end

#minus_with_duration(other) ⇒ Object Also known as: -

:nodoc:


197
198
199
200
201
202
203
# File 'motion/core_ext/time/calculations.rb', line 197

def minus_with_duration(other) #:nodoc:
  if MotionSupport::Duration === other
    other.until(self)
  else
    minus_without_duration(other)
  end
end

#plus_with_duration(other) ⇒ Object Also known as: +

:nodoc:


187
188
189
190
191
192
193
# File 'motion/core_ext/time/calculations.rb', line 187

def plus_with_duration(other) #:nodoc:
  if MotionSupport::Duration === other
    other.since(self)
  else
    plus_without_duration(other)
  end
end

#seconds_since_midnightObject

Seconds since midnight: Time.now.seconds_since_midnight


26
27
28
# File 'motion/core_ext/time/calculations.rb', line 26

def seconds_since_midnight
  to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
end

#seconds_until_end_of_dayObject

Returns the number of seconds until 23:59:59.

Time.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
Time.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
Time.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0

35
36
37
# File 'motion/core_ext/time/calculations.rb', line 35

def seconds_until_end_of_day
  end_of_day.to_i - to_i
end

#since(seconds) ⇒ Object Also known as: in

Returns a new Time representing the time a number of seconds since the instance time


103
104
105
106
107
# File 'motion/core_ext/time/calculations.rb', line 103

def since(seconds)
  self + seconds
rescue
  to_datetime.since(seconds)
end

#to_dateObject


2
3
4
# File 'motion/_stdlib/time.rb', line 2

def to_date
  Date.new(year, month, day)
end

#to_formatted_s(format = :default) ⇒ Object Also known as: to_s

Converts to a formatted string. See DATE_FORMATS for builtin formats.

This method is aliased to to_s.

time = Time.now                    # => Thu Jan 18 06:10:17 CST 2007

time.to_formatted_s(:time)         # => "06:10"
time.to_s(:time)                   # => "06:10"

time.to_formatted_s(:db)           # => "2007-01-18 06:10:17"
time.to_formatted_s(:number)       # => "20070118061017"
time.to_formatted_s(:short)        # => "18 Jan 06:10"
time.to_formatted_s(:long)         # => "January 18, 2007 06:10"
time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10"
time.to_formatted_s(:rfc822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"

Adding your own time formats to to_formatted_s

You can add your own formats to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time argument as the value.

# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = '%B %Y'
Time::DATE_FORMATS[:short_ordinal]  = ->(time) { time.strftime("%B #{time.day.ordinalize}") }

43
44
45
46
47
48
49
# File 'motion/core_ext/time/conversions.rb', line 43

def to_formatted_s(format = :default)
  if formatter = DATE_FORMATS[format]
    formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
  else
    to_default_s
  end
end

#to_timeObject


6
7
8
# File 'motion/_stdlib/time.rb', line 6

def to_time
  self
end