goldiloader 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 856cc3b8807810dbf9e6b357bbc460d4c0bec3ac
-  data.tar.gz: b8cd9a6f87ffa7a9427dd089ad7fcab7580361da
+  metadata.gz: 3912274cc2f34e5dafb2a3b1d8ee8e3f6521885e
+  data.tar.gz: 72e93497e463d924c5c06c49df9d10cb7427170a
 SHA512:
-  metadata.gz: 020f3bb39360cf4253f738592bb06fc222d83c71d6a6b343ca7e4df36741bf937f6e5bd62d7faee8c83638a6b020e2f950176184b757ac0b11a0a88687057c17
-  data.tar.gz: 4d3f56fd3c361608314c2c057cf0cbb9620513db6ecbc0595ac9e8f95a72a115c04339f678877c83142ed278d52f03a503a66ff651958deb39bfe038d1fe44cf
+  metadata.gz: 80396bbcaddfe170d4fd0db9a199839ef07c65d4fbfe8947de40dd31ab0500c86db372c11b105f3efaa980506402582af656da202088d7cd559c1f2d0dc10521
+  data.tar.gz: 060d399492cbbcd68cdb053fbc08c91781826404678e694287768d770c42736b39e5ad8e06cbad4600c0b2262fee4af4df469232fd973b6ccadb562c969d34ec

data/CHANGELOG.md

@@ -1,11 +1,24 @@
 # Changelog
 
