Class: Date

Inherits:
Object show all
Defined in:
lib/active_support/json/encoding.rb,
lib/active_support/core_ext/date/zones.rb,
lib/active_support/core_ext/date/acts_like.rb,
lib/active_support/core_ext/date/conversions.rb,
lib/active_support/core_ext/date/calculations.rb

Constant Summary collapse

DATE_FORMATS = 
{
  :short        => "%e %b",
  :long         => "%B %e, %Y",
  :db           => "%Y-%m-%d",
  :number       => "%Y%m%d",
  :long_ordinal => lambda { |date| date.strftime("%B #{ActiveSupport::Inflector.ordinalize(date.day)}, %Y") }, # => "April 25th, 2007"
  :rfc822       => "%e %b %Y"
}
DAYS_INTO_WEEK = 
{ :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.current ⇒ Object

Returns Time.zone.today when Time.zone or config.time_zone are set, otherwise just returns Date.today.



40
41
42
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 40

def current
  ::Time.zone ? ::Time.zone.today : ::Date.today
end

.tomorrow ⇒ Object

Returns a new Date representing the date 1 day after today (i.e. tomorrow’s date).



35
36
37
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 35

def tomorrow
  ::Date.current.tomorrow
end

.yesterday ⇒ Object

Returns a new Date representing the date 1 day ago (i.e. yesterday’s date).



30
31
32
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 30

def yesterday
  ::Date.current.yesterday
end

Instance Method Details

#>>(n) ⇒ Object

Backported from 1.9. The one in 1.8 leads to incorrect next_month and friends for dates where the calendar reform is involved. It additionally prevents an infinite loop fixed in r27013.



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 16

def >>(n)
  y, m = (year * 12 + (mon - 1) + n).divmod(12)
  m,   = (m + 1)                    .divmod(1)
  d = mday
  until jd2 = self.class.valid_civil?(y, m, d, start)
    d -= 1
    raise ArgumentError, 'invalid date' unless d > 0
  end
  self + (jd2 - jd)
end

#acts_like_date? ⇒ Boolean

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

Returns:

  • (Boolean) 


5
6
7
 
# File 'lib/active_support/core_ext/date/acts_like.rb', line 5

def acts_like_date?
  true
end

#advance(options) ⇒ Object

Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.



108
109
110
111
112
113
114
115
116
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 108

def advance(options)
  options = options.dup
  d = self
  d = d >> options.delete(:years) * 12 if options[:years]
  d = d >> options.delete(:months)     if options[:months]
  d = d +  options.delete(:weeks) * 7  if options[:weeks]
  d = d +  options.delete(:days)       if options[:days]
  d
end

#ago(seconds) ⇒ Object

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then subtracts the specified number of seconds.



62
63
64
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 62

def ago(seconds)
  to_time_in_current_zone.since(-seconds)
end

#as_json(options = nil) ⇒ Object

:nodoc:



267
268
269
270
271
272
273
 
# File 'lib/active_support/json/encoding.rb', line 267

def as_json(options = nil) #:nodoc:
  if ActiveSupport.use_standard_json_time_format
    strftime("%Y-%m-%d")
  else
    strftime("%Y/%m/%d")
  end
end

#beginning_of_day ⇒ Object Also known as: midnight, at_midnight, at_beginning_of_day

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)



74
75
76
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 74

def beginning_of_day
  to_time_in_current_zone
end

#beginning_of_month ⇒ Object Also known as: at_beginning_of_month

Returns a new ; DateTime objects will have time set to 0:00DateTime representing the start of the month (1st of the month; DateTime objects will have time set to 0:00)



231
232
233
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 231

def beginning_of_month
  self.acts_like?(:time) ? change(:day => 1, :hour => 0) : change(:day => 1)
end

#beginning_of_quarter ⇒ Object Also known as: at_beginning_of_quarter

Returns a new Date/DateTime representing the start of the quarter (1st of january, april, july, october; DateTime objects will have time set to 0:00)



244
245
246
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 244

def beginning_of_quarter
  beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
end

#beginning_of_week(start_day = :monday) ⇒ Object Also known as: at_beginning_of_week

Returns a new Date/DateTime representing the start of this week. Week is assumed to start on start_day, default is :monday. DateTime objects have their time set to 0:00.



188
189
190
191
192
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 188

def beginning_of_week(start_day = :monday)
  days_to_start = days_to_week_start(start_day)
  result = self - days_to_start
  acts_like?(:time) ? result.midnight : result
end

