activesupport 2.0.5 → 2.1.0

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

@@ -5,6 +5,7 @@ module ActiveSupport #:nodoc:
       module Conversions
         DATE_FORMATS = {
           :db           => "%Y-%m-%d %H:%M:%S",
+          :number       => "%Y%m%d%H%M%S",
           :time         => "%H:%M",
           :short        => "%d %b %H:%M",
           :long         => "%B %d, %Y %H:%M",
@@ -19,11 +20,10 @@ module ActiveSupport #:nodoc:
           end
         end
 
-        # Convert to a formatted string. See DATE_FORMATS for builtin formats.
+        # Converts to a formatted string. See DATE_FORMATS for builtin formats.
         #
         # This method is aliased to <tt>to_s</tt>.
         #
-        # ==== Examples:
         #   time = Time.now                     # => Thu Jan 18 06:10:17 CST 2007
         #
         #   time.to_formatted_s(:time)          # => "06:10:17"
@@ -35,7 +35,7 @@ module ActiveSupport #:nodoc:
         #   time.to_formatted_s(:long_ordinal)  # => "January 18th, 2007 06:10"
         #   time.to_formatted_s(:rfc822)        # => "Thu, 18 Jan 2007 06:10:17 -0600"
         #
-        # == Adding your own time formats to to_formatted_s
+        # == Adding your own time formats to +to_formatted_s+
         # You can add your own formats 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 argument as the value.
@@ -44,31 +44,25 @@ module ActiveSupport #:nodoc:
         #   Time::DATE_FORMATS[:month_and_year] = "%B %Y"
         #   Time::DATE_FORMATS[:short_ordinal] = lambda { |time| time.strftime("%B #{time.day.ordinalize}") }
         def to_formatted_s(format = :default)
-          if formatter = DATE_FORMATS[format]
-            if formatter.respond_to?(:call)
-              formatter.call(self).to_s
-            else
-              strftime(formatter)
-            end
-          else
-            to_default_s
-          end
+          return to_default_s unless formatter = DATE_FORMATS[format]
+          formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
         end
-
-        # Convert a Time object to a Date, dropping hour, minute, and second precision.
+        
+        # Returns the UTC offset as an +HH:MM formatted string.
         #
-        # ==== Examples
-        #   my_time = Time.now
-        #   # => Mon Nov 12 22:59:51 -0500 2007
-        #
-        #   my_time.to_date
-        #   #=> Mon, 12 Nov 2007
+        #   Time.local(2000).formatted_offset         # => "-06:00"
+        #   Time.local(2000).formatted_offset(false)  # => "-0600"
+        def formatted_offset(colon = true, alternate_utc_string = nil)
+          utc? && alternate_utc_string || utc_offset.to_utc_offset_s(colon)
+        end
+
+        # Converts a Time object to a Date, dropping hour, minute, and second precision.
         #
-        #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")
-        #   # => Tue Jan 13 13:13:03 -0500 2009
+        #   my_time = Time.now  # => Mon Nov 12 22:59:51 -0500 2007
+        #   my_time.to_date     # => Mon, 12 Nov 2007
         #
-        #   your_time.to_date
-        #   # => Tue, 13 Jan 2009
+        #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
+        #   your_time.to_date                                 # => Tue, 13 Jan 2009
         def to_date
           ::Date.new(year, month, day)
         end
@@ -81,18 +75,11 @@ module ActiveSupport #:nodoc:
 
         # Converts a Time instance to a Ruby DateTime instance, preserving UTC offset.
         #
-        # ==== Examples
-        #   my_time = Time.now
-        #   # => Mon Nov 12 23:04:21 -0500 2007
-        #
-        #   my_time.to_datetime
-        #   # => Mon, 12 Nov 2007 23:04:21 -0500
-        #
-        #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")
-        #   # => Tue Jan 13 13:13:03 -0500 2009
+        #   my_time = Time.now    # => Mon Nov 12 23:04:21 -0500 2007
+        #   my_time.to_datetime   # => Mon, 12 Nov 2007 23:04:21 -0500
         #
-        #   your_time.to_datetime
-        #   # => Tue, 13 Jan 2009 13:13:03 -0500
+        #   your_time = Time.parse("1/13/2009 1:13:03 P.M.")  # => Tue Jan 13 13:13:03 -0500 2009
+        #   your_time.to_datetime                             # => Tue, 13 Jan 2009 13:13:03 -0500
         def to_datetime
           ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400))
         end

