activerecord-precount 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1621a4f3c4f5d53c03ad4f6e2a62e9e23119a734
-  data.tar.gz: c0c2e63f3ef20f39f98ca38a0339395212597104
+  metadata.gz: 462619d22d3bb8cbc486321638ba93bf37f67495
+  data.tar.gz: d208201ce3549375e459fea3dba479b21e60c17d
 SHA512:
-  metadata.gz: 9a29284daa7c6fa23bb26cdc713fa7a9b71449a19bbd65b89eb7e48fe664c0dfe54fc3c64e38ee4227de8122728ed3421a6cb1287f73596593bf7f6d8c2c7c47
-  data.tar.gz: a07629cc1a93ccb7c250d74a1be50f7c143f615b32785eeaae059a56ec5dc1d0b19ad2cb7964de2a3af68cf190c6e8a5706e69c91f4b529effd8645a20997352
+  metadata.gz: 15b8082a44e4a542d9033daa594dd8987f709d0306a666c6d1c3ff3a86e5d7926cf79fd3e6758713f4ce52fbf60b17611b9466d422d0bdace802a91f5d223b59
+  data.tar.gz: 5e59714fc6686f6b8baf927bbe199e1480e762363fe84257ac409cf21d347f1d2b89e6edf05286e3f64b87cfd180eea7544509eb5b37f85e3d5746ef837345ca

data/README.md

@@ -1,66 +1,46 @@
 # ActiveRecord::Precount [![Build Status](https://travis-ci.org/k0kubun/activerecord-precount.svg?branch=master)](https://travis-ci.org/k0kubun/activerecord-precount)
 
-N+1 count query killer for ActiveRecord.  
+N+1 count query killer for ActiveRecord. Yet another counter\_cache alternative.  
 ActiveRecord::Precount allows you to cache count of associated records by eager loading.
 
