activesupport 4.1.0.beta2 → 4.1.0.rc1

data/lib/active_support/core_ext/enumerable.rb

@@ -35,7 +35,7 @@ module Enumerable
     if block_given?
       Hash[map { |elem| [yield(elem), elem] }]
     else
-      to_enum :index_by
+      to_enum(:index_by) { size if respond_to?(:size) }
     end
   end
 

data/lib/active_support/core_ext/hash.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/hash/compact'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/hash/deep_merge'
 require 'active_support/core_ext/hash/except'

data/lib/active_support/core_ext/hash/compact.rb

@@ -0,0 +1,20 @@
+class Hash
+  # Returns a hash with non +nil+ values.
+  # 
+  #   hash = { a: true, b: false, c: nil}
+  #   hash.compact # => { a: true, b: false}
+  #   hash # => { a: true, b: false, c: nil}
+  #   { c: nil }.compact # => {}
+  def compact
+    self.select { |_, value| !value.nil? }
+  end
+  
+  # Replaces current hash with non +nil+ values.
+  # 
+  #   hash = { a: true, b: false, c: nil}
+  #   hash.compact! # => { a: true, b: false}
+  #   hash # => { a: true, b: false}
+  def compact!
+    self.reject! { |_, value| value.nil? }
+  end
+end

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

@@ -105,7 +105,7 @@ class Hash
     #   hash = Hash.from_xml(xml)
     #   # => {"hash"=>{"foo"=>1, "bar"=>2}}
     #
-    # DisallowedType is raise if the XML contains attributes with <tt>type="yaml"</tt> or
+    # DisallowedType is raised if the XML contains attributes with <tt>type="yaml"</tt> or
     # <tt>type="symbol"</tt>. Use <tt>Hash.from_trusted_xml</tt> to parse this XML.
     def from_xml(xml, disallowed_types = nil)
       ActiveSupport::XMLConverter.new(xml, disallowed_types).to_h

data/lib/active_support/core_ext/hash/except.rb

@@ -1,5 +1,5 @@
 class Hash
-  # Return a hash that includes everything but the given keys. This is useful for
+  # Returns a hash that includes everything but the given keys. This is useful for
   # limiting a set of parameters to everything but a few known toggles:
   #
   #   @person.update(params[:person].except(:admin))

data/lib/active_support/core_ext/hash/keys.rb

@@ -1,5 +1,5 @@
 class Hash
-  # Return a new hash with all keys converted using the block operation.
+  # Returns a new hash with all keys converted using the block operation.
   #
   #  hash = { name: 'Rob', age: '28' }
   #
@@ -22,7 +22,7 @@ class Hash
     self
   end
 
-  # Return a new hash with all keys converted to strings.
+  # Returns a new hash with all keys converted to strings.
   #
   #   hash = { name: 'Rob', age: '28' }
   #
@@ -38,7 +38,7 @@ class Hash
     transform_keys!{ |key| key.to_s }
   end
 
-  # Return a new hash with all keys converted to symbols, as long as
+  # Returns a new hash with all keys converted to symbols, as long as
   # they respond to +to_sym+.
   #
   #   hash = { 'name' => 'Rob', 'age' => '28' }
@@ -73,7 +73,7 @@ class Hash
     end
   end
 
-  # Return a new hash with all keys converted by the block operation.
+  # Returns a new hash with all keys converted by the block operation.
   # This includes the keys from the root hash and from all
   # nested hashes.
   #
@@ -100,7 +100,7 @@ class Hash
     self
   end
 
-  # Return a new hash with all keys converted to strings.
+  # Returns a new hash with all keys converted to strings.
   # This includes the keys from the root hash and from all
   # nested hashes.
   #
@@ -119,7 +119,7 @@ class Hash
     deep_transform_keys!{ |key| key.to_s }
   end
 
-  # Return a new hash with all keys converted to symbols, as long as
+  # Returns a new hash with all keys converted to symbols, as long as
   # they respond to +to_sym+. This includes the keys from the root hash
   # and from all nested hashes.
   #

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

@@ -27,7 +27,8 @@ class Module
 
     def attr_internal_define(attr_name, type)
       internal_name = attr_internal_ivar_name(attr_name).sub(/\A@/, '')
-      class_eval do # class_eval is necessary on 1.9 or else the methods a made private
+      # class_eval is necessary on 1.9 or else the methods are made private
+      class_eval do
         # use native attr_* methods as they are faster on some Ruby implementations
         send("attr_#{type}", internal_name)
       end

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

@@ -63,7 +63,7 @@ class Module
   #
   # == Mix-in noise exiled to its own file:
   #
-  # Once our chunk of behavior starts pushing the scroll-to-understand it
+  # Once our chunk of behavior starts pushing the scroll-to-understand it's
   # boundary, we give in and move it to a separate file. At this size, the
   # overhead feels in good proportion to the size of our extraction, despite
   # diluting our at-a-glance sense of how things really work.

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

@@ -178,30 +178,32 @@ class Module
       # whereas conceptually, from the user point of view, the delegator should
       # be doing one call.
       if allow_nil
-        module_eval(<<-EOS, file, line - 3)
-          def #{method_prefix}#{method}(#{definition})        # def customer_name(*args, &block)
-            _ = #{to}                                         #   _ = client
-            if !_.nil? || nil.respond_to?(:#{method})         #   if !_.nil? || nil.respond_to?(:name)
-              _.#{method}(#{definition})                      #     _.name(*args, &block)
-            end                                               #   end
-          end                                                 # end
-        EOS
+        method_def = [
+          "def #{method_prefix}#{method}(#{definition})",  # def customer_name(*args, &block)
+          "_ = #{to}",                                     #   _ = client
+          "if !_.nil? || nil.respond_to?(:#{method})",     #   if !_.nil? || nil.respond_to?(:name)
+          "  _.#{method}(#{definition})",                  #     _.name(*args, &block)
+          "end",                                           #   end
+        "end"                                              # end
+        ].join ';'
       else
         exception = %(raise DelegationError, "#{self}##{method_prefix}#{method} delegated to #{to}.#{method}, but #{to} is nil: \#{self.inspect}")
 
-        module_eval(<<-EOS, file, line - 2)
-          def #{method_prefix}#{method}(#{definition})                                          # def customer_name(*args, &block)
-            _ = #{to}                                                                           #   _ = client
-            _.#{method}(#{definition})                                                          #   _.name(*args, &block)
-          rescue NoMethodError => e                                                             # rescue NoMethodError => e
-            if _.nil? && e.name == :#{method}                                                   #   if _.nil? && e.name == :name
-              #{exception}                                                                      #     # add helpful message to the exception
-            else                                                                                #   else
-              raise                                                                             #     raise
-            end                                                                                 #   end
-          end                                                                                   # end
-        EOS
+        method_def = [
+          "def #{method_prefix}#{method}(#{definition})",  # def customer_name(*args, &block)
+          " _ = #{to}",                                    #   _ = client
+          "  _.#{method}(#{definition})",                  #   _.name(*args, &block)
+          "rescue NoMethodError => e",                     # rescue NoMethodError => e
+          "  if _.nil? && e.name == :#{method}",           #   if _.nil? && e.name == :name
+          "    #{exception}",                              #     # add helpful message to the exception
+          "  else",                                        #   else
+          "    raise",                                     #     raise
+          "  end",                                         #   end
+          "end"                                            # end
+        ].join ';'
       end
+
+      module_eval(method_def, file, line)
     end
   end
 end

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

@@ -4,36 +4,42 @@ class Object
   # An object is blank if it's false, empty, or a whitespace string.
   # For example, '', '   ', +nil+, [], and {} are all blank.
   #
-  # This simplifies:
+  # This simplifies
   #
-  #   if address.nil? || address.empty?
+  #   address.nil? || address.empty?
   #
-  # ...to:
+  # to
   #
-  #   if address.blank?
+  #   address.blank?
+  #
+  # @return [true, false]
   def blank?
-    respond_to?(:empty?) ? empty? : !self
+    respond_to?(:empty?) ? !!empty? : !self
   end
 
-  # An object is present if it's not <tt>blank?</tt>.
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
   def present?
     !blank?
   end
 
-  # Returns object if it's <tt>present?</tt> otherwise returns +nil+.
-  # <tt>object.presence</tt> is equivalent to <tt>object.present? ? object : nil</tt>.
+  # Returns the receiver if it's present otherwise returns +nil+.
+  # <tt>object.presence</tt> is equivalent to
   #
-  # This is handy for any representation of objects where blank is the same
-  # as not present at all. For example, this simplifies a common check for
-  # HTTP POST/query parameters:
+  #    object.present? ? object : nil
+  #
+  # For example, something like
   #
   #   state   = params[:state]   if params[:state].present?
   #   country = params[:country] if params[:country].present?
   #   region  = state || country || 'US'
   #
-  # ...becomes:
+  # becomes
   #
   #   region = params[:state].presence || params[:country].presence || 'US'
+  #
+  # @return [Object]
   def presence
     self if present?
   end
@@ -43,6 +49,8 @@ class NilClass
   # +nil+ is blank:
   #
   #   nil.blank? # => true
+  #
+  # @return [true]
   def blank?
     true
   end
@@ -52,6 +60,8 @@ class FalseClass
   # +false+ is blank:
   #
   #   false.blank? # => true
+  #
+  # @return [true]
   def blank?
     true
   end
@@ -61,6 +71,8 @@ class TrueClass
   # +true+ is not blank:
   #
   #   true.blank? # => false
+  #
+  # @return [false]
   def blank?
     false
   end
@@ -71,6 +83,8 @@ class Array
   #
   #   [].blank?      # => true
   #   [1,2,3].blank? # => false
+  #
+  # @return [true, false]
   alias_method :blank?, :empty?
 end
 
@@ -79,18 +93,28 @@ class Hash
   #
   #   {}.blank?                # => true
   #   { key: 'value' }.blank?  # => false
+  #
+  # @return [true, false]
   alias_method :blank?, :empty?
 end
 
 class String
+  BLANK_RE = /\A[[:space:]]*\z/
+
   # A string is blank if it's empty or contains whitespaces only:
   #
-  #   ''.blank?                 # => true
-  #   '   '.blank?              # => true
-  #   '　'.blank?               # => true
-  #   ' something here '.blank? # => false
+  #   ''.blank?       # => true
+  #   '   '.blank?    # => true
+  #   "\t\n\r".blank? # => true
+  #   ' blah '.blank? # => false
+  #
+  # Unicode whitespace is supported:
+  #
+  #   "\u00a0".blank? # => true
+  #
+  # @return [true, false]
   def blank?
-    self =~ /\A[[:space:]]*\z/
+    BLANK_RE === self
   end
 end
 
@@ -99,6 +123,8 @@ class Numeric #:nodoc:
   #
   #   1.blank? # => false
   #   0.blank? # => false
+  #
+  # @return [false]
   def blank?
     false
   end

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

@@ -12,4 +12,16 @@ class Object
   rescue NoMethodError
     raise ArgumentError.new("The parameter passed to #in? must respond to #include?")
   end
+
+  # Returns the receiver if it's included in the argument otherwise returns +nil+.
+  # Argument must be any object which responds to +#include?+. Usage:
+  #
+  #   params[:bucket_type].present_in %w( project calendar )
+  #
+  # This will throw an ArgumentError if the argument doesn't respond to +#include?+.
+  #
+  # @return [Object]
+  def present_in(another_object)
+    self.in?(another_object) ? self : nil
+  end
 end

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

@@ -16,12 +16,12 @@ require 'active_support/core_ext/module/aliasing'
 # otherwise they will always use to_json gem implementation, which is backwards incompatible in
 # several cases (for instance, the JSON implementation for Hash does not work) with inheritance
 # and consequently classes as ActiveSupport::OrderedHash cannot be serialized to json.
-# 
+#
 # On the other hand, we should avoid conflict with ::JSON.{generate,dump}(obj). Unfortunately, the
 # JSON gem's encoder relies on its own to_json implementation to encode objects. Since it always
 # passes a ::JSON::State object as the only argument to to_json, we can detect that and forward the
 # calls to the original to_json method.
-# 
+#
 # It should be noted that when using ::JSON.{generate,dump} directly, ActiveSupport's encoder is
 # bypassed completely. This means that as_json won't be invoked and the JSON gem will simply
 # ignore any options it does not natively understand. This also means that ::JSON.{generate,dump}
@@ -163,7 +163,7 @@ end
 class Time
   def as_json(options = nil) #:nodoc:
     if ActiveSupport.use_standard_json_time_format
-      xmlschema(3)
+      xmlschema(ActiveSupport::JSON::Encoding.time_precision)
     else
       %(#{strftime("%Y/%m/%d %H:%M:%S")} #{formatted_offset(false)})
     end
@@ -183,7 +183,7 @@ end
 class DateTime
   def as_json(options = nil) #:nodoc:
     if ActiveSupport.use_standard_json_time_format
-      xmlschema(3)
+      xmlschema(ActiveSupport::JSON::Encoding.time_precision)
     else
       strftime('%Y/%m/%d %H:%M:%S %z')
     end

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

@@ -51,8 +51,12 @@ class Hash
   #
   # This method is also aliased as +to_query+.
   def to_param(namespace = nil)
-    collect do |key, value|
-      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
-    end.sort! * '&'
+    if empty?
+      namespace ? nil.to_query(namespace) : ''
+    else
+      collect do |key, value|
+        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+      end.sort! * '&'
+    end
   end
 end

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

@@ -18,7 +18,12 @@ class Array
   #   ['Rails', 'coding'].to_query('hobbies') # => "hobbies%5B%5D=Rails&hobbies%5B%5D=coding"
   def to_query(key)
     prefix = "#{key}[]"
-    collect { |value| value.to_query(prefix) }.join '&'
+
+    if empty?
+      nil.to_query(prefix)
+    else
+      collect { |value| value.to_query(prefix) }.join '&'
+    end
   end
 end
 

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

@@ -1,5 +1,4 @@
 require 'active_support/core_ext/module/aliasing'
-require 'active_support/core_ext/object/acts_like'
 
 class Range #:nodoc:
 
@@ -17,7 +16,7 @@ class Range #:nodoc:
 
   private
   def ensure_iteration_allowed
-    if first.acts_like?(:time)
+    if first.is_a?(Time)
       raise TypeError, "can't iterate from #{first.class}"
     end
   end

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

@@ -59,7 +59,7 @@ class String
   #   str.from(0).to(-1) # => "hello"
   #   str.from(1).to(-2) # => "ell"
   def to(position)
-    self[0, position + 1]
+    self[0..position]
   end
 
   # Returns the first character. If a limit is supplied, returns a substring

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

@@ -70,9 +70,20 @@ class ERB
     # them inside a script tag to avoid XSS vulnerability:
     #
     #   <script>
-    #     var currentUser = <%= json_escape current_user.to_json %>;
+    #     var currentUser = <%= raw json_escape(current_user.to_json) %>;
     #   </script>
     #
+    # It is necessary to +raw+ the result of +json_escape+, so that quotation marks
+    # don't get converted to <tt>&quot;</tt> entities. +json_escape+ doesn't
+    # automatically flag the result as HTML safe, since the raw value is unsafe to
+    # use inside HTML attributes.
+    #
+    # If you need to output JSON elsewhere in your HTML, you can just do something
+    # like this, as any unsafe characters (including quotation marks) will be
+    # automatically escaped for you:
+    #
+    #   <div data-user-info="<%= current_user.to_json %>">...</div>
+    #
     # WARNING: this helper only works with valid JSON. Using this on non-JSON values
     # will open up serious XSS vulnerabilities. For example, if you replace the
     # +current_user.to_json+ in the example above with user input instead, the browser
@@ -88,17 +99,6 @@ class ERB
     # is recommended that you always apply this helper (other libraries, such as the
     # JSON gem, do not provide this kind of protection by default; also some gems
     # might override +to_json+ to bypass Active Support's encoder).
-    #
-    # The output of this helper method is marked as HTML safe so that you can directly
-    # include it inside a <tt><script></tt> tag as shown above.
-    #
-    # However, it is NOT safe to use the output of this inside an HTML attribute,
-    # because quotation marks are not escaped. Doing so might break your page's layout.
-    # If you intend to use this inside an HTML attribute, you should use the
-    # +html_escape+ helper (or its +h+ alias) instead:
-    #
-    #   <div data-user-info="<%= h current_user.to_json %>">...</div>
-    #
     def json_escape(s)
       result = s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
       s.html_safe? ? result.html_safe : result