goldiloader 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5439cf46ad38cb53ae77b4b82480215d59ef665b
-  data.tar.gz: ef928602e0934eb6a372fb0476e9f807af0c4713
+  metadata.gz: 1fcd566afe07738acd5ebf7a634c40c310314ba3
+  data.tar.gz: d7db565dac03de0ef17bd44f372a0b861c9663c0
 SHA512:
-  metadata.gz: 6f621c060cec10acadf3beca30afbc80442b22734873acb32c3430451f0b83a0d137760ad908ac56f6e74abde5bfad02ba9d994b4e5aa9b4c2425e29f8a905ce
-  data.tar.gz: 43e6573c8978dd21fced0f8848421a2ec2eaeeffdebda8b88625557477044a6a03deed854fcdedfdeaef8b3c978c5565aa597f37e0367485cb3de29c7e6639fe
+  metadata.gz: eeae5d642ddd6e2b7a613045f328b92c327840ff4f7f061ab4c6a51647d0c2a47d999016628b0141b4943759b9185c623df9f41f97011d2b7033774130db504a
+  data.tar.gz: e9afd2b2bb91fdcfd821ce2701f1af6e13a0eea244b384f67179fc90ffb53eb8897aa0806941943bf110f02fe85c07bd083926c715297952fdef6054b7f2128d

data/.gitignore

@@ -18,3 +18,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version

data/.travis.yml

@@ -1,20 +1,28 @@
 language: ruby
+sudo: false
 env:
-  - RAILS_VERSION="~> 3.2.21" JRUBY_OPTS="$JRUBY_OPTS --debug"
+  - RAILS_VERSION="~> 3.2.22" JRUBY_OPTS="$JRUBY_OPTS --debug"
   - RAILS_VERSION="~> 4.0.13" JRUBY_OPTS="$JRUBY_OPTS --debug"
-  - RAILS_VERSION="~> 4.1.9" JRUBY_OPTS="$JRUBY_OPTS --debug"
-  - RAILS_VERSION="~> 4.2.0" JRUBY_OPTS="$JRUBY_OPTS --debug"
+  - RAILS_VERSION="~> 4.1.14" JRUBY_OPTS="$JRUBY_OPTS --debug"
+  - RAILS_VERSION="~> 4.2.5" JRUBY_OPTS="$JRUBY_OPTS --debug"
+  - RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
+  - 2.1.6
+  - 2.2.2
+  - 2.3.0
   - jruby-19mode
+  - jruby-9.0.5.0
 matrix:
   exclude:
-    # See https://github.com/salsify/goldiloader/issues/22
+    - rvm: 1.9.3
+      env: RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: 2.0.0
+      env: RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: 2.1.6
+      env: RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"
     - rvm: jruby-19mode