#beginning_of_year ⇒ Object Also known as: at_beginning_of_year

Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)



256
257
258
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 256

def beginning_of_year
  self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0) : change(:month => 1, :day => 1)
end

#change(options) ⇒ Object

Returns a new Date where one or more of the elements have been changed according to the options parameter.

Examples:

Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)



124
125
126
127
128
129
130
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 124

def change(options)
  ::Date.new(
    options[:year]  || self.year,
    options[:month] || self.month,
    options[:day]   || self.day
  )
end

#days_to_week_start(start_day = :monday) ⇒ Object

Returns number of days to start of this week. Week is assumed to start on start_day, default is :monday.



179
180
181
182
183
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 179

def days_to_week_start(start_day = :monday)
  start_day_number = DAYS_INTO_WEEK[start_day]
  current_day_number = wday != 0 ? wday - 1 : 6
  (current_day_number - start_day_number) % 7
end

#end_of_day ⇒ Object

Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)



82
83
84
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 82

def end_of_day
  to_time_in_current_zone.end_of_day
end

#end_of_month ⇒ Object Also known as: at_end_of_month

Returns a new Date/DateTime representing the end of the month (last day of the month; DateTime objects will have time set to 0:00)



237
238
239
240
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 237

def end_of_month
  last_day = ::Time.days_in_month( self.month, self.year )
  self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
end

#end_of_quarter ⇒ Object Also known as: at_end_of_quarter

Returns a new Date/DateTime representing the end of the quarter (last day of march, june, september, december; DateTime objects will have time set to 23:59:59)



250
251
252
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 250

def end_of_quarter
  beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
end

#end_of_week(start_day = :monday) ⇒ Object Also known as: at_end_of_week

Returns a new Date/DateTime representing the end of this week. Week is assumed to start on start_day, default is :monday. DateTime objects have their time set to 23:59:59.



204
205
206
207
208
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 204

def end_of_week(start_day = :monday)
  days_to_end = 6 - days_to_week_start(start_day)
  result = self + days_to_end.days
  self.acts_like?(:time) ? result.end_of_day : result
end

#end_of_year ⇒ Object Also known as: at_end_of_year

Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)



262
263
264
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 262

def end_of_year
  self.acts_like?(:time) ? change(:month => 12, :day => 31, :hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31)
end

#future? ⇒ Boolean

Returns true if the Date object’s date lies in the future.

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 56

def future?
  self > ::Date.current
end

#iso8601 ⇒ Object Also known as: rfc3339 



97
98
99
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 97

def iso8601
  strftime('%F')
end

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

:nodoc:



96
97
98
99
100
101
102
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 96

def minus_with_duration(other) #:nodoc:
  if ActiveSupport::Duration === other
    plus_with_duration(-other)
  else
    minus_without_duration(other)
  end
end

#monday ⇒ Object

Returns a new Date/DateTime representing the start of this week. Week is assumed to start on a Monday. DateTime objects have their time set to 0:00.



197
198
199
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 197

def monday
  beginning_of_week
end

#months_ago(months) ⇒ Object

Returns a new Date/DateTime representing the time a number of specified months ago.



138
139
140
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 138

def months_ago(months)
  advance(:months => -months)
end

#months_since(months) ⇒ Object

Returns a new Date/DateTime representing the time a number of specified months in the future.



143
144
145
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 143

def months_since(months)
  advance(:months => months)
end

#next_month ⇒ Object

Shorthand for months_since(1)



173
174
175
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 173

def next_month
  months_since(1)
end

#next_week(day = :monday) ⇒ Object

Returns a new Date/DateTime representing the start of the given day in next week (default is :monday).



225
226
227
228
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 225

def next_week(day = :monday)
  result = (self + 7).beginning_of_week + DAYS_INTO_WEEK[day]
  self.acts_like?(:time) ? result.change(:hour => 0) : result
end

#next_year ⇒ Object

Shorthand for years_since(1)



163
164
165
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 163

def next_year
  years_since(1)
end

#past? ⇒ Boolean

Returns true if the Date object’s date lies in the past. Otherwise returns false.

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 46

def past?
  self < ::Date.current
end

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

:nodoc:



86
87
88
89
90
91
92
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 86

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

#prev_month ⇒ Object

Shorthand for months_ago(1)



168
169
170
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 168

def prev_month
  months_ago(1)
end

#prev_week(day = :monday) ⇒ Object

Returns a new Date/DateTime representing the given day in the previous week. Default is :monday. DateTime objects have their time set to 0:00.



219
220
221
222
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 219

