activerecord-count_loader 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e96fba115f86ec9df8e6b61b9e46963db8863389
-  data.tar.gz: c133bf5dbdc42da2033c895edbafb54aad6503d4
+  metadata.gz: 515ec56ea17ba5bad414a147aed81f40819a657c
+  data.tar.gz: f9466f0bdbe2c07cbf84e0b48a166db145c4af82
 SHA512:
-  metadata.gz: 1fb324c9b4c13172114fa47337949bda6a45418e9fe6ebd4ef2d2702c1dc03df576220e014bf05d3069414063b384d17a649b345b48d0cc1f6baaf44afaee783
-  data.tar.gz: 0d5d2aaa5ebd82d0a60a8fee3b94fbce338072af25333fc173620f4b8f0e28f33725cd67c9656f56a991cdc69507cc5c12139826820f6bd2ad78fc4e0e3cb329
+  metadata.gz: 5d0efd9eac050114ada09182e50fc15098fbe5b1dcc8a6c382964433b249a38bb9082d77b87ec8729144cf28f71f0f3da326ab1b017a945584086e47a8129659
+  data.tar.gz: 3533abc4b13a3f41d083159442fa0a6a5917c111eb616ecf77db9a129dbf66cbafc9013f063e53c33783dda98510e00d06dc0b13eb4301668f68bad548f6c6a4

data/.travis.yml

@@ -1,12 +1,18 @@
 script: ci/travis.rb
 language: ruby
 rvm:
-  - 2.1.5
+  - 2.1
+  - 2.2
+sudo: false
 gemfile:
-  - ci/Gemfile.activerecord-3.2.x
-  - ci/Gemfile.activerecord-4.0.x
   - ci/Gemfile.activerecord-4.1.x
+  - ci/Gemfile.activerecord-4.2.x
 env:
-  - ARCONN=sqlite3
-  - ARCONN=mysql2
-  - ARCONN=postgresql
+  - TASK=test ARCONN=sqlite3
+  - TASK=test ARCONN=mysql2
+  - TASK=test ARCONN=postgresql
+  #- TASK=benchmark ARCONN=mysql2
+matrix:
+  allow_failures:
+    env:
+      - TASK=benchmark ARCONN=mysql2

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in activerecord-count_loader.gemspec
 gemspec
+
+gem 'rbench', github: 'miloops/rbench'

data/README.md

@@ -46,7 +46,7 @@ end
 You can eagerly load `count_loader` association by `includes` or `preload`.
 
 ```rb
-@tweets = Tweet.preload(:favorites_count)
+@tweets = Tweet.all.preload(:favorites_count)
 @tweets.each do |tweet|
   p tweets.favorites_count # this line doesn't execute an additional query
 end
@@ -55,7 +55,7 @@ end
 Since it is association, you can preload nested `count_loader` association.
 
 ```rb
-@users = User.preload(tweets: :favorites_count).all
+@users = User.all.preload(tweets: :favorites_count)
 @users.each do |user|
   user.tweets.each do |tweet|
     p tweet.favorites_count # this line doesn't execute an additional query
@@ -66,9 +66,9 @@ end
 ## Supported Versions
 
 - Ruby
-  - 2.1
+  - 2.1, 2.2
 - Rails
-  - 3.2, 4.0, 4.1
+  - 4.1, 4.2
 
 ### Databases
 

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+desc 'Run count_loader benchmarks'
+task :benchmark do
+  ruby('benchmark.rb')
+end
+
 Rake::TestTask.new do |t|
   t.libs << "lib" << "test"
   t.test_files = Dir.glob("test/**/*_test.rb")

data/activerecord-count_loader.gemspec

@@ -22,8 +22,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "erubis"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "mysql2"
   spec.add_development_dependency "postgres"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rbench"
+  spec.add_development_dependency "dalli"
 end

data/benchmark.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift File.expand_path('../test', __FILE__)
+
+require 'rbench'
+require 'cases/db_config'
+require 'models/favorite'
+require 'models/tweet'
+
+RBench.run(50) do
+  column :counter_cache,          title: 'counter_cache'
+  column :left_join,              title: 'LEFT JOIN'
+  column :count_loader,           title: 'activerecord-count_loader'
+  column :has_many,               title: 'preload has_many'
+  column :count_query,            title: 'N+1 COUNT'
+
+  join_relation = Tweet.joins('LEFT JOIN favorites ON tweets.id = favorites.tweet_id').
+    select('tweets.*, COUNT(favorites.id) AS joined_count').group('tweets.id')
+
+  def prepare_records(tweets_count, favorites_count)
+    tweets_count.times do
+      t = Tweet.create(favorites_count_cache: 0)
+      favorites_count.times { Favorite.create(tweet: t) }
+    end
+  end
+
+  test_cases = [
+    [10, 5],
+    [20, 20],
+    [30, 100],
+  ]
+
+  test_cases.each do |tweets_count, favorites_count|
+    prepare_records(tweets_count, favorites_count)
+
+    report "N = #{tweets_count}, count = #{favorites_count}" do
+      counter_cache          { Tweet.first(tweets_count).map(&:favorites_count_cache) }
+      left_join              { join_relation.first(tweets_count).map(&:joined_count) }
+      count_loader           { Tweet.preload(:favorites_count).first(tweets_count).map(&:favorites_count) }
+      has_many               { Tweet.preload(:favorites).first(tweets_count).map{ |t| t.favorites.size } }
+      count_query            { Tweet.first(tweets_count).map{ |t| t.favorites.count } }
+    end
+  end
+end

data/ci/Gemfile.activerecord-4.2.x

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
 
-gem 'rails', '~> 4.2.0.beta4'
+gem 'rails', '~> 4.2.0'
 gemspec path: '..'

data/ci/travis.rb

