activesupport 1.4.4 → 2.0.0

data/lib/active_support/core_ext/class/inheritable_attributes.rb

@@ -23,7 +23,7 @@ class Class # :nodoc:
   end
 
   def class_inheritable_writer(*syms)
-    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    options = syms.extract_options!
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)
@@ -40,7 +40,7 @@ class Class # :nodoc:
   end
 
   def class_inheritable_array_writer(*syms)
-    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    options = syms.extract_options!
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)
@@ -57,7 +57,7 @@ class Class # :nodoc:
   end
 
   def class_inheritable_hash_writer(*syms)
-    options = syms.last.is_a?(Hash) ? syms.pop : {}
+    options = syms.extract_options!
     syms.each do |sym|
       class_eval <<-EOS
         def self.#{sym}=(obj)

data/lib/active_support/core_ext/class/removal.rb

@@ -17,8 +17,8 @@ class Class #:nodoc:
       
       # Skip this class if it does not match the current one bound to this name
       next unless parent.const_defined?(basename) && klass = parent.const_get(basename)
-      
-      parent.send :remove_const, basename unless parent == klass
+
+      parent.instance_eval { remove_const basename } unless parent == klass
     end
   end
 end

data/lib/active_support/core_ext/date.rb

@@ -1,6 +1,10 @@
 require 'date'
-require File.dirname(__FILE__) + '/date/conversions'
+require 'active_support/core_ext/date/behavior'
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/date/conversions'
 
 class Date#:nodoc:
+  include ActiveSupport::CoreExtensions::Date::Behavior
+  include ActiveSupport::CoreExtensions::Date::Calculations
   include ActiveSupport::CoreExtensions::Date::Conversions
 end

data/lib/active_support/core_ext/date/behavior.rb

@@ -0,0 +1,13 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Date #:nodoc:
+      module Behavior
+        # Enable more predictable duck-typing on Date-like classes. See
+        # Object#acts_like?.
+        def acts_like_date?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/date/calculations.rb