data/lib/active_support/core_ext/time/zones.rb

@@ -0,0 +1,86 @@
+module ActiveSupport #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Time #:nodoc:
+      module Zones
+        def self.included(base) #:nodoc:
+          base.extend(ClassMethods) if base == ::Time # i.e., don't include class methods in DateTime
+        end
+        
+        module ClassMethods
+          attr_accessor :zone_default
+          
+          # Returns the TimeZone for the current request, if this has been set (via Time.zone=). 
+          # If <tt>Time.zone</tt> has not been set for the current request, returns the TimeZone specified in <tt>config.time_zone</tt>.
+          def zone
+            Thread.current[:time_zone] || zone_default
+          end
+
+          # Sets <tt>Time.zone</tt> to a TimeZone object for the current request/thread. 
+          #
+          # This method accepts any of the following:
+          #
+          # * A Rails TimeZone object.
+          # * An identifier for a Rails TimeZone object (e.g., "Eastern Time (US & Canada)", <tt>-5.hours</tt>).
+          # * A TZInfo::Timezone object.
+          # * An identifier for a TZInfo::Timezone object (e.g., "America/New_York").
+          #
+          # Here's an example of how you might set <tt>Time.zone</tt> on a per request basis -- <tt>current_user.time_zone</tt>
+          # just needs to return a string identifying the user's preferred TimeZone:
+          #
+          #   class ApplicationController < ActionController::Base
+          #     before_filter :set_time_zone
+          #
+          #     def set_time_zone
+          #       Time.zone = current_user.time_zone
+          #     end
+          #   end
+          def zone=(time_zone)
+            Thread.current[:time_zone] = get_zone(time_zone)
+          end
+          
+          # Allows override of <tt>Time.zone</tt> locally inside supplied block; resets <tt>Time.zone</tt> to existing value when done.
+          def use_zone(time_zone)
+            old_zone, ::Time.zone = ::Time.zone, get_zone(time_zone)
+            yield
+          ensure
+            ::Time.zone = old_zone
+          end
+          
+          # Returns <tt>Time.zone.now</tt> when <tt>config.time_zone</tt> is set, otherwise just returns <tt>Time.now</tt>.
+          def current
+            ::Time.zone_default ? ::Time.zone.now : ::Time.now
+          end
+          
+          private
+            def get_zone(time_zone)
+              return time_zone if time_zone.nil? || time_zone.is_a?(TimeZone)
+              # lookup timezone based on identifier (unless we've been passed a TZInfo::Timezone)
+              unless time_zone.respond_to?(:period_for_local)
+                time_zone = TimeZone[time_zone] || TZInfo::Timezone.get(time_zone) rescue nil
+              end
+              # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
+              if time_zone
+                time_zone.is_a?(TimeZone) ? time_zone : TimeZone.create(time_zone.name, nil, time_zone)
+              end
+            end
+        end
+        
+        # Returns the simultaneous time in <tt>Time.zone</tt>.
+        #
+        #   Time.zone = 'Hawaii'         # => 'Hawaii'
+        #   Time.utc(2000).in_time_zone  # => Fri, 31 Dec 1999 14:00:00 HST -10:00
+        #
+        # This method is similar to Time#localtime, except that it uses <tt>Time.zone</tt> as the local zone
+        # instead of the operating system's time zone.
+        #
+        # You can also pass in a TimeZone instance or string that identifies a TimeZone as an argument, 
+        # and the conversion will be based on that zone instead of <tt>Time.zone</tt>.
+        #
+        #   Time.utc(2000).in_time_zone('Alaska')  # => Fri, 31 Dec 1999 15:00:00 AKST -09:00
+        def in_time_zone(zone = ::Time.zone)
+          ActiveSupport::TimeWithZone.new(utc? ? self : getutc, ::Time.send!(:get_zone, zone))
+        end
+      end
+    end
+  end
+end

