ar_counter 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+ar_counter
+==========
+
+Behave similar to ActiveRecord counter cache but it will put the counter on separate table.
+
+note:
+Only works with MySQL database
+
+
+== Example
+
+You need to create a stats table for the model that you want to count.
+
+=== Model :
+
+  class Driver < ActiveRecord::Base 
+    has_many :cars
+    has_stats_for :cars
+  end 
+
+  class Car < ActiveRecord::Base 
+    belongs_to :driver
+    stats_to :driver
+  end
+
+=== Migration :
+
+  create_table :drivers, :force => true do |t| 
+    t.string :name  
+  end
+
+  create_table :cars, :force => true do |t| 
+    t.string :brand  
+    t.integer :driver_id  
+  end  
+
+  create_table :driver_stats, :force => true do |t|
+    t.integer :driver_id
+    t.integer :cars_count, :default => 0
+  end
+  
+  # unique index must be created for MySQL ON DUPLICATE KEY UPDATE to work
+  add_index :driver_stats, :driver_id, :unique => true
+
+=== Create stats records for existing model
+
+  rake rebuild_counter_cached MODEL=Driver
+
+== How to use 
+
+  @driver.cars_count
+

data/Rakefile

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

data/ar_counter.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ar_counter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ar_counter"
+  s.version     = ARCounter::VERSION
+  s.authors     = ["Rafeequl"]
+  s.email       = ["rafeequl@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A simple model to model stats/counter}
+  s.description = %q{A simple model to model stats/counter.  It behaves similar to ActiveRecord counter cache but it will put the counter in separate table.}
+
+  s.rubyforge_project = "ar_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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/ar_counter.rb

@@ -0,0 +1,78 @@
+require "ar_counter/version"
+require "active_support"
+
+module ARCounter
+  extend ActiveSupport::Concern
+
+  included do |target|
+    target.class_eval { 
+      @@counter_cached ||= [] 
+    }
+  end 
+
+  module ClassMethods
+    def counts_for(*args)
+      after_create  :increase_counter_stats
+      after_destroy :decrease_counter_stats
+      class_eval(<<CODE)
+      @@counter_cached = args
+CODE
+    end 
+
+    def has_counter_for(*args)
+      args.each do |a|
+        class_eval(<<CODE)
+        define_method "#{a.to_s}_count" do
+          count_target(a) 
+        end
+CODE
+      end
+    end
+
+  end
+
+  def increase_counter_stats
+    counter_sql @@counter_cached, 1
+  end
+
+  def decrease_counter_stats
+    counter_sql @@counter_cached, -1
+  end
+
+  def counter_sql(counter_cached, increment_by)
+    counter_cached.each do |klas|
+      stat_table      = "#{klas}_stats"
+      owner_id_column = "#{klas}_id"
+      klass_id = self.send("#{klas}_id")
+      sql_for_increment(stat_table, stat_column, owner_id_column, klass_id, increment_by)
+    end
+  end
+
+  # SQL
+  def sql_for_subtract(stat_table, stat_column, owner_id_column, klass_id)
+    sql = "UPDATE #{stat_table} SET #{stat_column}=#{stat_column}-1 WHERE #{owner_id_column}=#{klass_id}"
+    ActiveRecord::Base.connection.execute(sql) if stat_table && owner_id_column && klass_id
+  end
+
+  def sql_for_add(stat_table, stat_column, owner_id_column, klass_id)
+    sql = "INSERT INTO #{stat_table} (#{owner_id_column},#{stat_column}) VALUES (#{klass_id},1) \
+           ON DUPLICATE KEY UPDATE #{stat_column}=#{stat_column}+1"
+    ActiveRecord::Base.connection.execute(sql) if stat_table && owner_id_column && klass_id
+  end
+
+  def sql_for_increment(stat_table, stat_column, owner_id_column, klass_id, increment_by)
+    sql = "INSERT INTO #{stat_table} (#{owner_id_column},#{stat_column}) VALUES (#{klass_id},1) \
+           ON DUPLICATE KEY UPDATE #{stat_column}=#{stat_column}+#{increment_by}"
+    ActiveRecord::Base.connection.execute(sql) if stat_table && owner_id_column && klass_id
+  end
+
+  def stat_column
+    "#{self.class.to_s.pluralize.downcase}_count"
+  end 
+
+  def count_target(target)
+    sql = "SELECT #{target.to_s}_count from #{self.class.to_s.downcase}_stats where #{self.class.to_s.downcase}_id=#{self.id}"
+    query = ActiveRecord::Base.connection.execute(sql)
+    query.first ? query.first[0].to_i : 0
+  end
+end

data/lib/ar_counter/version.rb

@@ -0,0 +1,3 @@
+module ARCounter
+  VERSION = "0.0.1"
+end

data/test/model_counter_test.rb

@@ -0,0 +1,68 @@
+require_relative './test_helper.rb'
+
+require_relative "../lib/ar_counter"
+
+class Driver < ActiveRecord::Base
+  include ARCounter
+  has_many :cars
+  has_counter_for :cars 
+end 
+
+class Car < ActiveRecord::Base
+  include ARCounter
+  belongs_to :driver
+  counts_for :driver
+end
+
+
+class ModelCounterTest < Test::Unit::TestCase 
+  
+  def test_new_user
+    @driver = Driver.new(:name => rand(1000))
+    @driver.save
+   
+    assert_equal 0, @driver.cars_count
+  end
+
+  def test_new_user_have_one_car
+    @driver = Driver.new(:name => rand(1000))
+    @driver.save
+    
+    @car = Car.new(:brand => "BMW", :driver_id => @driver.id)
+    @car.save
+    
+    assert_equal 1, @driver.cars_count
+  end
+  
+  def test_increase_cars_count_when_driver_add_more_car
+    @driver = Driver.new(:name => rand(1000))
+    @driver.save
+
+    2.times do |i|
+      car = Car.new(:brand => "Motor #{i}", :driver_id => @driver.id)
+      car.save
+    end
+
+    current_car_total = @driver.cars_count
+
+    new_car = Car.new(:brand => 'BMW', :driver_id => @driver.id)
+    new_car.save
+
+    assert_equal current_car_total+1, @driver.cars_count
+  end  
+  
+  def test_decrease_cars_count_when_driver_deleted_a_car 
+    @driver = Driver.new(:name => rand(1000))
+    @driver.save!
+    
+    2.times do |i|
+      car = @driver.cars.build(:brand => "Motor #{i}", :driver_id => @driver.id)
+      car.save
+    end
+    
+    current_car_total = @driver.cars_count
+    car = Car.last.destroy
+    assert_equal current_car_total-1, @driver.cars_count
+  end               
+  
+end

data/test/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define(:version => 0) do  
+  create_table :drivers, :force => true do |t| 
+    t.string :name  
+  end
+  
+  create_table :cars, :force => true do |t| 
+    t.string :brand  
+    t.integer :driver_id  
+  end  
+  
+  create_table :driver_stats, :force => true do |t|
+    t.integer :driver_id
+    t.integer :cars_count, :default => 0
+  end
+  
+  add_index(:driver_stats, :driver_id, :unique => true)
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'test/unit'
+require 'active_record'
+
+begin 
+  require 'mysql2'  
+  'mysql2'
+rescue 
+  MissingSourceFile 
+end
+
+db_config = { 
+  adapter:  "mysql2",
+  database: "model_counter",
+  username: "root",
+  password: "",
+  host:     "localhost"
+}
+
+ActiveRecord::Base.establish_connection(db_config.merge(:database => "mysql"))
+# drop db if exist
+ActiveRecord::Base.connection.drop_database(db_config[:database]) rescue nil
+# create db
+ActiveRecord::Base.connection.create_database(db_config[:database])
+ActiveRecord::Base.establish_connection(db_config)
+load(File.dirname(__FILE__) + "/schema.rb")
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: ar_counter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafeequl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies: []
+description: A simple model to model stats/counter.  It behaves similar to ActiveRecord
+  counter cache but it will put the counter in separate table.
+email:
+- rafeequl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- ar_counter.gemspec
+- lib/ar_counter.rb
+- lib/ar_counter/version.rb
+- test/model_counter_test.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: ''
+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: ar_counter
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: A simple model to model stats/counter
+test_files:
+- test/model_counter_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: