← Back to branch summary

~michaelforrest/use-case-mapper/trunk

« back to all changes in this revision

Viewing changes to vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb

  • Committer: Michael Forrest
  • Date: 2010-10-15 16:28:50 UTC
  • Revision ID: michael.forrest@canonical.com-20101015162850-tj2vchanv0kr0dun
refroze gems

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/rails/activesupport/lib/active_support/core_ext/date/calculations.rb
 
1
module ActiveSupport #:nodoc:
 
2
  module CoreExtensions #:nodoc:
 
3
    module Date #:nodoc:
 
4
      # Enables the use of time calculations within Date itself
 
5
      module Calculations
 
6
        def self.included(base) #:nodoc:
 
7
          base.extend ClassMethods
 
8
 
 
9
          base.instance_eval do
 
10
            alias_method :plus_without_duration, :+
 
11
            alias_method :+, :plus_with_duration
 
12
 
 
13
            alias_method :minus_without_duration, :-
 
14
            alias_method :-, :minus_with_duration
 
15
          end
 
16
        end
 
17
 
 
18
        module ClassMethods
 
19
          # Returns a new Date representing the date 1 day ago (i.e. yesterday's date).
 
20
          def yesterday
 
21
            ::Date.today.yesterday
 
22
          end
 
23
 
 
24
          # Returns a new Date representing the date 1 day after today (i.e. tomorrow's date).
 
25
          def tomorrow
 
26
            ::Date.today.tomorrow
 
27
          end
 
28
 
 
29
          # Returns Time.zone.today when config.time_zone is set, otherwise just returns Date.today.
 
30
          def current
 
31
            ::Time.zone_default ? ::Time.zone.today : ::Date.today
 
32
          end
 
33
        end
 
34
 
 
35
        # Tells whether the Date object's date lies in the past
 
36
        def past?
 
37
          self < ::Date.current
 
38
        end
 
39
 
 
40
        # Tells whether the Date object's date is today
 
41
        def today?
 
42
          self.to_date == ::Date.current # we need the to_date because of DateTime
 
43
        end
 
44
 
 
45
        # Tells whether the Date object's date lies in the future
 
46
        def future?
 
47
          self > ::Date.current
 
48
        end
 
49
 
 
50
        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
 
51
        # and then subtracts the specified number of seconds
 
52
        def ago(seconds)
 
53
          to_time.since(-seconds)
 
54
        end
 
55
 
 
56
        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
 
57
        # and then adds the specified number of seconds
 
58
        def since(seconds)
 
59
          to_time.since(seconds)
 
60
        end
 
61
        alias :in :since
 
62
 
 
63
        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
 
64
        def beginning_of_day
 
65
          to_time
 
66
        end
 
67
        alias :midnight :beginning_of_day
 
68
        alias :at_midnight :beginning_of_day
 
69
        alias :at_beginning_of_day :beginning_of_day
 
70
 
 
71
        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
 
72
        def end_of_day
 
73
          to_time.end_of_day
 
74
        end
 
75
 
 
76
        def plus_with_duration(other) #:nodoc:
 
77
          if ActiveSupport::Duration === other
 
78
            other.since(self)
 
79
          else
 
80
            plus_without_duration(other)
 
81
          end
 
82
        end
 
83
 
 
84
        def minus_with_duration(other) #:nodoc:
 
85
          if ActiveSupport::Duration === other
 
86
            plus_with_duration(-other)
 
87
          else
 
88
            minus_without_duration(other)
 
89
          end
 
90
        end
 
91
 
 
92
        # Provides precise Date calculations for years, months, and days.  The +options+ parameter takes a hash with
 
93
        # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
 
94
        def advance(options)
 
95
          options = options.dup
 
96
          d = self
 
97
          d = d >> options.delete(:years) * 12 if options[:years]
 
98
          d = d >> options.delete(:months)     if options[:months]
 
99
          d = d +  options.delete(:weeks) * 7  if options[:weeks]
 
100
          d = d +  options.delete(:days)       if options[:days]
 
101
          d
 
102
        end
 
103
 
 
104
        # Returns a new Date where one or more of the elements have been changed according to the +options+ parameter.
 
105
        #
 
106
        # Examples:
 
107
        #
 
108
        #   Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
 
