activesupport 4.2.11.3 → 5.0.0.beta1

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

@@ -7,12 +7,21 @@ class Module
   #   m = Module.new
   #   m.name # => nil
   #
+  # +anonymous?+ method returns true if module does not have a name, false otherwise:
+  #
+  #   Module.new.anonymous? # => true
+  #
+  #   module M; end
+  #   M.anonymous?          # => false
+  #
   # A module gets a name when it is first assigned to a constant. Either
   # via the +module+ or +class+ keyword or by an explicit assignment:
   #
   #   m = Module.new # creates an anonymous module
-  #   M = m          # => m gets a name here as a side-effect
+  #   m.anonymous?   # => true
+  #   M = m          # m gets a name here as a side-effect
   #   m.name         # => "M"
+  #   m.anonymous?   # => false
   def anonymous?
     name.nil?
   end

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

@@ -27,11 +27,8 @@ class Module
 
     def attr_internal_define(attr_name, type)
       internal_name = attr_internal_ivar_name(attr_name).sub(/\A@/, '')
-      # 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
+      # use native attr_* methods as they are faster on some Ruby implementations
+      send("attr_#{type}", internal_name)
       attr_name, internal_name = "#{attr_name}=", "#{internal_name}=" if type == :writer
       alias_method attr_name, internal_name
       remove_method internal_name

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

@@ -5,7 +5,7 @@ require 'active_support/core_ext/array/extract_options'
 # attributes.
 class Module
   # Defines a class attribute and creates a class and instance reader methods.
-  # The underlying the class variable is set to +nil+, if it is not previously
+  # The underlying class variable is set to +nil+, if it is not previously
   # defined.
   #
   #   module HairColors
@@ -19,9 +19,9 @@ class Module
   # The attribute name must be a valid method name in Ruby.
   #
   #   module Foo
-  #     mattr_reader :"1_Badname "
+  #     mattr_reader :"1_Badname"
   #   end
-  #   # => NameError: invalid attribute name
+  #   # => NameError: invalid attribute name: 1_Badname
   #
   # If you want to opt out the creation on the instance reader method, pass
   # <tt>instance_reader: false</tt> or <tt>instance_accessor: false</tt>.
@@ -53,7 +53,7 @@ class Module
   def mattr_reader(*syms)
     options = syms.extract_options!
     syms.each do |sym|
-      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /\A[_A-Za-z]\w*\z/
       class_eval(<<-EOS, __FILE__, __LINE__ + 1)
         @@#{sym} = nil unless defined? @@#{sym}
 
@@ -119,7 +119,7 @@ class Module
   def mattr_writer(*syms)
     options = syms.extract_options!
     syms.each do |sym|
-      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /\A[_A-Za-z]\w*\z/
       class_eval(<<-EOS, __FILE__, __LINE__ + 1)
         @@#{sym} = nil unless defined? @@#{sym}
 
@@ -203,10 +203,10 @@ class Module
   #     include HairColors
   #   end
   #
-  #   Person.class_variable_get("@@hair_colors") #=> [:brown, :black, :blonde, :red]
+  #   Person.class_variable_get("@@hair_colors") # => [:brown, :black, :blonde, :red]
   def mattr_accessor(*syms, &blk)
     mattr_reader(*syms, &blk)
-    mattr_writer(*syms, &blk)
+    mattr_writer(*syms)
   end
   alias :cattr_accessor :mattr_accessor
 end

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

