activesupport 2.3.8 → 2.3.9.pre

data/CHANGELOG

@@ -1,3 +1,14 @@
+*2.3.9 (August 29, 2010)*
+
+* i18n: bundle i18n 0.4.1 for forward compatibility with Rails 3. Deprecates {{foo}} interpolation syntax in favor of 1.9-native %{foo}.
+
+* Deprecate Kernel#returning in favor of Object#tap since it's included in Ruby 1.8.7 and later. [Santiago Pastorino]
+
+* Deprecates ActiveSupport::Dependencies.load_(once_)paths, renamed to autoload_(once_)paths. [fxn]
+
+* Deprecates Array#random_element, renamed to sample to match Ruby 1.9, thanks to Marc-Andre Lafortune. [fxn]
+
+
 *2.3.8 (May 24, 2010)*
 
 * Version bump.

data/lib/active_support/core_ext/array/grouping.rb

@@ -33,7 +33,7 @@ module ActiveSupport #:nodoc:
           if block_given?
             collection.each_slice(number) { |slice| yield(slice) }
           else
-            returning [] do |groups|
+            [].tap do |groups|
               collection.each_slice(number) { |group| groups << group }
             end
           end

data/lib/active_support/core_ext/array/random_access.rb

@@ -8,14 +8,34 @@ module ActiveSupport #:nodoc:
         #   https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/4555
         #
         def rand # :nodoc:
-          ActiveSupport::Deprecation.warn 'Array#rand is deprecated and will be removed in Rails 3. Use "random_element" instead', caller
-          random_element
+          ActiveSupport::Deprecation.warn 'Array#rand is deprecated and will be removed in Rails 3. Use Array#sample instead', caller
+          sample
         end
 
         # Returns a random element from the array.
-        def random_element
-          self[Kernel.rand(length)]
+        def random_element # :nodoc:
+          ActiveSupport::Deprecation.warn 'Array#random_element is deprecated and will be removed in Rails 3. Use Array#sample instead', caller
+          sample
         end
+
+        # Backport of Array#sample based on Marc-Andre Lafortune's http://github.com/marcandre/backports/
+        def sample(n=nil)
+          return self[Kernel.rand(size)] if n.nil?
+          n = n.to_int
+        rescue Exception => e
+          raise TypeError, "Coercion error: #{n.inspect}.to_int => Integer failed:\n(#{e.message})"
+        else
+          raise TypeError, "Coercion error: #{n}.to_int did NOT return an Integer (was #{n.class})" unless n.kind_of? ::Integer
+          raise ArgumentError, "negative array size" if n < 0
+          n = size if n > size
+          result = ::Array.new(self)
+          n.times do |i|
+            r = i + Kernel.rand(size - i)
+            result[i], result[r] = result[r], result[i]
+          end
+          result[n..size] = []
+          result
+        end unless method_defined? :sample
       end
     end
   end

data/lib/active_support/core_ext/class.rb

@@ -2,3 +2,4 @@ require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/class/inheritable_attributes'
 require 'active_support/core_ext/class/removal'
 require 'active_support/core_ext/class/delegating_attributes'
+require 'active_support/core_ext/class/attribute'

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

