goldiloader 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cea2be18413e1cc1e5d2dc0a325a808f64165a52
-  data.tar.gz: b9ea0538d9894df028174a7e081acd5b96b4455b
+SHA256:
+  metadata.gz: 2b1702016efdeb47b12f583ff299bc46125714acc053b7c8594a9cf9a4fcba07
+  data.tar.gz: 6485555c4d71199683907813d9563fdecce3c8bada819d7ae1180f48ad5afadb
 SHA512:
-  metadata.gz: 28df2ae2eed0bc12cd4d29458aebbc16cf5f667d2950d8b113bf92859447b75a2380d83abf59ef1b36ec0d707fe3954ef25d12b642b69502850d142aa590607e
-  data.tar.gz: 1ebb5abe80281c1a76fc3b3dd8eed50367ccde1dce353493d90d7da468750e436c4d273e39e1d1388800d31ba2676e4729fbc37ee271e063267a83b6612c96c5
+  metadata.gz: 949fc36b600662dde9597b87c26430949bbdc12dff2d2eb9845405dcb273c2c9621edbb8d850f95dd602c892687dffc95849243bbd94c4e3473c31932f48464a
+  data.tar.gz: 5d645a33f703ad458096af205535efcd5cebb2ab802ae0af8203cc6236f388a73d79ec0c08681c447dbbe4b057a29a0bd373c001ce277dd34285447614f138a8

data/lib/goldiloader.rb

@@ -4,7 +4,7 @@ require 'active_support/all'
 require 'active_record'
 require 'goldiloader/compatibility'
 require 'goldiloader/auto_include_context'
-require 'goldiloader/association_info'
+require 'goldiloader/scope_info'
 require 'goldiloader/association_options'
 require 'goldiloader/association_loader'
 require 'goldiloader/active_record_patches'

data/lib/goldiloader/active_record_patches.rb

@@ -47,21 +47,12 @@ module Goldiloader
     end
 
     def auto_include_value
-      # Note: Don't use get_value because that doesn't work properly with defaulting boolean values
       @values.fetch(:auto_include, true)
     end
 
     def auto_include_value=(value)
-      if Goldiloader::Compatibility.rails_4?
-        raise ::ActiveRecord::Relation::ImmutableRelation if @loaded
-        check_cached_relation
-        @values[:auto_include] = value
-      elsif Goldiloader::Compatibility.rails_5_0?
-        assert_mutability!
-        @values[:auto_include] = value
-      else
-        set_value(:auto_include, value)
-      end
+      assert_mutability!
+      @values[:auto_include] = value
     end
   end
   ::ActiveRecord::Relation.prepend(::Goldiloader::RelationPatch)
@@ -76,6 +67,29 @@ module Goldiloader
   end
   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 = Goldiloader::ScopeInfo.new(scope_for(klass.unscoped))
+                          scope_info.auto_include? &&
+                            !scope_info.limit? &&
+                            !scope_info.offset? &&
+                            (!has_one? || !scope_info.order?)
+                        end
+    end
+  end
+  ActiveRecord::Reflection::AssociationReflection.include(::Goldiloader::AssociationReflectionPatch)
+  ActiveRecord::Reflection::ThroughReflection.include(::Goldiloader::AssociationReflectionPatch)
+
   module AssociationPatch
     extend ActiveSupport::Concern
 
@@ -97,25 +111,26 @@ module Goldiloader
     private
 
     def eager_loadable?
-      association_info = Goldiloader::AssociationInfo.new(self)
-      association_info.auto_include? &&
-        !association_info.limit? &&
-        !association_info.offset? &&
-        (!association_info.has_one? || !association_info.order?) &&
-        (::Goldiloader::Compatibility.group_eager_loadable? || !association_info.group?) &&
-        (::Goldiloader::Compatibility.from_eager_loadable? || !association_info.from?) &&
-        (::Goldiloader::Compatibility.destroyed_model_associations_eager_loadable? || !owner.destroyed?) &&
-        !association_info.instance_dependent?
+      reflection.eager_loadable? &&
+        (::Goldiloader::Compatibility.destroyed_model_associations_eager_loadable? || !owner.destroyed?)
     end
 
     def load_with_auto_include
       if loaded? && !stale_target?
         target
-      elsif auto_include?
+      elsif !auto_include?
+        yield
+      elsif owner.auto_include_context.size == 1
+        # Bypassing the preloader for a single model reduces object allocations by ~5% in benchmarks
+        result = yield
+        # As of https://github.com/rails/rails/commit/bd3b28f7f181dce53e872daa23dda101498b8fb4
+        # ActiveRecord does not use ActiveRecord::Relation#exec_queries to resolve association
+        # queries
+        Goldiloader::AutoIncludeContext.register_models(result)
+        result
+      else
         Goldiloader::AssociationLoader.load(owner, reflection.name)
         target
