cached_counts 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @cached_counts --create

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mario Visic
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Cached Counts
+
+Performing `COUNT(*)` operations in relational databases can get slow for large sets of data. There are already existing ways to deal with improving counting performance and techniques to avoid doing it altogether.
+
+This gem adds caching support to the `ActiveRecord::Relation` class to allow repeated count calls to be cached. Counts are cached based on the query that is to be run and cleared when records are saved or destroyed.
+
+Cached counts works well with tables that are large and have many more selects than inserts. You will see *some* benefits even in tables that have regular inserts, but the gains will not be as great.
+
+
+## Installation
+
+Add it to your gemfile in your Rails 3.2+ project
+
+    gem 'cached_counts'
+
+Cached counts uses your Rails.cache setup, for a good memcached store, [look at dalli](https://github.com/mperham/dalli)
+
+## Usage
+
+You can use the size, length or count method on any active record model.
+
+```ruby
+  User.count # => # Cached count value
+  User.size # => # Cached count value
+  User.length # => # Cached count value
+```
+
+You can use scopes as well
+
+```ruby
+  User.where(:admin => true).count # Cached count value for this specific query
+```
+
+You can clear the cache at any time for a model:
+
+```ruby
+  User.clear_count_cache
+```
+
+You can also use the non cached count on the class or scopes.
+
+```ruby
+  User.count_without_caching # => Runs a database lookup
+  User.where(:admin => true).count_without_caching # => Runs a database lookup
+```
+
+## Clearing the cache
+
+The counts cache is cleared for a model after save and after destroy.
+If you are updating the database manually without these methods then you will need to clear the cache yourself.
+
+```ruby
+User.update_all(:name => 'joe')
+User.clear_count_cache
+```
+
+## Example
+
+```
+1.9.3p194 :020 > User.count
+   (0.2ms)  SELECT COUNT(*) FROM "users"
+ => 130 
+1.9.3p194 :021 > User.count
+ => 130
+1.9.3p194 :022 > User.last.destroy
+ # ...
+ => #<User id: 131 ...>
+1.9.3p194 :023 > User.count
+   (0.4ms)  SELECT COUNT(*) FROM "users"
+ => 129
+1.9.3p194 :024 > User.count
+ => 129
+1.9.3p194 :036 > User.where(:admin => true).count
+   (0.5ms)  SELECT COUNT(*) FROM "users" WHERE "users"."admin" = 't'
+ => 72
+1.9.3p194 :037 > User.where(:admin => true).count
+ => 72
+1.9.3p194 :038 >
+```
+
+## TODO
+ - Better testing

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/cached_counts.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cached_counts/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cached_counts"
+  gem.version       = CachedCounts::VERSION
+  gem.authors       = ["Mario Visic"]
+  gem.email         = ["mario@mariovisic.com"]
+  gem.description   = %q{Speed up ActiveRecord counting with caching}
+  gem.summary       = %q{Uses the Rails cache to store cached counts for active record models as well as models with scopes}
+  gem.homepage      = "https://github.com/desktoppr/cached_counts"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "activesupport"
+  gem.add_development_dependency "activerecord"
+end

data/contributing.md

@@ -0,0 +1,8 @@
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write a failing test
+4. Commit your changes with passing tests (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/cached_counts/active_record_base_methods.rb

@@ -0,0 +1,11 @@
+require 'active_support'
+
+module CachedCounts
+  module ActiveRecordBaseMethods
+    extend ActiveSupport::Concern
+
+    delegate :clear_count_cache, :count_with_caching, :length_with_caching,
+      :size_with_caching, :count_without_caching, :length_without_caching,
+      :size_without_caching, :to => :scoped
+  end
+end

data/lib/cached_counts/active_record_relation_methods.rb

@@ -0,0 +1,29 @@
+require 'active_support'
+
+module CachedCounts
+  module ActiveRecordRelationMethods
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :count,  :caching
+      alias_method_chain :length, :caching
+      alias_method_chain :size,   :caching
+    end
+
+    def count_with_caching(*args)
+      CachedCounts::Cache.new(self).count
+    end
+
+    def length_with_caching(*args)
+      CachedCounts::Cache.new(self).count
+    end
+
+    def size_with_caching(*args)
+      CachedCounts::Cache.new(self).count
+    end
+
+    def clear_count_cache
+      CachedCounts::Cache.new(self).clear
+    end
+  end
+end

data/lib/cached_counts/cache.rb

@@ -0,0 +1,37 @@
+module CachedCounts
+  class Cache
+    def initialize(scope)
+      @scope = scope
+    end
+
+    def count(*args)
+      if all_keys.include?(current_key)
+        Rails.cache.fetch(current_key)
+      else
+        @scope.count_without_caching(*args).tap do |count|
+          Rails.cache.write(current_key, count)
+          Rails.cache.write(list_key, all_keys + [current_key])
+        end
+      end
+    end
+
+    def clear
+      all_keys.each { |key| Rails.cache.delete(key) }
+      Rails.cache.delete(list_key)
+    end
+
+    private
+
+    def all_keys
+      Rails.cache.fetch(list_key) || []
+    end
+
+    def list_key
+      "count:#{@scope.model_name.underscore}::keys"
+    end
+
+    def current_key
+      "count:#{@scope.model_name.underscore}::cached_count::#{@scope.to_sql}"
+    end
+  end
+end

data/lib/cached_counts/cached_count_observer.rb

@@ -0,0 +1,21 @@
+require 'active_record'
+
+module CachedCounts
+  class CachedCountObserver < ActiveRecord::Observer
+    observe :'ActiveRecord::Base'
+
+    def reload
+      observed_classes.each do |klass|
+        klass.name.constantize.add_observer(self)
+      end
+    end
+
+    def after_save(record)
+      CachedCounts::Cache.new(record.class).clear
+    end
+
+    def after_destroy(record)
+      CachedCounts::Cache.new(record.class).clear
+    end
+  end
+end

data/lib/cached_counts/railtie.rb

@@ -0,0 +1,14 @@
+module CachedCounts
+  class Railtie < ::Rails::Railtie
+    initializer 'cached_counts' do |app|
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Relation.send :include, CachedCounts::ActiveRecordRelationMethods
+        ::ActiveRecord::Base.send :extend, CachedCounts::ActiveRecordBaseMethods
+      end
+
+      app.config.after_initialize { app.config.active_record.observers += [ :cached_count_observer ] }
+      app.config.to_prepare { CachedCounts::CachedCountObserver.instance.reload }
+    end
+  end
+end
+

data/lib/cached_counts/version.rb

@@ -0,0 +1,3 @@
+module CachedCounts
+  VERSION = '0.1.0'
+end

data/lib/cached_counts.rb

@@ -0,0 +1,15 @@
+begin
+  require 'rails'
+  require 'cached_counts/railtie'
+rescue LoadError
+  #do nothing
+end
+
+require 'cached_counts/Active_record_base_methods'
+require 'cached_counts/active_record_relation_methods'
+require 'cached_counts/cache'
+require 'cached_counts/cached_count_observer'
+require 'cached_counts/version'
+
+module CachedCounts
+end

data/spec/cached_counts/cache_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'cached_counts/cache'
+
+describe CachedCounts::Cache do
+  let(:scope) { Scope.new('Cat') }
+  let(:cache) { described_class.new(scope) }
+
+  before { cache.clear }
+
+  describe '#count' do
+    context 'when there is no cached count' do
+      it 'returns the cached count' do
+        scope.should_receive(:count_without_caching).and_return(10)
+        cache.count.should == 10
+      end
+
+      it 'passes any given options to the count method' do
+        scope.should_receive(:count_without_caching).with('first').and_return(5)
+        cache.count('first').should == 5
+      end
+    end
+
+    context 'when there is already a cached count' do
+      before do
+        scope.should_receive(:count_without_caching).once.and_return(8)
+        cache.count
+      end
+
+      it 'returns the cached value' do
+        cache.count.should == 8
+      end
+    end
+
+    context 'using multiple scope objects' do
+      let(:new_scope)  { Scope.new('Cat') }
+      let(:same_scope) { Scope.new('Cat') }
+
+      before { new_scope.stub(:to_sql => 'new-sql-here') }
+
+      it 'uses a different cache for different to_sql values' do
+        scope.stub(:count_without_caching => 5)
+        new_scope.stub(:count_without_caching => 4)
+
+        cache.count
+
+        described_class.new(new_scope).count.should == 4
+      end
+
+      it 'uses the same cache for scopes with the same to_sql values' do
+        scope.stub(:count_without_caching => 5)
+        same_scope.should_not_receive(:count_without_caching)
+
+        cache.count
+        described_class.new(same_scope).count.should == 5
+      end
+    end
+  end
+
+  describe '#clear' do
+    it 'clears the cached count' do
+      scope.stub(:count_without_caching => 9)
+      cache.count.should == 9
+      cache.clear
+      scope.stub(:count_without_caching => 11)
+
+      cache.count.should == 11
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'active_support/all'
+require 'support/cache'
+require 'support/rails'
+require 'support/scope'

data/spec/support/cache.rb

@@ -0,0 +1,11 @@
+class Cache < Hash
+  # A regular hash will raise a KeyError when we try to fetch a key that does
+  # not exist
+  def fetch(*args)
+    super rescue nil
+  end
+
+  def write(key, value)
+    self[key] = value
+  end
+end

data/spec/support/rails.rb

@@ -0,0 +1,5 @@
+class Rails;
+  def self.cache;
+    @@cache ||= Cache.new
+  end
+end

data/spec/support/scope.rb

@@ -0,0 +1,7 @@
+class Scope
+  attr_accessor :model_name, :to_sql
+  def initialize(model_name)
+    @model_name = model_name
+    @to_sql     = 'sql'
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: cached_counts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mario Visic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Speed up ActiveRecord counting with caching
+email:
+- mario@mariovisic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cached_counts.gemspec
+- contributing.md
+- lib/cached_counts.rb
+- lib/cached_counts/active_record_base_methods.rb
+- lib/cached_counts/active_record_relation_methods.rb
+- lib/cached_counts/cache.rb
+- lib/cached_counts/cached_count_observer.rb
+- lib/cached_counts/railtie.rb
+- lib/cached_counts/version.rb
+- spec/cached_counts/cache_spec.rb
+- spec/spec_helper.rb
+- spec/support/cache.rb
+- spec/support/rails.rb
+- spec/support/scope.rb
+homepage: https://github.com/desktoppr/cached_counts
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Uses the Rails cache to store cached counts for active record models as well
+  as models with scopes
+test_files:
+- spec/cached_counts/cache_spec.rb
+- spec/spec_helper.rb
+- spec/support/cache.rb
+- spec/support/rails.rb
+- spec/support/scope.rb