Module: PassiveSupport::CoreExtensions::DateTime::Conversions

Included in:
DateTime
Defined in:
lib/passive_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

.append_features(base) ⇒ Object

:nodoc:



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 6

def self.append_features(base) #:nodoc:
  base.class_eval do
    alias_method :default_inspect, :inspect
    alias_method :to_default_s, :to_s unless (instance_methods(false) & [:to_s, 'to_s']).empty?

    # 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 instance_methods.include?(:to_time)
  end

  super

  base.class_eval do
    alias_method :to_s, :to_formatted_s
    alias_method :inspect, :readable_inspect
  end
end

Instance Method Details

#formatted_offset(colon = true, alternate_utc_string = nil) ⇒ Object

Returns the utc_offset as an +HH:MM formatted string. Examples:

datetime = DateTime.civil(2000, 1, 1, 0, 0, 0, Rational(-6, 24))
datetime.formatted_offset         # => "-06:00"
datetime.formatted_offset(false)  # => "-0600"



58
59
60
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 58

def formatted_offset(colon = true, alternate_utc_string = nil)
  utc? && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
end

#readable_inspect ⇒ Object

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



63
64
65
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 63

def readable_inspect
  to_s(:rfc822)
end

#to_date ⇒ Object

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



68
69
70
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 68

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

#to_datetime ⇒ Object

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



79
80
81
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 79

def to_datetime
  self
end

#to_f ⇒ Object

Converts self to a floating-point number of seconds since the Unix epoch



89
90
91
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 89

def to_f
  seconds_since_unix_epoch.to_f
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}") }



48
49
50
51
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 48

def to_formatted_s(format = :default)
  return to_default_s unless formatter = ::Time::DATE_FORMATS[format]
  formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
end

#to_i ⇒ Object

Converts self to an integer number of seconds since the Unix epoch



94
95
96
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 94

def to_i
  seconds_since_unix_epoch.to_i
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



74
75
76
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 74

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



84
85
86
 
# File 'lib/passive_support/core_ext/date_time/conversions.rb', line 84

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