@@ -0,0 +1,67 @@
+require 'active_support/core_ext/kernel/singleton_class'
+require 'active_support/core_ext/module/remove_method'
+
+class Class
+  # Declare a class-level attribute whose value is inheritable and
+  # overwritable by subclasses:
+  #
+  #   class Base
+  #     class_attribute :setting
+  #   end
+  #
+  #   class Subclass < Base
+  #   end
+  #
+  #   Base.setting = true
+  #   Subclass.setting            # => true
+  #   Subclass.setting = false
+  #   Subclass.setting            # => false
+  #   Base.setting                # => true
+  #
+  # This matches normal Ruby method inheritance: think of writing an attribute
+  # on a subclass as overriding the reader method.
+  #
+  # For convenience, a query method is defined as well:
+  #
+  #   Subclass.setting?           # => false
+  #
+  # Instances may overwrite the class value in the same way:
+  #
+  #   Base.setting = true
+  #   object = Base.new
+  #   object.setting          # => true
+  #   object.setting = false
+  #   object.setting          # => false
+  #   Base.setting            # => true
+  #
+  # To opt out of the instance writer method, pass :instance_writer => false.
+  #
+  #   object.setting = false  # => NoMethodError
+  def class_attribute(*attrs)
+    instance_writer = !attrs.last.is_a?(Hash) || attrs.pop[:instance_writer]
+
+    attrs.each do |name|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def self.#{name}() nil end
+        def self.#{name}?() !!#{name} end
+
+        def self.#{name}=(val)
+          singleton_class.class_eval do
+            remove_possible_method(:#{name})
+            define_method(:#{name}) { val }
+          end
+        end
+
+        def #{name}
+          defined?(@#{name}) ? @#{name} : singleton_class.#{name}
+        end
+
+        def #{name}?
+          !!#{name}
+        end
+      RUBY
+
+      attr_writer name if instance_writer
+    end
+  end
+end

data/lib/active_support/core_ext/enumerable.rb

@@ -75,7 +75,7 @@ module Enumerable
   #   (1..5).each_with_object(1) { |value, memo| memo *= value } # => 1
   #
   def each_with_object(memo, &block)
-    returning memo do |m|
+    memo.tap do |m|
       each do |element|
         block.call(element, m)
       end

data/lib/active_support/core_ext/kernel/singleton_class.rb

@@ -0,0 +1,13 @@
+module Kernel
+  # Returns the object's singleton class.
+  def singleton_class
+    class << self
+      self
+    end
+  end unless respond_to?(:singleton_class) # exists in 1.9.2
+
+  # class_eval on an object acts like singleton_class.class_eval.
+  def class_eval(*args, &block)
+    singleton_class.class_eval(*args, &block)
+  end
+end

data/lib/active_support/core_ext/module/remove_method.rb

@@ -0,0 +1,6 @@
+class Module
+  def remove_possible_method(method)
+    remove_method(method)
+  rescue NameError
+  end
+end

data/lib/active_support/core_ext/object/misc.rb

@@ -1,3 +1,5 @@
+require 'active_support/deprecation'
+
 class Object
   # Returns +value+ after yielding +value+ to the block. This simplifies the
   # process of constructing an object, performing work on the object, and then
@@ -36,6 +38,7 @@ class Object
   #  
   #  foo # => ['bar', 'baz']
   def returning(value)
+    ActiveSupport::Deprecation.warn('Object#returning has been deprecated in favor of Object#tap.', caller)
     yield(value)
     value
   end

data/lib/active_support/core_ext/range/blockless_step.rb

@@ -12,7 +12,7 @@ module ActiveSupport #:nodoc:
             if block_given?
               step_without_blockless(value, &block)
             else
-              returning [] do |array|
+              [].tap do |array|
                 step_without_blockless(value) { |step| array << step }
               end
             end

data/lib/active_support/core_ext/string/output_safety.rb

@@ -62,17 +62,6 @@ end
 
 module ActiveSupport #:nodoc:
   class SafeBuffer < String
-    alias safe_concat concat
-
-    def concat(value)
-      if value.html_safe?
-        super(value)
-      else
-        super(ERB::Util.h(value))
-      end
-    end
-    alias << concat
-
     def +(other)
       dup.concat(other)
     end

data/lib/active_support/dependencies.rb

@@ -20,14 +20,38 @@ module ActiveSupport #:nodoc:
 
     # 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 = []
+    # unless the directory also appears in autoload_once_paths.
+    mattr_accessor :autoload_paths
+    self.autoload_paths = []
+    
+    # Deprecated, use autoload_paths.
+    def self.load_paths
+      ActiveSupport::Deprecation.warn("ActiveSupport::Dependencies.load_paths is deprecated, please use autoload_paths instead", caller)
+      autoload_paths
+    end
+
+    # Deprecated, use autoload_paths=.
+    def self.load_paths=(paths)
+      ActiveSupport::Deprecation.warn("ActiveSupport::Dependencies.load_paths= is deprecated, please use autoload_paths= instead", caller)
+      self.autoload_paths = paths
+    end
 
     # 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 = []
+    # only once. All directories in this set must also be present in +autoload_paths+.
+    mattr_accessor :autoload_once_paths
+    self.autoload_once_paths = []
+
+    # Deprecated, use autoload_once_paths.
+    def self.load_once_paths
+      ActiveSupport::Deprecation.warn("ActiveSupport::Dependencies.load_once_paths is deprecated and removed in Rails 3, please use autoload_once_paths instead", caller)
+      autoload_once_paths
+    end
+
+    # Deprecated, use autoload_once_paths=.
+    def self.load_once_paths=(paths)
+      ActiveSupport::Deprecation.warn("ActiveSupport::Dependencies.load_once_paths= is deprecated and removed in Rails 3, please use autoload_once_paths= instead", caller)
+      self.autoload_once_paths = paths
+    end
 
     # 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.
@@ -305,7 +329,7 @@ module ActiveSupport #:nodoc:
 
     # 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)
+    def loadable_constants_for_path(path, bases = autoload_paths)
       path = $1 if path =~ /\A(.*)\.rb\Z/
       expanded_path = File.expand_path(path)
 
@@ -326,10 +350,10 @@ module ActiveSupport #:nodoc:
       end.flatten.compact.uniq
     end
 
-    # Search for a file in load_paths matching the provided suffix.
+    # Search for a file in autoload_paths matching the provided suffix.
     def search_for_file(path_suffix)
       path_suffix = path_suffix + '.rb' unless path_suffix.ends_with? '.rb'
-      load_paths.each do |root|
+      autoload_paths.each do |root|
         path = File.join(root, path_suffix)
         return path if File.file? path
       end
@@ -339,14 +363,14 @@ module ActiveSupport #:nodoc:
     # Does the provided path_suffix correspond to an autoloadable module?
     # Instead of returning a boolean, the autoload base for this module is returned.
     def autoloadable_module?(path_suffix)
-      load_paths.each do |load_path|
+      autoload_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 }
+      autoload_once_paths.any? { |base| path.starts_with? base }
     end
 
     # Attempt to autoload the provided module name by searching for a directory
@@ -358,7 +382,7 @@ module ActiveSupport #:nodoc:
       return nil unless base_path = autoloadable_module?(path_suffix)
       mod = Module.new
       into.const_set const_name, mod
-      autoloaded_constants << qualified_name unless load_once_paths.include?(base_path)
+      autoloaded_constants << qualified_name unless autoload_once_paths.include?(base_path)
       return mod
     end
 

data/lib/active_support/deprecation.rb

@@ -120,6 +120,13 @@ module ActiveSupport
     end
 
     class DeprecationProxy #:nodoc:
+      def self.new(*args, &block)
+        object = args.first
+        
+        return object unless object
+        super
+      end
+      
       silence_warnings do
         instance_methods.each { |m| undef_method m unless m =~ /^__/ }
       end

data/lib/active_support/json/backends/yajl.rb

@@ -1,4 +1,4 @@
-require 'yajl-ruby' unless defined?(Yajl)
+require 'yajl' unless defined?(Yajl)
 
 module ActiveSupport
   module JSON

data/lib/active_support/ordered_hash.rb

@@ -134,6 +134,8 @@ module ActiveSupport
         self
       end
 
+      alias_method :update, :merge!
+
       def merge(other_hash)
         dup.merge!(other_hash)
       end
@@ -145,6 +147,10 @@ module ActiveSupport
         self
       end
 
+      def invert
+        OrderedHash[self.to_a.map!{|key_value_pair| key_value_pair.reverse}]
+      end
+
       def inspect
         "#<OrderedHash #{super}>"
       end

data/lib/active_support/testing/performance.rb

@@ -24,7 +24,7 @@ module ActiveSupport
         end.freeze
 
       def self.included(base)
-        base.superclass_delegating_accessor :profile_options
+        base.class_attribute :profile_options
         base.profile_options = DEFAULTS
       end
 

data/lib/active_support/values/time_zone.rb

@@ -387,7 +387,11 @@ module ActiveSupport
       def [](arg)
         case arg
           when String
-            zones_map[arg] ||= lookup(arg)
+            if tz = zones_map[arg]
+              tz
+            elsif tz = lookup(arg)
+              zones_map[arg] = tz
+            end
           when Numeric, ActiveSupport::Duration
             arg *= 3600 if arg.abs <= 13
             all.find { |z| z.utc_offset == arg.to_i }

data/lib/active_support/vendor.rb

@@ -21,9 +21,9 @@ rescue Gem::LoadError
 end
 
 begin
-  gem 'i18n', '>= 0.3.3'
+  gem 'i18n', '>= 0.4.1'
 rescue Gem::LoadError
-  $:.unshift "#{File.dirname(__FILE__)}/vendor/i18n-0.3.7"
+  $:.unshift "#{File.dirname(__FILE__)}/vendor/i18n-0.4.1"
 end
 require 'i18n'
 

data/lib/active_support/vendor/{i18n-0.3.7 → i18n-0.4.1}/i18n.rb

@@ -12,94 +12,11 @@ require 'i18n/core_ext/string/interpolate'
 
 module I18n
   autoload :Backend, 'i18n/backend'
-  autoload :Helpers, 'i18n/helpers'
+  autoload :Config,  'i18n/config'
+  autoload :Gettext, 'i18n/gettext'
   autoload :Locale,  'i18n/locale'
 
-  class Config
-    # The only configuration value that is not global and scoped to thread is :locale.
-    # It defaults to the default_locale.
-    def locale
-      @locale ||= default_locale
-    end
-
-    # Sets the current locale pseudo-globally, i.e. in the Thread.current hash.
-    def locale=(locale)
-      @locale = locale.to_sym rescue nil
-    end
-
-    # Returns the current backend. Defaults to +Backend::Simple+.
-    def backend
-      @@backend ||= Backend::Simple.new
-    end
-
-    # Sets the current backend. Used to set a custom backend.
-    def backend=(backend)
-      @@backend = backend
-    end
-
-    # Returns the current default locale. Defaults to :'en'
-    def default_locale
-      @@default_locale ||= :en
-    end
-
-    # Sets the current default locale. Used to set a custom default locale.
-    def default_locale=(locale)
-      @@default_locale = locale.to_sym rescue nil
-    end
-
-    # Returns an array of locales for which translations are available.
-    # Unless you explicitely set the these through I18n.available_locales=
-    # the call will be delegated to the backend and memoized on the I18n module.
-    def available_locales
-      @@available_locales ||= backend.available_locales
-    end
-
-    # Sets the available locales.
-    def available_locales=(locales)
-      @@available_locales = locales
-    end
-
-    # Returns the current default scope separator. Defaults to '.'
-    def default_separator
-      @@default_separator ||= '.'
-    end
-
-    # Sets the current default scope separator.
-    def default_separator=(separator)
-      @@default_separator = separator
-    end
-
-    # Return the current exception handler. Defaults to :default_exception_handler.
-    def exception_handler
-      @@exception_handler ||= :default_exception_handler
-    end
-
-    # Sets the exception handler.
-    def exception_handler=(exception_handler)
-      @@exception_handler = exception_handler
-    end
-
-    # Allow clients to register paths providing translation data sources. The
-    # backend defines acceptable sources.
-    #
-    # E.g. the provided SimpleBackend accepts a list of paths to translation
-    # files which are either named *.rb and contain plain Ruby Hashes or are
-    # named *.yml and contain YAML data. So for the SimpleBackend clients may
-    # register translation files like this:
-    #   I18n.load_path << 'path/to/locale/en.yml'
-    def load_path
-      @@load_path ||= []
-    end
-
-    # Sets the load path instance. Custom implementations are expected to
-    # behave like a Ruby Array.
-    def load_path=(load_path)
-      @@load_path = load_path
-    end
-  end
-
   class << self
-
     # Gets I18n configuration object.
     def config
       Thread.current[:i18n_config] ||= I18n::Config.new
@@ -163,7 +80,7 @@ module I18n
     # values passed to #translate as part of the options hash, with the keys matching
     # the interpolation variable names.
     #
-    # <em>E.g.</em>, with a translation <tt>:foo => "foo {{bar}}"</tt> the option
+    # <em>E.g.</em>, with a translation <tt>:foo => "foo %{bar}"</tt> the option
     # value for the key +bar+ will be interpolated into the translation:
     #   I18n.t :foo, :bar => 'baz' # => 'foo baz'
     #
@@ -184,7 +101,7 @@ module I18n
     #
     # The <tt>:count</tt> option can be used both for pluralization and interpolation.
     # <em>E.g.</em>, with the translation
-    # <tt>:foo => ['{{count}} foo', '{{count}} foos']</tt>, count will
+    # <tt>:foo => ['%{count} foo', '%{count} foos']</tt>, count will
     # be interpolated to the pluralized translation:
     #   I18n.t :foo, :count => 1 # => '1 foo'
     #
@@ -218,7 +135,7 @@ module I18n
     # called and passed the key and options.
     #
     # E.g. assuming the key <tt>:salutation</tt> resolves to:
-    #   lambda { |key, options| options[:gender] == 'm' ? "Mr. {{options[:name]}}" : "Mrs. {{options[:name]}}" }
+    #   lambda { |key, options| options[:gender] == 'm' ? "Mr. %{options[:name]}" : "Mrs. %{options[:name]}" }
     #
     # Then <tt>I18n.t(:salutation, :gender => 'w', :name => 'Smith') will result in "Mrs. Smith".
     #
@@ -244,6 +161,69 @@ module I18n
     end
     alias :t! :translate!
 
+    # Transliterates UTF-8 characters to ASCII. By default this method will
+    # transliterate only Latin strings to an ASCII approximation:
+    #
+    #    I18n.transliterate("Ærøskøbing")
+    #    # => "AEroskobing"
+    #
+    #    I18n.transliterate("日本語")
+    #    # => "???"
+    #
+    # It's also possible to add support for per-locale transliterations. I18n
+    # expects transliteration rules to be stored at
+    # <tt>i18n.transliterate.rule</tt>.
+    #
+    # Transliteration rules can either be a Hash or a Proc. Procs must accept a
+    # single string argument. Hash rules inherit the default transliteration
+    # rules, while Procs do not.
+    #
+    # *Examples*
+    #
+    # Setting a Hash in <locale>.yml:
+    #
+    #    i18n:
+    #      transliterate:
+    #        rule:
+    #          ü: "ue"
+    #          ö: "oe"
+    #
+    # Setting a Hash using Ruby:
+    #
+    #     store_translations(:de, :i18n => {
+    #       :transliterate => {
+    #         :rule => {
+    #           "ü" => "ue",
+    #           "ö" => "oe"
+    #         }
+    #       }
+    #     )
+    #
+    # Setting a Proc:
+    #
+    #     translit = lambda {|string| MyTransliterator.transliterate(string) }
+    #     store_translations(:xx, :i18n => {:transliterate => {:rule => translit})
+    #
+    # Transliterating strings:
+    #
+    #     I18n.locale = :en
+    #     I18n.transliterate("Jürgen") # => "Jurgen"
+    #     I18n.locale = :de
+    #     I18n.transliterate("Jürgen") # => "Juergen"
+    #     I18n.transliterate("Jürgen", :locale => :en) # => "Jurgen"
+    #     I18n.transliterate("Jürgen", :locale => :de) # => "Juergen"
+    def transliterate(*args)
+      options      = args.pop if args.last.is_a?(Hash)
+      key          = args.shift
+      locale       = options && options.delete(:locale) || config.locale
+      raises       = options && options.delete(:raise)
+      replacement  = options && options.delete(:replacement)
+      config.backend.transliterate(locale, key, replacement)
+    rescue I18n::ArgumentError => exception
+      raise exception if raises
+      handle_exception(exception, locale, key, options)
+    end
+
     # Localizes certain objects, such as dates and numbers to local formatting.
     def localize(object, options = {})
       locale = options.delete(:locale) || config.locale
@@ -252,14 +232,29 @@ module I18n
     end
     alias :l :localize
 
+    # Executes block with given I18n.locale set.
+    def with_locale(tmp_locale = nil)
+      if tmp_locale
+        current_locale = self.locale
+        self.locale    = tmp_locale
+      end
+      yield
+    ensure
+      self.locale = current_locale if tmp_locale
+    end
+
+
     # Merges the given locale, key and scope into a single array of keys.
     # Splits keys that contain dots into multiple keys. Makes sure all
     # keys are Symbols.
     def normalize_keys(locale, key, scope, separator = nil)
       separator ||= I18n.default_separator
-      normalize_key(locale, separator) +
-        normalize_key(scope, separator) +
-        normalize_key(key, separator)
+
+      keys = []
+      keys.concat normalize_key(locale, separator)
+      keys.concat normalize_key(scope, separator)
+      keys.concat normalize_key(key, separator)
+      keys
     end
 
   # making these private until Ruby 1.9.2 can send to protected methods again
@@ -308,28 +303,20 @@ module I18n
     end
 
     def normalize_key(key, separator)
-      normalized_key_cache(separator)[key] ||=
+      normalized_key_cache[separator][key] ||=
         case key
         when Array
           key.map { |k| normalize_key(k, separator) }.flatten
-        when nil
-          []
         else
-          key = key.to_s
-          if key == ''
-            []
-          elsif key.include?(separator)
-            keys = key.split(separator) - ['']
-            keys.map { |k| k.to_sym }
-          else
-            [key.to_sym]
-          end
+          keys = key.to_s.split(separator)
+          keys.delete('')
+          keys.map!{ |k| k.to_sym }
+          keys
         end
     end
 
-    def normalized_key_cache(separator)
+    def normalized_key_cache
       @normalized_key_cache ||= Hash.new { |h,k| h[k] = {} }
-      @normalized_key_cache[separator]
     end
   end
 end