activesupport 3.0.pre → 3.0.0.rc

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

@@ -1,3 +1,14 @@
+class Hash
+  # By default, only instances of Hash itself are extractable.
+  # Subclasses of Hash may implement this method and return
+  # true to declare themselves as extractable. If a Hash
+  # is extractable, Array#extract_options! pops it from
+  # the Array when it is the last element of the Array.
+  def extractable_options?
+    instance_of?(Hash)
+  end
+end
+
 class Array
   # Extracts options from a set of arguments. Removes and returns the last
   # element in the array if it's a hash, otherwise returns a blank hash.
@@ -9,6 +20,10 @@ class Array
   #   options(1, 2)           # => {}
   #   options(1, 2, :a => :b) # => {:a=>:b}
   def extract_options!
-    last.is_a?(::Hash) ? pop : {}
+    if last.is_a?(Hash) && last.extractable_options?
+      pop
+    else
+      {}
+    end
   end
 end

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

@@ -55,7 +55,7 @@ class Array
   #   ["6", "7"]
   def in_groups(number, fill_with = nil)
     # size / number gives minor group size;
-    # size % number gives how many objects need extra accomodation;
+    # size % number gives how many objects need extra accommodation;
     # each group hold either division or division + 1 items.
     division = size / number
     modulo = size % number

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

@@ -1,6 +1,27 @@
 class Array
-  # Returns a random element from the array.
-  def rand
-    self[Kernel.rand(length)]
-  end
-end
+  # Backport of Array#sample based on Marc-Andre Lafortune's http://github.com/marcandre/backports/
+  # Returns a random element or +n+ random elements from the array. 
+  # If the array is empty and +n+ is nil, returns <tt>nil</tt>. if +n+ is passed, returns <tt>[]</tt>.
+  # 
+  #   [1,2,3,4,5,6].sample    # => 4 
+  #   [1,2,3,4,5,6].sample(3) # => [2, 4, 5] 
+  #              [].sample    # => nil
+  #              [].sample(3) # => []
+  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: obj.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

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

@@ -0,0 +1,17 @@
+class Array
+  # Return an unique array based on the criteria given as a proc.
+  #
+  #   [1, 2, 3, 4].uniq_by { |i| i.odd? }
+  #   #=> [1, 2]
+  #
+  def uniq_by
+    hash, array = {}, []
+    each { |i| hash[yield(i)] ||= (array << i) }
+    array
+  end
+
+  # Same as uniq_by, but modifies self.
+  def uniq_by!
+    replace(uniq_by{ |i| yield(i) })
+  end
+end

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

@@ -1,18 +1,22 @@
 class Array
   # Wraps the object in an Array unless it's an Array.  Converts the
   # object to an Array using #to_ary if it implements that.
+  #
+  # It differs with Array() in that it does not call +to_a+ on
+  # the argument:
+  #
+  #   Array(:foo => :bar)      # => [[:foo, :bar]]
+  #   Array.wrap(:foo => :bar) # => [{:foo => :bar}]
+  #
+  #   Array("foo\nbar")        # => ["foo\n", "bar"], in Ruby 1.8
+  #   Array.wrap("foo\nbar")   # => ["foo\nbar"]
   def self.wrap(object)
-    case object
-    when nil
+    if object.nil?
       []
-    when self
-      object
+    elsif object.respond_to?(:to_ary)
+      object.to_ary
     else
-      if object.respond_to?(:to_ary)
-        object.to_ary
-      else
-        [object]
-      end
+      [object]
     end
   end
 end

data/lib/active_support/core_ext/benchmark.rb

@@ -1,18 +1,6 @@
 require 'benchmark'
 
 class << Benchmark
-  # Earlier Ruby had a slower implementation.
-  if RUBY_VERSION < '1.8.7'
-    remove_method :realtime
-
-    def realtime
-      r0 = Time.now
-      yield
-      r1 = Time.now
-      r1.to_f - r0.to_f
-    end
-  end
-
   def ms
     1000 * realtime { yield }
   end

data/lib/active_support/core_ext/cgi/escape_skipping_slashes.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 class CGI #:nodoc:
   if RUBY_VERSION >= '1.9'
     def self.escape_skipping_slashes(str)

data/lib/active_support/core_ext/class.rb

@@ -1,4 +1,5 @@
+require 'active_support/core_ext/class/attribute'
 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/subclasses'

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/class/attribute_accessors.rb

@@ -10,42 +10,48 @@ require 'active_support/core_ext/array/extract_options'
 #  Person.hair_colors = [:brown, :black, :blonde, :red]
 class Class
   def cattr_reader(*syms)