@@ -0,0 +1,141 @@
+require 'active_support/core_ext/array/extract_options'
+
+# Extends the module object with class/module and instance accessors for
+# class/module attributes, just like the native attr* accessors for instance
+# attributes, but does so on a per-thread basis.
+# 
+# So the values are scoped within the Thread.current space under the class name
+# of the module.
+class Module
+  # Defines a per-thread class attribute and creates class and instance reader methods.
+  # The underlying per-thread class variable is set to +nil+, if it is not previously defined.
+  #
+  #   module Current
+  #     thread_mattr_reader :user
+  #   end
+  #
+  #   Current.user # => nil
+  #   Thread.current[:attr_Current_user] = "DHH"
+  #   Current.user # => "DHH"
+  #
+  # The attribute name must be a valid method name in Ruby.
+  #
+  #   module Foo
+  #     thread_mattr_reader :"1_Badname"
+  #   end
+  #   # => NameError: invalid attribute name: 1_Badname
+  #
+  # If you want to opt out the creation on the instance reader method, pass
+  # <tt>instance_reader: false</tt> or <tt>instance_accessor: false</tt>.
+  #
+  #   class Current
+  #     thread_mattr_reader :user, instance_reader: false
+  #   end
+  #
+  #   Current.new.user # => NoMethodError
+  def thread_mattr_reader(*syms)
+    options = syms.extract_options!
+
+    syms.each do |sym|
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}
+          Thread.current[:"attr_#{name}_#{sym}"]
+        end
+      EOS
+
+      unless options[:instance_reader] == false || options[:instance_accessor] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}
+            Thread.current[:"attr_#{self.class.name}_#{sym}"]
+          end
+        EOS
+      end
+    end
+  end
+  alias :thread_cattr_reader :thread_mattr_reader
+
+  # Defines a per-thread class attribute and creates a class and instance writer methods to
+  # allow assignment to the attribute.
+  #
+  #   module Current
+  #     thread_mattr_writer :user
+  #   end
+  #
+  #   Current.user = "DHH"
+  #   Thread.current[:attr_Current_user] # => "DHH"
+  #
+  # If you want to opt out the instance writer method, pass
+  # <tt>instance_writer: false</tt> or <tt>instance_accessor: false</tt>.
+  #
+  #   class Current
+  #     thread_mattr_writer :user, instance_writer: false
+  #   end
+  #
+  #   Current.new.user = "DHH" # => NoMethodError
+  def thread_mattr_writer(*syms)
+    options = syms.extract_options!
+    syms.each do |sym|
+      raise NameError.new("invalid attribute name: #{sym}") unless sym =~ /^[_A-Za-z]\w*$/
+      class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+        def self.#{sym}=(obj)
+          Thread.current[:"attr_#{name}_#{sym}"] = obj
+        end
+      EOS
+
+      unless options[:instance_writer] == false || options[:instance_accessor] == false
+        class_eval(<<-EOS, __FILE__, __LINE__ + 1)
+          def #{sym}=(obj)
+            Thread.current[:"attr_#{self.class.name}_#{sym}"] = obj
+          end
+        EOS
+      end
+    end
+  end
+  alias :thread_cattr_writer :thread_mattr_writer
+
+  # Defines both class and instance accessors for class attributes.
+  #
+  #   class Account
+  #     thread_mattr_accessor :user
+  #   end
+  #
+  #   Account.user = "DHH"
+  #   Account.user     # => "DHH"
+  #   Account.new.user # => "DHH"
+  #
+  # If a subclass changes the value, the parent class' value is not changed.
+  # Similarly, if the parent class changes the value, the value of subclasses
+  # is not changed.
+  #
+  #   class Customer < Account
+  #   end
+  #
+  #   Customer.user = "Rafael"
+  #   Customer.user # => "Rafael"
+  #   Account.user  # => "DHH"
+  #
+  # To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.
+  # To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.
+  #
+  #   class Current
+  #     thread_mattr_accessor :user, instance_writer: false, instance_reader: false
+  #   end
+  #
+  #   Current.new.user = "DHH"  # => NoMethodError
+  #   Current.new.user          # => NoMethodError
+  #
+  # Or pass <tt>instance_accessor: false</tt>, to opt out both instance methods.
+  #
+  #   class Current
+  #     mattr_accessor :user, instance_accessor: false
+  #   end
+  #
+  #   Current.new.user = "DHH"  # => NoMethodError
+  #   Current.new.user          # => NoMethodError
+  def thread_mattr_accessor(*syms, &blk)
+    thread_mattr_reader(*syms, &blk)
+    thread_mattr_writer(*syms, &blk)
+  end
+  alias :thread_cattr_accessor :thread_mattr_accessor
+end

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

