Module: ActiveSupport::CoreExtensions::DateTime::Conversions

Included in:
DateTime
Defined in:
lib/active_support/core_ext/date_time/conversions.rb

Overview

Converting datetimes to formatted strings, dates, and times.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 6

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

Instance Method Details

#readable_inspect ⇒ Object

Overrides the default inspect method with a human readable one, e.g., “Mon, 21 Feb 2005 14:30:00 +0000”



56
57
58
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 56

def readable_inspect
  to_s(:rfc822)
end

#to_date ⇒ Object

Converts self to a Ruby Date object; time portion is discarded



61
62
63
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 61

def to_date
  ::Date.new(year, month, day)
end

#to_datetime ⇒ Object

To be able to keep Times, Dates and DateTimes interchangeable on conversions



72
73
74
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 72

def to_datetime
  self
end

#to_formatted_s(format = :default) ⇒ Object

Convert to a formatted string. See Time::DATE_FORMATS for predefined formats.

This method is aliased to to_s.

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"

Adding your own datetime formats to to_formatted_s

DateTime formats are shared with Time. You can add your own to the Time::DATE_FORMATS hash. Use the format name as the hash key and either a strftime string or Proc instance that takes a time or datetime argument as the value.

# config/initializers/time_formats.rb
Time::DATE_FORMATS[:month_and_year] = "%B %Y"
Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }



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

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

#to_time ⇒ Object

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



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

def to_time
  self.offset == 0 ? ::Time.utc_time(year, month, day, hour, min, sec) : self
end

#xmlschema ⇒ Object

Converts datetime to an appropriate format for use in XML



77
78
79
 
# File 'lib/active_support/core_ext/date_time/conversions.rb', line 77

def xmlschema
  strftime("%Y-%m-%dT%H:%M:%S%Z")
end