-    syms.flatten.each do |sym|
-      next if sym.is_a?(Hash)
+    options = syms.extract_options!
+    syms.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-        unless defined? @@#{sym}  # unless defined? @@hair_colors
-          @@#{sym} = nil          #   @@hair_colors = nil
-        end                       # end
-                                  #
-        def self.#{sym}           # def self.hair_colors
-          @@#{sym}                #   @@hair_colors
-        end                       # end
-                                  #
-        def #{sym}                # def hair_colors
-          @@#{sym}                #   @@hair_colors
-        end                       # end
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}
+          @@#{sym}
+        end
       EOS
+
+      unless options[:instance_reader] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}
+            @@#{sym}
+          end
+        EOS
+      end
     end
   end
 
   def cattr_writer(*syms)
     options = syms.extract_options!
-    syms.flatten.each do |sym|
+    syms.each do |sym|
       class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-        unless defined? @@#{sym}                       # unless defined? @@hair_colors
-          @@#{sym} = nil                               #   @@hair_colors = nil
-        end                                            # end
-                                                       #
-        def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
-          @@#{sym} = obj                               #   @@hair_colors = obj
-        end                                            # end
-                                                       #
-        #{"                                            #
-        def #{sym}=(obj)                               # def hair_colors=(obj)
-          @@#{sym} = obj                               #   @@hair_colors = obj
-        end                                            # end
-        " unless options[:instance_writer] == false }  # # instance writer above is generated unless options[:instance_writer] == false
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
       EOS
+
+      unless options[:instance_writer] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}=(obj)
+            @@#{sym} = obj
+          end
+        EOS
+      end
       self.send("#{sym}=", yield) if block_given?
     end
   end

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

@@ -1,50 +1,44 @@
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/kernel/singleton_class'
+require 'active_support/core_ext/module/remove_method'
 
 class Class