-      else
-        yield
       end
     end
   end
@@ -132,12 +147,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)
@@ -148,10 +158,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,17 +15,11 @@ module Goldiloader
     private
 
     def eager_load(models, association_name)
-      ::ActiveRecord::Associations::Preloader.new.preload(models, [association_name])
-    end
-
-    def first_model_with_association(models, association_name)
-      models.find { |model| has_association?(model, association_name) }
-    end
-
-    def associated_models(models, association_name)
-      # We can't just do model.send(association_name) because the association method may have been
-      # overridden
-      models.map { |model| model.association(association_name).target }.flatten.compact.uniq
+      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 ::ActiveRecord::VERSION::MAJOR >= 5
-        ActiveRecord::Associations::Builder::Association.extensions << AssociationBuilderExtension
-      else
-        ActiveRecord::Associations::Builder::Association.valid_options.concat(OPTIONS)
-      end
+      ActiveRecord::Associations::Builder::Association.extensions << AssociationBuilderExtension
     end
   end
 end

data/lib/goldiloader/auto_include_context.rb

@@ -4,6 +4,8 @@ module Goldiloader
   class AutoIncludeContext
     attr_reader :models
 
+    delegate :size, to: :models
+
     def initialize
       @models = []
     end

data/lib/goldiloader/compatibility.rb

@@ -2,34 +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')
-    PRE_RAILS_5_2 = ACTIVE_RECORD_VERSION < ::Gem::Version.new('5.2.0')
-    POST_RAILS_5_1_4 = ACTIVE_RECORD_VERSION > ::Gem::Version.new('5.1.5')
-    PRE_RAILS_5_1_5 = ACTIVE_RECORD_VERSION < ::Gem::Version.new('5.1.5')
-    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
-    end
-
-    def self.rails_5_0?
-      ::ActiveRecord::VERSION::MAJOR == 5 && ::ActiveRecord::VERSION::MINOR == 0
+    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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Goldiloader
+  class ScopeInfo
+    attr_reader :scope
+
+    def initialize(scope)
+      @scope = scope
+    end
+
+    def offset?
+      scope.offset_value.present?
+    end
+
+    def limit?
+      scope.limit_value.present?
+    end
+
+    def auto_include?
+      scope.auto_include_value
+    end
+
+    def from?
+      scope.from_clause.present?
+    end
+
+    def group?
+      scope.group_values.present?
+    end
+
+    def order?
+      scope.order_values.present?
+    end
+  end
+end

data/lib/goldiloader/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldiloader
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Joel Turkel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-05 00:00:00.000000000 Z
+date: 2021-02-08 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: '5.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: '5.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: '5.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: '5.3'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -65,7 +65,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -78,6 +78,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -134,20 +148,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   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
@@ -166,16 +194,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 description: Automatically eager loads Rails associations as associations are traversed
 email:
 - jturkel@salsify.com
@@ -186,11 +214,11 @@ files:
 - LICENSE.txt
 - lib/goldiloader.rb
 - lib/goldiloader/active_record_patches.rb
-- lib/goldiloader/association_info.rb
 - lib/goldiloader/association_loader.rb
 - lib/goldiloader/association_options.rb
 - lib/goldiloader/auto_include_context.rb
 - lib/goldiloader/compatibility.rb
+- lib/goldiloader/scope_info.rb
 - lib/goldiloader/version.rb
 homepage: https://github.com/salsify/goldiloader
 licenses:
@@ -200,7 +228,7 @@ metadata:
   changelog_uri: https://github.com/salsify/goldiloader/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/salsify/goldiloader/
   bug_tracker_uri: https://github.com/salsify/goldiloader/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -208,16 +236,15 @@ 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: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Automatic Rails association eager loading
 test_files: []

data/lib/goldiloader/association_info.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Goldiloader
-  class AssociationInfo
-
-    def initialize(association)
-      @association = association
-    end
-
-    delegate :association_scope, :reflection, to: :@association
-
-    def has_one? # rubocop:disable Naming/PredicateName
-      reflection.has_one?
-    end
-
-    def offset?
-      association_scope && association_scope.offset_value.present?
-    end
-
-    def limit?
-      association_scope && association_scope.limit_value.present?
-    end
-
-    def auto_include?
-      association_scope.nil? || association_scope.auto_include_value
-    end
-
-    def from?
-      if ActiveRecord::VERSION::MAJOR >= 5
-        association_scope && association_scope.from_clause.present?
-      else
-        association_scope && association_scope.from_value.present?
-      end
-    end
-
-    def group?
-      association_scope && association_scope.group_values.present?
-    end
-
-    def order?
-      association_scope && association_scope.order_values.present?
-    end
-
-    def instance_dependent?
-      reflection.scope.present? && reflection.scope.arity > 0
-    end
-  end
-end