cache_helper 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,7 @@
+= CacheHelper
+
+Overrides ActiveRecord::Base#cache_key to return unique keys for new records
+and adds methods to more easily work with Rails caching.
+
+Author::  Clyde Law (mailto:clyde@futureadvisor.com)
+License:: Released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/cache_helper.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cache_helper/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cache_helper"
+  s.version     = CacheHelper::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Clyde Law"]
+  s.email       = ["clyde@futureadvisor.com"]
+  s.homepage    = %q{http://github.com/FutureAdvisor/cache_helper}
+  s.summary     = %q{Adds methods to more easily work with Rails caching.}
+  s.description = %q{Overrides ActiveRecord::Base#cache_key to return unique keys for new records and adds methods to more easily work with Rails caching.}
+  s.license     = 'MIT'
+
+  s.add_dependency('activerecord', '>= 2.1.0')
+  s.add_dependency('alias_helper')
+
+  s.rubyforge_project = "cache_helper"
+
+  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"]
+end

data/lib/cache_helper.rb

@@ -0,0 +1,48 @@
+module CacheHelper
+  def self.included(base)
+    base.alias_method_chain :cache_key, :new_record_id
+    base.extend(ClassMethods)
+  end
+
+  # Overrides ActiveRecord::Base#cache_key to return unique keys for new
+  # records.
+  def cache_key_with_new_record_id
+    key = cache_key_without_new_record_id
+    if self.new_record?
+      # The object is not yet database-backed; append the object's ID and the
+      # current time to use as a provisional cache key.
+      if @temp_cache_key.nil?
+        @temp_cache_key = key << "(#{self.__id__})-#{Time.now.to_s(:number)}"
+      else
+        key = @temp_cache_key
+      end
+    end
+    key
+  end
+
+  # Returns a cache key associated with the record for the specified method
+  # and options.
+  def method_cache_key(method, options = {})
+    key = self.cache_key + "-#{method.to_s}"
+    key << ".#{options.hash.to_s(36)}" unless options.empty?
+    key
+  end
+
+  module ClassMethods
+  private
+    # Wraps an instance method with basic caching functionality.
+    def cache_method(method)
+      method_with_caching, method_without_caching = method_chain_aliases(method, :caching)
+      define_method(method_with_caching.to_sym) {
+        Rails.cache.fetch(method_cache_key(method)) do
+          self.__send__(method_without_caching.to_sym)
+        end
+      }
+      alias_method_chain method, :caching
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include CacheHelper
+end

data/lib/cache_helper/version.rb

@@ -0,0 +1,3 @@
+module CacheHelper
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: cache_helper
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Clyde Law
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: alias_helper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Overrides ActiveRecord::Base#cache_key to return unique keys for new records and adds methods to more easily work with Rails caching.
+email: 
+- clyde@futureadvisor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- cache_helper.gemspec
+- lib/cache_helper.rb
+- lib/cache_helper/version.rb
+homepage: http://github.com/FutureAdvisor/cache_helper
+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: cache_helper
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Adds methods to more easily work with Rails caching.
+test_files: []
+