+### 0.0.5
+
+* Fix ActiveRecord and ActiveSupport dependencies to work with versions greater than 4.1.0. Thanks for the pull
+  requests [Alexey Volodkin](https://github.com/miraks) and [Philip Claren](https://github.com/DerKobe).
+* Workaround [issue 13](https://github.com/salsify/goldiloader/issues/13) by not auto-eager loading associations
+  that use `unscope`. This workaround will be removed when the underlying 
+  [bug 11036](https://github.com/rails/rails/issues/11036) in the Rails eager loader is fixed.
+* Workaround [issue 11](https://github.com/salsify/goldiloader/issues/11) by not auto-eager loading associations
+  that use `joins`. This workaround will be removed when the underlying 
+  [bug 11518](https://github.com/rails/rails/pull/11518) in the Rails eager loader is fixed.
+* Fix [issue 15](https://github.com/salsify/goldiloader/issues/15) - Don't auto eager load associations 
+  with finder_sql in Rails 4.0. Previously this was only done for Rails 3.2.
+
 ### 0.0.4
  
-* Fix [issue 3](https://github.com/salsify/goldiloader/issues/3) - `exists?` method should take an argument 
-  — thanks for reporting [Bert Goethals](https://github.com/Bertg)
+* Fix [issue 3](https://github.com/salsify/goldiloader/issues/3) - `exists?` method should take an argument. 
+  Thanks for reporting [Bert Goethals](https://github.com/Bertg)
 * Fix [issue 4](https://github.com/salsify/goldiloader/issues/4) - Associations couldn't be loaded in after 
-  destroy callbacks — thanks for reporting [Bert Goethals](https://github.com/Bertg)
+  destroy callbacks. Thanks for reporting [Bert Goethals](https://github.com/Bertg)
 * Fix [issue 6](https://github.com/salsify/goldiloader/issues/6) - Models in read only associations weren't
   being marked as read only
 * Fix [issue 7](https://github.com/salsify/goldiloader/issues/7) - Don't attempt to eager load associations that

data/goldiloader.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = Dir.glob('spec/**/*')
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', ENV.fetch('RAILS_VERSION', ['>= 3.2', '<= 4.1'])
-  spec.add_dependency 'activesupport', ENV.fetch('RAILS_VERSION', ['>= 3.2', '<= 4.1'])
+  spec.add_dependency 'activerecord', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 4.2'])
+  spec.add_dependency 'activesupport', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 4.2'])
 
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'database_cleaner', '>= 1.2'

data/lib/goldiloader.rb

@@ -2,9 +2,9 @@
 
 require 'active_support/all'
 require 'active_record'
+require 'goldiloader/compatibility'
 require 'goldiloader/auto_include_context'
 require 'goldiloader/association_info'
 require 'goldiloader/association_options'
 require 'goldiloader/association_loader'
-require 'goldiloader/model_registry'
 require 'goldiloader/active_record_patches'

data/lib/goldiloader/active_record_patches.rb

@@ -14,7 +14,12 @@ module Goldiloader
     end
 
     def auto_include_context
-      @auto_include_context ||= Goldiloader::AutoIncludeContext.create_empty.register_model(self)
+      @auto_include_context ||= Goldiloader::AutoIncludeContext.new.register_model(self)
+    end
+
+    def reload(*)
+      @auto_include_context = nil
+      super
     end
   end
 end
@@ -28,7 +33,7 @@ ActiveRecord::Relation.class_eval do
 
     models = exec_queries_without_auto_include
     # Add all loaded models to the same AutoIncludeContext
-    auto_include_context = Goldiloader::AutoIncludeContext.create_empty
+    auto_include_context = Goldiloader::AutoIncludeContext.new
     auto_include_context.register_models(models)
     models
   end
@@ -52,27 +57,26 @@ ActiveRecord::Associations::Association.class_eval do
     !loaded? && options.fetch(:fully_load) { self.class.default_fully_load }
   end
 
-  def auto_include_context
-    @auto_include_context ||= Goldiloader::AutoIncludeContext.new(owner.auto_include_context.model_registry,
-                                                                  owner.auto_include_context.association_path + [reflection.name])
-  end
+  private
 
   def eager_loadable?
     association_info = Goldiloader::AssociationInfo.new(self)
     !association_info.limit? &&
         !association_info.offset? &&
         !association_info.group? &&
-        !association_info.from?
+        !association_info.from? &&
+        !association_info.finder_sql? &&
+        # Joins not properly eager loaded - See https://github.com/salsify/goldiloader/issues/11
+        !association_info.joins? &&
+        # Unscope not properly eager loaded - https://github.com/salsify/goldiloader/issues/13
+        !association_info.unscope?
   end
 
-  private
-
   def load_with_auto_include(load_method, *args)
     if loaded? && !stale_target?
       target
     elsif auto_include?
-      Goldiloader::AssociationLoader.load(auto_include_context.model_registry, owner,
-                                          auto_include_context.association_path)
+      Goldiloader::AssociationLoader.load(owner, reflection.name)
       target
     else
       send("#{load_method}_without_auto_include", *args)

data/lib/goldiloader/association_info.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 module Goldiloader
   class AssociationInfo
 
@@ -5,6 +7,16 @@ module Goldiloader
       @association = association
     end
 
+    def unscope?
+      Goldiloader::Compatibility.unscope_query_method_enabled? &&
+        @association.association_scope.unscope_values.present?
+    end
+
+    def finder_sql?
+      Goldiloader::Compatibility.association_finder_sql_enabled? &&
+        @association.options[:finder_sql].present?
+    end
+
     if ActiveRecord::VERSION::MAJOR >= 4
       def read_only?
         @association.association_scope.readonly_value.present?
@@ -25,6 +37,23 @@ module Goldiloader
       def group?
         @association.association_scope.group_values.present?
       end
+
+      def joins?
+        # Yuck - Through associations will always have a join for *each* 'through' table
+        (@association.association_scope.joins_values.size - num_through_joins) > 0
+      end
+
+      private
+
+      def num_through_joins
+        association = @association
+        count = 0
+        while association.is_a?(ActiveRecord::Associations::ThroughAssociation)
+          count += 1
+          association = association.owner.association(association.through_reflection.name)
+        end
+        count
+      end
     else
       def read_only?
         @association.options[:readonly].present?
@@ -39,12 +68,17 @@ module Goldiloader
       end
 
       def from?
-        @association.options[:finder_sql].present?
+        false
       end
 
       def group?
         @association.options[:group].present?
       end
+
+      def joins?
+        # Rails 3 didn't support joins for associations
+        false
+      end
     end
 
   end

data/lib/goldiloader/association_loader.rb

@@ -4,19 +4,18 @@ module Goldiloader
   module AssociationLoader
     extend self
 
-    def load(model_registry, model, association_path)
-      *model_path, association_name = *association_path
-      models = model_registry.peers(model, model_path).select do |peer|
+    def load(model, association_name)
+      models = model.auto_include_context.models.select do |peer|
         load?(peer, association_name)
       end
 
       eager_load(models, association_name)
 
-      associated_models = associated_models(models, association_name)
       # Workaround Rails #15853 by setting models read only
-      mark_read_only(associated_models) if read_only?(models, association_name)
-      auto_include_context = Goldiloader::AutoIncludeContext.new(model_registry, association_path)
-      auto_include_context.register_models(associated_models)
+      if read_only?(models, association_name)
+        associated_models = associated_models(models, association_name)
+        mark_read_only(associated_models)
+      end
     end
 
     private

data/lib/goldiloader/auto_include_context.rb

@@ -1,15 +1,17 @@
 # encoding: UTF-8
 
 module Goldiloader
-  class AutoIncludeContext < Struct.new(:model_registry, :association_path)
-    def self.create_empty
-      Goldiloader::AutoIncludeContext.new(Goldiloader::ModelRegistry.new, [])
+  class AutoIncludeContext
+    attr_reader :models
+
+    def initialize
+      @models = []
     end
 
     def register_models(models)
       Array.wrap(models).each do |model|
         model.auto_include_context = self
-        model_registry.register(model, association_path)
+        self.models << model
       end
       self
     end

data/lib/goldiloader/compatibility.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+module Goldiloader
+  module Compatibility
+
+    def self.mass_assignment_security_enabled?
+      ::ActiveRecord::VERSION::MAJOR < 4 || defined?(::ActiveRecord::MassAssignmentSecurity)
+    end
+
+    def self.association_finder_sql_enabled?
+      ::Gem::Version.new(::ActiveRecord::VERSION::STRING) < ::Gem::Version.new('4.1')
+    end
+
+    def self.unscope_query_method_enabled?
+      ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new('4.1')
+    end
+  end
+end

data/lib/goldiloader/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Goldiloader
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/db/schema.rb

@@ -67,17 +67,27 @@ class Blog < ActiveRecord::Base
     has_many :grouped_posts, -> { group(:blog_id) }, class_name: 'Post'
     has_many :offset_posts, -> { offset(2) }, class_name: 'Post'
     has_many :from_posts, -> { from('(select distinct blog_id from posts) as posts') }, class_name: 'Post'
+
+    has_many :posts_ordered_by_author, -> { joins(:author).order('users.name') }, class_name: 'Post'
+
+    has_many :authors_with_join, -> { joins(:address).order('addresses.city') }, through: :posts, source: :author
   else
     has_many :read_only_posts, readonly: true, class_name: 'Post'
     has_many :limited_posts, limit: 2, class_name: 'Post'
     has_many :grouped_posts, group: :blog_id, class_name: 'Post'
     has_many :offset_posts, offset: 2, class_name: 'Post'
-    has_many :from_posts, finder_sql: Proc.new { "select distinct blog_id from posts where blog_id = #{self.id}" },
+
+    has_many :posts_ordered_by_author, include: :author, order: 'users.name', class_name: 'Post'
+  end
+
+  if Goldiloader::Compatibility.association_finder_sql_enabled?
+    has_many :finder_sql_posts, finder_sql: Proc.new { "select distinct blog_id from posts where blog_id = #{self.id}" },
              class_name: 'Post'
   end
 
   has_many :posts_overridden, class_name: 'Post'
   has_many :authors, through: :posts
+  has_many :addresses, through: :authors
 
   if Goldiloader::Compatibility.mass_assignment_security_enabled?
     attr_accessible :name
@@ -118,6 +128,10 @@ class User < ActiveRecord::Base
   has_one :address
   has_one :address_without_auto_include, auto_include: false, class_name: 'Address'
 
+  if Goldiloader::Compatibility.unscope_query_method_enabled?
+    has_one :scoped_address_with_default_scope_remove, -> { unscope(where: :city) }, class_name: 'ScopedAddress'
+  end
+
   if Goldiloader::Compatibility.mass_assignment_security_enabled?
     attr_accessible :name
   end
@@ -131,6 +145,16 @@ class Address < ActiveRecord::Base
   end
 end
 
+class ScopedAddress < ActiveRecord::Base
+  self.table_name = 'addresses'
+  default_scope { where(city: ['Philadelphia'])}
+  belongs_to :user
+
+  if Goldiloader::Compatibility.mass_assignment_security_enabled?
+    attr_accessible :city
+  end
+end
+
 class Group < ActiveRecord::Base
   has_many :tags, as: :owner
 

data/spec/goldiloader/goldiloader_spec.rb

@@ -150,6 +150,19 @@ describe Goldiloader do
     expect(User).to have_received(:find_by_sql).once
   end
 
+  it "auto eager loads nested has_many through associations" do
+    blogs = Blog.order(:name).to_a
+    blogs.first.addresses.to_a
+
+    blogs.each do |blog|
+      expect(blog.association(:addresses)).to be_loaded
+    end
+
+    expect(blogs.first.addresses).to match_array([author1, author2].map(&:address))
+    expect(blogs.second.addresses).to match_array([author3, author1].map(&:address))
+    expect(Address).to have_received(:find_by_sql).once
+  end
+
   it "auto eager loads associations when the model is loaded via find" do
     blog = Blog.find(blog1.id)
     blog.posts.to_a.first.author
@@ -235,8 +248,8 @@ describe Goldiloader do
     let(:blogs) { Blog.order(:name).to_a }
 
     before do
-      blog1.posts.create!(title: 'blog1-post3')
-      blog2.posts.create!(title: 'blog2-post3')
+      blog1.posts.create!(title: 'blog1-post3', author: author1)
+      blog2.posts.create!(title: 'blog2-post3', author: author1)
     end
 
     shared_examples "it doesn't auto eager the association" do |association_name|
@@ -283,16 +296,81 @@ describe Goldiloader do
       it_behaves_like "it doesn't auto eager the association", :offset_posts
     end
 
-    context "associations with an overridden from" do
-      before do
-        blogs.first.from_posts.to_a
+    if ActiveRecord::VERSION::MAJOR >= 4
+      context "associations with an overridden from" do
+        before do
+          blogs.first.from_posts.to_a
+        end
+
+        it "applies the from correctly" do
+          expect(blogs.first.from_posts.to_a.size).to eq 1
+        end
+
+        it_behaves_like "it doesn't auto eager the association", :from_posts
       end
+    end
+
+    if Goldiloader::Compatibility.association_finder_sql_enabled?
+      context "associations with finder_sql" do
+        before do
+          blogs.first.finder_sql_posts.to_a
+        end
+
+        it "applies the finder_sql correctly" do
+          expect(blogs.first.finder_sql_posts.to_a.size).to eq 1
+        end
 
-      it "applies the from correctly" do
-        expect(blogs.first.from_posts.to_a.size).to eq 1
+        it_behaves_like "it doesn't auto eager the association", :finder_sql_posts
       end
+    end
 
-      it_behaves_like "it doesn't auto eager the association", :from_posts
+    if ActiveRecord::VERSION::MAJOR >= 4
+      context "associations with a join" do
+        before do
+          blogs.first.posts_ordered_by_author.to_a
+        end
+
+        it "applies the join correctly" do
+          expect(blogs.first.posts_ordered_by_author.to_a.size).to eq 3
+        end
+
+        it_behaves_like "it doesn't auto eager the association", :posts_ordered_by_author
+      end
+
+      context "associations with a join in a has_many_through" do
+        before do
+          blogs.first.authors_with_join.to_a
+        end
+
+        it "applies the join correctly" do
+          expect(blogs.first.authors_with_join.to_a.size).to eq 3
+        end
+
+        it_behaves_like "it doesn't auto eager the association", :authors_with_join
+      end
+    end
+
+    if Goldiloader::Compatibility.unscope_query_method_enabled?
+      context "associations with an unscoped" do
+        let(:authors) { User.order(:id).to_a }
+
+        before do
+          author1.address.update_attributes!(city: 'Boston')
+          author2.address.update_attributes!(city: 'Philadelphia')
+          author3.address.update_attributes!(city: 'Philadelphia')
+          authors.first.scoped_address_with_default_scope_remove
+        end
+
+        it "applies the unscope correctly" do
+          expect(authors.first.scoped_address_with_default_scope_remove).to be_present
+        end
+
+        it "doesn't auto eager the association" do
+          authors.drop(1).each do |author|
+            expect(author.association(:scoped_address_with_default_scope_remove)).to_not be_loaded
+          end
+        end
+      end
     end
   end
 

data/spec/spec_helper.rb

@@ -16,9 +16,6 @@ require 'database_cleaner'
 require 'goldiloader'
 require 'yaml'
 
-spec_dir = File.dirname(__FILE__)
-Dir["#{spec_dir}/support/**/*.rb"].sort.each { |f| require f }
-
 FileUtils.makedirs('log')
 
 ActiveRecord::Base.logger = Logger.new('log/test.log')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: goldiloader
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Joel Turkel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,9 +47,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -156,13 +156,12 @@ files:
 - lib/goldiloader/association_loader.rb
 - lib/goldiloader/association_options.rb
 - lib/goldiloader/auto_include_context.rb
-- lib/goldiloader/model_registry.rb
+- lib/goldiloader/compatibility.rb
 - lib/goldiloader/version.rb
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/goldiloader/goldiloader_spec.rb
 - spec/spec_helper.rb
-- spec/support/compatibility.rb
 homepage: https://github.com/salsify/goldiloader
 licenses:
 - MIT
@@ -192,4 +191,3 @@ test_files:
 - spec/db/schema.rb
 - spec/goldiloader/goldiloader_spec.rb
 - spec/spec_helper.rb
-- spec/support/compatibility.rb

data/lib/goldiloader/model_registry.rb

@@ -1,26 +0,0 @@
-# encoding: UTF-8
-
-module Goldiloader
-  class ModelRegistry
-    def initialize
-      @registry = {}
-    end
-
-    def register(record, association_path)
-      key = registry_key(record, association_path)
-      @registry[key] ||= []
-      @registry[key] << record
-    end
-
-    # Returns all models with the same base class loaded from the same association path
-    def peers(record, association_path)
-      @registry.fetch(registry_key(record, association_path), [])
-    end
-
-    private
-
-    def registry_key(record, association_path)
-      [record.class.base_class, association_path]
-    end
-  end
-end

data/spec/support/compatibility.rb

@@ -1,14 +0,0 @@
-# encoding: UTF-8
-
-require 'active_support/version'
-require 'active_record/version'
-
-module Goldiloader
-  module Compatibility
-
-    def self.mass_assignment_security_enabled?
-      ::ActiveRecord::VERSION::MAJOR < 4 || defined?(::ActiveRecord::MassAssignmentSecurity)
-    end
-
-  end
-end