data/lib/active_support/dependencies.rb

@@ -21,36 +21,36 @@ module Dependencies #:nodoc:
   # Should we load files or require them?
   mattr_accessor :mechanism
   self.mechanism = :load
-  
+
   # The set of directories from which we may automatically load files. Files
   # under these directories will be reloaded on each request in development mode,
   # unless the directory also appears in load_once_paths.
   mattr_accessor :load_paths
   self.load_paths = []
-  
+
   # The set of directories from which automatically loaded constants are loaded
   # only once. All directories in this set must also be present in +load_paths+.
   mattr_accessor :load_once_paths
   self.load_once_paths = []
-  
+
   # An array of qualified constant names that have been loaded. Adding a name to
   # this array will cause it to be unloaded the next time Dependencies are cleared.
   mattr_accessor :autoloaded_constants
   self.autoloaded_constants = []
-  
+
   # An array of constant names that need to be unloaded on every request. Used
   # to allow arbitrary constants to be marked for unloading.
   mattr_accessor :explicitly_unloadable_constants
   self.explicitly_unloadable_constants = []
-  
+
   # Set to true to enable logging of const_missing and file loads
   mattr_accessor :log_activity
   self.log_activity = false
-  
+
   # An internal stack used to record which constants are loaded by any block.
   mattr_accessor :constant_watch_stack
   self.constant_watch_stack = []
-  
+
   def load?
     mechanism == :load
   end
@@ -81,66 +81,78 @@ module Dependencies #:nodoc:
     # Record that we've seen this file *before* loading it to avoid an
     # infinite loop with mutual dependencies.
     loaded << expanded
-    
-    if load?
-      log "loading #{file_name}"
-      begin
+
+    begin
+      if load?
+        log "loading #{file_name}"
+
         # Enable warnings iff this file has not been loaded before and
         # warnings_on_first_load is set.
         load_args = ["#{file_name}.rb"]
         load_args << const_path unless const_path.nil?
-        
+
         if !warnings_on_first_load or history.include?(expanded)
           result = load_file(*load_args)
         else
           enable_warnings { result = load_file(*load_args) }
         end
-      rescue Exception
-        loaded.delete expanded
-        raise
+      else
+        log "requiring #{file_name}"
+        result = require file_name
       end
-    else
-      log "requiring #{file_name}"
-      result = require file_name
+    rescue Exception
+      loaded.delete expanded
+      raise
     end
 
     # Record history *after* loading so first load gets warnings.
     history << expanded
     return result
   end
-  
+
   # Is the provided constant path defined?
   def qualified_const_defined?(path)
     raise NameError, "#{path.inspect} is not a valid constant name!" unless
       /^(::)?([A-Z]\w*)(::[A-Z]\w*)*$/ =~ path
-    
+
     names = path.to_s.split('::')
     names.shift if names.first.empty?
-    
+
     # We can't use defined? because it will invoke const_missing for the parent
     # of the name we are checking.
     names.inject(Object) do |mod, name|
-      return false unless mod.const_defined? name
+      return false unless uninherited_const_defined?(mod, name)
       mod.const_get name
     end
     return true
   end
-  
+
+  if Module.method(:const_defined?).arity == 1
+    # Does this module define this constant?
+    # Wrapper to accomodate changing Module#const_defined? in Ruby 1.9
+    def uninherited_const_defined?(mod, const)
+      mod.const_defined?(const)
+    end
+  else
+    def uninherited_const_defined?(mod, const) #:nodoc:
+      mod.const_defined?(const, false)
+    end
+  end
+
   # Given +path+, a filesystem path to a ruby file, return an array of constant
   # paths which would cause Dependencies to attempt to load this file.