@@ -0,0 +1,188 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Date #:nodoc:
+      # Enables the use of time calculations within Time itself
+      module Calculations
+        def self.included(base) #:nodoc:
+          base.extend ClassMethods
+
+          base.instance_eval do
+            alias_method :plus_without_duration, :+
+            alias_method :+, :plus_with_duration
+
+            alias_method :minus_without_duration, :-
+            alias_method :-, :minus_with_duration
+          end
+        end
+
+        module ClassMethods
+          def yesterday
+            ::Date.today.yesterday
+          end
+          
+          def tomorrow
+            ::Date.today.tomorrow
+          end
+        end
+        
+        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+        # and then subtracts the specified number of seconds
+        def ago(seconds)
+          to_time.since(-seconds)
+        end
+
+        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+        # and then adds the specified number of seconds
+        def since(seconds)
+          to_time.since(seconds)
+        end
+        alias :in :since
+
+        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+        def beginning_of_day
+          to_time
+        end
+        alias :midnight :beginning_of_day
+        alias :at_midnight :beginning_of_day
+        alias :at_beginning_of_day :beginning_of_day
+
+        # Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
+        def end_of_day
+          to_time.end_of_day
+        end
+        
+        def plus_with_duration(other) #:nodoc:
+          if ActiveSupport::Duration === other
+            other.since(self)
+          else
+            plus_without_duration(other)
+          end
+        end
+        
+        def minus_with_duration(other) #:nodoc:
+          if ActiveSupport::Duration === other
+            plus_with_duration(-other)
+          else
+            minus_without_duration(other)
+          end
+        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.
+        def advance(options)
+          d = self
+          d = d >> options.delete(:years) * 12 if options[:years]
+          d = d >> options.delete(:months)     if options[:months]
+          d = d +  options.delete(:weeks) * 7  if options[:weeks]
+          d = d +  options.delete(:days)       if options[:days]
+          d
+        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)
+        def change(options)
+          ::Date.new(
+            options[:year]  || self.year,
+            options[:month] || self.month,
+            options[:day]   || self.day
+          )
+        end
+        
+        # Returns a new Date/DateTime representing the time a number of specified months ago
+        def months_ago(months)
+          advance(:months => -months)
+        end
+
+        # Returns a new Date/DateTime representing the time a number of specified months in the future
+        def months_since(months)
+          advance(:months => months)
+        end
+
+        # Returns a new Date/DateTime representing the time a number of specified years ago
+        def years_ago(years)
+          advance(:years => -years)
+        end
+
+        # Returns a new Date/DateTime representing the time a number of specified years in the future
+        def years_since(years)
+          advance(:years => years)
+        end
+
+        # Short-hand for years_ago(1)
+        def last_year
+          years_ago(1)
+        end
+
+        # Short-hand for years_since(1)
+        def next_year
+          years_since(1)
+        end
+
+        # Short-hand for months_ago(1)
+        def last_month
+          months_ago(1)
+        end
+
+        # Short-hand for months_since(1)
+        def next_month
+          months_since(1)
+        end
+
+        # Returns a new Date/DateTime representing the "start" of this week (i.e, Monday; DateTime objects will have time set to 0:00)
+        def beginning_of_week
+          days_to_monday = self.wday!=0 ? self.wday-1 : 6
+          result = self - days_to_monday
+          self.acts_like?(:time) ? result.midnight : result
+        end
+        alias :monday :beginning_of_week
+        alias :at_beginning_of_week :beginning_of_week
+
+        # Returns a new Date/DateTime representing the start of the given day in next week (default is Monday).
+        def next_week(day = :monday)
+          days_into_week = { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6}
+          result = (self + 7).beginning_of_week + days_into_week[day]
+          self.acts_like?(:time) ? result.change(:hour => 0) : result
+        end          
+
+        # Returns a new ; DateTime objects will have time set to 0:00DateTime representing the start of the month (1st of the month; DateTime objects will have time set to 0:00)
+        def beginning_of_month
+          self.acts_like?(:time) ? change(:day => 1,:hour => 0, :min => 0, :sec => 0) : change(:day => 1)
+        end
+        alias :at_beginning_of_month :beginning_of_month
+
+        # Returns a new Date/DateTime representing the end of the month (last day of the month; DateTime objects will have time set to 0:00)
+        def end_of_month
+          last_day = ::Time.days_in_month( self.month, self.year )
+          self.acts_like?(:time) ? change(:day => last_day, :hour => 23, :min => 59, :sec => 59) : change(:day => last_day)
+        end
+        alias :at_end_of_month :end_of_month
+
+        # Returns a new Date/DateTime representing the start of the quarter (1st of january, april, july, october; DateTime objects will have time set to 0:00)
+        def beginning_of_quarter
+          beginning_of_month.change(:month => [10, 7, 4, 1].detect { |m| m <= self.month })
+        end
+        alias :at_beginning_of_quarter :beginning_of_quarter
+
+        # Returns a new Date/DateTime representing the start of the year (1st of january; DateTime objects will have time set to 0:00)
+        def beginning_of_year
+          self.acts_like?(:time) ? change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0) : change(:month => 1, :day => 1)
+        end
+        alias :at_beginning_of_year :beginning_of_year
+
+        # Convenience method which returns a new Date/DateTime representing the time 1 day ago
+        def yesterday
+          self - 1
+        end
+
+        # Convenience method which returns a new Date/DateTime representing the time 1 day since the instance time
+        def tomorrow
+          self + 1
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/date/conversions.rb

@@ -4,32 +4,88 @@ module ActiveSupport #:nodoc:
       # Getting dates in different convenient string representations and other objects
       module Conversions
         DATE_FORMATS = {
-          :short => "%e %b",
-          :long  => "%B %e, %Y"
+          :short        => "%e %b",
+          :long         => "%B %e, %Y",
+          :db           => "%Y-%m-%d",
+          :long_ordinal => lambda { |date| date.strftime("%B #{date.day.ordinalize}, %Y") }, # => "April 25th, 2007"
+          :rfc822       => "%e %b %Y"
         }
 
-        def self.included(klass) #:nodoc:
-          klass.send(:alias_method, :to_default_s, :to_s)
-          klass.send(:alias_method, :to_s, :to_formatted_s)
+        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)
+          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:
+        #   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"
         def to_formatted_s(format = :default)
-          DATE_FORMATS[format] ? strftime(DATE_FORMATS[format]).strip : to_default_s
+          if formatter = DATE_FORMATS[format]
+            if formatter.respond_to?(:call)
+              formatter.call(self).to_s
+            else
+              strftime(formatter)
+            end
+          else
+            to_default_s
+          end
+        end
+
+        # 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
 
-        # To be able to keep Dates and Times interchangeable on conversions
+        # A method to keep Time, Date and DateTime instances interchangeable on conversions.
+        # In this case, it simply returns +self+.
         def to_date
           self
