ninjudd-cache_version 0.9.3

data/README.rdoc

@@ -0,0 +1,34 @@
+= CacheVersion
+
+CacheVersion lets you maintain a version for any class. This can be used for cache
+invalidation, and RecordCache and MethodCache use it for that. It uses memcache to reduce
+database access when the version of a class hasn't changed.
+
+== Usage:
+
+  CacheVersion.get(User)
+  # => 0
+  
+  CacheVersion.increment(User)
+  CacheVersion.get(User)
+  # => 1
+
+  # Or you can use the alternate syntax:
+
+  User.version
+  # => 1
+
+  User.increment_version
+  User.version
+  # => 2
+
+== Install:
+
+  sudo gem install ninjudd-memcache -s http://gems.github.com
+  sudo gem install ninjudd-cache_version -s http://gems.github.com
+
+Also, you need to create a migration to make the cache_versions table. See examples/sample_migration.rb
+
+== License:
+
+Copyright (c) 2009 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 3
+:major: 0
+:minor: 9

data/lib/cache_version.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require 'active_record'
+require 'memcache_extended'
+
+module CacheVersion
+  def self.db
+    if @db.nil?
+      @db = ActiveRecord::Base.connection
+      @db = @db.send(:master) if defined?(DataFabric::ConnectionProxy) and @db.kind_of?(DataFabric::ConnectionProxy)
+    end
+    @db
+  end
+  
+  def self.cache
+    CACHE
+  end
+
+  def self.get(key)
+    key = key.to_s
+    version_by_key[key] ||= CACHE.get_or_set(cache_key(key)) do
+      db.select_value("SELECT version FROM cache_versions WHERE key = '#{key}'").to_i
+    end
+  end
+
+  def self.increment(key)
+    key = key.to_s
+    if get(key) == 0
+      db.execute("INSERT INTO cache_versions (key, version) VALUES ('#{key}', 1)")
+    else
+      db.execute("UPDATE cache_versions SET version = version + 1 WHERE key = '#{key}'")
+    end
+    invalidate_cache(key)
+    get(key)
+  end
+
+  def self.invalidate_cache(key)
+    key = key.to_s
+    cache.delete(cache_key(key))
+    version_by_key.delete(key)
+  end
+  
+  def self.clear_cache
+    @version_by_key = {}
+  end
+
+private
+  def self.version_by_key
+    @version_by_key ||= {}
+  end  
+    
+  def self.cache_key(key)
+    "v:#{key}"
+  end
+end
+
+class Module
+  def version(context = nil)
+    key = [self, context].compact.join('_')
+    CacheVersion.get(key)
+  end
+
+  def increment_version(context = nil)
+    key = [self, context].compact.join('_')
+    CacheVersion.increment(key)
+  end
+end
+
+class CacheVersionMigration < ActiveRecord::Migration
+  def self.up
+    create_table :cache_versions, :id => false do |t|
+      t.column :key, :string
+      t.column :version, :integer, :default => 0
+    end
+
+    add_index :cache_versions, :key, :unique => true
+  end
+
+  def self.down
+    drop_table :cache_versions
+  end
+end

data/test/cache_version_test.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CacheVersionTest < Test::Unit::TestCase
+  context 'with a memcache and db connection' do
+    setup do
+      system('memcached -d')
+      CACHE.servers = ["localhost:11211"]
+      CacheVersionMigration.up
+    end
+    
+    teardown do
+      system('killall memcached')
+      CacheVersionMigration.down
+    end
+
+    should 'increment cache version' do
+      5.times do |i|
+        assert_equal i, Object.version
+        Object.increment_version
+        assert_equal i + 1, Object.version
+      end
+      CacheVersion.clear_cache
+      assert_equal 5, Object.version
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../lib"
+$LOAD_PATH.unshift File.dirname(__FILE__) + "/../../memcache/lib"
+
+require 'cache_version'
+
+class Test::Unit::TestCase
+end
+
+CACHE = MemCache.new(
+  :ttl=>1800,
+  :compression=>false,
+  :readonly=>false,
+  :debug=>false,
+  :c_threshold=>10000,
+  :urlencode=>false
+)
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :host     => "localhost",
+  :username => "postgres",
+  :password => "",
+  :database => "record_cache_test"
+)
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.connection.client_min_messages = 'panic'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: ninjudd-cache_version
+version: !ruby/object:Gem::Version 
+  version: 0.9.3
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Store the version of any class for cache invalidation
+email: code@justinbalthrop.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/cache_version.rb
+- test/cache_version_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/ninjudd/cache_version
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Store the version of any class for cache invalidation
+test_files: []
+