activerecord 3.2.22.5 → 5.2.8

data/lib/active_record/relation/delegation.rb

@@ -1,49 +1,147 @@
-require 'active_support/core_ext/module/delegation'
+# frozen_string_literal: true
 
 module ActiveRecord
-  module Delegation
-    # Set up common delegations for performance (avoids method_missing)
-    delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :to => :to_a
-    delegate :table_name, :quoted_table_name, :primary_key, :quoted_primary_key,
-             :connection, :columns_hash, :auto_explain_threshold_in_seconds, :to => :klass
-
-    def self.delegate_to_scoped_klass(method)
-      if method.to_s =~ /\A[a-zA-Z_]\w*[!?]?\z/
-        module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            scoping { @klass.#{method}(*args, &block) }
+  module Delegation # :nodoc:
+    module DelegateCache # :nodoc:
+      def relation_delegate_class(klass)
+        @relation_delegate_cache[klass]
+      end
+
+      def initialize_relation_delegate_cache
+        @relation_delegate_cache = cache = {}
+        [
+          ActiveRecord::Relation,
+          ActiveRecord::Associations::CollectionProxy,
+          ActiveRecord::AssociationRelation
+        ].each do |klass|
+          delegate = Class.new(klass) {
+            include ClassSpecificRelation
+          }
+          include_relation_methods(delegate)
+          mangled_name = klass.name.gsub("::".freeze, "_".freeze)
+          const_set mangled_name, delegate
+          private_constant mangled_name
+
+          cache[klass] = delegate
+        end
+      end
+
+      def inherited(child_class)
+        child_class.initialize_relation_delegate_cache
+        super
+      end
+
+      protected
+        def include_relation_methods(delegate)
+          superclass.include_relation_methods(delegate) unless base_class == self
+          delegate.include generated_relation_methods
+        end
+
+      private
+        def generated_relation_methods
+          @generated_relation_methods ||= Module.new.tap do |mod|
+            mod_name = "GeneratedRelationMethods"
+            const_set mod_name, mod
+            private_constant mod_name
           end
-        RUBY
-      else
-        module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def #{method}(*args, &block)
-            scoping { @klass.send(#{method.inspect}, *args, &block) }
+        end
+
+        def generate_relation_method(method)
+          if /\A[a-zA-Z_]\w*[!?]?\z/.match?(method)
+            generated_relation_methods.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{method}(*args, &block)
+                scoping { klass.#{method}(*args, &block) }
+              end
+            RUBY
+          else
+            generated_relation_methods.send(:define_method, method) do |*args, &block|
+              scoping { klass.public_send(method, *args, &block) }
+            end
           end
-        RUBY
-      end
+        end
     end
 
-    def respond_to?(method, include_private = false)
-      super || Array.method_defined?(method) ||
-        @klass.respond_to?(method, include_private) ||
-        arel.respond_to?(method, include_private)
+    extend ActiveSupport::Concern
+
+    # This module creates compiled delegation methods dynamically at runtime, which makes
+    # subsequent calls to that method faster by avoiding method_missing. The delegations
+    # may vary depending on the klass of a relation, so we create a subclass of Relation
+    # for each different klass, and the delegations are compiled into that subclass only.
+
+    delegate :to_xml, :encode_with, :length, :each, :uniq, :join,
+             :[], :&, :|, :+, :-, :sample, :reverse, :rotate, :compact, :in_groups, :in_groups_of,
+             :to_sentence, :to_formatted_s, :as_json,
+             :shuffle, :split, :slice, :index, :rindex, to: :records
+
+    delegate :primary_key, :connection, to: :klass
+
+    module ClassSpecificRelation # :nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        @delegation_mutex = Mutex.new
+      end
+
+      module ClassMethods # :nodoc:
+        def name
+          superclass.name
+        end
+
+        def delegate_to_scoped_klass(method)
+          @delegation_mutex.synchronize do
+            return if method_defined?(method)
+
+            if /\A[a-zA-Z_]\w*[!?]?\z/.match?(method)
+              module_eval <<-RUBY, __FILE__, __LINE__ + 1
+                def #{method}(*args, &block)
+                  scoping { @klass.#{method}(*args, &block) }
+                end
+              RUBY
+            else
+              define_method method do |*args, &block|
+                scoping { @klass.public_send(method, *args, &block) }
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+        def method_missing(method, *args, &block)
+          if @klass.respond_to?(method)
+            self.class.delegate_to_scoped_klass(method)
+            scoping { @klass.public_send(method, *args, &block) }
+          elsif @delegate_to_klass && @klass.respond_to?(method, true)
+            ActiveSupport::Deprecation.warn \
+              "Delegating missing #{method} method to #{@klass}. " \
+              "Accessibility of private/protected class methods in :scope is deprecated and will be removed in Rails 6.0."
+            @klass.send(method, *args, &block)
+          elsif arel.respond_to?(method)
+            ActiveSupport::Deprecation.warn \
+              "Delegating #{method} to arel is deprecated and will be removed in Rails 6.0."
+            arel.public_send(method, *args, &block)
+          else
+            super
+          end
+        end
     end
 
-    protected
-
-    def method_missing(method, *args, &block)
-      if @klass.respond_to?(method)
-        ::ActiveRecord::Delegation.delegate_to_scoped_klass(method)
-        scoping { @klass.send(method, *args, &block) }
-      elsif Array.method_defined?(method)
-        ::ActiveRecord::Delegation.delegate method, :to => :to_a
-        to_a.send(method, *args, &block)
-      elsif arel.respond_to?(method)
-        ::ActiveRecord::Delegation.delegate method, :to => :arel
-        arel.send(method, *args, &block)
-      else
-        super
+    module ClassMethods # :nodoc:
+      def create(klass, *args)
+        relation_class_for(klass).new(klass, *args)
       end
+
+      private
+
+        def relation_class_for(klass)
+          klass.relation_delegate_class(self)
+        end
     end
+
+    private
+      def respond_to_missing?(method, _)
+        super || @klass.respond_to?(method) || arel.respond_to?(method)
+      end
   end
 end