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"
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.currentObject

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


38
39
40
# File 'lib/active_support/core_ext/date/calculations.rb', line 38

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

.tomorrowObject

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


33
34
35
# File 'lib/active_support/core_ext/date/calculations.rb', line 33

def tomorrow
  ::Date.current.tomorrow
end

.yesterdayObject

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


28
29
30
# File 'lib/active_support/core_ext/date/calculations.rb', line 28

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.


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

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.


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

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.


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

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

#as_json(options = nil) ⇒ Object

:nodoc:


224
225
226
227
228
229
230
# File 'lib/active_support/json/encoding.rb', line 224

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_dayObject 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)


72
73
74
# File 'lib/active_support/core_ext/date/calculations.rb', line 72

def beginning_of_day
  to_time_in_current_zone
end

#beginning_of_monthObject 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)


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

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

#beginning_of_quarterObject 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)


209
210
211
# File 'lib/active_support/core_ext/date/calculations.rb', line 209

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

#beginning_of_weekObject Also known as: monday, at_beginning_of_week

Returns a new Date/DateTime representing the “start” of this week (i.e, Monday; DateTime objects will have time set to 0:00).


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

def beginning_of_week
  days_to_monday = self.wday!=0 ? self.wday-1 : 6
  result = self - days_to_monday
  self.acts_like?(:time) ? result.midnight : result
end

#beginning_of_yearObject 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)


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

def beginning_of_year
  self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 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)

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

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

#end_of_dayObject

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


80
81
82
# File 'lib/active_support/core_ext/date/calculations.rb', line 80

def end_of_day
  to_time_in_current_zone.end_of_day
end

#end_of_monthObject 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)


202
203
204
205
# File 'lib/active_support/core_ext/date/calculations.rb', line 202

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_quarterObject 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)


215
216
217
# File 'lib/active_support/core_ext/date/calculations.rb', line 215

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

#end_of_weekObject Also known as: sunday, at_end_of_week

Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59).


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

def end_of_week
  days_to_sunday = self.wday!=0 ? 7-self.wday : 0
  result = self + days_to_sunday.days
  self.acts_like?(:time) ? result.end_of_day : result
end

#end_of_yearObject 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)


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

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)

54
55
56
# File 'lib/active_support/core_ext/date/calculations.rb', line 54

def future?
  self > ::Date.current
end

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

:nodoc:


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

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

#months_ago(months) ⇒ Object

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


131
132
133
# File 'lib/active_support/core_ext/date/calculations.rb', line 131

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.


136
137
138
# File 'lib/active_support/core_ext/date/calculations.rb', line 136

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

#next_monthObject

Shorthand for months_since(1)


166
167
168
# File 'lib/active_support/core_ext/date/calculations.rb', line 166

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).


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

def next_week(day = :monday)
  days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
  result = (self + 7).beginning_of_week + days_into_week[day]
  self.acts_like?(:time) ? result.change(:hour => 0) : result
end

#next_yearObject

Shorthand for years_since(1)


156
157
158
# File 'lib/active_support/core_ext/date/calculations.rb', line 156

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)

44
45
46
# File 'lib/active_support/core_ext/date/calculations.rb', line 44

def past?
  self < ::Date.current
end

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

:nodoc:


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

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

#prev_monthObject

Shorthand for months_ago(1)


161
162
163
# File 'lib/active_support/core_ext/date/calculations.rb', line 161

def prev_month
  months_ago(1)
end

#prev_yearObject

Shorthand for years_ago(1)


151
152
153
# File 'lib/active_support/core_ext/date/calculations.rb', line 151

def prev_year
  years_ago(1)
end

#readable_inspectObject Also known as: inspect

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


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

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


66
67
68
# File 'lib/active_support/core_ext/date/calculations.rb', line 66

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

#to_dateObject

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


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

def to_date
  self
end

#to_datetimeObject

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

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

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}") }

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

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

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

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

#to_time_in_current_zoneObject

Converts Date to a TimeWithZone in the current zone if 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_default
    ::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)

49
50
51
# File 'lib/active_support/core_ext/date/calculations.rb', line 49

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

#tomorrowObject

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


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

def tomorrow
  self + 1
end

#xmlschemaObject


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

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.


141
142
143
# File 'lib/active_support/core_ext/date/calculations.rb', line 141

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.


146
147
148
# File 'lib/active_support/core_ext/date/calculations.rb', line 146

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

#yesterdayObject

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


233
234
235
# File 'lib/active_support/core_ext/date/calculations.rb', line 233

def yesterday
  self - 1
end