109
        #   Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)
 
110
        def change(options)
 
111
          ::Date.new(
 
112
            options[:year]  || self.year,
 
113
            options[:month] || self.month,
 
114
            options[:day]   || self.day
 
115
          )
 
116
        end
 
117
 
 
118
        # Returns a new Date/DateTime representing the time a number of specified months ago
 
119
        def months_ago(months)
 
120
          advance(:months => -months)
 
121
        end
 
122
 
 
123
        # Returns a new Date/DateTime representing the time a number of specified months in the future
 
124
        def months_since(months)
 
125
          advance(:months => months)
 
126
        end
 
127
 
 
128
        # Returns a new Date/DateTime representing the time a number of specified years ago
 
129
        def years_ago(years)
 
130
          advance(:years => -years)
 
131
        end
 
132
 
 
133
        # Returns a new Date/DateTime representing the time a number of specified years in the future
 
134
        def years_since(years)
 
135
          advance(:years => years)
 
136
        end
 
137
 
 
138
        # Short-hand for years_ago(1)
 
139
        def last_year
 
140
          years_ago(1)
 
141
        end
 
142
 
 
143
        # Short-hand for years_since(1)
 
144
        def next_year
 
145
          years_since(1)
 
146
        end
 
147
 
 
148
        # Short-hand for months_ago(1)
 
149
        def last_month
 
150
          months_ago(1)
 
151
        end
 
152
 
 
153
        # Short-hand for months_since(1)
 
154
        def next_month
 
155
          months_since(1)
 
156
        end
 
157
 
 
158
        # Returns a new Date/DateTime representing the "start" of this week (i.e, Monday; DateTime objects will have time set to 0:00)
 
159
        def beginning_of_week
 
160
          days_to_monday = self.wday!=0 ? self.wday-1 : 6
 
161
          result = self - days_to_monday
 
162
          self.acts_like?(:time) ? result.midnight : result
 
163
        end
 
164
        alias :monday :beginning_of_week
 
165
        alias :at_beginning_of_week :beginning_of_week
 
166
 
 
167
        # Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59)
 
168
        def end_of_week
 
169
          days_to_sunday = self.wday!=0 ? 7-self.wday : 0
 
170
          result = self + days_to_sunday.days
 
171
          self.acts_like?(:time) ? result.end_of_day : result
 
172
        end
 
173
        alias :at_end_of_week :end_of_week
 
174
 
 
175
        # Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).
 
176
        def next_week(day = :monday)
 
177
          days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
 
178
          result = (self + 7).beginning_of_week + days_into_week[day]
 
179
          self.acts_like?(:time) ? result.change(:hour => 0) : result
 
180
        end
 
181
 
 
182
        # 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)
 
183
        def beginning_of_month
 
184
          self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
 
185
        end
 
186
        alias :at_beginning_of_month :beginning_of_month
 
187
 
 
188
        # 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)
 
189
        def end_of_month
 
190
          last_day = ::Time.days_in_month( self.month, self.year )
 
191
          self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
 
192
        end
 
193
        alias :at_end_of_month :end_of_month
 
194
 
 
195
        # 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)
 
196
        def beginning_of_quarter
 
197
          beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
 
198
        end
 
199
        alias :at_beginning_of_quarter :beginning_of_quarter
 
200
 
 
201
        # 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)
 
202
        def end_of_quarter
 
203
          beginning_of_month.change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
 
204
        end
 
205
        alias :at_end_of_quarter :end_of_quarter
 
206
 
 
207
        # Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)
 
208
        def beginning_of_year
 
209
          self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1)
 
210
        end
 
211
        alias :at_beginning_of_year :beginning_of_year
 
212
 
 
213
        # Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)
 
214
        def end_of_year
 
215
          self.acts_like?(:time) ? change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59) : change(:month => 12, :day => 31)
 
216
        end
 
217
        alias :at_end_of_year :end_of_year
 
218
 
 
219
        # Convenience method which returns a new Date/DateTime representing the time 1 day ago
 
220
        def yesterday
 
221
          self - 1
 
222
        end
 
223
 
 
224
        # Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time
 
225
        def tomorrow
 
226
          self + 1
 
227
        end
 
228
      end
 
229
    end
 
230
  end
 
231
end