Class | Date |
In: |
lib/more/facets/date.rb
|
Parent: | Object |
This new version of Date extension has been largely improved by porting some of the methods used by ActiveSupport. The old version already had much in common with the Active Support library, so it was decided to take it a step further in that direction for the sake of interoparability.
Hopefully most of these methods will find there way into Ruby‘s own standard library eventually.
The biggest difference with ActiveSupport is the lack of many of the "English-esque" methods, and that we use stamp with Date::FORMAT, instead of to_formmated_s with Date::DATE_FORMATS. We do not override the standard to_s method like ActiveSupport does.
FORMAT | = | { :short => "%e %b", :long => "%B %e, %Y", :db => "%Y-%m-%d", :number => "%Y%m%d", :rfc822 => "%e %b %Y", :default => "%Y-%m-%d", nil => "%Y-%m-%d" |
Returns Time.zone.today when config.time_zone is set, otherwise just returns Date.today.
# File lib/more/facets/date.rb, line 43 43: def self.current 44: ::Time.zone_default ? ::Time.zone.today : ::Date.today 45: end
Provides precise Date calculations for years, months, and days. The options parameter takes a hash with any of these keys: :years, :months, :weeks, :days.
# File lib/more/facets/date.rb, line 139 139: def advance(options) 140: d = self 141: d = d >> options.delete(:years) * 12 if options[:years] 142: d = d >> options.delete(:months) if options[:months] 143: d = d + options.delete(:weeks) * 7 if options[:weeks] 144: d = d + options.delete(:days) if options[:days] 145: d 146: end
Returns a new Date where one or more of the elements have been changed according to the options parameter.
Examples:
Date.new(2007, 5, 12).change(:day => 1) # => Date.new(2007, 5, 1) Date.new(2007, 5, 12).change(:year => 2005, :month => 1) # => Date.new(2005, 1, 12)
# File lib/more/facets/date.rb, line 154 154: def change(options) 155: ::Date.new( 156: options[:year] || self.year, 157: options[:month] || self.month, 158: options[:day] || self.day 159: ) 160: end
Get the month name for this date object
CREDIT: Benjamin Oakes
# File lib/more/facets/date.rb, line 101 101: def month_name 102: MONTHNAMES[self.month] 103: end
Convert to a formatted string. See DATE_FORMATS for predefined formats.
This method is aliased to to_s.
date = Date.new(2007, 11, 10) # => Sat, 10 Nov 2007 date.stamp(:db) # => "2007-11-10" date.stamp(:short) # => "10 Nov" date.stamp(:long) # => "November 10, 2007" date.stamp(:rfc822) # => "10 Nov 2007"
You can add your own formats to the Date::FORMAT hash. Use the format name as the hash key and a strftime string as the value. Eg.
Date::FORMAT[:month_and_year] = "%B %Y"
# File lib/more/facets/date.rb, line 124 124: def stamp(format=:default) 125: if formatter = FORMAT[format] 126: strftime(formatter) 127: else 128: to_s 129: end 130: end
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.
date = Date.new(2007, 11, 10) # => Sat, 10 Nov 2007 date.to_datetime # => Sat, 10 Nov 2007 00:00:00 0000
# File lib/more/facets/date.rb, line 60 60: def to_datetime 61: ::DateTime.civil(year, month, day, 0, 0, 0, 0) 62: end
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).
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
# File lib/more/facets/date.rb, line 74 74: def to_time(form=:local) 75: ::Time.send(form, year, month, day) 76: #::Time.send("#{form}_time", year, month, day) 77: end