cache_version 0.9.4

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Justin Balthrop
+
+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,37 @@
+= 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 cache-version -s http://gemcutter.org
+
+Also, you need to create a migration to make the cache_versions table. See examples/sample_migration.rb
+
+== Dependencies:
+
+* {memcache}[http://github.com/ninjudd/memcache]
+
+== License:
+
+Copyright (c) 2009 Justin Balthrop, Geni.com; Published under The MIT License, see LICENSE

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "cache_version"
+    s.summary = %Q{Store the version of any class for cache invalidation}
+    s.email = "code@justinbalthrop.com"
+    s.homepage = "http://github.com/ninjudd/cache_version"
+    s.description = "Store the version of any class for cache invalidation"
+    s.authors = ["Justin Balthrop"]
+    s.add_dependency('memcache', '>= 1.0.0')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'cache_version'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.9.4

data/examples/sample_migration.rb

@@ -0,0 +1,9 @@
+class CreateCacheVersions < ActiveRecord::Migration
+  def self.up
+    CacheVersionMigration.up
+  end
+
+  def self.down
+    CacheVersionMigration.down
+  end
+end

data/lib/cache_version.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'memcache'
+require 'active_record'
+
+module CacheVersion
+  def self.db
+    db = ActiveRecord::Base.connection
+    if defined?(DataFabric::ConnectionProxy) and db.kind_of?(DataFabric::ConnectionProxy)
+      db.send(:master)
+    else
+      db
+    end
+  end
+  
+  def self.cache
+    CACHE
+  end
+
+  def self.get(key)
+    key = key.to_s
+    version_by_key[key] ||= CACHE.get_or_add(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,25 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class CacheVersionTest < Test::Unit::TestCase
+  context 'with a memcache and db connection' do
+    setup do
+      system('memcached -d')
+      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,23 @@
+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(:servers => 'localhost')
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :host     => "localhost",
+  :username => "postgres",
+  :password => "",
+  :database => "test"
+)
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.connection.client_min_messages = 'panic'

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: cache_version
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- Justin Balthrop
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-20 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: memcache
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+description: Store the version of any class for cache invalidation
+email: code@justinbalthrop.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/sample_migration.rb
+- 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: 
+- --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: 3
+summary: Store the version of any class for cache invalidation
+test_files: 
+- test/cache_version_test.rb
+- test/test_helper.rb
+- examples/sample_migration.rb