goldiloader 3.2.0 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5ec15cfc51915f390119375f633b3438f08226e9ebac6e8523c46e69f91e16c
-  data.tar.gz: 61894b325643cc364eaea59e9b3d16aa25f32a76aabbd0f30a126355dbd6d365
+  metadata.gz: 452d46a8d8dc72a51e686d522826ad8f80ad3e686ef03d61f34c8044458f1d3f
+  data.tar.gz: f4c428261a9d7d69858e065da735795b7be00bae3d6c4910b5e9d31064558e51
 SHA512:
-  metadata.gz: b792fb0a79df0076eddbe2e451d7df31583bb2a7d6cd90c2aa50c3f55bc97839367f6f006e82688eab3f2d0e3e056a5a3ba9b881095f8ae88dbed3aedc44d1f5
-  data.tar.gz: 920bb6c789be76a3e10c9bff4d74026d7ea7ceb18575217bccf5bfa3bf05653e093f0ea3a4188c5e14167e81d7fecced7578fcd81eca9abe19126543f54362a0
+  metadata.gz: ebf67521e4fed82d0d90b5f1597b296e0de04f53ab35b975c5e48383fa6392b0a4d0ed91225e16e471bfa87840144d68d590711e92353cd6138a637b94b5aa30
+  data.tar.gz: ee9fac3561f9e8c875f4bcbaca2fa9cbf7be9d3450f440e77eddcc3816da80fd4a38d534128e78fa154ce6ebaa83f99e502b838b7be106aa8bbe7db75466022e

data/lib/goldiloader.rb

@@ -8,3 +8,37 @@ require 'goldiloader/scope_info'
 require 'goldiloader/association_options'
 require 'goldiloader/association_loader'
 require 'goldiloader/active_record_patches'
+
+module Goldiloader
+  class << self
+
+    # Sets the process-wide enabled status
+    attr_accessor :globally_enabled
+
+    def enabled?
+      Thread.current.fetch(:goldiloader_enabled, globally_enabled)
+    end
+
+    def enabled=(val)
+      Thread.current[:goldiloader_enabled] = val
+    end
+
+    def enabled
+      old_enabled = Thread.current[:goldiloader_enabled]
+      self.enabled = true
+      yield
+    ensure
+      self.enabled = old_enabled
+    end
+
+    def disabled
+      old_enabled = Thread.current[:goldiloader_enabled]
+      self.enabled = false
+      yield
+    ensure
+      self.enabled = old_enabled
+    end
+  end
+
+  self.globally_enabled = true
+end

data/lib/goldiloader/active_record_patches.rb

@@ -51,13 +51,7 @@ module Goldiloader
     end
 
     def auto_include_value=(value)
-      if Goldiloader::Compatibility.rails_4?
-        raise ::ActiveRecord::Relation::ImmutableRelation if @loaded
-        check_cached_relation
-      else
-        assert_mutability!
-      end
-
+      assert_mutability!
       @values[:auto_include] = value
     end
   end
@@ -74,29 +68,26 @@ module Goldiloader
   ActiveRecord::Relation::Merger.prepend(::Goldiloader::MergerPatch)
 
   module AssociationReflectionPatch
-    def eager_loadable?
-      return @eager_loadable if instance_variable_defined?(:@eager_loadable)
-
-      @eager_loadable = if scope.nil?
-                          # Associations without any scoping options are eager loadable
-                          true
-                        elsif scope.arity > 0
-                          # The scope will be evaluated for every model instance so it can't
-                          # be eager loaded
-                          false
-                        else
-                          scope_info = if Goldiloader::Compatibility.rails_4?
-                                         Goldiloader::ScopeInfo.new(klass.unscoped.instance_exec(&scope) || klass.unscoped)
-                                       else
-                                         Goldiloader::ScopeInfo.new(scope_for(klass.unscoped))
-                                       end
-                          scope_info.auto_include? &&
-                            !scope_info.limit? &&
-                            !scope_info.offset? &&
-                            (!has_one? || !scope_info.order?) &&
-                            (::Goldiloader::Compatibility.group_eager_loadable? || !scope_info.group?) &&
-                            (::Goldiloader::Compatibility.from_eager_loadable? || !scope_info.from?)
-                        end
+    # Note we need to pass the association's target class as an argument since it won't be known
+    # outside the context of an association instance for polymorphic associations.
+    def eager_loadable?(target_klass)
+      @eager_loadable_cache ||= Hash.new do |cache, target_klass_key|
+        cache[target_klass_key] = if scope.nil?
+                                    # Associations without any scoping options are eager loadable
+                                    true
+                                  elsif scope.arity > 0
+                                    # The scope will be evaluated for every model instance so it can't
+                                    # be eager loaded
+                                    false
+                                  else
+                                    scope_info = Goldiloader::ScopeInfo.new(scope_for(target_klass_key.unscoped))
+                                    scope_info.auto_include? &&
+                                      !scope_info.limit? &&
+                                      !scope_info.offset? &&
+                                      (!has_one? || !scope_info.order?)
+                                  end
+      end
+      @eager_loadable_cache[target_klass]
     end
   end
   ActiveRecord::Reflection::AssociationReflection.include(::Goldiloader::AssociationReflectionPatch)