-  # 
   def loadable_constants_for_path(path, bases = load_paths)
     path = $1 if path =~ /\A(.*)\.rb\Z/
     expanded_path = File.expand_path(path)
-    
+
     bases.collect do |root|
       expanded_root = File.expand_path(root)
       next unless %r{\A#{Regexp.escape(expanded_root)}(/|\\)} =~ expanded_path
-      
+
       nesting = expanded_path[(expanded_root.size)..-1]
       nesting = nesting[1..-1] if nesting && nesting[0] == ?/
       next if nesting.blank?
-      
+
       [
         nesting.camelize,
         # Special case: application.rb might define ApplicationControlller.
@@ -148,7 +160,7 @@ module Dependencies #:nodoc:
       ]
     end.flatten.compact.uniq
   end
-  
+
   # Search for a file in load_paths matching the provided suffix.
   def search_for_file(path_suffix)
     path_suffix = path_suffix + '.rb' unless path_suffix.ends_with? '.rb'
@@ -158,20 +170,20 @@ module Dependencies #:nodoc:
     end
     nil # Gee, I sure wish we had first_match ;-)
   end
-  
+
   # Does the provided path_suffix correspond to an autoloadable module?
-  # Instead of returning a boolean, the autoload base for this module is returned. 
+  # Instead of returning a boolean, the autoload base for this module is returned.
   def autoloadable_module?(path_suffix)
     load_paths.each do |load_path|
       return load_path if File.directory? File.join(load_path, path_suffix)
     end
     nil
   end
-  
+
   def load_once_path?(path)
     load_once_paths.any? { |base| path.starts_with? base }
   end
-  
+
   # Attempt to autoload the provided module name by searching for a directory
   # matching the expect path suffix. If found, the module is created and assigned
   # to +into+'s constants with the name +const_name+. Provided that the directory
@@ -184,12 +196,12 @@ module Dependencies #:nodoc:
     autoloaded_constants << qualified_name unless load_once_paths.include?(base_path)
     return mod
   end
-  
+
   # Load the file at the provided path. +const_paths+ is a set of qualified
   # constant names. When loading the file, Dependencies will watch for the
   # addition of these constants. Each that is defined will be marked as
   # autoloaded, and will be removed when Dependencies.clear is next called.
-  # 
+  #
   # If the second parameter is left off, then Dependencies will construct a set
   # of names that the file at +path+ may define. See
   # +loadable_constants_for_path+ for more details.
@@ -197,24 +209,24 @@ module Dependencies #:nodoc:
     log_call path, const_paths
     const_paths = [const_paths].compact unless const_paths.is_a? Array
     parent_paths = const_paths.collect { |const_path| /(.*)::[^:]+\Z/ =~ const_path ? $1 : :Object }
-    
+
     result = nil
     newly_defined_paths = new_constants_in(*parent_paths) do
       result = load_without_new_constant_marking path
     end
-    
+
     autoloaded_constants.concat newly_defined_paths unless load_once_path?(path)
     autoloaded_constants.uniq!
     log "loading #{path} defined #{newly_defined_paths * ', '}" unless newly_defined_paths.empty?
     return result
   end
-  
+
   # Return the constant path for the provided parent and constant name.
   def qualified_name_for(mod, name)
     mod_name = to_constant_name mod
     (%w(Object Kernel).include? mod_name) ? name.to_s : "#{mod_name}::#{name}"
   end
-  
+
   # Load the constant named +const_name+ which is missing from +from_mod+. If
   # it is not possible to load the constant into from_mod, try its parent module
   # using const_missing.
@@ -237,21 +249,21 @@ module Dependencies #:nodoc:
       raise ArgumentError, "A copy of #{from_mod} has been removed from the module tree but is still active!"
     end
 
-    raise ArgumentError, "#{from_mod} is not missing constant #{const_name}!" if from_mod.const_defined?(const_name)
-    
+    raise ArgumentError, "#{from_mod} is not missing constant #{const_name}!" if uninherited_const_defined?(from_mod, const_name)
+
     qualified_name = qualified_name_for from_mod, const_name
     path_suffix = qualified_name.underscore
     name_error = NameError.new("uninitialized constant #{qualified_name}")
-    
+
     file_path = search_for_file(path_suffix)
     if file_path && ! loaded.include?(File.expand_path(file_path)) # We found a matching file to load
       require_or_load file_path
-      raise LoadError, "Expected #{file_path} to define #{qualified_name}" unless from_mod.const_defined?(const_name)
+      raise LoadError, "Expected #{file_path} to define #{qualified_name}" unless uninherited_const_defined?(from_mod, const_name)
       return from_mod.const_get(const_name)
     elsif mod = autoload_module!(from_mod, const_name, qualified_name, path_suffix)
       return mod
     elsif (parent = from_mod.parent) && parent != from_mod &&
-          ! from_mod.parents.any? { |p| p.const_defined?(const_name) }
+          ! from_mod.parents.any? { |p| uninherited_const_defined?(p, const_name) }
       # If our parents do not have a constant named +const_name+ then we are free
       # to attempt to load upwards. If they do have such a constant, then this
       # const_missing must be due to from_mod::const_name, which should not
@@ -266,7 +278,7 @@ module Dependencies #:nodoc:
       raise name_error
     end
   end
-  
+
   # Remove the constants that have been autoloaded, and those that have been
   # marked for unloading.
   def remove_unloadable_constants!
@@ -274,7 +286,7 @@ module Dependencies #:nodoc:
     autoloaded_constants.clear
     explicitly_unloadable_constants.each { |const| remove_constant const }
   end
-  
+
   # Determine if the given constant has been automatically loaded.
   def autoloaded?(desc)
     # No name => anonymous module.
@@ -283,13 +295,13 @@ module Dependencies #:nodoc:
     return false unless qualified_const_defined? name
     return autoloaded_constants.include?(name)
   end
-  
+
   # Will the provided constant descriptor be unloaded?
   def will_unload?(const_desc)
-    autoloaded?(const_desc) ||
+    autoloaded?(desc) ||
       explicitly_unloadable_constants.include?(to_constant_name(const_desc))
   end
-  
+
   # Mark the provided constant name for unloading. This constant will be
   # unloaded on each request, not just the next one.
   def mark_for_unload(const_desc)
@@ -301,18 +313,18 @@ module Dependencies #:nodoc:
       return true
     end
   end
-  
+
   # Run the provided block and detect the new constants that were loaded during
   # its execution. Constants may only be regarded as 'new' once -- so if the
   # block calls +new_constants_in+ again, then the constants defined within the
   # inner call will not be reported in this one.
-  # 
+  #
   # If the provided block does not run to completion, and instead raises an
   # exception, any new constants are regarded as being only partially defined
   # and will be removed immediately.
   def new_constants_in(*descs)
     log_call(*descs)
-    
+
     # Build the watch frames. Each frame is a tuple of
     #   [module_name_as_string, constants_defined_elsewhere]
     watch_frames = descs.collect do |desc|
@@ -321,7 +333,7 @@ module Dependencies #:nodoc:
         initial_constants = desc.local_constant_names
       elsif desc.is_a?(String) || desc.is_a?(Symbol)
         mod_name = desc.to_s
-        
+
         # Handle the case where the module has yet to be defined.
         initial_constants = if qualified_const_defined?(mod_name)
           mod_name.constantize.local_constant_names
@@ -331,12 +343,12 @@ module Dependencies #:nodoc:
       else
         raise Argument, "#{desc.inspect} does not describe a module!"
       end
-      
+
       [mod_name, initial_constants]
     end
-    
+
     constant_watch_stack.concat watch_frames
-    
+
     aborting = true
     begin
       yield # Now yield to the code that is to define new constants.
@@ -346,41 +358,41 @@ module Dependencies #:nodoc:
       new_constants = watch_frames.collect do |mod_name, prior_constants|
         # Module still doesn't exist? Treat it as if it has no constants.
         next [] unless qualified_const_defined?(mod_name)
-        
+
         mod = mod_name.constantize
         next [] unless mod.is_a? Module
         new_constants = mod.local_constant_names - prior_constants
-        
+
         # Make sure no other frames takes credit for these constants.
         constant_watch_stack.each do |frame_name, constants|
           constants.concat new_constants if frame_name == mod_name
         end
-        
+
         new_constants.collect do |suffix|
           mod_name == "Object" ? suffix : "#{mod_name}::#{suffix}"
         end
       end.flatten
-      
+
       log "New constants: #{new_constants * ', '}"
-      
+
       if aborting
         log "Error during loading, removing partially loaded constants "
         new_constants.each { |name| remove_constant name }
         new_constants.clear
       end
     end
-    
+
     return new_constants
   ensure
     # Remove the stack frames that we added.
-    if defined?(watch_frames) && ! watch_frames.empty?
+    if defined?(watch_frames) && ! watch_frames.blank?
       frame_ids = watch_frames.collect(&:object_id)
       constant_watch_stack.delete_if do |watch_frame|
         frame_ids.include? watch_frame.object_id
       end
     end
   end
-  
+
   class LoadingModule #:nodoc:
     # Old style environment.rb referenced this method directly.  Please note, it doesn't
     # actually *do* anything any more.
@@ -423,18 +435,20 @@ module Dependencies #:nodoc:
 
 protected
   def log_call(*args)
-    arg_str = args.collect(&:inspect) * ', '
-    /in `([a-z_\?\!]+)'/ =~ caller(1).first
-    selector = $1 || '<unknown>' 
-    log "called #{selector}(#{arg_str})"
+    if defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER && log_activity
+      arg_str = args.collect(&:inspect) * ', '
+      /in `([a-z_\?\!]+)'/ =~ caller(1).first
+      selector = $1 || '<unknown>'
+      log "called #{selector}(#{arg_str})"
+    end
   end
-  
+
   def log(msg)
     if defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER && log_activity
       RAILS_DEFAULT_LOGGER.debug "Dependencies: #{msg}"
     end
   end
-  
+
 end
 
 Object.instance_eval do
@@ -446,17 +460,17 @@ end
 class Module #:nodoc:
   # Rename the original handler so we can chain it to the new one
   alias :rails_original_const_missing :const_missing
-  
+
   # Use const_missing to autoload associations so we don't have to
   # require_association when using single-table inheritance.
   def const_missing(class_id)
     Dependencies.load_missing_constant self, class_id
   end
-  
+
   def unloadable(const_desc = self)
     super(const_desc)
   end
-  
+
 end
 
 class Class
@@ -482,18 +496,17 @@ class Class
 end
 
 class Object
-  
   alias_method :load_without_new_constant_marking, :load
-  
+
   def load(file, *extras) #:nodoc:
-    Dependencies.new_constants_in(Object) { super(file, *extras) }
+    Dependencies.new_constants_in(Object) { super }
   rescue Exception => exception  # errors from loading file
     exception.blame_file! file
     raise
   end
 
   def require(file, *extras) #:nodoc:
-    Dependencies.new_constants_in(Object) { super(file, *extras) }
+    Dependencies.new_constants_in(Object) { super }
   rescue Exception => exception  # errors from required file
     exception.blame_file! file
     raise
@@ -501,21 +514,20 @@ class Object
 
   # Mark the given constant as unloadable. Unloadable constants are removed each
   # time dependencies are cleared.
-  # 
+  #
   # Note that marking a constant for unloading need only be done once. Setup
   # or init scripts may list each unloadable constant that may need unloading;
   # each constant will be removed for every subsequent clear, as opposed to for
   # the first clear.
-  # 
+  #
   # The provided constant descriptor may be a (non-anonymous) module or class,
   # or a qualified constant name as a string or symbol.
-  # 
+  #
   # Returns true if the constant was not previously marked for unloading, false
   # otherwise.
   def unloadable(const_desc)
     Dependencies.mark_for_unload const_desc
   end
-
 end
 
 # Add file-blaming to exceptions