@@ -10,3 +10,5 @@ commands = [
 commands.each do |command|
   system("#{command} > /dev/null 2>&1")
 end
+
+exit system("bundle exec rake $TASK")

data/lib/active_record/associations/count_loader.rb

@@ -14,4 +14,14 @@ module ActiveRecord
       end
     end
   end
+
+  module Reflection
+    class CountLoaderReflection < AssociationReflection
+      def initialize(name, scope, options, active_record)
+        super(name, scope, options, active_record)
+      end
+
+      def macro; :count_loader; end
+    end
+  end
 end

data/lib/active_record/count_loader/extend.rb

@@ -1,9 +1,9 @@
 ActiveSupport.on_load(:active_record) do
   module ActiveRecord
-    Reflection.prepend(CountLoader::ReflectionExtension)
-    Associations::Preloader.prepend(CountLoader::PreloaderExtension)
-    Associations::JoinDependency.prepend(CountLoader::JoinDependencyExtension)
-    Associations::Builder::HasMany.prepend(CountLoader::Builder::HasManyExtension)
-    Reflection::AssociationReflection.prepend(CountLoader::AssociationReflectionExtension)
+    Reflection.send(:prepend, CountLoader::ReflectionExtension)
+    Associations::Preloader.send(:prepend, CountLoader::PreloaderExtension)
+    Associations::JoinDependency.send(:prepend, CountLoader::JoinDependencyExtension)
+    Associations::Builder::HasMany.send(:prepend, CountLoader::Builder::HasManyExtension)
+    Reflection::AssociationReflection.send(:prepend, CountLoader::AssociationReflectionExtension)
   end
 end

data/lib/active_record/count_loader/reflection_extension.rb

@@ -11,7 +11,11 @@ module ActiveRecord
         def create(macro, name, scope, options, ar)
           case macro
           when :count_loader
-            Reflection::AssociationReflection.new(macro, name, scope, options, ar)
+            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

data/lib/active_record/count_loader/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module CountLoader
-    VERSION = "0.2.2"
+    VERSION = "0.3.0"
   end
 end

data/sample/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '4.1.5'
+gem 'rails', '4.2.0'
 gem 'mysql2'
 gem 'sass-rails', '~> 4.0.3'
 gem 'uglifier', '>= 1.3.0'
@@ -13,7 +13,7 @@ gem 'sdoc', '~> 0.4.0', group: :doc
 gem 'activerecord-count_loader', path: '..'
 
 group :development do
-  gem 'pry'
+  gem 'pry-rails'
   gem 'spring'
   gem 'silencer'
 end

data/test/cases/db_config.rb

@@ -0,0 +1,24 @@
+require 'config'
+
+require 'active_record'
+require 'activerecord-count_loader'
+
+require 'support/config'
+require 'support/connection'
+
+# Connect to the database
+ARTest.connect
+
+def load_schema
+  # silence verbose schema loading
+  original_stdout = $stdout
+  $stdout = StringIO.new
+
+  adapter_name = ActiveRecord::Base.connection.adapter_name.downcase
+
+  load SCHEMA_ROOT + "/schema.rb"
+ensure
+  $stdout = original_stdout
+end
+
+load_schema

data/test/cases/helper.rb

@@ -1,27 +1,4 @@
-require 'config'
+require 'cases/db_config'
 
 require 'support/autorun'
-
-require 'active_record'
-require 'activerecord-count_loader'
 require 'cases/test_case'
-
-require 'support/config'
-require 'support/connection'
-
-# Connect to the database
-ARTest.connect
-
-def load_schema
-  # silence verbose schema loading
-  original_stdout = $stdout
-  $stdout = StringIO.new
-
-  adapter_name = ActiveRecord::Base.connection.adapter_name.downcase
-
-  load SCHEMA_ROOT + "/schema.rb"
-ensure
-  $stdout = original_stdout
-end
-
-load_schema

data/test/models/favorite.rb

@@ -1,3 +1,3 @@
 class Favorite < ActiveRecord::Base
-  belongs_to :tweet
+  belongs_to :tweet, counter_cache: :favorites_count_cache
 end

data/test/schema/schema.rb

@@ -2,13 +2,15 @@ ActiveRecord::Schema.define do
   create_table :favorites, force: true do |t|
     t.integer  :tweet_id
     t.integer  :user_id
-    t.datetime :created_at
     t.timestamps
   end
+  add_index :favorites, :tweet_id
 
   create_table :tweets, force: true do |t|
     t.integer  :in_reply_to_tweet_id
     t.integer  :user_id
+    t.integer  :favorites_count_cache
     t.timestamps
   end
+  add_index :tweets, :in_reply_to_tweet_id
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-count_loader
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rbench
+  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: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,8 +178,7 @@ files:
 - README.md
 - Rakefile
 - activerecord-count_loader.gemspec
-- ci/Gemfile.activerecord-3.2.x
-- ci/Gemfile.activerecord-4.0.x
+- benchmark.rb
 - ci/Gemfile.activerecord-4.1.x
 - ci/Gemfile.activerecord-4.2.x
 - ci/travis.rb
@@ -224,6 +251,7 @@ files:
 - test/cases/associations/eager_load_test.rb
 - test/cases/associations/includes_test.rb
 - test/cases/associations/preload_test.rb
+- test/cases/db_config.rb
 - test/cases/helper.rb
 - test/cases/test_case.rb
 - test/config.example.yml
@@ -254,8 +282,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: N+1 count query killer for ActiveRecord
 test_files: []
+has_rdoc: 

data/ci/Gemfile.activerecord-3.2.x

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 3.2.0'
-gemspec path: '..'

data/ci/Gemfile.activerecord-4.0.x

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-gem 'activerecord', '~> 4.0.0'
-gemspec path: '..'