predictive_load 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c06e8dd628fc0332e30ded32af6042aa499143be
+  data.tar.gz: 0cef50d150b563becfd37449cb32f09425f6297b
+SHA512:
+  metadata.gz: 8b84b9da822ee49efb981cfb1ecbab8456d48c7c495b4de0ba7689a5611205584b722097b33054eb8e2e6515044519a3c78188138379862d2c1a44b840a0a7fc
+  data.tar.gz: 5188551f856d9827928b14a72bb667fab7b78e2868ac16af44c4c8695c2a2f890217dc56d3d8d5a8e6c72c1c67c55f90dd279308e0583287d8936c73e702e90f

data/.gitignore

@@ -0,0 +1,2 @@
+test/db
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+gem "activerecord", "3.2"
+gem "minitest"
+gem 'sqlite3'
+gem 'rake'

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,62 @@
+[![Build Status](https://travis-ci.org/eac/resque-durable.png)](https://travis-ci.org/eac/predictive_load)
+
+predictive_load
+===============
+
+Observes Active Record collections and notifies when a member loads an association. This allows for:
+* automatically preloading the association in a single query for all members of that collection.
+* N+1 detection logging 
+
+
+
+### Automatic preloading
+
+
+```ruby
+ActiveRecord::Relation.collection_observer = PredictiveLoad::Loader
+
+Ticket.all.each do |ticket| 
+  ticket.requester.identities.each { |identity| identity.account }
+end
+```
+
+Produces:
+```sql
+  SELECT `tickets`.* FROM `tickets`
+  SELECT `requesters`.* FROM `requesters` WHERE `requesters`.`id` IN (2, 7, 12, 32, 37)
+  SELECT `identities`.* FROM `identities` WHERE `identities`.`requester_id` IN (2, 7, 12, 32, 37)
+  SELECT `accounts`.* FROM `accounts` WHERE `accounts`.`id` IN (1, 2, 3)
+```
+
+### N+1 detection logging
+
+There is also a log-only version:
+```ruby
+ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
+
+Comment.all.each do |comment|
+  comment.account
+end
+
+```
+
+Produces:
+
+```
+detected n1 call on Comment#account
+expect to prevent 10 queries
+would preload with: SELECT `accounts`.* FROM `accounts`  WHERE `accounts`.`id` IN (...)
++----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+| id | select_type | table    | type  | possible_keys | key     | key_len | ref   | rows | Extra |
++----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+|  1 | SIMPLE      | accounts | const | PRIMARY       | PRIMARY | 4       | const |    10 |      |
++----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+1 row in set (0.00 sec)
+would have prevented all 10 queries
+
+```
+
+#### Known limitations:
+
+* Calling association#size will trigger an N+1 on SELECT COUNT(*). Work around by calling #length, loading all records.
+* Calling first / last will trigger an N+1.

data/Rakefile

@@ -0,0 +1,11 @@
+require './test/helper'
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/predictive_load/active_record_collection_observation.rb

@@ -0,0 +1,71 @@
+module PredictiveLoad::ActiveRecordCollectionObservation
+
+  def self.included(base)
+    ActiveRecord::Relation.send(:include, RelationObservation)
+    ActiveRecord::Base.send(:include, CollectionMember)
+    ActiveRecord::Associations::Association.send(:include, AssociationNotification)
+    ActiveRecord::Associations::CollectionAssociation.send(:include, CollectionAssociationNotification)
+  end
+
+  module RelationObservation
+
+    def self.included(base)
+      base.class_attribute :collection_observer
+      base.alias_method_chain :to_a, :collection_observer
+    end
+
+    def to_a_with_collection_observer
+      records = to_a_without_collection_observer
+
+      if records.size > 1 && collection_observer
+        collection_observer.observe(records.dup)
+      end
+
+      records
+    end
+
+  end
+
+  module CollectionMember
+
+    attr_accessor :collection_observer
+
+  end
+
+  module AssociationNotification
+
+    def self.included(base)
+      base.alias_method_chain :load_target, :notification
+    end
+
+    def load_target_with_notification
+      notify_collection_observer if find_target?
+
+      load_target_without_notification
+    end
+
+    protected
+
+    def notify_collection_observer
+      if @owner.collection_observer
+        @owner.collection_observer.loading_association(@owner, @reflection.name)
+      end
+    end
+
+  end
+
+  module CollectionAssociationNotification
+
+    def self.included(base)
+      base.alias_method_chain :load_target, :notification
+    end
+
+    def load_target_with_notification
+      notify_collection_observer if find_target?
+
+      load_target_without_notification
+    end
+
+  end
+
+end

data/lib/predictive_load/loader.rb

@@ -0,0 +1,61 @@
+module PredictiveLoad
+  # Predictive loader
+  #
+  # Usage:
+  # ActiveRecord::Relation.collection_observer = LazyLoader
+  #
+  class Loader
+
+    def self.observe(records)
+      new(records).observe
+    end
+
+    def initialize(records)
+      @records = records
+    end
+
+    def observe
+      records.each do |record|
+        record.collection_observer = self
+      end
+    end
+
+    def loading_association(record, association_name)
+      if all_records_will_likely_load_association?(association_name)
+        preload(association_name)
+      end
+    end
+
+    def all_records_will_likely_load_association?(association_name)
+      if defined?(Mocha) && association_name.to_s.index('_stub_')
+        false
+      else
+        true
+      end
+    end
+
+    protected
+
+    attr_reader :records
+
+    def preload(association_name)
+      ActiveRecord::Associations::Preloader.new(records_with_association(association_name), [ association_name ]).run
+    end
+
+    def records_with_association(association_name)
+      if mixed_collection?
+        @records.select { |r| r.class.reflect_on_association(association_name) }
+      else
+        @records
+      end
+    end
+
+    def mixed_collection?
+      @mixed_collection ||= begin
+                              klass = records.first.class
+                              records.any? { |record| record.class != klass }
+                            end
+    end
+
+  end
+end

data/lib/predictive_load/preload_log.rb

@@ -0,0 +1,40 @@
+require 'active_record/associations/preloader'
+
+module PredictiveLoad
+  class PreloadLog < ActiveRecord::Associations::Preloader
+
+    attr_accessor :logger
+
+    def preload(association)
+      grouped_records(association).each do |reflection, klasses|
+        klasses.each do |klass, records|
+          preloader   = preloader_for(reflection).new(klass, records, reflection, options)
+
+          if preloader.respond_to?(:through_reflection)
+            log("encountered :through association for #{association}. Requires loading records to generate query, so skipping for now.")
+            next
+          end
+
+          preload_sql = preloader.scoped.where(collection_arel(preloader)).to_sql
+
+          log("would preload with: #{preload_sql.to_s}")
+          klass.connection.explain(preload_sql).each_line do |line|
+            log(line)
+          end
+        end
+      end
+    end
+
+    def collection_arel(preloader)
+      owners_map = preloader.owners_by_key
+      owner_keys = owners_map.keys.compact
+      preloader.association_key.in(owner_keys)
+    end
+
+    def log(message)
+      ActiveRecord::Base.logger.info("predictive_load: #{message}")
+    end
+
+  end
+
+end

data/lib/predictive_load/watcher.rb

@@ -0,0 +1,80 @@
+require 'predictive_load/loader'
+require 'predictive_load/preload_log'
+
+module PredictiveLoad
+  # Provides N+1 detection / log mode.
+  #
+  # Usage:
+  # ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
+  #
+  # Example output:
+  # predictive_load: detected n1 call on Comment#account
+  # predictive_load: expect to prevent 1 queries
+  # predictive_load: would preload with: SELECT `accounts`.* FROM `accounts`  WHERE `accounts`.`id` IN (...)
+  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+  # predictive_load: | id | select_type | table    | type  | possible_keys | key     | key_len | ref   | rows | Extra |
+  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+  # predictive_load: |  1 | SIMPLE      | accounts | const | PRIMARY       | PRIMARY | 4       | const |    1 |       |
+  # predictive_load: +----+-------------+----------+-------+---------------+---------+---------+-------+------+-------+
+  # predictive_load: 1 row in set (0.00 sec)
+  # predictive_load: would have prevented all 1 queries
+  class Watcher < Loader
+
+    attr_reader :loaded_associations
+
+    def initialize(records)
+      super
+      @loaded_associations = {}
+    end
+
+    def loading_association(record, association_name)
+      return if !all_records_will_likely_load_association?(association_name)
+
+      if loaded_associations.key?(association_name)
+        log_query_plan(association_name)
+      end
+
+      increment_query_count(association_name)
+    end
+
+    protected
+
+    def log_query_plan(association_name)
+      log("detected n1 call on #{records.first.class.name}##{association_name}")
+
+      # Detailed logging for first query
+      if query_count(association_name) == 1
+        log("expect to prevent #{expected_query_count} queries")
+        log_preload(association_name)
+      end
+
+      # All records loaded association
+      if query_count(association_name) == expected_query_count
+        log("would have prevented all #{expected_query_count} queries")
+      end
+
+    end
+
+    def query_count(association_name)
+      loaded_associations[association_name] || 0
+    end
+
+    def increment_query_count(association_name)
+      loaded_associations[association_name] ||= 0
+      loaded_associations[association_name] += 1
+    end
+
+    def expected_query_count
+      records.size - 1
+    end
+
+    def log_preload(association_name)
+      PreloadLog.new(records_with_association(association_name), [ association_name ]).run
+    end
+
+    def log(message)
+      ActiveRecord::Base.logger.info("predictive_load: #{message}")
+    end
+
+  end
+end

data/lib/predictive_load.rb

@@ -0,0 +1,2 @@
+module PredictiveLoad
+end

data/predictive_load.gemspec

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eric Chapweske"]
+  gem.email         = ["eac@zendesk.com"]
+  gem.description   = "Predictive loader"
+  gem.summary       = %q{}
+  gem.homepage      = ""
+  gem.license       = "Apache License Version 2.0"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "predictive_load"
+  gem.version       = '0.1.1'
+end

data/test/active_record_collection_observation_test.rb

@@ -0,0 +1,44 @@
+require_relative 'helper'
+require 'predictive_load/watcher'
+
+describe PredictiveLoad::ActiveRecordCollectionObservation do
+
+  describe "Relation#to_a" do
+    before do
+      user1 = User.create!(:name => "Rudolph")
+      user2 = User.create!(:name => "Santa")
+    end
+
+    after do
+      User.delete_all
+    end
+
+    describe "when a collection observer is specified" do
+      before do
+        ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
+      end
+
+      it "observes the members of that collection" do
+        users = User.all
+        assert_equal 2, users.size
+        assert users.all? { |user| user.collection_observer }
+      end
+
+    end
+
+    describe "when a collection observer is not specified" do
+      before do
+        ActiveRecord::Relation.collection_observer = nil
+      end
+
+      it "does not observe the members of that collection" do
+        users = User.all
+        assert_equal 2, users.size, users.inspect
+        assert users.none? { |user| user.collection_observer }
+      end
+
+    end
+
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: test/db

data/test/helper.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'active_record'
+require 'predictive_load'
+require 'predictive_load/active_record_collection_observation'
+
+ActiveRecord::Base.class_eval do
+  include PredictiveLoad::ActiveRecordCollectionObservation
+end
+
+database_config = YAML.load_file(File.join(File.dirname(__FILE__), 'database.yml'))
+ActiveRecord::Base.establish_connection(database_config['test'])
+ActiveRecord::Base.default_timezone = :utc
+require_relative 'schema'
+require_relative 'models'
+
+def assert_queries(num = 1)
+  ActiveRecord::SQLCounter.log = []
+  yield
+ensure
+  assert_equal num, ActiveRecord::SQLCounter.log.size, "#{ActiveRecord::SQLCounter.log.size} instead of #{num} queries were executed.#{ActiveRecord::SQLCounter.log.size == 0 ? '' : "\nQueries:\n#{ActiveRecord::SQLCounter.log.join("\n")}"}"
+end
+
+# Yanked from ActiveRecord tests
+module ActiveRecord
+  class SQLCounter
+    cattr_accessor :ignored_sql
+    self.ignored_sql = [/^PRAGMA (?!(table_info))/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /^SHOW max_identifier_length/, /^BEGIN/, /^COMMIT/]
+
+    # FIXME: this needs to be refactored so specific database can add their own
+    # ignored SQL.  This ignored SQL is for Oracle.
+    ignored_sql.concat [/^select .*nextval/i, /^SAVEPOINT/, /^ROLLBACK TO/, /^\s*select .* from all_triggers/im]
+
+    cattr_accessor :log
+    self.log = []
+
+    attr_reader :ignore
+
+    def initialize(ignore = self.class.ignored_sql)
+      @ignore   = ignore
+    end
+
+    def call(name, start, finish, message_id, values)
+      sql = values[:sql]
+
+      # FIXME: this seems bad. we should probably have a better way to indicate
+      # the query was cached
+      return if 'CACHE' == values[:name] || ignore.any? { |x| x =~ sql }
+      self.class.log << sql
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe('sql.active_record', SQLCounter.new)
+end

data/test/loader_test.rb

@@ -0,0 +1,147 @@
+require_relative 'helper'
+require 'predictive_load/loader'
+
+describe PredictiveLoad::Loader do
+
+  describe "A collection of records" do
+    before do
+      ActiveRecord::Relation.collection_observer = PredictiveLoad::Loader
+      # trigger schema lookup to avoid messing with query count assertions
+      Photo.columns
+
+      topic = Topic.create!(:title => "Sleigh repairs")
+      user1 = User.create!(:name => "Rudolph")
+      user2 = User.create!(:name => "Santa")
+      user1.emails.create!
+      comment1 = topic.comments.create!(:body => "meow",     :user => user1)
+      comment2 = topic.comments.create!(:body => "Ho Ho ho", :user => user2)
+    end
+
+    after do
+      User.delete_all
+      Comment.delete_all
+      Topic.delete_all
+      Photo.delete_all
+      Email.delete_all
+    end
+
+    it "supports nested loading" do
+      # 3: User, Comment, Topic
+      assert_queries(3) do
+        User.all.each do |user|
+          user.comments.each { |comment| assert comment.topic }
+        end
+      end
+    end
+
+    describe "belongs_to" do
+
+      it "automatically preloads" do
+        comments = Comment.all
+        assert_equal 2, comments.size
+        assert_queries(1) do
+          comments.each { |comment| assert comment.user.name }
+        end
+      end
+
+    end
+
+    describe "has_one" do
+
+      it "automatically preloads" do
+        users = User.all
+        assert_equal 2, users.size
+
+        assert_queries(1) do
+          users.each { |user| user.photo }
+        end
+      end
+
+    end
+
+    describe "has_many :through" do
+
+      it "automatically preloads" do
+        users = User.all
+        assert_equal 2, users.size
+
+        assert_queries(3) do
+          users.each do |user|
+            user.topics.each do |topic|
+              topic.comments.to_a
+            end
+          end
+        end
+
+      end
+    end
+
+    describe "has_and_belongs_to_many" do
+
+      it "automatically preloads" do
+        users = User.all
+        assert_equal 2, users.size
+
+        assert_queries(1) do
+          users.each { |user| user.emails.to_a }
+        end
+
+      end
+    end
+
+    describe "has_many" do
+
+      it "automatically prelaods" do
+        users = User.all
+        assert_equal 2, users.size
+        assert_queries(1) do
+          users.each { |user| user.comments.to_a }
+        end
+      end
+
+      it "preloads #length" do
+        users = User.all
+        assert_equal 2, users.size
+        assert_queries(1) do
+          users.each { |user| user.comments.length }
+        end
+      end
+
+      describe "unsupported behavior" do
+        it "does not preload when dynamically scoped" do
+          users = User.all
+          topic = Topic.first
+          assert_queries(2) do
+            users.each { |user| user.comments.by_topic(topic).to_a }
+          end
+        end
+
+        it "does not preload when staticly scoped" do
+          users = User.all
+          topic = Topic.first
+          assert_queries(2) do
+            users.each { |user| user.comments.recent.to_a }
+          end
+        end
+
+
+        it "does not preload #size" do
+          users = User.all
+          assert_queries(2) do
+            users.each { |user| user.comments.size }
+          end
+        end
+
+        it "does not preload first/last" do
+          users = User.all
+          assert_queries(2) do
+            users.each { |user| user.comments.first }
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/test/models.rb

@@ -0,0 +1,25 @@
+class User < ActiveRecord::Base
+  has_many :comments,  :dependent => :destroy
+  has_many :topics,    :through => :comments
+  has_one  :photo
+  has_and_belongs_to_many :emails
+end
+
+class Email < ActiveRecord::Base
+end
+
+class Topic < ActiveRecord::Base
+  has_many :comments, :dependent => :destroy
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :topic
+
+  scope :by_topic, lambda { |topic| where(:topic_id => topic.id) }
+  scope :recent, order('updated_at desc')
+end
+
+class Photo < ActiveRecord::Base
+  belongs_to :user
+end

data/test/schema.rb

@@ -0,0 +1,37 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  drop_table(:users)    rescue nil
+  drop_table(:emails)   rescue nil
+  drop_table(:photos)   rescue nil
+  drop_table(:topics)   rescue nil
+  drop_table(:comments) rescue nil
+  drop_table(:emails_users) rescue nil
+
+  create_table(:users) do |t|
+    t.string   :name,    :null => false
+  end
+
+  create_table(:photos) do |t|
+    t.integer  :user_id, :null => false
+  end
+
+  create_table(:emails_users) do |t|
+    t.integer :user_id
+    t.integer :email_id
+  end
+
+  create_table(:emails) do |t|
+  end
+
+  create_table(:topics) do |t|
+    t.string   :title,   :null => false
+  end
+
+  create_table(:comments) do |t|
+    t.string   :body,     :null => false
+    t.integer  :topic_id, :null => false
+    t.integer  :user_id,  :null => false
+    t.timestamps
+  end
+
+end

data/test/watcher_test.rb

@@ -0,0 +1,79 @@
+require_relative 'helper'
+require 'predictive_load/watcher'
+require 'logger'
+
+describe PredictiveLoad::Watcher do
+
+  describe "A collection of records" do
+    before do
+      ActiveRecord::Relation.collection_observer = PredictiveLoad::Watcher
+
+      topic = Topic.create!(:title => "Sleigh repairs")
+      user1 = User.create!(:name => "Rudolph")
+      user2 = User.create!(:name => "Santa")
+      comment1 = topic.comments.create!(:body => "meow",     :user => user1)
+      comment2 = topic.comments.create!(:body => "Ho Ho ho", :user => user2)
+    end
+
+    after do
+      User.delete_all
+      Comment.delete_all
+      Topic.delete_all
+    end
+
+    it "logs what the loader would have done" do
+      users = User.all
+      users[0].id = 1
+      users[1].id = 2
+      message = "predictive_load: detected n1 call on User#comments
+predictive_load: expect to prevent 1 queries
+predictive_load: would preload with: SELECT \"comments\".* FROM \"comments\"  WHERE \"comments\".\"user_id\" IN (1, 2)
+predictive_load: 0|0|0|SCAN TABLE comments (~100000 rows)
+
+predictive_load: 0|0|0|EXECUTE LIST SUBQUERY 1
+
+predictive_load: would have prevented all 1 queries
+"
+      timing_pattern = /\d+\.\d+ms/
+      message.gsub!(timing_pattern, '')
+      assert_log(message, timing_pattern) do
+        users.each { |user| user.comments.to_a }
+      end
+    end
+
+    it "does not log :through association queries" do
+      users = User.all
+      message = "predictive_load: detected n1 call on User#topics
+predictive_load: expect to prevent 1 queries
+predictive_load: encountered :through association for topics. Requires loading records to generate query, so skipping for now.
+predictive_load: would have prevented all 1 queries
+"
+
+      timing_pattern = /\d+\.\d+ms/
+      message.gsub!(timing_pattern, '')
+      assert_log(message, timing_pattern) do
+        users.each { |user| user.topics.to_a }
+      end
+
+    end
+
+  end
+
+  def assert_log(message, gsub_pattern)
+    original_logger = ActiveRecord::Base.logger
+    log    = StringIO.new
+    logger = Logger.new(log)
+    logger.level = Logger::Severity::INFO
+    logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+    ActiveSupport::LogSubscriber.colorize_logging = false
+    ActiveRecord::Base.logger = logger
+
+    yield
+    result = log.string
+    result.gsub!(gsub_pattern, '')
+    assert_equal message, result
+  ensure
+    ActiveRecord::Base.logger = original_logger
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: predictive_load
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Eric Chapweske
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-07 00:00:00.000000000 Z
+dependencies: []
+description: Predictive loader
+email:
+- eac@zendesk.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/predictive_load.rb
+- lib/predictive_load/active_record_collection_observation.rb
+- lib/predictive_load/loader.rb
+- lib/predictive_load/preload_log.rb
+- lib/predictive_load/watcher.rb
+- predictive_load.gemspec
+- test/active_record_collection_observation_test.rb
+- test/database.yml
+- test/helper.rb
+- test/loader_test.rb
+- test/models.rb
+- test/schema.rb
+- test/watcher_test.rb
+homepage: ''
+licenses:
+- Apache License Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/active_record_collection_observation_test.rb
+- test/database.yml
+- test/helper.rb
+- test/loader_test.rb
+- test/models.rb
+- test/schema.rb
+- test/watcher_test.rb