model_cached 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Ary Djmal
+
+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.rdoc

@@ -0,0 +1,81 @@
+= model_cached plugin
+
+This Rails 3 plugin gives you the ability to transparently cache single active record objects using memcached.
+
+The purpose is to cache by fields that are being validated for unique values.
+
+Cache gets refresh after save, and expire after destroy or after a logical delete.
+
+It is less than 100 lines of code, so don't be shy to look at the source for full understanding.
+
+
+== Usage
+
+In your model:
+
+  # defines find_by_id, and handles the cache refresh or expiration
+  # also modifies find, so when pass a single integer it uses find_by_id or raises and exception
+  cache_by :id
+  
+  # same plus defines find_by_email
+  cache_by :id, :email
+  
+  # same but only gives you the cache version if call it with the right scope
+  # eg: User.find_by_id(1) => will not use cache
+  # eg: current_account.users.find_by_id(1) => will use cache
+  cache_by :id, :email, :scope => :account_id
+
+  # you should use the :logical_delete option specifying the method that checks if a record is deleted
+  # disregard if not using logical deletes
+  cache_by :id, :email, :logical_delete => :is_deleted?
+
+== Real life example
+
+  class Account < ActiveRecord::Base
+    has_many :users
+    cache_by :subdomain
+  end
+  
+  class User < ActiveRecord::Base
+    belongs_to :account
+    cache_by :id, :scope => :account_id
+  end
+
+  class ApplicationController < ActionController::Base
+    before_filter :require_account, :require_user
+    
+    private
+    def current_account
+      @_current_account ||= Account.find_by_subdomain(request.subdomain)
+    end
+    
+    def current_user
+      @_current_user ||= session[:user_id] ? current_account.users.find_by_id(session[:user_id]) : nil
+    end
+    
+    def require_account
+      unless current_account
+        redirect_to sign_up_url
+      end
+    end
+    
+    def require_user
+      unless current_account
+        redirect_to sign_in_url
+      end
+    end
+  end
+
+
+== Dependencies
+
+  memcached
+
+
+== Install
+
+  ./script/plugin install git://github.com/arydjmal/model_cached.git
+
+
+
+Copyright (c) 2012 Ary Djmal, released under the MIT license

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the model_cached gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/model_cached.rb