def prev_week(day = :monday)
  result = (self - 7).beginning_of_week + DAYS_INTO_WEEK[day]
  self.acts_like?(:time) ? result.change(:hour => 0) : result
end

#prev_year ⇒ Object

Shorthand for years_ago(1)



158
159
160
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 158

def prev_year
  years_ago(1)
end

#readable_inspect ⇒ Object Also known as: inspect

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005”



60
61
62
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 60

def readable_inspect
  strftime("%a, %d %b %Y")
end

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

Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00) and then adds the specified number of seconds



68
69
70
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 68

def since(seconds)
  to_time_in_current_zone.since(seconds)
end

#sunday ⇒ Object

Returns a new Date/DateTime representing the end of this week. Week is assumed to start on a Monday. DateTime objects have their time set to 23:59:59.



213
214
215
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 213

def sunday
  end_of_week
end

#to_date ⇒ Object

A method to keep Time, Date and DateTime instances interchangeable on conversions. In this case, it simply returns self.



68
69
70
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 68

def to_date
  self
end

#to_datetime ⇒ Object

Converts a Date instance to a DateTime, where the time is set to the beginning of the day and UTC offset is set to 0.

Examples

date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007

date.to_datetime               # => Sat, 10 Nov 2007 00:00:00 0000



93
94
95
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 93

def to_datetime
  ::DateTime.civil(year, month, day, 0, 0, 0, 0)
end

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

Convert to a formatted string. See DATE_FORMATS for predefined formats.

This method is aliased to to_s.

Examples

date = Date.new(2007, 11, 10)       # => Sat, 10 Nov 2007

date.to_formatted_s(:db)            # => "2007-11-10"
date.to_s(:db)                      # => "2007-11-10"

date.to_formatted_s(:short)         # => "10 Nov"
date.to_formatted_s(:long)          # => "November 10, 2007"
date.to_formatted_s(:long_ordinal)  # => "November 10th, 2007"
date.to_formatted_s(:rfc822)        # => "10 Nov 2007"

Adding your own time formats to to_formatted_s

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

# config/initializers/time_formats.rb
Date::DATE_FORMATS[:month_and_year] = "%B %Y"
Date::DATE_FORMATS[:short_ordinal] = lambda { |date| date.strftime("%B #{date.day.ordinalize}") }



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 45

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

#to_time(form = :local) ⇒ Object

Converts a Date instance to a Time, where the time is set to the beginning of the day. The timezone can be either :local or :utc (default :local).

Examples

date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007

date.to_time                   # => Sat Nov 10 00:00:00 0800 2007
date.to_time(:local)           # => Sat Nov 10 00:00:00 0800 2007

date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007



82
83
84
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 82

def to_time(form = :local)
  ::Time.send("#{form}_time", year, month, day)
end

#to_time_in_current_zone ⇒ Object

Converts Date to a TimeWithZone in the current zone if Time.zone or Time.zone_default is set, otherwise converts Date to a Time via Date#to_time



7
8
9
10
11
12
13
 
# File 'lib/active_support/core_ext/date/zones.rb', line 7

def to_time_in_current_zone
  if ::Time.zone
    ::Time.zone.local(year, month, day)
  else
    to_time
  end
end

#today? ⇒ Boolean

Returns true if the Date object’s date is today.

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 51

def today?
  self.to_date == ::Date.current # we need the to_date because of DateTime
end

#tomorrow ⇒ Object

Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time



273
274
275
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 273

def tomorrow
  self + 1
end

#weeks_ago(weeks) ⇒ Object

Returns a new Date/DateTime representing the time a number of specified weeks ago.



133
134
135
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 133

def weeks_ago(weeks)
  advance(:weeks => -weeks)
end

#xmlschema ⇒ Object 



103
104
105
 
# File 'lib/active_support/core_ext/date/conversions.rb', line 103

def xmlschema
  to_time_in_current_zone.xmlschema
end

#years_ago(years) ⇒ Object

Returns a new Date/DateTime representing the time a number of specified years ago.



148
149
150
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 148

def years_ago(years)
  advance(:years => -years)
end

#years_since(years) ⇒ Object

Returns a new Date/DateTime representing the time a number of specified years in the future.



153
154
155
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 153

def years_since(years)
  advance(:years => years)
end

#yesterday ⇒ Object

Convenience method which returns a new Date/DateTime representing the time 1 day ago



268
269
270
 
# File 'lib/active_support/core_ext/date/calculations.rb', line 268

def yesterday
  self - 1
end