-## Why ActiveRecord::Precount?
-Rails provides a way to resolve N+1 count query, which is [belongs\_to's counter\_cache option](http://guides.rubyonrails.org/association_basics.html#counter-cache).  
-It requires a column to cache the count. But adding a column just for count cache is overkill.  
-  
-Thus this plugin enables you to preload counts in the same way as `has_many` and `belongs_to`.  
-`count_loader` is an ActiveRecord's association, which is preloadable by `preload` or `includes`.
+## Synopsis
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'activerecord-precount'
-```
-
-## Usage
-
-### Enable count\_loader option
-First, enable your has\_many association's count\_loader option.
-
-```diff
- class Tweet
--  has_many :favorites
-+  has_many :favorites, count_loader: true
- end
-```
+### N+1 count query
 
-The option defines an additional association whose name is `favorites_count`.  
-Its association type is not an ordinary one (i.e. `has_many`, `belongs_to`) but `count_loader`.
-
-### Preload the association
-This association works well by default.
+Sometimes you may see many count queries for one association.
+You can use counter\_cache to solve it, but it costs much to use counter\_cache.
 
 ```rb
-@tweets = Tweet.all
-@tweets.each do |tweet|
-  p tweets.favorites_count # same as tweets.favorites.count
+Tweet.all.each do |tweet|
+  p tweet.favorites.count
 end
+# SELECT `tweets`.* FROM `tweets`
+# SELECT COUNT(*) FROM `tweets` WHERE `tweets`.`tweet_id` = 1
+# SELECT COUNT(*) FROM `tweets` WHERE `tweets`.`tweet_id` = 2
+# SELECT COUNT(*) FROM `tweets` WHERE `tweets`.`tweet_id` = 3
+# SELECT COUNT(*) FROM `tweets` WHERE `tweets`.`tweet_id` = 4
+# SELECT COUNT(*) FROM `tweets` WHERE `tweets`.`tweet_id` = 5
 ```
 
-You can eagerly load `count_loader` association by `includes` or `preload`.
+### Count eager loading
+
+With activerecord-precount gem installed, you can use `precount` method
+to eagerly load counts of associated records.
 
 ```rb
-@tweets = Tweet.all.preload(:favorites_count)
-@tweets.each do |tweet|
-  p tweets.favorites_count # this line doesn't execute an additional query
+Tweet.all.precount(:favorites).each do |tweet|
+  p tweet.favorites.count
 end
+# SELECT `tweets`.* FROM `tweets`
+# SELECT `tweets`.`in_reply_to_tweet_id` FROM `tweets` WHERE `tweets`.`tweet_id` IN (1, 2, 3, 4, 5)
 ```
 
-Since it is association, you can preload nested `count_loader` association.
+## Installation
 
-```rb
-@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
-  end
-end
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-precount'
 ```
 
 ## Supported Versions
@@ -69,12 +49,10 @@ end
   - 2.0, 2.1, 2.2
 - Rails
   - 4.1, 4.2
-
-### Databases
-
-- sqlite
-- mysql
-- postgresql
+- Databases
+  - sqlite
+  - mysql
+  - postgresql
 
 ## Testing
 

data/lib/active_record/precount/base_extension.rb

@@ -2,6 +2,18 @@ module ActiveRecord
   module Precount
     module BaseExtension
       delegate :precount, to: :all
+
+      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/collection_proxy_extension.rb

@@ -0,0 +1,18 @@
+module ActiveRecord
+  module Precount
+    module CollectionProxyExtension
+      def count(*args)
+        return super(*args) if args.present?
+
+        counter_name = :"#{@association.reflection.name}_count"
+        owner        = @association.owner
+
+        if owner.class.has_reflection?(counter_name)
+          owner.send(counter_name)
+        else
+          super(*args)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/precount/extend.rb

@@ -1,4 +1,5 @@
 require "active_record/precount/base_extension"
+require "active_record/precount/collection_proxy_extension"
 require "active_record/precount/has_many_extension"
 require "active_record/precount/join_dependency_extension"
 require "active_record/precount/preloader_extension"
@@ -12,6 +13,7 @@ ActiveSupport.on_load(:active_record) do
     Reflection.send(:prepend, Precount::ReflectionExtension)
     Associations::Preloader.send(:prepend, Precount::PreloaderExtension)
     Associations::JoinDependency.send(:prepend, Precount::JoinDependencyExtension)
+    Associations::CollectionProxy.send(:prepend, Precount::CollectionProxyExtension)
     Associations::Builder::HasMany.send(:prepend, Precount::Builder::HasManyExtension)
     Reflection::AssociationReflection.send(:prepend, Precount::AssociationReflectionExtension)
   end

data/lib/active_record/precount/relation_extension.rb

@@ -25,18 +25,6 @@ module ActiveRecord
           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

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

data/test/cases/associations/precount_test.rb

@@ -19,12 +19,14 @@ class PrecountTest < ActiveRecord::CountLoader::TestCase
   def test_precount_has_many_does_not_execute_n_1_queries
     assert_equal(Tweet.reflections['favs_count'].present?, false)
     assert_queries(1 + tweets_count) { Tweet.all.map { |t| t.favs.count } }
+    assert_queries(2) { Tweet.precount(:favs).map { |t| t.favs.count } }
     assert_queries(2) { Tweet.precount(:favs).map(&:favs_count) }
   end
 
   def test_precount_has_many_with_count_loader_does_not_execute_n_1_queries
     assert_queries(1 + tweets_count) { Tweet.all.map { |t| t.favorites.count } }
     assert_queries(1 + tweets_count) { Tweet.all.map(&:favorites_count) }
+    assert_queries(2) { Tweet.precount(:favorites).map { |t| t.favorites.count } }
     assert_queries(2) { Tweet.precount(:favorites).map(&:favorites_count) }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-precount
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -186,6 +186,7 @@ files:
 - lib/active_record/associations/count_loader.rb
 - lib/active_record/associations/preloader/count_loader.rb
 - lib/active_record/precount/base_extension.rb
+- lib/active_record/precount/collection_proxy_extension.rb
 - lib/active_record/precount/extend.rb
 - lib/active_record/precount/has_many_extension.rb
 - lib/active_record/precount/join_dependency_extension.rb