-        end
+        end if RUBY_VERSION < '1.9'
 
+        # 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).
+        #
+        # ==== Examples:
+        #   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
         def to_time(form = :local)
-          if respond_to?(:hour)
-            ::Time.send(form, year, month, day, hour, min, sec)
-          else
-            ::Time.send(form, year, month, day)
-          end
+          ::Time.send("#{form}_time", year, month, day)
         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.
+        #
+        # ==== Example:
+        #   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'
+
         def xmlschema
           to_time.xmlschema
         end

data/lib/active_support/core_ext/date_time.rb

@@ -0,0 +1,10 @@
+require 'date'
+require 'active_support/core_ext/time/behavior'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/conversions'
+
+class DateTime
+  include ActiveSupport::CoreExtensions::Time::Behavior
+  include ActiveSupport::CoreExtensions::DateTime::Calculations
+  include ActiveSupport::CoreExtensions::DateTime::Conversions
+end

data/lib/active_support/core_ext/date_time/calculations.rb

@@ -0,0 +1,77 @@
+require 'rational'
+
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module DateTime #:nodoc:
+      # Enables the use of time calculations within DateTime itself
+      module Calculations
+        def self.included(base) #:nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          # DateTimes aren't aware of DST rules, so use a consistent non-DST offset when creating a DateTime with an offset in the local zone
+          def local_offset
+            ::Time.local(2007).utc_offset.to_r / 86400
+          end
+        end
+
+        # Seconds since midnight: DateTime.now.seconds_since_midnight
+        def seconds_since_midnight
+          self.sec + (self.min * 60) + (self.hour * 3600)
+        end
+
+        # Returns a new DateTime where one or more of the elements have been changed according to the +options+ parameter. The time options
+        # (hour, minute, sec) reset cascadingly, so if only the hour is passed, then minute and sec is set to 0. If the hour and
+        # minute is passed, then sec is set to 0.
+        def change(options)
+          ::DateTime.civil(
+            options[:year]  || self.year,
+            options[:month] || self.month,
+            options[:day]   || self.day,
+            options[:hour]  || self.hour,
+            options[:min]   || (options[:hour] ? 0 : self.min),
+            options[:sec]   || ((options[:hour] || options[:min]) ? 0 : self.sec),
+            options[:offset]  || self.offset,
+            options[:start]  || self.start
+          )
+        end
+
+        # Uses Date to provide precise Time calculations for years, months, and days.  The +options+ parameter takes a hash with
+        # any of these keys: :years, :months, :weeks, :days, :hours, :minutes, :seconds.
+        def advance(options)
+          d = to_date.advance(options)
+          datetime_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
+          seconds_to_advance = (options[:seconds] || 0) + (options[:minutes] || 0) * 60 + (options[:hours] || 0) * 3600
+          seconds_to_advance == 0 ? datetime_advanced_by_date : datetime_advanced_by_date.since(seconds_to_advance)
+        end
+
+        # Returns a new DateTime representing the time a number of seconds ago
+        # Do not use this method in combination with x.months, use months_ago instead!
+        def ago(seconds)
+          self.since(-seconds)
+        end
+
+        # Returns a new DateTime representing the time a number of seconds since the instance time
+        # Do not use this method in combination with x.months, use months_since instead!
+        def since(seconds)
+          self + Rational(seconds.round, 86400)
+        end
+        alias :in :since
+
+        # Returns a new DateTime representing the start of the day (0:00)
+        def beginning_of_day
+          change(:hour => 0)
+        end
+        alias :midnight :beginning_of_day
+        alias :at_midnight :beginning_of_day
+        alias :at_beginning_of_day :beginning_of_day
+
+        # Returns a new DateTime representing the end of the day (23:59:59)
+        def end_of_day
+          change(:hour => 23, :min => 59, :sec => 59)
+        end
+      end
+    end
+  end
+end

data/lib/active_support/core_ext/date_time/conversions.rb

@@ -0,0 +1,54 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module DateTime #:nodoc:
+      # Getting datetimes in different convenient string representations and other objects
+      module Conversions
+        def self.included(base)
+          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
+          end
+        end
+
+        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
+        
+        def xmlschema
+          strftime("%Y-%m-%dT%H:%M:%S#{offset == 0 ? 'Z' : '%Z'}")
+        end
+      end
+    end
+  end
+end