activesupport 1.2.4 → 8.1.2

data/lib/active_support/dependencies/interlock.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "active_support/concurrency/share_lock"
+
+module ActiveSupport # :nodoc:
+  module Dependencies # :nodoc:
+    class Interlock
+      def initialize # :nodoc:
+        @lock = ActiveSupport::Concurrency::ShareLock.new
+      end
+
+      def loading(&block)
+        ActiveSupport.deprecator.warn(
+          "ActiveSupport::Dependencies::Interlock#loading is deprecated and " \
+          "will be removed in Rails 9.0. The loading interlock is no longer " \
+          "used since Rails switched to Zeitwerk for autoloading."
+        )
+        yield if block
+      end
+
+      def unloading(&block)
+        @lock.exclusive(purpose: :unload, compatible: [:unload], after_compatible: [:unload], &block)
+      end
+
+      def start_unloading
+        @lock.start_exclusive(purpose: :unload, compatible: [:unload])
+      end
+
+      def done_unloading
+        @lock.stop_exclusive(compatible: [:unload])
+      end
+
+      def start_running
+        @lock.start_sharing
+      end
+
+      def done_running
+        @lock.stop_sharing
+      end
+
+      def running(&block)
+        @lock.sharing(&block)
+      end
+
+      def permit_concurrent_loads(&block)
+        # Soft deprecated: no deprecation warning for now, but this is a no-op.
+        yield if block
+      end
+
+      def raw_state(&block) # :nodoc:
+        @lock.raw_state(&block)
+      end
+    end
+  end
+end

data/lib/active_support/dependencies/require_dependency.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ActiveSupport::Dependencies::RequireDependency
+  # <b>Warning:</b> This method is obsolete. The semantics of the autoloader
+  # match Ruby's and you do not need to be defensive with load order anymore.
+  # Just refer to classes and modules normally.
+  #
+  # Engines that do not control the mode in which their parent application runs
+  # should call +require_dependency+ where needed in case the runtime mode is
+  # +:classic+.
+  def require_dependency(filename)
+    filename = filename.to_path if filename.respond_to?(:to_path)
+
+    unless filename.is_a?(String)
+      raise ArgumentError, "the file name must be either a String or implement #to_path -- you passed #{filename.inspect}"
+    end
+
+    if abspath = ActiveSupport::Dependencies.search_for_file(filename)
+      require abspath
+    else
+      require filename
+    end
+  end
+
+  # We could define require_dependency in Object directly, but a module makes
+  # the extension apparent if you list ancestors.
+  Object.prepend(self)
+end

data/lib/active_support/dependencies.rb

@@ -1,240 +1,102 @@
-require File.dirname(__FILE__) + '/module_attribute_accessors'
-require File.dirname(__FILE__) + '/core_ext/load_error'
+# frozen_string_literal: true
 
-module Dependencies #:nodoc:
-  extend self
+require "active_support/dependencies/interlock"
 
-  @@loaded = [ ]
-  mattr_accessor :loaded
+module ActiveSupport # :nodoc:
+  module Dependencies # :nodoc:
+    require_relative "dependencies/require_dependency"
 
-  @@mechanism = :load
-  mattr_accessor :mechanism
-  
-  def load?
-    mechanism == :load
-  end
-  
-  def depend_on(file_name, swallow_load_errors = false)
-    unless loaded.include?(file_name)
-      loaded << file_name
-
-      begin
-        require_or_load(file_name)
-      rescue LoadError
-        raise unless swallow_load_errors
-      end
-    end
-  end
+    singleton_class.attr_accessor :interlock
+    @interlock = Interlock.new
 