-      env: RAILS_VERSION="~> 4.2.0" JRUBY_OPTS="$JRUBY_OPTS --debug"
-    # See https://github.com/rails/rails/pull/18306
-    - rvm: 2.2.0
-      env: RAILS_VERSION="~> 3.2.21" JRUBY_OPTS="$JRUBY_OPTS --debug"
+      env: RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-9.0.5.0
+      env: RAILS_VERSION="~> 5.0.0.beta3" JRUBY_OPTS="$JRUBY_OPTS --debug"

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+### 0.0.10 (unreleased)
+* Fix [issue 13](https://github.com/salsify/goldiloader/issues/13) - Eager load associations with unscope
+  in Rails 4.1.9+ now that the underlying Rails bug has been fixed.
+* Fix [issue 11](https://github.com/salsify/goldiloader/issues/11) - Eager load associations with joins in 
+  Rails 4.2+ now that the underlying Rails bug has been fixed.
+* Initial support for Rails 5. There are no known issues but see 
+  [issue 27](https://github.com/salsify/goldiloader/issues/27) for remaining tasks.
+* MRI 2.3.0 support.
+
 ### 0.0.9
 * Merge [pull request](https://github.com/salsify/goldiloader/pull/24) - Optimization: Cache compatibility
   checks. **Thanks Jonathan Calvert!**

data/README.md

@@ -162,15 +162,14 @@ Associations with any of the following options cannot be eager loaded:
 * `finder_sql`
 * `group` (due to a Rails bug)
 * `from` (due to a Rails bug)
-* `unscope` (due to a Rails bug)
-* `joins` (due to a Rails bug)
+* `joins` (only Rails 4.0/4.1 - due to a Rails bug)
 * `uniq` (only Rails 3.2 - due to a Rails bug)
 
 Goldiloader detects associations with any of these options and disables automatic eager loading on them.
 
 ## Status
 
-This gem is tested with Rails 3.2, 4.0, 4.1, and 4.2 using MRI 1.9.3, 2.0.0, 2.1.0 and JRuby in 1.9 mode. 
+This gem is tested with Rails 3.2, 4.0, 4.1, 4.2, and 5.0 using MRI 1.9.3, 2.0, 2.1, 2.2, 2.3, JRuby 1.7 in 1.9 mode, and JRuby 9000. 
 
 Let us know if you find any issues or have any other feedback. 
 

data/goldiloader.gemspec

@@ -17,14 +17,16 @@ 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.3'])
-  spec.add_dependency 'activesupport', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 4.3'])
+  spec.add_dependency 'activerecord', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 5.1'])
+  spec.add_dependency 'activesupport', ENV.fetch('RAILS_VERSION', ['>= 3.2', '< 5.1'])
 
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'database_cleaner', '>= 1.2'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2'
   spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  # mime-type 3 requires Ruby >= 2.0
+  spec.add_development_dependency 'mime-types', '~> 2'
 
   if RUBY_PLATFORM == 'java'
     spec.add_development_dependency 'jdbc-sqlite3'

data/lib/goldiloader/active_record_patches.rb

@@ -36,7 +36,7 @@ ActiveRecord::Relation.class_eval do
     models
   end
 
-  alias_method_chain :exec_queries, :auto_include
+  Goldiloader::Compatibility.alias_method_chain self, :exec_queries, :auto_include
 end
 
 ActiveRecord::Associations::Association.class_eval do
@@ -64,10 +64,8 @@ ActiveRecord::Associations::Association.class_eval do
         !association_info.group? &&
         !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 - See https://github.com/salsify/goldiloader/issues/13
-        !association_info.unscope? &&
+        (Goldiloader::Compatibility.unscoped_eager_loadable? || !association_info.unscope?) &&
+        (Goldiloader::Compatibility.joins_eager_loadable? || !association_info.joins?) &&
         !association_info.instance_dependent?
   end
 
@@ -92,7 +90,7 @@ ActiveRecord::Associations::SingularAssociation.class_eval do
     load_with_auto_include(:find_target, *args)
   end
 
-  alias_method_chain :find_target, :auto_include
+  Goldiloader::Compatibility.alias_method_chain self, :find_target, :auto_include
 end
 
 ActiveRecord::Associations::CollectionAssociation.class_eval do
@@ -107,7 +105,7 @@ ActiveRecord::Associations::CollectionAssociation.class_eval do
       send("#{aliased_target}_without_fully_load#{punctuation}", *args, &block)
     end
 
-    alias_method_chain method, :fully_load
+    Goldiloader::Compatibility.alias_method_chain self, method, :fully_load
   end
 
   private
@@ -116,7 +114,7 @@ ActiveRecord::Associations::CollectionAssociation.class_eval do
     load_with_auto_include(:load_target, *args)
   end
 
-  alias_method_chain :load_target, :auto_include
+  Goldiloader::Compatibility.alias_method_chain self, :load_target, :auto_include
 
 end
 

data/lib/goldiloader/association_info.rb

@@ -28,7 +28,11 @@ module Goldiloader
       end
 
       def from?
-        association_scope && association_scope.from_value.present?
+        if ActiveRecord::VERSION::MAJOR >= 5
+          association_scope && association_scope.from_clause.present?
+        else
+          association_scope && association_scope.from_value.present?
+        end
       end
 
       def group?
@@ -36,8 +40,14 @@ module Goldiloader
       end
 
       def joins?
+        return false unless association_scope
+
+        num_joins = association_scope.joins_values.size
+        if ActiveRecord::VERSION::MAJOR >= 5
+          num_joins += association_scope.left_joins_values.size + association_scope.left_outer_joins.size
+        end
         # Yuck - Through associations will always have a join for *each* 'through' table
-        association_scope && (association_scope.joins_values.size - num_through_joins) > 0
+        num_joins - num_through_joins > 0
       end
 
       def uniq?

data/lib/goldiloader/association_options.rb

@@ -4,10 +4,23 @@ module Goldiloader
   module AssociationOptions
     extend self
 
-    OPTIONS = [:auto_include, :fully_load]
+    OPTIONS = [:auto_include, :fully_load].freeze
+
+    # This is only used in Rails 5+
+    module AssociationBuilderExtension
+      def self.build(model, reflection)
+        # We have no callbacks to register
+      end
+
+      def self.valid_options
+        OPTIONS
+      end
+    end
 
     def register
-      if ::ActiveRecord::VERSION::MAJOR >= 4
+      if ::ActiveRecord::VERSION::MAJOR >= 5
+        ActiveRecord::Associations::Builder::Association.extensions << AssociationBuilderExtension
+      elsif ::ActiveRecord::VERSION::MAJOR >= 4
         ActiveRecord::Associations::Builder::Association.valid_options.concat(OPTIONS)
       else
         # Each subclass of CollectionAssociation will have its own copy of valid_options so we need

data/lib/goldiloader/compatibility.rb

@@ -3,9 +3,12 @@
 module Goldiloader
   module Compatibility
 
-    MASS_ASSIGNMENT_SECURITY = ::ActiveRecord::VERSION::MAJOR < 4 || defined?(::ActiveRecord::MassAssignmentSecurity)
-    ASSOCIATION_FINDER_SQL = ::Gem::Version.new(::ActiveRecord::VERSION::STRING) < ::Gem::Version.new('4.1')
-    UNSCOPE_QUERY_METHOD = ::Gem::Version.new(::ActiveRecord::VERSION::STRING) >= ::Gem::Version.new('4.1')
+    ACTIVE_RECORD_VERSION = ::Gem::Version.new(::ActiveRecord::VERSION::STRING)
+    MASS_ASSIGNMENT_SECURITY = ACTIVE_RECORD_VERSION < ::Gem::Version.new('4') || defined?(::ActiveRecord::MassAssignmentSecurity)
+    ASSOCIATION_FINDER_SQL = ACTIVE_RECORD_VERSION < ::Gem::Version.new('4.1')
+    UNSCOPE_QUERY_METHOD = ACTIVE_RECORD_VERSION >= ::Gem::Version.new('4.1')
+    JOINS_EAGER_LOADABLE = ACTIVE_RECORD_VERSION >= ::Gem::Version.new('4.2')
+    UNSCOPED_EAGER_LOADABLE = ACTIVE_RECORD_VERSION >= ::Gem::Version.new('4.1.9')
 
     def self.mass_assignment_security_enabled?
       MASS_ASSIGNMENT_SECURITY
@@ -18,5 +21,41 @@ module Goldiloader
     def self.unscope_query_method_enabled?
       UNSCOPE_QUERY_METHOD
     end
+
+    def self.joins_eager_loadable?
+      # Associations with joins were not eager loadable prior to Rails 4.2 due to
+      # https://github.com/rails/rails/pull/17678
+      JOINS_EAGER_LOADABLE
+    end
+
+    def self.unscoped_eager_loadable?
+      # Unscoped associations weren't properly eager loaded until after Rails 4.1.9.
+      # See https://github.com/rails/rails/issues/11036.
+      UNSCOPED_EAGER_LOADABLE
+    end
+
+    # Copied from Rails since it is deprecated in Rails 5.0. Switch to using
+    # Module#prepend when we drop Ruby 1.9 support.
+    def self.alias_method_chain(klass, target, feature)
+      # Strip out punctuation on predicates, bang or writer methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+
+      with_method = "#{aliased_target}_with_#{feature}#{punctuation}"
+      without_method = "#{aliased_target}_without_#{feature}#{punctuation}"
+
+      klass.send(:alias_method, without_method, target)
+      klass.send(:alias_method, target, with_method)
+
+      case
+      when klass.public_method_defined?(without_method)
+        klass.send(:public, target)
+      when klass.protected_method_defined?(without_method)
+        klass.send(:protected, target)
+      when klass.private_method_defined?(without_method)
+        klass.send(:private, target)
+      end
+    end
   end
 end

data/lib/goldiloader/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Goldiloader
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'.freeze
 end

data/spec/goldiloader/goldiloader_spec.rb

@@ -300,6 +300,14 @@ describe Goldiloader do
       end
     end
 
+    shared_examples "it auto eager loads the association" do |association_name|
+      specify do
+        blogs.drop(1).each do |blog|
+          expect(blog.association(association_name)).to be_loaded
+        end
+      end
+    end
+
     context "associations with a limit" do
       before do
         blogs.first.limited_posts.to_a
@@ -371,10 +379,15 @@ describe Goldiloader do
         end
 
         it "applies the join correctly" do
-          expect(blogs.first.posts_ordered_by_author.to_a.size).to eq 3
+          sorted_post_authors = blogs.first.posts.map(&:author).map(&:name).sort
+          expect(blogs.first.posts_ordered_by_author.map(&:author).map(&:name)).to eq sorted_post_authors
         end
 
-        it_behaves_like "it doesn't auto eager the association", :posts_ordered_by_author
+        if Goldiloader::Compatibility.joins_eager_loadable?
+          it_behaves_like "it auto eager loads the association", :posts_ordered_by_author
+        else
+          it_behaves_like "it doesn't auto eager the association", :posts_ordered_by_author
+        end
       end
 
       context "associations with a join in a has_many_through" do
@@ -383,10 +396,15 @@ describe Goldiloader do
         end
 
         it "applies the join correctly" do
-          expect(blogs.first.authors_with_join.to_a.size).to eq 3
+          sorted_post_cities = blogs.first.posts.map(&:author).map(&:address).map(&:city).sort
+          expect(blogs.first.posts_ordered_by_author.map(&:author).map(&:address).map(&:city)).to eq sorted_post_cities
         end
 
-        it_behaves_like "it doesn't auto eager the association", :authors_with_join
+        if Goldiloader::Compatibility.joins_eager_loadable?
+          it_behaves_like "it auto eager loads the association", :authors_with_join
+        else
+          it_behaves_like "it doesn't auto eager the association", :authors_with_join
+        end
       end
     end
 
@@ -405,9 +423,9 @@ describe Goldiloader do
           expect(authors.first.scoped_address_with_default_scope_remove).to be_present
         end
 
-        it "doesn't auto eager the association" do
+        it "auto eager loads the association" do
           authors.drop(1).each do |author|
-            expect(author.association(:scoped_address_with_default_scope_remove)).to_not be_loaded
+            expect(author.association(:scoped_address_with_default_scope_remove)).to be_loaded
           end
         end
       end

metadata

@@ -1,139 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: goldiloader
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Joel Turkel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: '5.1'
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+        version: '5.1'
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.1'
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: coveralls
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: simplecov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: mime-types
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '2'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: jdbc-sqlite3
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: activerecord-jdbcsqlite3-adapter
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
 description: Automatically eager loads Rails associations as associations are traversed
 email:
 - jturkel@salsify.com
@@ -167,7 +195,7 @@ homepage: https://github.com/salsify/goldiloader
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,14 +210,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
 specification_version: 4
 summary: Automatic Rails association eager loading
 test_files:
+- spec/spec_helper.rb
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/goldiloader/auto_include_context_spec.rb
 - spec/goldiloader/goldiloader_spec.rb
-- spec/spec_helper.rb