@@ -123,11 +114,13 @@ module Goldiloader
     private
 
     def eager_loadable?
-      reflection.eager_loadable? &&
+      klass && reflection.eager_loadable?(klass) &&
         (::Goldiloader::Compatibility.destroyed_model_associations_eager_loadable? || !owner.destroyed?)
     end
 
     def load_with_auto_include
+      return yield unless Goldiloader.enabled?
+
       if loaded? && !stale_target?
         target
       elsif !auto_include?
@@ -159,12 +152,7 @@ module Goldiloader
 
   module CollectionAssociationPatch
     # Force these methods to load the entire association for fully_load associations
-    association_methods = [:size, :ids_reader, :empty?]
-    if Goldiloader::Compatibility::ACTIVE_RECORD_VERSION < ::Gem::Version.new('5.1')
-      association_methods.concat([:first, :second, :third, :fourth, :fifth, :last])
-    end
-
-    association_methods.each do |method|
+    [:size, :ids_reader, :empty?].each do |method|
       define_method(method) do |*args, &block|
         load_target if fully_load?
         super(*args, &block)
@@ -175,10 +163,8 @@ module Goldiloader
       load_with_auto_include { super }
     end
 
-    if Goldiloader::Compatibility::ACTIVE_RECORD_VERSION >= ::Gem::Version.new('5.1')
-      def find_from_target?
-        fully_load? || super
-      end
+    def find_from_target?
+      fully_load? || super
     end
   end
   ::ActiveRecord::Associations::CollectionAssociation.prepend(::Goldiloader::CollectionAssociationPatch)

data/lib/goldiloader/association_loader.rb

@@ -15,7 +15,11 @@ module Goldiloader
     private
 
     def eager_load(models, association_name)
-      ::ActiveRecord::Associations::Preloader.new.preload(models, [association_name])
+      if Goldiloader::Compatibility.pre_rails_6_2?
+        ::ActiveRecord::Associations::Preloader.new.preload(models, [association_name])
+      else
+        ::ActiveRecord::Associations::Preloader.new(records: models, associations: [association_name]).call
+      end
     end
 
     def load?(model, association_name)

data/lib/goldiloader/association_options.rb

@@ -18,11 +18,7 @@ module Goldiloader
     end
 
     def register
-      if Goldiloader::Compatibility.rails_4?
-        ActiveRecord::Associations::Builder::Association.valid_options.concat(OPTIONS)
-      else
-        ActiveRecord::Associations::Builder::Association.extensions << AssociationBuilderExtension
-      end
+      ActiveRecord::Associations::Builder::Association.extensions << AssociationBuilderExtension
     end
   end
 end

data/lib/goldiloader/compatibility.rb

@@ -2,27 +2,17 @@
 
 module Goldiloader
   module Compatibility
-    ACTIVE_RECORD_VERSION = ::Gem::Version.new(::ActiveRecord::VERSION::STRING)
+    ACTIVE_RECORD_VERSION = ::Gem::Version.new(::ActiveRecord::VERSION::STRING).release
+    PRE_RAILS_6_2 = ACTIVE_RECORD_VERSION < ::Gem::Version.new('6.2.0')
     RAILS_5_2_0 = ACTIVE_RECORD_VERSION == ::Gem::Version.new('5.2.0')
-    FROM_EAGER_LOADABLE = ACTIVE_RECORD_VERSION >= ::Gem::Version.new('5.1.5') ||
-      (ACTIVE_RECORD_VERSION >= ::Gem::Version.new('5.0.7') && ACTIVE_RECORD_VERSION < ::Gem::Version.new('5.1.0'))
-    GROUP_EAGER_LOADABLE = FROM_EAGER_LOADABLE
 
-    def self.rails_4?
-      ::ActiveRecord::VERSION::MAJOR == 4
+    def self.pre_rails_6_2?
+      PRE_RAILS_6_2
     end
 
     # See https://github.com/rails/rails/pull/32375
     def self.destroyed_model_associations_eager_loadable?
       !RAILS_5_2_0
     end
-
-    def self.from_eager_loadable?
-      FROM_EAGER_LOADABLE
-    end
-
-    def self.group_eager_loadable?
-      GROUP_EAGER_LOADABLE
-    end
   end
 end

data/lib/goldiloader/scope_info.rb

@@ -21,11 +21,7 @@ module Goldiloader
     end
 
     def from?
-      if Goldiloader::Compatibility.rails_4?
-        scope.from_value.present?
-      else
-        scope.from_clause.present?
-      end
+      scope.from_clause.present?
     end
 
     def group?

data/lib/goldiloader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Goldiloader
-  VERSION = '3.2.0'
+  VERSION = '4.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldiloader
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.1.1
 platform: ruby
 authors:
 - Joel Turkel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.3'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -166,16 +166,16 @@ dependencies:
   name: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1.1
+        version: 1.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1.1
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -236,14 +236,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Automatic Rails association eager loading