-  def associate_with(file_name)
-    depend_on(file_name, true)
-  end
-  
-  def clear
-    self.loaded = [ ]
-  end
-  
-  def require_or_load(file_name)
-    file_name = "#{file_name}.rb" unless ! load? || file_name[-3..-1] == '.rb'
-    load? ? load(file_name) : require(file_name)
-  end
-  
-  def remove_subclasses_for(*classes)
-    Object.remove_subclasses_of(*classes)
-  end
-  
-  # LoadingModules implement namespace-safe dynamic loading.
-  # They support automatic loading via const_missing, allowing contained items to be automatically
-  # loaded when required. No extra syntax is required, as expressions such as Controller::Admin::UserController
-  # load the relavent files automatically.
-  #
-  # Ruby-style modules are supported, as a folder named 'submodule' will load 'submodule.rb' when available.
-  class LoadingModule < Module #:nodoc:
-    attr_reader :path
-    attr_reader :root
-    
-    class << self
-      def root(*load_paths)
-        RootLoadingModule.new(*load_paths)
-      end
-    end
-    
-    def initialize(root, path=[])
-      @path = path.clone.freeze
-      @root = root
-    end
-    
-    def root?()      self.root == self    end
-    def load_paths() self.root.load_paths end
-    
-    # Load missing constants if possible.
-    def const_missing(name)
-      const_load!(name) ? const_get(name) : super(name)
-    end
-  
-    # Load the controller class or a parent module.
-    def const_load!(name, file_name = nil)
-      file_name ||= 'application' if root? && name.to_s == 'ApplicationController'
-      path = self.path + [file_name || name]
-
-      load_paths.each do |load_path|
-        fs_path = load_path.filesystem_path(path)
-        next unless fs_path
-
-        case 
-        when File.directory?(fs_path)
-          new_module = LoadingModule.new(self.root, self.path + [name])
-          self.const_set name, new_module
-          if self.root?
-            if Object.const_defined?(name)
-              msg = "Cannot load module #{name}: Object::#{name} is set to #{Object.const_get(name).inspect}"
-              raise NameError, msg
-            end
-            Object.const_set(name, new_module)
-          end
-          break
-        when File.file?(fs_path)
-          loaded_file = self.root.load_file!(fs_path)
-          
-          # Import the loaded constant from Object provided we are the root node.
-          self.const_set(name, Object.const_get(name)) if self.root? && Object.const_defined?(name)
-          
-          # Throw an error if we load the file but we don't find the Object we expect
-          if loaded_file and not self.const_defined?(name)
-            msg = "Already loaded file '#{fs_path}' but '#{name.to_s}' was not set, perhaps you need to rename '#{fs_path}'?"
-            raise LoadError, msg
-          end
-          break
-        end
-      end
-      
-      self.const_defined?(name)
-    end
-    
-    # Is this name present or loadable?
-    # This method is used by Routes to find valid controllers.
-    def const_available?(name)
-      self.const_defined?(name) || load_paths.any? {|lp| lp.filesystem_path(path + [name])}
-    end
-  end
-  
-  class RootLoadingModule < LoadingModule #:nodoc:
-    attr_reader :load_paths
+    # :doc:
 
-    def initialize(*paths)
-      @load_paths = paths.flatten.collect {|p| p.kind_of?(ConstantLoadPath) ? p : ConstantLoadPath.new(p)}
+    # Execute the supplied block without interference from any
+    # concurrent loads.
+    def self.run_interlock(&block)
+      interlock.running(&block)
     end
 
-    def root() self end
-
-    def path() [] end
-    
-    # Load the source file at the given file path
-    def load_file!(file_path)
-      require_dependency(file_path)
+    # Execute the supplied block while holding an exclusive lock,
+    # preventing any other thread from being inside a #run_interlock
+    # block at the same time.
+    def self.load_interlock(&block)
+      ActiveSupport.deprecator.warn(
+        "ActiveSupport::Dependencies.load_interlock is deprecated and " \
+        "will be removed in Rails 9.0. The loading interlock is no longer " \
+        "used since Rails switched to Zeitwerk for autoloading."
+      )
+      yield if block
     end
 
-    # Erase all items in this module
-    def clear!
-      constants.each do |name|
-        Object.send(:remove_const, name) if Object.const_defined?(name) && Object.const_get(name).object_id == self.const_get(name).object_id
-        self.send(:remove_const, name)
-      end
+    # Execute the supplied block while holding an exclusive lock,
+    # preventing any other thread from being inside a #run_interlock
+    # block at the same time.
+    def self.unload_interlock(&block)
+      interlock.unloading(&block)
     end
-  end
-  
-  # This object defines a path from which Constants can be loaded.
-  class ConstantLoadPath #:nodoc:
-    # Create a new load path with the filesystem path
-    def initialize(root) @root = root end
-    
-    # Return nil if the path does not exist, or the path to a directory
-    # if the path leads to a module, or the path to a file if it leads to an object.
-    def filesystem_path(path, allow_module=true)
-      fs_path = [@root]
-      fs_path += path[0..-2].map {|name| const_name_to_module_name name}
-
-      if allow_module
-        result = File.join(fs_path, const_name_to_module_name(path.last))
-        return result if File.directory? result # Return the module path if one exists
-      end
 
-      result = File.join(fs_path, const_name_to_file_name(path.last))
-
-      File.file?(result) ? result : nil
-    end
-    
-    def const_name_to_file_name(name)
-      name.to_s.underscore + '.rb'
+    # :nodoc:
+
+    # The array of directories from which we autoload and reload, if reloading
+    # is enabled. The public interface to push directories to this collection
+    # from applications or engines is config.autoload_paths.
+    #
+    # This collection is allowed to have intersection with autoload_once_paths.
+    # Common directories are not reloaded.
+    singleton_class.attr_accessor :autoload_paths
+    self.autoload_paths = []
+
+    # The array of directories from which we autoload and never reload, even if
+    # reloading is enabled. The public interface to push directories to this
+    # collection from applications or engines is config.autoload_once_paths.
+    singleton_class.attr_accessor :autoload_once_paths
+    self.autoload_once_paths = []
+
+    # This is a private set that collects all eager load paths during bootstrap.
+    # Useful for Zeitwerk integration. The public interface to push custom
+    # directories to this collection from applications or engines is
+    # config.eager_load_paths.
+    singleton_class.attr_accessor :_eager_load_paths
+    self._eager_load_paths = Set.new
+
+    # If reloading is enabled, this private set holds autoloaded classes tracked
+    # by the descendants tracker. It is populated by an on_load callback in the
+    # main autoloader. Used to clear state.
+    singleton_class.attr_accessor :_autoloaded_tracked_classes
+    self._autoloaded_tracked_classes = Set.new
+
+    # If reloading is enabled, this private attribute stores the main autoloader
+    # of a Rails application. It is `nil` otherwise.
+    #
+    # The public interface for this autoloader is `Rails.autoloaders.main`.
+    singleton_class.attr_accessor :autoloader
+
+    # Private method that reloads constants autoloaded by the main autoloader.
+    #
+    # Rails.application.reloader.reload! is the public interface for application
+    # reload. That involves more things, like deleting unloaded classes from the
+    # internal state of the descendants tracker, or reloading routes.
+    def self.clear
+      unload_interlock do
+        _autoloaded_tracked_classes.clear
+        autoloader.reload
+      end
     end
 
-    def const_name_to_module_name(name)
-      name.to_s.underscore
+    # Private method used by require_dependency.
+    def self.search_for_file(relpath)
+      relpath += ".rb" unless relpath.end_with?(".rb")
+      autoload_paths.each do |autoload_path|
+        abspath = File.join(autoload_path, relpath)
+        return abspath if File.file?(abspath)
+      end
+      nil
     end
-  end
-end
-
-Object.send(:define_method, :require_or_load)     { |file_name| Dependencies.require_or_load(file_name) } unless Object.respond_to?(:require_or_load)
-Object.send(:define_method, :require_dependency)  { |file_name| Dependencies.depend_on(file_name) }       unless Object.respond_to?(:require_dependency)
-Object.send(:define_method, :require_association) { |file_name| Dependencies.associate_with(file_name) }  unless Object.respond_to?(:require_association)
-
-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)
-    if Object.const_defined?(:Controllers) and Object::Controllers.const_available?(class_id)
-      return Object::Controllers.const_get(class_id)
+    # Private method that helps configuring the autoloaders.
+    def self.eager_load?(path)
+      _eager_load_paths.member?(path)
     end
-    
-    file_name = class_id.to_s.demodulize.underscore
-    begin
-      require_dependency(file_name)
-      raise NameError.new("uninitialized constant #{class_id}") unless Object.const_defined?(class_id)
-      return Object.const_get(class_id)
-    rescue MissingSourceFile => e
-      # Convert the exception to a NameError only if the file we are looking for is the missing one.
-      raise unless e.is_missing? file_name
-      raise NameError.new("uninitialized constant #{class_id}").copy_blame!(e)
-    end
-  end
-end
-
-class Object #:nodoc:
-  def load(file, *extras)
-    super(file, *extras)
-  rescue Object => exception
-    exception.blame_file! file
-    raise
-  end
-
-  def require(file, *extras)
-    super(file, *extras)
-  rescue Object => exception
-    exception.blame_file! file
-    raise
-  end
-end
-
-# Add file-blaming to exceptions
-class Exception #:nodoc:
-  def blame_file!(file)
-    (@blamed_files ||= []).unshift file
-  end
-
-  def blamed_files
-    @blamed_files ||= []
-  end
-
-  def describe_blame
-    return nil if blamed_files.empty?
-    "This error occured while loading the following files:\n   #{blamed_files.join "\n   "}"
-  end
-
-  def copy_blame!(exc)
-    @blamed_files = exc.blamed_files.clone
-    self
   end
 end

