calculations.rb 8.4 KB
Newer Older
1 2 3 4 5 6
module ActiveSupport #:nodoc:
  module CoreExtensions #:nodoc:
    module Date #:nodoc:
      # Enables the use of time calculations within Time itself
      module Calculations
        def self.included(base) #:nodoc:
J
Jeremy Kemper 已提交
7 8 9 10 11 12 13 14 15
          base.extend ClassMethods

          base.instance_eval do
            alias_method :plus_without_duration, :+
            alias_method :+, :plus_with_duration

            alias_method :minus_without_duration, :-
            alias_method :-, :minus_with_duration
          end
16 17 18
        end

        module ClassMethods
P
Pratik Naik 已提交
19
          # Returns a new Date representing the date 1 day ago (i.e. yesterday's date).
20 21
          def yesterday
            ::Date.today.yesterday
22 23
          end
          
P
Pratik Naik 已提交
24
          # Returns a new Date representing the date 1 day after today (i.e. tomorrow's date).
25 26
          def tomorrow
            ::Date.today.tomorrow
27
          end
28 29 30 31 32
          
          # Returns Time.zone.today when config.time_zone is set, otherwise just returns Date.today.
          def current
            ::Time.zone_default ? ::Time.zone.today : ::Date.today
          end
33 34
        end
        
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
        # 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
        def ago(seconds)
          to_time.since(-seconds)
        end

        # 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
        def since(seconds)
          to_time.since(seconds)
        end
        alias :in :since

        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
        def beginning_of_day
          to_time
        end
        alias :midnight :beginning_of_day
        alias :at_midnight :beginning_of_day
        alias :at_beginning_of_day :beginning_of_day

        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
        def end_of_day
          to_time.end_of_day
        end
        
61 62 63 64 65
        def plus_with_duration(other) #:nodoc:
          if ActiveSupport::Duration === other
            other.since(self)
          else
            plus_without_duration(other)
66
          end
67 68 69 70 71 72 73
        end
        
        def minus_with_duration(other) #:nodoc:
          if ActiveSupport::Duration === other
            plus_with_duration(-other)
          else
            minus_without_duration(other)
74
          end
75 76 77
        end
        
        # Provides precise Date calculations for years, months, and days.  The +options+ parameter takes a hash with 
78
        # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
79
        def advance(options)
80 81 82
          d = self
          d = d >> options.delete(:years) * 12 if options[:years]
          d = d >> options.delete(:months)     if options[:months]
83
          d = d +  options.delete(:weeks) * 7  if options[:weeks]
84
          d = d +  options.delete(:days)       if options[:days]
85 86
          d
        end
87

88 89 90 91
        # Returns a new Date where one or more of the elements have been changed according to the +options+ parameter.
        #
        # Examples:
        #
92
        #   Date.new(2007, 5, 12).change(:day => 1)                  # => Date.new(2007, 5, 1)
93 94 95 96 97
        #   Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)
        def change(options)
          ::Date.new(
            options[:year]  || self.year,
            options[:month] || self.month,
98
            options[:day]   || self.day
99 100 101 102 103
          )
        end
        
        # Returns a new Date/DateTime representing the time a number of specified months ago
        def months_ago(months)
104
          advance(:months => -months)
105
        end
106

107
        # Returns a new Date/DateTime representing the time a number of specified months in the future
108
        def months_since(months)
109
          advance(:months => months)
110
        end
111

112 113
        # Returns a new Date/DateTime representing the time a number of specified years ago
        def years_ago(years)
114
          advance(:years => -years)
115
        end
116

117
        # Returns a new Date/DateTime representing the time a number of specified years in the future
118
        def years_since(years)
119
          advance(:years => years)
120
        end
121

122 123 124 125
        # Short-hand for years_ago(1)
        def last_year
          years_ago(1)
        end
126

127 128 129 130
        # Short-hand for years_since(1)
        def next_year
          years_since(1)
        end
131

132 133 134 135
        # Short-hand for months_ago(1)
        def last_month
          months_ago(1)
        end
136

137 138 139 140
        # Short-hand for months_since(1)
        def next_month
          months_since(1)
        end
141

142 143 144 145 146 147 148 149 150
        # Returns a new Date/DateTime representing the "start" of this week (i.e, Monday; DateTime objects will have time set to 0:00)
        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
        alias :monday :beginning_of_week
        alias :at_beginning_of_week :beginning_of_week

151 152 153 154 155 156 157 158
        # Returns a new Date/DateTime representing the end of this week (Sunday, DateTime objects will have time set to 23:59:59)
        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
        alias :at_end_of_week :end_of_week

159 160 161 162 163 164 165 166 167 168 169 170
        # Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).
        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          

        # 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)
        def beginning_of_month
          self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
        end
        alias :at_beginning_of_month :beginning_of_month
171

172 173 174
        # 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)
        def end_of_month
          last_day = ::Time.days_in_month( self.month, self.year )
175
          self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
176 177
        end
        alias :at_end_of_month :end_of_month
178

179 180 181 182 183 184
        # 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)
        def beginning_of_quarter
          beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
        end
        alias :at_beginning_of_quarter :beginning_of_quarter

185 186 187 188 189 190
        # 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)
        def end_of_quarter
          change(:month => [3, 6, 9, 12].detect { |m| m >= self.month }).end_of_month
        end
        alias :at_end_of_quarter :end_of_quarter

191 192 193 194 195 196
        # Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)
        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
        alias :at_beginning_of_year :beginning_of_year

197 198 199 200 201 202
        # Returns a new Time representing the end of the year (31st of december; DateTime objects will have time set to 23:59:59)
        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
        alias :at_end_of_year :end_of_year

203 204 205 206 207 208 209 210
        # Convenience method which returns a new Date/DateTime representing the time 1 day ago
        def yesterday
          self - 1
        end

        # Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time
        def tomorrow
          self + 1
211 212 213 214
        end
      end
    end
  end
J
Jeremy Kemper 已提交
215
end