scoped_cache_keys 0.1.0

data/.travis.yml

@@ -0,0 +1,5 @@
+script: "bundle exec rake"
+rvm:
+  - ree
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+
+gem 'rake'
+gem 'rspec', '~>2'
+gem 'activerecord'
+gem 'sqlite3'
+gem 'timecop'

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    scoped_cache_keys (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.3.4)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.6)
+    timecop (0.3.5)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  rake
+  rspec (~> 2)
+  scoped_cache_keys!
+  sqlite3
+  timecop

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+
+task :default do
+  sh "rspec spec/"
+end
+
+# extracted from https://github.com/grosser/project_template
+rule /^version:bump:.*/ do |t|
+  sh "git status | grep 'nothing to commit'" # ensure we are not dirty
+  index = ['major', 'minor','patch'].index(t.name.split(':').last)
+  file = 'lib/scoped_cache_keys/version.rb'
+
+  version_file = File.read(file)
+  old_version, *version_parts = version_file.match(/(\d+)\.(\d+)\.(\d+)/).to_a
+  version_parts[index] = version_parts[index].to_i + 1
+  version_parts[2] = 0 if index < 2 # remove patch for minor
+  version_parts[1] = 0 if index < 1 # remove minor for major
+  new_version = version_parts * '.'
+  File.open(file,'w'){|f| f.write(version_file.sub(old_version, new_version)) }
+
+  sh "bundle && git add #{file} Gemfile.lock && git commit -m 'bump version to #{new_version}'"
+end

data/Readme.md

@@ -0,0 +1,37 @@
+Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping of model-related caches.
+
+Install
+=======
+    sudo gem install scoped_cache_keys
+Or
+
+    rails plugin install git://github.com/grosser/scoped_cache_keys.git
+
+Usage
+=====
+
+Gives you a key that will change whenever expire_scoped_cache_key is called.
+
+    <% cache user.scoped_cache_key :products do %>
+      ... user.products.each ...
+    <% end %>
+
+    <% cache "something-else-" + user.scoped_cache_key :products %>
+      ... will also be expired ...
+    <% end %>
+
+    # app/sweepers/product_sweeper.rb
+    class ProductSweeper < ActionController::Caching::Sweeper
+      observe Product
+
+      def after_save(record)
+        record.user.expire_scoped_cache_key :products
+      end
+    end
+
+Author
+======
+[Zendesk](http://zendesk.com)<br/>
+michael@grosser.it<br/>
+License: MIT<br/>
+[![Build Status](https://secure.travis-ci.org/grosser/scoped_cache_keys.png)](http://travis-ci.org/grosser/scoped_cache_keys)

data/lib/scoped_cache_keys/version.rb

@@ -0,0 +1,3 @@
+module ScopedCacheKeys
+  VERSION = '0.1.0'
+end

data/lib/scoped_cache_keys.rb

@@ -0,0 +1,23 @@
+require 'scoped_cache_keys/version'
+
+module ScopedCacheKeys
+  def scoped_cache_key(scope)
+    base_key = Rails.cache.fetch(build_scoped_cache_key([scope])){ Time.now.to_f }
+    build_scoped_cache_key [scope, base_key]
+  end
+
+  def expire_scoped_cache_key(scope)
+    Rails.cache.delete(build_scoped_cache_key(scope))
+  end
+
+  def touch_if_necessary
+    raise "#{self.class} has no updated_at" unless respond_to? :updated_at=
+    touch if updated_at < 1.second.ago
+  end
+
+  private
+
+  def build_scoped_cache_key(*scopes)
+    "#{self.class.table_name}/#{id}/#{scopes.join('/')}"
+  end
+end

data/scoped_cache_keys.gemspec

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+name = "scoped_cache_keys"
+require "#{name}/version"
+
+Gem::Specification.new name, ScopedCacheKeys::VERSION do |s|
+  s.summary = "Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping of model-related caches + touch_if_necessary"
+  s.authors = ["Michael Grosser"]
+  s.email = "michael@grosser.it"
+  s.homepage = "http://github.com/grosser/#{name}"
+  s.files = `git ls-files`.split("\n")
+  s.license = 'MIT'
+end

data/spec/scoped_cache_keys_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.timestamp :updated_at
+  end
+
+  create_table :products do |t|
+  end
+end
+
+# setup models
+class User < ActiveRecord::Base
+  include ScopedCacheKeys
+end
+
+class Product < ActiveRecord::Base
+  include ScopedCacheKeys
+end
+
+describe ScopedCacheKeys do
+  let(:user){ User.create! }
+
+  before do
+    Rails.cache.clear
+  end
+
+  it "has a VERSION" do
+    ScopedCacheKeys::VERSION.should =~ /^[\.\da-z]+$/
+  end
+
+  describe "#scoped_cache_key" do
+    it "is scoped by id" do
+      Timecop.freeze "2011-01-01"
+      user.scoped_cache_key(:foo).should_not == User.create!.scoped_cache_key(:foo)
+    end
+
+    it "stays the same" do
+      user.scoped_cache_key(:foo).should == user.scoped_cache_key(:foo)
+    end
+
+    it "does not depend on updated_at" do
+      expect{
+        user.updated_at = 1.week.ago
+      }.to_not change{ user.scoped_cache_key(:foo) }
+    end
+  end
+
+  describe "#expire_scoped_cache_key" do
+    it "expires a specific scope" do
+      expect{
+        user.expire_scoped_cache_key :foo
+      }.to change{ user.scoped_cache_key(:foo) }
+    end
+
+    it "does not expire other keys" do
+      expect{
+        user.expire_scoped_cache_key :bar
+      }.to_not change{ user.scoped_cache_key(:foo) }
+    end
+  end
+
+  describe "#touch_if_necessary" do
+    context "with a model that has updated_at" do
+      let(:model) do
+        user = User.create!
+        user.update_attribute(:updated_at, 1.month.ago)
+        user
+      end
+
+      it  "increments updated_at" do
+        expect{
+          model.touch_if_necessary
+        }.to change{ model.reload.updated_at.to_i }
+      end
+
+      it  "does not update updated_at if it thinks the model is fresh" do
+        model.touch_if_necessary
+        expect{
+          model.class.update(model.id, :updated_at => 1.month.ago)
+          model.touch_if_necessary
+        }.to change{ model.reload.updated_at.to_i }
+      end
+    end
+
+    context "with a model that does not have updated_at" do
+      let(:model){ Product.create! }
+
+      it "raises" do
+        expect{
+          model.touch_if_necessary
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift 'lib'
+require 'scoped_cache_keys'
+
+require 'active_record'
+require 'timecop'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+module Rails
+  def self.cache
+    @cache ||= ActiveSupport::Cache::MemoryStore.new
+  end
+end
+
+RSpec.configure do |config|
+  config.before do
+    Timecop.return
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: scoped_cache_keys
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-04 00:00:00 Z
+dependencies: []
+
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- lib/scoped_cache_keys.rb
+- lib/scoped_cache_keys/version.rb
+- scoped_cache_keys.gemspec
+- spec/scoped_cache_keys_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/grosser/scoped_cache_keys
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add scoped_cache_key / expire_scoped_cache_key to your models for caching/sweeping of model-related caches + touch_if_necessary
+test_files: []
+