data/lib/active_support/deprecation/behaviors.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+module ActiveSupport
+  # Raised when ActiveSupport::Deprecation::Behavior#behavior is set with <tt>:raise</tt>.
+  # You would set <tt>:raise</tt>, as a behavior to raise errors and proactively report exceptions from deprecations.
+  class DeprecationException < StandardError
+  end
+
+  class Deprecation
+    # Default warning behaviors per Rails.env.
+    DEFAULT_BEHAVIORS = {
+      raise: ->(message, callstack, deprecator) do
+        e = DeprecationException.new(message)
+        e.set_backtrace(callstack.map(&:to_s))
+        raise e
+      end,
+
+      stderr: ->(message, callstack, deprecator) do
+        $stderr.puts(message)
+        $stderr.puts callstack.join("\n  ") if deprecator.debug
+      end,
+
+      log: ->(message, callstack, deprecator) do
+        logger =
+            if defined?(Rails.logger) && Rails.logger
+              Rails.logger
+            else
+              require "active_support/logger"
+              ActiveSupport::Logger.new($stderr)
+            end
+        logger.warn message
+        logger.debug callstack.join("\n  ") if deprecator.debug
+      end,
+
+      notify: ->(message, callstack, deprecator) do
+        ActiveSupport::Notifications.instrument(
+          "deprecation.#{deprecator.gem_name.underscore.tr("/", "_")}",
+          message: message,
+          callstack: callstack,
+          gem_name: deprecator.gem_name,
+          deprecation_horizon: deprecator.deprecation_horizon,
+        )
+      end,
+
+      silence: ->(message, callstack, deprecator) { },
+
+      report: ->(message, callstack, deprecator) do
+        error = DeprecationException.new(message)
+        error.set_backtrace(callstack.map(&:to_s))
+        ActiveSupport.error_reporter.report(error)
+      end
+    }
+
+    # Behavior module allows to determine how to display deprecation messages.
+    # You can create a custom behavior or set any from the +DEFAULT_BEHAVIORS+
+    # constant. Available behaviors are:
+    #
+    # [+:raise+]   Raise ActiveSupport::DeprecationException.
+    # [+:stderr+]  Log all deprecation warnings to <tt>$stderr</tt>.
+    # [+:log+]     Log all deprecation warnings to +Rails.logger+.
+    # [+:notify+]  Use ActiveSupport::Notifications to notify +deprecation.rails+.
+    # [+:report+]  Use ActiveSupport::ErrorReporter to report deprecations.
+    # [+:silence+] Do nothing. On \Rails, set <tt>config.active_support.report_deprecations = false</tt> to disable all behaviors.
+    #
+    # Setting behaviors only affects deprecations that happen after boot time.
+    # For more information you can read the documentation of the #behavior= method.
+    module Behavior
+      # Whether to print a backtrace along with the warning.
+      attr_accessor :debug
+
+      # Returns the current behavior or if one isn't set, defaults to +:stderr+.
+      def behavior
+        @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
+      end
+
+      # Returns the current behavior for disallowed deprecations or if one isn't set, defaults to +:raise+.
+      def disallowed_behavior
+        @disallowed_behavior ||= [DEFAULT_BEHAVIORS[:raise]]
+      end
+
+      # Sets the behavior to the specified value. Can be a single value, array,
+      # or an object that responds to +call+.
+      #
+      # Available behaviors:
+      #
+      # [+:raise+]   Raise ActiveSupport::DeprecationException.
+      # [+:stderr+]  Log all deprecation warnings to <tt>$stderr</tt>.
+      # [+:log+]     Log all deprecation warnings to +Rails.logger+.
+      # [+:notify+]  Use ActiveSupport::Notifications to notify +deprecation.rails+.
+      # [+:report+]  Use ActiveSupport::ErrorReporter to report deprecations.
+      # [+:silence+] Do nothing.
+      #
+      # Setting behaviors only affects deprecations that happen after boot time.
+      # Deprecation warnings raised by gems are not affected by this setting
+      # because they happen before \Rails boots up.
+      #
+      #   deprecator = ActiveSupport::Deprecation.new
+      #   deprecator.behavior = :stderr
+      #   deprecator.behavior = [:stderr, :log]
+      #   deprecator.behavior = MyCustomHandler
+      #   deprecator.behavior = ->(message, callstack, deprecation_horizon, gem_name) {
+      #     # custom stuff
+      #   }
+      #
+      # If you are using \Rails, you can set
+      # <tt>config.active_support.report_deprecations = false</tt> to disable
+      # all deprecation behaviors. This is similar to the +:silence+ option but
+      # more performant.
+      def behavior=(behavior)
+        @behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || arity_coerce(b) }
+      end
+
+      # Sets the behavior for disallowed deprecations (those configured by
+      # ActiveSupport::Deprecation#disallowed_warnings=) to the specified
+      # value. As with #behavior=, this can be a single value, array, or an
+      # object that responds to +call+.
+      def disallowed_behavior=(behavior)
+        @disallowed_behavior = Array(behavior).map { |b| DEFAULT_BEHAVIORS[b] || arity_coerce(b) }
+      end
+
+      private
+        def arity_coerce(behavior)
+          unless behavior.respond_to?(:call)
+            raise ArgumentError, "#{behavior.inspect} is not a valid deprecation behavior."
+          end
+
+          case arity_of_callable(behavior)
+          when 2
+            ->(message, callstack, deprecator) do
+              behavior.call(message, callstack)
+            end
+          when -2..3
+            behavior
+          else
+            ->(message, callstack, deprecator) do
+              behavior.call(message, callstack, deprecator.deprecation_horizon, deprecator.gem_name)
+            end
+          end
+        end
+
+        def arity_of_callable(callable)
+          callable.respond_to?(:arity) ? callable.arity : callable.method(:call).arity
+        end
+    end
+  end
+end

