preload_counts 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df7e7e5e2c7c650635bde6f479c71b9ade401b08
-  data.tar.gz: 3ce8526debbc0c8cd1aec23416bfd265b525cc96
+  metadata.gz: 08d789c6a318d6934f7d40b3af28308bcc72f99a
+  data.tar.gz: 49116bb125a4e84ed0b0fd50e1d7d509839f913f
 SHA512:
-  metadata.gz: f2363d843cb7e77813f4d79918aafe6ff5ff7e53b046faa12bf3fdc3257ae54dc568f812507390891dec2e19e2d79354e8e7b6cad80013bc636088d3127e938b
-  data.tar.gz: 41e37ad43b98d39c9001254840684b2fb5bf96b200b6b63771ff13b5f814214dfbd1473655240b326131f7c1e30818f7734da91e02061360b14685c05a405898
+  metadata.gz: b7768313608e32515cd120f442056455c59f43d5df190313b30ba69100ba2e32ad3780434f9c873c0a28b211c79d77b3149d2bb3552af498f2653f6be2283e05
+  data.tar.gz: c50fbead90d424477e048cf354e74fe4a7326e335bc893e168518e2382802ae8e454af890db934cbc1a6daa43d97b0fbff31622a59bb6b40fe4a67648286a7bd

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/.rvmrc

@@ -1 +1 @@
-rvm use ree-1.8.7@preload_counts
+rvm use 2.2.0@preload_counts --create

data/.travis.yml

@@ -0,0 +1,14 @@
+env:
+  - "ACTIVERECORD_VERSION=4.2"
+  - "ACTIVERECORD_VERSION=4.1"
+  - "ACTIVERECORD_VERSION=4.0"
+  - "ACTIVERECORD_VERSION=master"
+
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - 2.2.0
+  - ruby-head
+  - jruby-19mode
+  - rbx
+

data/Gemfile

@@ -2,3 +2,20 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in preload_counts.gemspec
 gemspec
+
+activerecord_version = ENV["ACTIVERECORD_VERSION"] || "default"
+
+activerecord_version = case activerecord_version
+when "master"
+  {github: "rails/rails"}
+when "default"
+  ">= 3.2.0"
+else
+  "~> #{activerecord_version}"
+end
+
+
+gem "activerecord", activerecord_version
+gem "pry"
+gem "awesome_print"
+gem "rake"

data/README.md

