aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/core_ext/time/calculations.rb
blob: f5e9ab212c20774452ff48dce4f1dfd35ca865b0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
module ActiveSupport #:nodoc:
  module CoreExtensions #:nodoc:
    module Time #:nodoc:
      # Enables the use of time calculations within Time itself
      module Calculations
        # Seconds since midnight: Time.now.seconds_since_midnight
        def seconds_since_midnight
          self.hour.hours + self.min.minutes + self.sec + (self.usec/1.0e+6)
        end
            
        # Returns a new Time where one or more of the elements have been changed according to the +options+ parameter. The time options
        # (hour, minute, 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.
        def change(options, time_factory_method = :local)
          ::Time.send(
            time_factory_method, 
            options[:year]  || self.year, 
            options[:month] || self.month, 
            options[:mday]  || self.mday, 
            options[:hour]  || self.hour, 
            options[:min]   || (options[:hour] ? 0 : self.min),
            options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
            options[:usec]  || ((options[:hour] || options[:min] || options[:usec]) ? 0 : self.usec)
          )
        end

        # Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension
        # Do not use this method in combination with x.months, use months_ago instead!
        def ago(seconds)
          seconds.until(self)
        end

        # Returns a new Time representing the time a number of seconds since the instance time, this is basically a wrapper around 
        #the Numeric extension. Do not use this method in combination with x.months, use months_since instead!
        def since(seconds)
          seconds.since(self)
        end

        # Returns a new Time representing the time a number of specified months ago
        def months_ago(months, time_factory_method = :local)
          if months >= self.month 
            change({ :year => self.year - 1, :month => 12 }, time_factory_method).months_ago(months - self.month)
          else
            change({ :year => self.year, :month => self.month - months }, time_factory_method)
          end
        end

        def months_since(months, time_factory_method = :local)
          if months + self.month > 12
            change({ :year => self.year + 1, :month => 1 }, time_factory_method).months_since(
              months - (self.month == 1 ? 12 : (self.month + 1))
            )
          else
            change({ :year => self.year, :month => self.month + months }, time_factory_method)
          end
        end

        # Returns a new Time representing the "start" of this week (sunday, 0:00)
        def beginning_of_week
          (self - self.wday.days).midnight
        end
        alias :sunday :beginning_of_week
        alias :at_beginning_of_week :beginning_of_week
        
        # Returns a new Time representing the start of the day (0:00)
        def beginning_of_day
          self - self.seconds_since_midnight
        end
        alias :midnight :beginning_of_day
        alias :at_midnight :beginning_of_day
        alias :at_beginning_of_day :beginning_of_day
        
        # Returns a new Time representing the start of the month (1st of the month, 0:00)
        def beginning_of_month
          self - ((self.mday-1).days + self.seconds_since_midnight)
        end
        alias :at_beginning_of_month :beginning_of_month
        
        # Convenience method which returns a new Time representing the time 1 day ago
        def yesterday
          self.ago(1.day)
        end
        
        # Convenience method which returns a new Time representing the time 1 day since the instance time
        def tomorrow
          self.since(1.day)
        end
           
        # Returns a new Time of the current day at 9:00 (am) in the morning
        def in_the_morning(time_factory_method = :local)
          change({:hour => 9}, time_factory_method)
        end

        # Returns a new Time of the current day at 14:00 in the afternoon
        def in_the_afternoon(time_factory_method = :local)
          change({:hour => 14}, time_factory_method)
        end        
      end
    end
  end
end