activerecord-precount 0.4.0

data/lib/active_record/precount/join_dependency_extension.rb

@@ -0,0 +1,23 @@
+module ActiveRecord
+  # This imitates EagerLoadPolymorphicError
+  class EagerLoadCountLoaderError < ActiveRecordError
+    def initialize(reflection)
+      super("Cannot eagerly load the count_loader association #{reflection.name.inspect}")
+    end
+  end
+
+  module Precount
+    module JoinDependencyExtension
+      def build(associations, base_klass)
+        associations.map do |name, right|
+          reflection = find_reflection base_klass, name
+          if reflection.macro == :count_loader
+            raise EagerLoadCountLoaderError.new(reflection)
+          end
+        end
+
+        super(associations, base_klass)
+      end
+    end
+  end
+end

data/lib/active_record/precount/preloader_extension.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module Precount
+    module PreloaderExtension
+      def preloader_for(reflection, owners, rhs_klass)
+        preloader = super(reflection, owners, rhs_klass)
+        return preloader if preloader
+
+        case reflection.macro
+        when :count_loader
+          Associations::Preloader::CountLoader
+        end
+      end
+    end
+  end
+end

data/lib/active_record/precount/reflection_extension.rb

@@ -0,0 +1,50 @@
+module ActiveRecord
+  module Precount
+    module ReflectionExtension
+      def self.prepended(base)
+        class << base
+          prepend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def create(macro, name, scope, options, ar)
+          case macro
+          when :count_loader
+            if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 2
+              Reflection::CountLoaderReflection.new(name, scope, options, ar)
+            else
+              Reflection::AssociationReflection.new(macro, name, scope, options, ar)
+            end
+          else
+            super(macro, name, scope, options, ar)
+          end
+        end
+      end
+    end
+
+    module AssociationReflectionExtension
+      def klass
+        case macro
+        when :count_loader
+          @klass ||= active_record.send(:compute_type, options[:class_name] || name_without_count.singularize.classify)
+        else
+          super
+        end
+      end
+
+      def name_without_count
+        name.to_s.sub(/_count$/, "")
+      end
+
+      def association_class
+        case macro
+        when :count_loader
+          ActiveRecord::Associations::CountLoader
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/precount/relation_extension.rb

@@ -0,0 +1,42 @@
+module ActiveRecord
+  module Precount
+    module RelationExtension
+      def precount(*args)
+        check_if_method_has_arguments!(:precount, args)
+        spawn.precount!(*args)
+      end
+
+      def precount!(*args)
+        define_count_loader!(*args)
+
+        self.preload_values += args.map { |arg| :"#{arg}_count" }
+        self
+      end
+
+      private
+
+      def define_count_loader!(*args)
+        args.each do |arg|
+          raise ArgumentError, "#{klass} does not have :#{arg} association." unless has_reflection?(arg)
+          next if has_reflection?(counter_name = :"#{arg}_count")
+
+          options = reflection_for(arg).options.slice(*Associations::Builder::CountLoader.valid_options)
+          reflection = Associations::Builder::CountLoader.build(klass, counter_name, nil, options)
+          Reflection.add_reflection(model, counter_name, reflection)
+        end
+      end
+
+      def has_reflection?(name)
+        reflection_for(name).present?
+      end
+
+      def reflection_for(name)
+        if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 2
+          reflections[name.to_s]
+        else
+          reflections[name.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/active_record/precount/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Precount
+    VERSION = "0.4.0"
+  end
+end

data/lib/activerecord-precount.rb

@@ -0,0 +1,8 @@
+require "active_record"
+require "active_support/lazy_load_hooks"
+
+require "active_record/associations/count_loader"
+require "active_record/associations/builder/count_loader"
+require "active_record/associations/preloader/count_loader"
+
+require "active_record/precount/extend"

data/sample/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/sample/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.2.0'
+gem 'mysql2'
+gem 'sass-rails', '~> 4.0.3'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.0.0'
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 2.0'
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+gem 'activerecord-precount', path: '..'
+
+group :development do
+  gem 'pry-rails'
+  gem 'spring'
+  gem 'silencer'
+end

data/sample/README.md

@@ -0,0 +1,6 @@
+# sample
+
+```bash
+$ bundle exec rake db:create db:migrate
+$ bundle exec rake db:seed
+```

data/sample/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/sample/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/sample/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/sample/app/controllers/application_controller.rb

@@ -0,0 +1,13 @@
+class ApplicationController < ActionController::Base
+  def index
+    @tweets = Tweet.all
+    if eager_load?
+      @tweets = @tweets.precount(:replies).preload(in_reply_to: :favorites_count)
+    end
+  end
+
+  def eager_load?
+    params[:eager_load] == 'true'
+  end
+  helper_method :eager_load?
+end

data/sample/app/helpers/application_helper.rb

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

data/sample/app/models/favorite.rb

@@ -0,0 +1,4 @@
+class Favorite < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :tweet
+end

data/sample/app/models/tweet.rb

@@ -0,0 +1,6 @@
+class Tweet < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :in_reply_to, class_name: 'Tweet', foreign_key: :in_reply_to_tweet_id
+  has_many :favorites, count_loader: true
+  has_many :replies, class_name: 'Tweet', foreign_key: :in_reply_to_tweet_id
+end

data/sample/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  has_many :favorites
+  has_many :tweets
+end

data/sample/app/views/application/index.html.erb

@@ -0,0 +1,49 @@
+<% start = Time.now %>
+<table border="1">
+  <thead>
+    <tr>
+      <th>
+        id
+      </th>
+      <th>
+        replies_count
+      </th>
+      <th>
+        in_reply_to.id
+      </th>
+      <th>
+        in_reply_to.favorites_count
+      </th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @tweets.each do |tweet| %>
+      <tr>
+        <td>
+          <%= tweet.id %>
+        </td>
+        <td>
+          <%= eager_load? ? tweet.replies_count : tweet.replies.count %>
+        </td>
+        <td>
+          <%= tweet.in_reply_to.try(:id) %>
+        </td>
+        <td>
+          <%= tweet.in_reply_to.try(:favorites_count) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<% finish = Time.now %>
+
+<p>
+  <%= eager_load? ? 'Eager loaded' : 'N+1 query' %>
+</p>
+<p>
+  Time: <%= "%.1f" % ((finish - start) * 1000) %>ms
+</p>
+
+<p>
+  <%= link_to 'Swtich', url_for(eager_load: !eager_load?) %>
+<p>

data/sample/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sample</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/sample/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/sample/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/sample/bin/rake

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path("../spring", __FILE__)
+rescue LoadError
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/sample/bin/spring

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# This file loads spring without using Bundler, in order to be fast
+# It gets overwritten when you run the `spring binstub` command
+
+unless defined?(Spring)
+  require "rubygems"
+  require "bundler"
+
+  if match = Bundler.default_lockfile.read.match(/^GEM$.*?^    spring \((.*?)\)$.*?^$/m)
+    ENV["GEM_PATH"] = ([Bundler.bundle_path.to_s] + Gem.path).join(File::PATH_SEPARATOR)
+    ENV["GEM_HOME"] = ""
+    Gem.paths = ENV
+
+    gem "spring", match[1]
+    require "spring/binstub"
+  end
+end

data/sample/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/sample/config/application.rb

@@ -0,0 +1,30 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Sample
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end