aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support/core_ext/date_time/conversions.rb
blob: 2ee663ac9315fd098b144d790edbace9251083f9 (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
module ActiveSupport #:nodoc:
  module CoreExtensions #:nodoc:
    module DateTime #:nodoc:
      # Getting datetimes in different convenient string representations and other objects.
      #
      # == Adding your own time formats in to_formatted_s
      # You can add your own time formats by merging them into the  ::Time::Conversions::DATE_FORMATS constant. Use a string with
      # Ruby's strftime formatting (http://ruby-doc.org/core/classes/Time.html#M000297), or
      # pass a lambda. The lambda yields the instance to_formatted_s is called on, so that calculations
      # can be performed on that instance. This is handy when Ruby's strftime formatting is insufficient. See
      # the +short_ordinal+ example below.
      #
      # See ActiveSupport::CoreExtensions::Time::Conversions::DATE_FORMATS for the list of built-in formats, and
      # to_formatted_s for implementation details.
      #
      # === Examples:
      #   # config/initializers/time_formats.rb
      #   ActiveSupport::CoreExtensions::Time::Conversions::DATE_FORMATS.merge!(
      #     :month_and_year => "%B %Y",
      #     :short_ordinal => lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
      #   )
      #
      # Calling it on a Time instance:
      #
      #   Time.now.to_s(:short_ordinal)
      module Conversions
        def self.included(base) #:nodoc:
          base.class_eval do
            alias_method :to_datetime_default_s, :to_s
            alias_method :to_s, :to_formatted_s
            alias_method :default_inspect, :inspect
            alias_method :inspect, :readable_inspect

            # Ruby 1.9 has DateTime#to_time which internally relies on Time. We define our own #to_time which allows
            # DateTimes outside the range of what can be created with Time.
            remove_method :to_time if base.instance_methods.include?(:to_time)
          end
        end
        
        # Convert to a formatted string - see DATE_FORMATS for predefined formats.
        # You can also add your own formats to the DATE_FORMATS constant and use them with this method.
        # 
        # This method is also aliased as <tt>to_s</tt>.
        # 
        # === Examples:
        #   datetime = DateTime.civil(2007, 12, 4, 0, 0, 0, 0)   # => Tue, 04 Dec 2007 00:00:00 +0000
        # 
        #   datetime.to_formatted_s(:db)            # => "2007-12-04 00:00:00"
        #   datetime.to_s(:db)                      # => "2007-12-04 00:00:00"
        #   datetime.to_s(:number)                  # => "20071204000000"
        #   datetime.to_formatted_s(:short)         # => "04 Dec 00:00"
        #   datetime.to_formatted_s(:long)          # => "December 04, 2007 00:00"
        #   datetime.to_formatted_s(:long_ordinal)  # => "December 4th, 2007 00:00"
        #   datetime.to_formatted_s(:rfc822)        # => "Tue, 04 Dec 2007 00:00:00 +0000"
        def to_formatted_s(format = :default)
          if formatter = ::Time::DATE_FORMATS[format]
            if formatter.respond_to?(:call)
              formatter.call(self).to_s
            else
              strftime(formatter)
            end
          else
            to_datetime_default_s
          end
        end

        # Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005 14:30:00 +0000"
        def readable_inspect
          to_s(:rfc822)
        end

        # Converts self to a Ruby Date object; time portion is discarded
        def to_date
          ::Date.new(year, month, day)
        end

        # Attempts to convert self to a Ruby Time object; returns self if out of range of Ruby Time class
        # If self has an offset other than 0, self will just be returned unaltered, since there's no clean way to map it to a Time
        def to_time
          self.offset == 0 ? ::Time.utc_time(year, month, day, hour, min, sec) : self
        end

        # To be able to keep Times, Dates and DateTimes interchangeable on conversions
        def to_datetime
          self
        end

        # Converts datetime to an appropriate format for use in XML
        def xmlschema
          strftime("%Y-%m-%dT%H:%M:%S%Z")
        end if RUBY_VERSION < '1.9'
      end
    end
  end
end