2007-01-22 14:43:50 +01:00
|
|
|
module ActiveSupport #:nodoc:
|
|
|
|
module CoreExtensions #:nodoc:
|
|
|
|
module Date #:nodoc:
|
2008-05-18 06:22:34 +02:00
|
|
|
# Converting dates to formatted strings, times, and datetimes.
|
2007-01-22 14:43:50 +01:00
|
|
|
module Conversions
|
|
|
|
DATE_FORMATS = {
|
2007-12-21 08:48:59 +01:00
|
|
|
:short => "%e %b",
|
|
|
|
:long => "%B %e, %Y",
|
|
|
|
:db => "%Y-%m-%d",
|
2008-05-18 06:22:34 +02:00
|
|
|
:number => "%Y%m%d",
|
2007-12-21 08:48:59 +01:00
|
|
|
:long_ordinal => lambda { |date| date.strftime("%B #{date.day.ordinalize}, %Y") }, # => "April 25th, 2007"
|
|
|
|
:rfc822 => "%e %b %Y"
|
2007-01-22 14:43:50 +01:00
|
|
|
}
|
2007-02-09 09:04:31 +01:00
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def self.included(base) #:nodoc:
|
|
|
|
base.instance_eval do
|
|
|
|
alias_method :to_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 Date#to_time which converts to localtime only.
|
|
|
|
remove_method :to_time if base.instance_methods.include?(:to_time)
|
|
|
|
|
|
|
|
# Ruby 1.9 has Date#xmlschema which converts to a string without the time component.
|
|
|
|
remove_method :xmlschema if base.instance_methods.include?(:xmlschema)
|
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
# Convert to a formatted string. See DATE_FORMATS for predefined formats.
|
2007-12-21 08:48:59 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# This method is aliased to <tt>to_s</tt>.
|
2007-12-21 08:48:59 +01:00
|
|
|
#
|
2009-02-04 21:26:08 +01:00
|
|
|
# ==== Examples
|
2007-12-21 08:48:59 +01:00
|
|
|
# date = Date.new(2007, 11, 10) # => Sat, 10 Nov 2007
|
|
|
|
#
|
|
|
|
# date.to_formatted_s(:db) # => "2007-11-10"
|
|
|
|
# date.to_s(:db) # => "2007-11-10"
|
|
|
|
#
|
|
|
|
# date.to_formatted_s(:short) # => "10 Nov"
|
|
|
|
# date.to_formatted_s(:long) # => "November 10, 2007"
|
|
|
|
# date.to_formatted_s(:long_ordinal) # => "November 10th, 2007"
|
|
|
|
# date.to_formatted_s(:rfc822) # => "10 Nov 2007"
|
2008-05-18 06:22:34 +02:00
|
|
|
#
|
|
|
|
# == Adding your own time formats to to_formatted_s
|
|
|
|
# You can add your own formats to the Date::DATE_FORMATS hash.
|
|
|
|
# Use the format name as the hash key and either a strftime string
|
|
|
|
# or Proc instance that takes a date argument as the value.
|
|
|
|
#
|
|
|
|
# # config/initializers/time_formats.rb
|
|
|
|
# Date::DATE_FORMATS[:month_and_year] = "%B %Y"
|
|
|
|
# Date::DATE_FORMATS[:short_ordinal] = lambda { |date| date.strftime("%B #{date.day.ordinalize}") }
|
2007-01-22 14:43:50 +01:00
|
|
|
def to_formatted_s(format = :default)
|
2007-12-21 08:48:59 +01:00
|
|
|
if formatter = DATE_FORMATS[format]
|
|
|
|
if formatter.respond_to?(:call)
|
|
|
|
formatter.call(self).to_s
|
|
|
|
else
|
|
|
|
strftime(formatter)
|
|
|
|
end
|
|
|
|
else
|
|
|
|
to_default_s
|
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
# Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005"
|
|
|
|
def readable_inspect
|
|
|
|
strftime("%a, %d %b %Y")
|
|
|
|
end
|
|
|
|
|
|
|
|
# A method to keep Time, Date and DateTime instances interchangeable on conversions.
|
|
|
|
# In this case, it simply returns +self+.
|
2007-01-22 14:43:50 +01:00
|
|
|
def to_date
|
|
|
|
self
|
2007-12-21 08:48:59 +01:00
|
|
|
end if RUBY_VERSION < '1.9'
|
2007-01-22 14:43:50 +01:00
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
# Converts a Date instance to a Time, where the time is set to the beginning of the day.
|
|
|
|
# The timezone can be either :local or :utc (default :local).
|
|
|
|
#
|
2009-02-04 21:26:08 +01:00
|
|
|
# ==== Examples
|
2007-12-21 08:48:59 +01:00
|
|
|
# date = Date.new(2007, 11, 10) # => Sat, 10 Nov 2007
|
|
|
|
#
|
|
|
|
# date.to_time # => Sat Nov 10 00:00:00 0800 2007
|
|
|
|
# date.to_time(:local) # => Sat Nov 10 00:00:00 0800 2007
|
|
|
|
#
|
|
|
|
# date.to_time(:utc) # => Sat Nov 10 00:00:00 UTC 2007
|
2007-01-22 14:43:50 +01:00
|
|
|
def to_time(form = :local)
|
2007-12-21 08:48:59 +01:00
|
|
|
::Time.send("#{form}_time", year, month, day)
|
2007-02-09 09:04:31 +01:00
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
# Converts a Date instance to a DateTime, where the time is set to the beginning of the day
|
|
|
|
# and UTC offset is set to 0.
|
|
|
|
#
|
2009-02-04 21:26:08 +01:00
|
|
|
# ==== Examples
|
2007-12-21 08:48:59 +01:00
|
|
|
# date = Date.new(2007, 11, 10) # => Sat, 10 Nov 2007
|
|
|
|
#
|
|
|
|
# date.to_datetime # => Sat, 10 Nov 2007 00:00:00 0000
|
|
|
|
def to_datetime
|
|
|
|
::DateTime.civil(year, month, day, 0, 0, 0, 0)
|
|
|
|
end if RUBY_VERSION < '1.9'
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
def xmlschema
|
|
|
|
to_time.xmlschema
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
end
|