data/lib/active_support/deprecation/constant_accessor.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ActiveSupport
+  class Deprecation
+    module DeprecatedConstantAccessor
+      def self.included(base)
+        require "active_support/inflector/methods"
+
+        extension = Module.new do
+          def const_missing(missing_const_name)
+            if class_variable_defined?(:@@_deprecated_constants)
+              if (replacement = class_variable_get(:@@_deprecated_constants)[missing_const_name.to_s])
+                replacement[:deprecator].warn(replacement[:message] || "#{name}::#{missing_const_name} is deprecated! Use #{replacement[:new]} instead.", caller_locations)
+                return ActiveSupport::Inflector.constantize(replacement[:new].to_s)
+              end
+            end
+            super
+          end
+
+          # Provides a way to rename constants with a deprecation cycle in which
+          # both the old and new names work, but using the old one prints a
+          # deprecation message.
+          #
+          # In order to rename <tt>A::B</tt> to <tt>C::D</tt>, you need to delete the
+          # definition of <tt>A::B</tt> and declare the deprecation in +A+:
+          #
+          #   require "active_support/deprecation"
+          #
+          #   module A
+          #     include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+          #
+          #     deprecate_constant "B", "C::D", deprecator: ActiveSupport::Deprecation.new
+          #   end
+          #
+          # The first argument is a constant name (no colons). It is the name of
+          # the constant you want to deprecate in the enclosing class or module.
+          #
+          # The second argument is the constant path of the replacement. That
+          # has to be a full path even if the replacement is defined in the same
+          # namespace as the deprecated one was.
+          #
+          # In both cases, strings and symbols are supported.
+          #
+          # The +deprecator+ keyword argument is the object that will print the
+          # deprecation message, an instance of ActiveSupport::Deprecation.
+          #
+          # With that in place, references to <tt>A::B</tt> still work, they
+          # evaluate to <tt>C::D</tt> now, and trigger a deprecation warning:
+          #
+          #   DEPRECATION WARNING: A::B is deprecated! Use C::D instead.
+          #   (called from ...)
+          #
+          # The message can be customized with the optional +message+ keyword
+          # argument.
+          #
+          # For this to work, a +const_missing+ hook is installed. When client
+          # code references the deprecated constant, the callback prints the
+          # message and constantizes the replacement.
+          #
+          # Caveat: If the deprecated constant name is reachable in a different
+          # namespace and Ruby constant lookup finds it, the hook won't be
+          # called and the deprecation won't work as intended. This may happen,
+          # for example, if an ancestor of the enclosing namespace has a
+          # constant with the same name. This is an unsupported edge case.
+          def deprecate_constant(old_constant_name, new_constant_path, deprecator:, message: nil)
+            class_variable_set(:@@_deprecated_constants, {}) unless class_variable_defined?(:@@_deprecated_constants)
+            class_variable_get(:@@_deprecated_constants)[old_constant_name.to_s] = { new: new_constant_path, message: message, deprecator: deprecator }
+          end
+        end
+        base.singleton_class.prepend extension
+      end
+    end
+  end
+end