-  def superclass_delegating_reader(*names)
-    class_name_to_stop_searching_on = superclass.name.blank? ? "Object" : superclass.name
-    names.each do |name|
-      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-        def self.#{name}                                            # def self.only_reader
-          if defined?(@#{name})                                     #   if defined?(@only_reader)
-            @#{name}                                                #     @only_reader
-          elsif superclass < #{class_name_to_stop_searching_on} &&  #   elsif superclass < Object &&
-                superclass.respond_to?(:#{name})                    #         superclass.respond_to?(:only_reader)
-            superclass.#{name}                                      #     superclass.only_reader
-          end                                                       #   end
-        end                                                         # end
-        def #{name}                                                 # def only_reader
-          self.class.#{name}                                        #   self.class.only_reader
-        end                                                         # end
-        def self.#{name}?                                           # def self.only_reader?
-          !!#{name}                                                 #   !!only_reader
-        end                                                         # end
-        def #{name}?                                                # def only_reader?
-          !!#{name}                                                 #   !!only_reader
-        end                                                         # end
-      EOS
-    end
+  def superclass_delegating_accessor(name, options = {})
+    # Create private _name and _name= methods that can still be used if the public
+    # methods are overridden. This allows
+    _superclass_delegating_accessor("_#{name}")
+
+    # Generate the public methods name, name=, and name?
+    # These methods dispatch to the private _name, and _name= methods, making them
+    # overridable
+    singleton_class.send(:define_method, name) { send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}?") { !!send("_#{name}") }
+    singleton_class.send(:define_method, "#{name}=") { |value| send("_#{name}=", value) }
+
+    # If an instance_reader is needed, generate methods for name and name= on the
+    # class itself, so instances will be able to see them
+    define_method(name) { send("_#{name}") } if options[:instance_reader] != false
+    define_method("#{name}?") { !!send("#{name}") } if options[:instance_reader] != false
   end
 
-  def superclass_delegating_writer(*names, &block)
-    names.each do |name|
-      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-        def self.#{name}=(value)     # def self.property=(value)
-          @#{name} = value           #   @property = value
-        end                          # end
-      EOS
-      self.send("#{name}=", yield) if block_given?
-    end
+private
+
+  # Take the object being set and store it in a method. This gives us automatic
+  # inheritance behavior, without having to store the object in an instance
+  # variable and look up the superclass chain manually.
+  def _stash_object_in_method(object, method, instance_reader = true)
+    singleton_class.remove_possible_method(method)
+    singleton_class.send(:define_method, method) { object }
+    remove_possible_method(method)
+    define_method(method) { object } if instance_reader
   end
 
-  # These class attributes behave something like the class
-  # inheritable accessors.  But instead of copying the hash over at
-  # the time the subclass is first defined, the accessors simply
-  # delegate to their superclass unless they have been given a 
-  # specific value.  This stops the strange situation where values 
-  # set after class definition don't get applied to subclasses.
-  def superclass_delegating_accessor(*names, &block)
-    superclass_delegating_reader(*names)
-    superclass_delegating_writer(*names, &block)
+  def _superclass_delegating_accessor(name, options = {})
+    singleton_class.send(:define_method, "#{name}=") do |value|
+      _stash_object_in_method(value, name, options[:instance_reader] != false)
+    end
+    send("#{name}=", nil)
   end
+
 end

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

@@ -1,4 +1,5 @@
 require 'active_support/core_ext/object/duplicable'
+require 'active_support/core_ext/array/extract_options'
 
 # Retain for backward compatibility.  Methods are now included in Class.
 module ClassInheritableAttributes # :nodoc:
@@ -8,18 +9,24 @@ end
 # their parents' attributes, instead of just a pointer to the same. This means that the child can add elements
 # to, for example, an array without those additions being shared with either their parent, siblings, or
 # children, which is unlike the regular class-level attributes that are shared across the entire hierarchy.
+#
+# The copies of inheritable parent attributes are added to subclasses when they are created, via the
+# +inherited+ hook.
 class Class # :nodoc:
   def class_inheritable_reader(*syms)
+    options = syms.extract_options!
     syms.each do |sym|
       next if sym.is_a?(Hash)
       class_eval(<<-EOS, __FILE__, __LINE__ + 1)
-        def self.#{sym}                         # def self.after_add
-          read_inheritable_attribute(:#{sym})   #   read_inheritable_attribute(:after_add)
-        end                                     # end
-
-        def #{sym}                              # def after_add
-          self.class.#{sym}                     #   self.class.after_add
-        end                                     # end
+        def self.#{sym}                                # def self.after_add
+          read_inheritable_attribute(:#{sym})          #   read_inheritable_attribute(:after_add)
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}                                     # def after_add
+          self.class.#{sym}                            #   self.class.after_add
+        end                                            # end
+        " unless options[:instance_reader] == false }  # # the reader above is generated unless options[:instance_reader] == false
       EOS
     end
   end
@@ -121,7 +128,7 @@ class Class # :nodoc:
 
   private
     # Prevent this constant from being created multiple times
-    EMPTY_INHERITABLE_ATTRIBUTES = {}.freeze unless const_defined?(:EMPTY_INHERITABLE_ATTRIBUTES)
+    EMPTY_INHERITABLE_ATTRIBUTES = {}.freeze
 
     def inherited_with_inheritable_attributes(child)
       inherited_without_inheritable_attributes(child) if respond_to?(:inherited_without_inheritable_attributes)
@@ -155,8 +162,8 @@ class Class
   #   (error out or do the same as other methods above) instead of silently
   #   moving on). In particular, this makes the return value of this function
   #   less useful.
-  def extlib_inheritable_reader(*ivars)
-    instance_reader = ivars.pop[:reader] if ivars.last.is_a?(Hash)
+  def extlib_inheritable_reader(*ivars, &block)
+    options = ivars.extract_options!
 
     ivars.each do |ivar|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -164,16 +171,17 @@ class Class
           return @#{ivar} if self.object_id == #{self.object_id} || defined?(@#{ivar})
           ivar = superclass.#{ivar}
           return nil if ivar.nil? && !#{self}.instance_variable_defined?("@#{ivar}")
-          @#{ivar} = ivar && !ivar.is_a?(Module) && !ivar.is_a?(Numeric) && !ivar.is_a?(TrueClass) && !ivar.is_a?(FalseClass) ? ivar.dup : ivar
+          @#{ivar} = ivar.duplicable? ? ivar.dup : ivar
         end
       RUBY
-      unless instance_reader == false
+      unless options[:instance_reader] == false
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{ivar}
             self.class.#{ivar}
           end
         RUBY
       end
+      instance_variable_set(:"@#{ivar}", yield) if block_given?
     end
   end
 
@@ -190,14 +198,15 @@ class Class
   # @todo We need a style for class_eval <<-HEREDOC. I'd like to make it
   #   class_eval(<<-RUBY, __FILE__, __LINE__), but we should codify it somewhere.
   def extlib_inheritable_writer(*ivars)
-    instance_writer = ivars.pop[:writer] if ivars.last.is_a?(Hash)
+    options = ivars.extract_options!
+
     ivars.each do |ivar|
       self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def self.#{ivar}=(obj)
           @#{ivar} = obj
         end
       RUBY
-      unless instance_writer == false
+      unless options[:instance_writer] == false
         self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{ivar}=(obj) self.class.#{ivar} = obj end
         RUBY