@@ -0,0 +1,85 @@
+[![Build Status](https://travis-ci.org/smathieu/preload_counts.png?branch=master)](https://travis-ci.org/smathieu/preload_counts)
+
+# Preload Counts
+
+Did you ever write an index page that only needs the count of an association? Consider the following example: 
+
+
+```ruby
+# Models
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  named_scope :by_moderators, lambda { {:conditions => {:by_moderator => true} }
+end
+
+# Controller
+def index
+  @posts = Post.all
+end
+
+# View
+<% @posts.each do |post| %>
+  <%= post.name %>
+  (<%= post.comments.count %>)
+  (<%= post.comments.by_moderators.count %>)
+<% end %>
+```
+
+This will create two count request to the database for each post each time the view 
+is rendered. This is really slow. Preload counts helps you minimize the number of 
+calls to the database with minimal code change. 
+
+## Usage
+
+```ruby
+# Model
+class Post < ActiveRecord::Base
+  # create a named_scope to preload the comments count as well as the comments
+  # by_moderators. 
+  preload_counts :comments => [:by_moderators]
+
+  # preload_counts :comments would have only, preloaded the comments which
+  # would have been slightly faster. You can preload any number of scopes, but
+  # the more to preload, the more complex and slow the request will be.
+  has_many :comments
+end
+
+# Controller
+def index
+  # Tell AR to preload the counts in the select request. If you don't specify
+  # this, the behaviour is to fallback to the slow count.
+  @posts = Post.preload_comment_counts
+end
+
+# View
+# You have different accessor to get to the count. Beware of methods like
+# .empty? that has an internal call to count.
+<% @posts.each do |post| %>
+  <%= post.name %>
+  (<%= post.comments_count %>)
+  (<%= post.by_moderators_comments_count %>)
+<% end %>
+```
+
+## Benchmark
+More in depth benchmarking is needed, but here's sone annecdotal evidence.
+
+Without: 650ms per request
+With: 450ms per request
+
+That's right, this saved me 200ms per request with very minimal code change. 
+
+## Support
+This has been tested on Rails 2.3.12, 3.1.0 and 4.0.2.
+
+## Help
+### My requests are still slow? 
+
+It's possible that this isn't the fix you need. Sometimes multiple small requests might be faster than one large request. Always benchmark your page before using this gem. 
+
+Another thing you might want to look into is adding an index to speed up the query that is being generated by preload_counts. 

data/lib/preload_counts/ar.rb

@@ -1,9 +1,9 @@
-# This adds a scope to preload the counts of an association in one SQL query. 
+# This adds a scope to preload the counts of an association in one SQL query.
 #
 # Consider the following code:
 # Service.all.each{|s| puts s.incidents.acknowledged.count}
 #
-# Each time count is called, a db query is made to fetch the count. 
+# Each time count is called, a db query is made to fetch the count.
 #
 # Adding this to the Service class:
 #
@@ -28,22 +28,22 @@ module PreloadCounts
         singleton.send :define_method, name do
           sql = ["#{table_name}.*"] + scopes_to_select(association, scopes)
           sql = sql.join(', ')
-          scoped(:select => sql)
+          all.select(sql)
         end
 
         scopes.each do |scope|
           # Define accessor for each count
           accessor_name = find_accessor_name(association, scope)
           define_method accessor_name do
-            result = send(association)
-            result = result.send(scope) if scope
+            result = public_send(association)
+            result = result.public_send(scope) if scope
             (self[accessor_name] || result.size).to_i
           end
         end
 
       end
     end
-    
+
     private
     def scopes_to_select(association, scopes)
       scopes.map do |scope|
@@ -56,25 +56,21 @@ module PreloadCounts
       conditions = []
 
       if scope
-        if ActiveRecord::VERSION::MAJOR < 3
-          scope_sql = resolved_association.scopes[scope].call(resolved_association).send(:construct_finder_sql, {})
-        else
-          scope_sql = resolved_association.send(scope).to_sql
-        end
+        scope_sql = resolved_association.send(scope).to_sql
         condition = scope_sql.gsub(/^.*WHERE/, '')
         conditions << condition
       end
 
-      association_condition = self.reflections[association].options[:conditions]
-      conditions << association_condition if association_condition
+      r_scope = self.reflections.with_indifferent_access[association].scope
+      if r_scope
+        conditions += self.instance_eval(&r_scope).where_values
+      end
 
-      # FIXME This is a really hacking way of getting the named_scope condition.
-      # In Rails 3 we would have AREL to get to it. 
       sql = <<-SQL
-      (SELECT count(*) 
-       FROM #{association} 
-       WHERE #{association}.#{table_name.singularize}_id = #{table_name}.id AND 
-       #{conditions_to_sql conditions}) as #{find_accessor_name(association, scope)} 
+      (SELECT count(*)
+       FROM #{association}
+       WHERE #{association}.#{table_name.singularize}_id = #{table_name}.id AND
+       #{conditions_to_sql conditions}) AS #{find_accessor_name(association, scope)}
       SQL
     end
 

data/lib/preload_counts/version.rb

@@ -1,3 +1,3 @@
 module PreloadCounts
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/preload_counts.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "activerecord", "~> 3.2.0"
+  s.add_dependency "activerecord", "> 3.2.0"
+  s.add_development_dependency "rspec", "~> 2.0"
   s.add_development_dependency "sqlite3"
 end

data/spec/active_record_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 require 'logger'
 
-if ActiveRecord::VERSION::MAJOR < 3
-  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
-else
-  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-  ActiveRecord::Base.logger = Logger.new(nil)
-end
+puts "Using ActiveRecord #{ActiveRecord::VERSION::STRING}"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.logger = Logger.new(nil)
 
 def setup_db
   ActiveRecord::Schema.define(:version => 1) do
@@ -14,40 +12,36 @@ def setup_db
     end
 
     create_table :comments do |t|
-      t.integer :post_id, :null => false 
+      t.integer :post_id, :null => false
       t.datetime :deleted_at
     end
   end
 end
 
-setup_db 
+setup_db
 
 class Post < ActiveRecord::Base
   has_many :comments
-  has_many :active_comments, :conditions => "deleted_at IS NULL", :class_name => 'Comment'
+  has_many :active_comments, -> { where( "deleted_at IS NULL") }, :class_name => 'Comment'
   preload_counts :comments => [:with_even_id]
   preload_counts :active_comments
 end
 
 class PostWithActiveComments < ActiveRecord::Base
-  set_table_name :posts
+  self.table_name = :posts
 
-  has_many :comments, :conditions => "deleted_at IS NULL"
+  has_many :comments, -> { where "deleted_at IS NULL" }
   preload_counts :comments
 end
 
 class Comment < ActiveRecord::Base
   belongs_to :post
 
-  if ActiveRecord::VERSION::MAJOR < 3
-    named_scope :with_even_id, lambda { {:conditions => "comments.id % 2 == 0"} }
-  else
-    scope :with_even_id, where('id % 2 = 0')
-  end
+  scope :with_even_id, -> { where('id % 2 = 0') }
 end
 
 def create_data
-  post = Post.create 
+  post = Post.create
   5.times { post.comments.create }
   5.times { post.comments.create :deleted_at => Time.now }
 end
@@ -56,14 +50,14 @@ create_data
 
 describe Post do
   it "should have a preload_comment_counts scope" do
-    Post.should respond_to(:preload_comment_counts) 
+    Post.should respond_to(:preload_comment_counts)
   end
 
   describe 'instance' do
-    let(:post) { Post.first } 
+    let(:post) { Post.first }
 
     it "should have a comment_count accessor" do
-      post.should respond_to(:comments_count) 
+      post.should respond_to(:comments_count)
     end
 
     it "should be able to get count without preloading them" do
@@ -71,12 +65,12 @@ describe Post do
     end
 
     it "should have an active_comments_count accessor" do
-      post.should respond_to(:comments_count) 
+      post.should respond_to(:comments_count)
     end
   end
 
   describe 'instance with preloaded count' do
-    let(:post) { Post.preload_comment_counts.first } 
+    let(:post) { Post.preload_comment_counts.first }
 
     it "should be able to get the association count" do
       post.comments_count.should equal(10)
@@ -90,7 +84,7 @@ end
 
 describe PostWithActiveComments do
   describe 'instance with preloaded count' do
-    let(:post) { PostWithActiveComments.preload_comment_counts.first } 
+    let(:post) { PostWithActiveComments.preload_comment_counts.first }
 
     it "should be able to get the association count" do
       post.comments_count.should equal(5)

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 require 'rspec'
+require 'pry'
+require 'awesome_print'
 require 'active_record'
 require 'preload_counts'
 
 RSpec.configure do |config|
-  config.color_enabled = true
-  config.formatter     = 'documentation'
 end
 

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: preload_counts
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Simon Mathieu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 description: Preload association or scope counts. This can greatly reduce the number
@@ -60,10 +60,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - lib/preload_counts.rb
 - lib/preload_counts/ar.rb
@@ -80,17 +82,17 @@ 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: preload_counts
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Preload association or scope counts.

data/README.rdoc

@@ -1,82 +0,0 @@
-= Preload Counts
-
-Did you ever write an index page that only needs the count of an association? Consider the following example: 
-
-  # Models
-  class Post < ActiveRecord::Base
-    has_many :comments
-  end
-  
-  class Comment < ActiveRecord::Base
-    belongs_to :post
-  
-    named_scope :by_moderators, lambda { {:conditions => {:by_moderator => true} }
-  end
-
-  # Controller
-  def index
-    @posts = Post.all
-  end
-
-  # View
-  <% @posts.each do |post| %>
-    <%= post.name %>
-    (<%= post.comments.count %>)
-    (<%= post.comments.by_moderators.count %>)
-  <% end %>
-
-
-This will create two count request to the database for each post each time the view 
-is rendered. This is really slow. Preload counts helps you minimize the number of 
-calls to the database with minimal code change. 
-
-== Usage
-
-  # Model
-  class Post < ActiveRecord::Base
-    # create a named_scope to preload the comments count as well as the comments
-    # by_moderators. 
-    preload_counts :comments => [:by_moderators]
-
-    # preload_counts :comments would have only, preloaded the comments which
-    # would have been slightly faster. You can preload any number of scopes, but
-    # the more to preload, the more complex and slow the request will be.
-    has_many :comments
-  end
-
-  # Controller
-  def index
-    # Tell AR to preload the counts in the select request. If you don't specify
-    # this, the behaviour is to fallback to the slow count.
-    @posts = Post.preload_comment_counts
-  end
-
-  # View
-  # You have different accessor to get to the count. Beware of methods like
-  # .empty? that has an internal call to count.
-  <% @posts.each do |post| %>
-    <%= post.name %>
-    (<%= post.comments_count %>)
-    (<%= post.by_moderators_comments_count %>)
-  <% end %>
-
-== Benchmark
-
-More in depth benchmarking is needed, but here's sone annecdotal evidence.
-
-Without: 650ms per request
-With: 450ms per request
-
-That's right, this saved me 200ms per request with very minimal code change. 
-
-== Support
-
-This has been tested on Rails 2.3.12 and Rails 3.1.0
-
-== Help
-
-- My request is still slow? 
-
-It's possible that this isn't the fix you need. Sometime multiple small requests might be faster than one large request. Always benchmark your page before using this gem. 
-
-Another think you might want to look into is adding index to speedup the query that is being generated by preload_counts.