@@ -63,10 +63,10 @@ class Module
   #
   # == Mix-in noise exiled to its own file:
   #
-  # Once our chunk of behavior starts pushing the scroll-to-understand it's
+  # Once our chunk of behavior starts pushing the scroll-to-understand-it
   # 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.
+  # increased overhead can be a reasonable tradeoff even if it reduces our
+  # at-a-glance perception of how things work.
   #
   #   class Todo
   #     # Other todo implementation
@@ -99,7 +99,7 @@ class Module
   #   end
   #
   #   Todo.ancestors
-  #   # => Todo, Todo::EventTracking, Object
+  #   # => [Todo, Todo::EventTracking, Object]
   #
   # This small step has some wonderful ripple effects. We can
   # * grok the behavior of our class in one glance,

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

@@ -5,18 +5,11 @@ class Module
   # option is not used.
   class DelegationError < NoMethodError; end
 
-  RUBY_RESERVED_WORDS = Set.new(
-    %w(alias and BEGIN begin break case class def defined? do else elsif END
-       end ensure false for if in module next nil not or redo rescue retry
-       return self super then true undef unless until when while yield)
-  ).freeze
-
-  DELEGATION_RESERVED_KEYWORDS = Set.new(
-    %w(_ arg args block)
-  )
-
   DELEGATION_RESERVED_METHOD_NAMES = Set.new(
-    RUBY_RESERVED_WORDS + DELEGATION_RESERVED_KEYWORDS
+    %w(_ arg args alias and BEGIN begin block break case class def defined? do
+       else elsif END end ensure false for if in module next nil not or redo
+       rescue retry return self super then true undef unless until when while
+       yield)
   ).freeze
 
   # Provides a +delegate+ class method to easily expose contained objects'
@@ -25,7 +18,7 @@ class Module
   # ==== Options
   # * <tt>:to</tt> - Specifies the target object
   # * <tt>:prefix</tt> - Prefixes the new method with the target name or a custom prefix
-  # * <tt>:allow_nil</tt> - if set to true, prevents a +NoMethodError+ to be raised
+  # * <tt>:allow_nil</tt> - if set to true, prevents a +NoMethodError+ from being raised
   #
   # The macro receives one or more method names (specified as symbols or
   # strings) and the name of the target object via the <tt>:to</tt> option
@@ -175,11 +168,11 @@ class Module
         ''
       end
 
-    file, line = caller.first.split(':', 2)
+    file, line = caller(1, 1).first.split(':'.freeze, 2)
     line = line.to_i
 
     to = to.to_s
-    to = "self.#{to}" if RUBY_RESERVED_WORDS.include?(to)
+    to = "self.#{to}" if DELEGATION_RESERVED_METHOD_NAMES.include?(to)
 
     methods.each do |method|
       # Attribute writer methods only accept one argument. Makes sure []=

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

@@ -1,13 +1,3 @@
-class Module
-  ###
-  # TODO: remove this after 1.9 support is dropped
-  def methods_transplantable? # :nodoc:
-    x = Module.new {
-      def foo; end # :nodoc:
-    }
-    Module.new { define_method :bar, x.instance_method(:foo) }
-    true
-  rescue TypeError
-    false
-  end
-end
+require 'active_support/deprecation'
+
+ActiveSupport::Deprecation.warn("This file is deprecated and will be removed in Rails 5.1 with no replacement.")

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

@@ -3,13 +3,16 @@ require 'active_support/core_ext/string/inflections'
 #--
 # Allows code reuse in the methods below without polluting Module.
 #++
-module QualifiedConstUtils
-  def self.raise_if_absolute(path)
-    raise NameError.new("wrong constant name #$&") if path =~ /\A::[^:]+/
-  end
 