@@ -0,0 +1,81 @@
+module ModelCached
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def cache_by(*column_names)
+      options = {logical_delete: nil, scope: nil}.merge(column_names.extract_options!)
+      options[:columns] = column_names
+      after_save :refresh_mc_keys
+      after_destroy :expire_mc_keys
+      class_eval %{ def self.mc_options; #{options}; end }
+      column_names.each do |column|
+        class_eval %{ def self.find_by_#{column}(value); find_cached_by(#{column.to_s.inspect}, value); end }
+      end
+      if column_names.include?(:id)
+        class_eval do
+          def self.find(*args)
+            if args.size == 1 && (id = args.first).is_a?(Integer)
+              find_by_id(id) || raise(ActiveRecord::RecordNotFound, "Couldn't find #{name} with ID=#{id}")
+            else
+              super(*args)
+            end
+          end
+        end
+      end
+      include ModelCached::InstanceMethods
+    end
+
+    def find_cached_by(column, value)
+      if mc_options[:scope] and mc_scope_key.nil?
+        where(column => value).first
+      else
+        Rails.cache.fetch(mc_key(column, value)) { where(column => value).first }
+      end
+    end
+
+    def mc_scope_key
+      self.new().mc_scope_key
+    end
+
+    def mc_key(column, value, scope_key=nil)
+      [column, value, scope_key || mc_scope_key].unshift(self.name.tableize).compact.join('/').gsub(/\s+/, '+')
+    end
+  end
+
+  module InstanceMethods
+    def mc_columns; self.class.mc_options[:columns]; end
+    def mc_scope; self.class.mc_options[:scope]; end
+    def mc_logical_delete; self.class.mc_options[:logical_delete]; end
+
+    def mc_key(column, value=nil)
+      self.class.mc_key(column, value || self.send(column), mc_scope_key)
+    end
+
+    def mc_scope_key
+      "#{mc_scope}:#{self.send(mc_scope)}" if mc_scope
+    end
+
+    def expire_mc_keys
+      mc_columns.each do |column|
+        Rails.cache.delete(mc_key(column))
+      end
+    end
+
+    def refresh_mc_keys
+      if mc_logical_delete && send(mc_logical_delete)
+        expire_mc_keys
+      else
+        mc_columns.each do |column|
+          Rails.cache.write(mc_key(column), self)
+          if send("#{column}_changed?")
+            Rails.cache.delete(mc_key(column, send("#{column}_was")))
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ModelCached)

data/model_cached.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'model_cached'
+  s.version     = '0.1.0'
+  s.authors     = ['Ary Djmal']
+  s.email       = ['arydjmal@gmail.com']
+  s.summary     = 'Rails gem that gives you the ability to transparently cache single active record objects using memcached.'
+  s.homepage    = 'http://github.com/arydjmal/model_cached'
+
+  s.add_dependency 'rails', '>= 3.0.0'
+
+  s.add_development_dependency 'rake'
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'test/unit'
+require 'rails'
+require 'active_support'
+require 'active_record'
+require 'memcache'
+require 'model_cached'
+
+ActiveRecord::Base.establish_connection({
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+})
+
+ActiveRecord::Schema.define do
+  create_table :accounts do |t|
+    t.string  :name
+  end
+
+  create_table :users do |t|
+    t.string  :email
+    t.integer :account_id
+    t.boolean :deleted
+  end
+end
+
+class Account < ActiveRecord::Base
+  has_many :users
+end
+
+class User < ActiveRecord::Base; end
+
+RAILS_CACHE = ActiveSupport::Cache.lookup_store(:mem_cache_store)

data/test/model_cached_test.rb

@@ -0,0 +1,155 @@
+require 'helper'
+
+class ModelCachedTest < Test::Unit::TestCase
+  def setup
+    User.delete_all
+    User.send(:cache_by, :id, :email)
+    @ary  = User.create!(:email => 'Ary')
+    @nati = User.create!(:email => 'Nati')
+    Rails.cache.clear
+  end
+
+  def test_make_cache_key
+    assert_equal 'users/email/Ary', @ary.mc_key('email')
+  end
+
+  def test_find_with_correct_data_when_not_in_cache
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+    assert_equal @ary, User.find(@ary.id)
+    assert_equal @ary, Rails.cache.read("users/id/#{@ary.id}")
+  end
+
+  def test_find_with_incorrect_data_when_not_in_cache
+    assert_raise(ActiveRecord::RecordNotFound) do
+      User.find(1234567890)
+    end
+  end
+
+  def test_find_by_id_with_correct_data_when_not_in_cache
+    assert_equal @ary, User.find_by_id(@ary.id)
+  end
+
+  def test_find_by_id_with_correct_data_when_in_cache
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+    assert_equal @ary, User.find_by_id(@ary.id)
+    assert_equal @ary, Rails.cache.read("users/id/#{@ary.id}")
+  end
+
+  def test_find_by_email_with_correct_data
+    assert_equal @ary, User.find_by_email('Ary')
+  end
+
+  def test_find_by_email_with_correct_data_when_in_cache
+    Rails.cache.write('users/email/Naty', @nati)
+    assert_equal @nati, User.find_by_email('Nati')
+  end
+
+  def test_find_by_email_with_incorrect_data
+    assert_equal nil, User.find_by_email('Djmal')
+  end
+
+  def test_should_refresh_cache_after_save
+    @ary.email = 'new_email'
+    @ary.save
+    assert_equal 'new_email', Rails.cache.read("users/id/#{@ary.id}").try(:email)
+  end
+
+  def test_should_expire_cache_and_write_new_cache_when_keys_are_modified
+    assert_equal nil, Rails.cache.read('users/email/Ary')
+    @ary = User.find_by_email('Ary')
+    assert_equal @ary, Rails.cache.read('users/email/Ary')
+    @ary.email = 'new_email'
+    @ary.save
+    assert_equal nil, Rails.cache.read('users/email/Ary')
+    assert_equal @ary, Rails.cache.read('users/email/new_email')
+  end
+
+  def test_should_expire_cache_on_destroy
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+    @ary = User.find_by_id(@ary.id)
+    assert_equal @ary, Rails.cache.read("users/id/#{@ary.id}")
+    @ary.destroy
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+  end
+end
+
+class ModelCachedWithScopeTest < Test::Unit::TestCase
+  def setup
+    User.delete_all
+    User.send(:cache_by, :id, :email, :scope => :account_id)
+    @account = Account.create!(:name => 'Natural Bits')
+    @ary  = @account.users.create!(:email => 'Ary')
+    @nati = @account.users.create!(:email => 'Nati')
+    Rails.cache.clear
+  end
+
+  def test_make_cache_key
+    assert_equal "users/email/Ary/account_id:#{@account.id}", @ary.mc_key('email')
+  end
+
+  def test_find_by_id_with_correct_data_when_not_in_cache
+    assert_equal @ary, @account.users.find_by_id(@ary.id)
+  end
+
+  def test_find_by_id_with_correct_data_when_in_cache
+    key = "users/id/#{@ary.id}/account_id:#{@account.id}"
+    assert_equal nil, Rails.cache.read(key)
+    @account.users.find_by_id(@ary.id)
+    assert_equal @ary, Rails.cache.read(key)
+  end
+
+  def test_find_by_id_without_scoping
+    key = "users/id/#{@ary.id}/account_id:#{@account.id}"
+    assert_equal nil, Rails.cache.read(key)
+    User.find_by_id(@ary.id)
+    assert_equal nil, Rails.cache.read(key)
+  end
+
+  def test_find_by_email_with_correct_data    
+    assert_equal @ary, @account.users.find_by_email('Ary')
+  end
+
+  def test_find_by_email_with_correct_data_when_in_cache
+    Rails.cache.write('users/email/Naty', @nati)
+    assert_equal @nati, @account.users.find_by_email('Nati')
+  end
+
+  def test_find_by_email_with_incorrect_data
+    assert_equal nil, @account.users.find_by_email('Djmal')
+  end
+
+  def test_should_refresh_cache_after_save
+    @ary.email = 'new_email'
+    @ary.save
+    assert_equal 'new_email', Rails.cache.read("users/id/#{@ary.id}/account_id:#{@account.id}").try(:email)
+  end
+
+  def test_should_expire_cache_and_write_new_cache_when_keys_are_modified
+    assert_equal nil, Rails.cache.read("users/email/Ary/account_id:#{@account.id}")
+    @ary = @account.users.find_by_email('Ary')
+    @ary.email = 'new_email'
+    @ary.save
+    assert_equal nil, Rails.cache.read("users/email/Ary/account_id:#{@account.id}")
+    assert_equal @ary, Rails.cache.read("users/email/new_email/account_id:#{@account.id}")
+  end
+end
+
+class ModelCachedWithLogicalDeleteTest < Test::Unit::TestCase
+  def setup
+    User.delete_all
+    User.send(:cache_by, :id, :logical_delete => :is_deleted?)
+    User.class_eval { def is_deleted?() deleted == true; end }
+    @ary  = User.create!(:email => 'Ary', :deleted => false)
+    @nati = User.create!(:email => 'Nati', :deleted => false)
+    Rails.cache.clear
+  end
+
+  def test_default_logical_delete
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+    @ary = User.find_by_id(@ary.id)
+    assert_equal @ary, Rails.cache.read("users/id/#{@ary.id}")
+    @ary.deleted = true
+    @ary.save
+    assert_equal nil, Rails.cache.read("users/id/#{@ary.id}")
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: model_cached
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ary Djmal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70255150855040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70255150855040
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70255150852720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70255150852720
+description: 
+email:
+- arydjmal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ./lib/model_cached.rb
+- ./MIT-LICENSE
+- ./model_cached.gemspec
+- ./Rakefile
+- ./README.rdoc
+- ./test/helper.rb
+- ./test/model_cached_test.rb
+homepage: http://github.com/arydjmal/model_cached
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rails gem that gives you the ability to transparently cache single active
+  record objects using memcached.
+test_files: []
+has_rdoc: