scope_counter 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in scope_counter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Yuri Barbashov.
+
+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,49 @@
+scope_counter is a simple implementation of counter_cache functionality for models scopes with ActiveRecord
+
+Install
+--------
+
+```shell
+gem install scope_counter
+```
+or add the following line to Gemfile:
+
+```ruby
+gem 'scope_counter'
+```
+and run `bundle install` from your shell.
+
+Usage
+--------
+
+Create columns in db according to scopes in your model ("#{scope_name}_count"):
+
+```ruby
+t.integer :usefull_count, :default => 0
+t.integer :useless_count, :default => 0
+```
+
+List in array scopes, which you want to create counter cache for, as :conter_cache option:
+
+```ruby
+class Advice  < ActiveRecord::Base
+  has_many :utilities
+end
+
+class Utility  < ActiveRecord::Base
+  belongs_to :advice, :counter_cache => [:usefull, :useless]
+  scope :usefull, where(:usefull => true)
+  scope :useless, where(:usefull => false)
+end
+
+advice = Advice.create
+
+advice.usefull_count # => 0
+
+advice.utilities.usefull.create
+
+advice.usefull_count # => 1
+```
+
+
+

data/Rakefile

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

data/lib/scope_counter/version.rb

@@ -0,0 +1,3 @@
+module ScopeCounter
+  VERSION = "0.1.0"
+end

data/lib/scope_counter.rb

@@ -0,0 +1,49 @@
+require 'active_record'
+require "scope_counter/version"
+
+module ScopeCounter
+  module BelongsToExtension
+    module ActiveRecord::Associations::Builder
+      class BelongsTo < SingularAssociation #:nodoc:
+        private
+        alias_method :old_add_counter_cache_callbacks, :add_counter_cache_callbacks
+        
+        def add_counter_cache_callbacks(reflection)
+          if Array === options[:counter_cache]
+            name = self.name
+            options[:counter_cache].each do |scope|
+              cache_column = "#{scope}_count"
+              
+              method_name = "belongs_to_counter_cache_after_create_for_#{scope}"
+              model.redefine_method(method_name) do
+                record = send(name)
+                record.class.increment_counter(cache_column, record.id) unless record.nil?
+              end
+              
+              in_scope_method = "in_#{scope}?"
+              model.redefine_method(in_scope_method) do
+                send(:class).send(scope).exists?(send(:id))
+              end
+            
+              model.after_create(method_name, :if => :"#{in_scope_method}")
+      
+              method_name = "belongs_to_counter_cache_before_destroy_for_#{scope}"
+              model.redefine_method(method_name) do
+                record = send(name)
+                record.class.decrement_counter(cache_column, record.id) unless record.nil?
+              end
+              model.before_destroy(method_name,:if => :"#{in_scope_method}")
+  
+              model.send(:module_eval,
+                "#{reflection.class_name}.send(:attr_readonly,\"#{cache_column}\".intern) if defined?(#{reflection.class_name}) && #{reflection.class_name}.respond_to?(:attr_readonly)", __FILE__, __LINE__
+              )
+            end
+          else
+            old_add_counter_cache_callbacks(reflection)
+          end
+        end
+      end 
+    end
+  end
+end
+

data/scope_counter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scope_counter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scope_counter"
+  s.version     = ScopeCounter::VERSION
+  s.authors     = ["Yuri Barbashov"]
+  s.email       = ["lolcoltd@gmail.com"]
+  s.homepage    = "https://github.com/playa/scope_counter"
+  s.summary     = %q{Provide counter_cache functionality for model scopes}
+  s.description = %q{Simple implementation of counter_cache functionality for model scopes}
+
+  s.rubyforge_project = "scope_counter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3-ruby"
+  s.add_dependency "activerecord", "~> 3.0"
+end

data/spec/lib/scope_counter_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "scope_counter" do
+  before(:each) do
+    @advice = Advice.create(:text => "Some advice") 
+  end
+
+  it "should increase usefull count after usefull utility creation" do
+    @advice.utilities.create(:usefull => true)
+    @advice.reload
+    @advice.usefull_count.should == 1
+    @advice.useless_count.should == 0
+  end
+  
+  it "should increase useless count after useless utility creation" do
+    @advice.utilities.create(:usefull => false)
+    @advice.reload
+    @advice.useless_count.should == 1
+    @advice.usefull_count.should == 0
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'scope_counter'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", 
+                                       :database => File.dirname(__FILE__) + "/scope_counter.sqlite3")
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'

data/spec/support/models.rb

@@ -0,0 +1,9 @@
+class Advice  < ActiveRecord::Base
+  has_many :utilities
+end
+
+class Utility  < ActiveRecord::Base
+  belongs_to :advice, :counter_cache => [:usefull, :useless]
+  scope :usefull, where(:usefull => true)
+  scope :useless, where(:usefull => false)
+end

data/spec/support/schema.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :advices, :force => true do |t|
+    t.string :text
+    t.integer :usefull_count, :default => 0
+    t.integer :useless_count, :default => 0
+  end
+
+  create_table :utilities, :force => true do |t|
+    t.boolean :usefull
+    t.integer :advice_id
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: scope_counter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Yuri Barbashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &72891890 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *72891890
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &72891660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72891660
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &72891400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *72891400
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &72891150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *72891150
+description: Simple implementation of counter_cache functionality for model scopes
+email:
+- lolcoltd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/scope_counter.rb
+- lib/scope_counter/version.rb
+- scope_counter.gemspec
+- spec/lib/scope_counter_spec.rb
+- spec/scope_counter.sqlite3
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/playa/scope_counter
+licenses: []
+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: scope_counter
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provide counter_cache functionality for model scopes
+test_files: []