-  def self.names(path)
-    path.split('::')
+module ActiveSupport
+  module QualifiedConstUtils
+    def self.raise_if_absolute(path)
+      raise NameError.new("wrong constant name #$&") if path =~ /\A::[^:]+/
+    end
+
+    def self.names(path)
+      path.split('::')
+    end
   end
 end
 
@@ -24,9 +27,14 @@ end
 #++
 class Module
   def qualified_const_defined?(path, search_parents=true)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_defined? is deprecated in favour of the builtin
+      Module#const_defined? and will be removed in Rails 5.1.
+    MESSAGE
 
-    QualifiedConstUtils.names(path).inject(self) do |mod, name|
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
+
+    ActiveSupport::QualifiedConstUtils.names(path).inject(self) do |mod, name|
       return unless mod.const_defined?(name, search_parents)
       mod.const_get(name)
     end
@@ -34,19 +42,29 @@ class Module
   end
 
   def qualified_const_get(path)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_get is deprecated in favour of the builtin
+      Module#const_get and will be removed in Rails 5.1.
+    MESSAGE
+
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
 
-    QualifiedConstUtils.names(path).inject(self) do |mod, name|
+    ActiveSupport::QualifiedConstUtils.names(path).inject(self) do |mod, name|
       mod.const_get(name)
     end
   end
 
   def qualified_const_set(path, value)
-    QualifiedConstUtils.raise_if_absolute(path)
+    ActiveSupport::Deprecation.warn(<<-MESSAGE.squish)
+      Module#qualified_const_set is deprecated in favour of the builtin
+      Module#const_set and will be removed in Rails 5.1.
+    MESSAGE
+
+    ActiveSupport::QualifiedConstUtils.raise_if_absolute(path)
 
     const_name = path.demodulize
     mod_name = path.deconstantize
-    mod = mod_name.empty? ? self : qualified_const_get(mod_name)
+    mod = mod_name.empty? ? self : const_get(mod_name)
     mod.const_set(const_name, value)
   end
 end

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

@@ -1,12 +1,35 @@
 class Module
+  # Removes the named method, if it exists.
   def remove_possible_method(method)
     if method_defined?(method) || private_method_defined?(method)
       undef_method(method)
     end
   end
 
+  # Removes the named singleton method, if it exists.
+  def remove_possible_singleton_method(method)
+    singleton_class.instance_eval do
+      remove_possible_method(method)
+    end
+  end
+
+  # Replaces the existing method definition, if there is one, with the passed
+  # block as its body.
   def redefine_method(method, &block)
+    visibility = method_visibility(method)
     remove_possible_method(method)
     define_method(method, &block)
+    send(visibility, method)
+  end
+
+  def method_visibility(method) # :nodoc:
+    case
+    when private_method_defined?(method)
+      :private
+    when protected_method_defined?(method)
+      :protected
+    else
+      :public
+    end
   end
 end

data/lib/active_support/core_ext/name_error.rb

@@ -1,5 +1,12 @@
 class NameError
   # Extract the name of the missing constant from the exception message.
+  #
+  #   begin
+  #     HelloWorld
+  #   rescue NameError => e
+  #     e.missing_name
+  #   end
+  #   # => "HelloWorld"
   def missing_name
     if /undefined local variable or method/ !~ message
       $1 if /((::)?([A-Z]\w*)(::[A-Z]\w*)*)$/ =~ message
@@ -7,10 +14,16 @@ class NameError
   end
 
   # Was this exception raised because the given name was missing?
+  #
+  #   begin
+  #     HelloWorld
+  #   rescue NameError => e
+  #     e.missing_name?("HelloWorld")
+  #   end
+  #   # => true
   def missing_name?(name)
     if name.is_a? Symbol
-      last_name = (missing_name || '').split('::').last
-      last_name == name.to_s
+      self.name == name
     else
       missing_name == name.to_s
     end