cache_back 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gemspec
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mick Staugaard
+
+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,17 @@
+= cache_back
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Mick Staugaard. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cache_back"
+    gem.summary = %Q{A write back caching layer on active record}
+    gem.description = %Q{A rewrite of cache money}
+    gem.email = "mick@staugaard.com"
+    gem.homepage = "http://github.com/staugaard/cache_back"
+    gem.authors = ["Mick Staugaard"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache_back #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/cache_back/cache.rb

@@ -0,0 +1,20 @@
+module CacheBack
+  class Cache
+    def initialize
+      reset!
+    end
+
+    def read(*args)
+      @local_cache[args[0]] ||= Rails.cache.read(*args)
+    end
+
+    def write(*args)
+      @local_cache[args[0]] = args[1]
+      Rails.cache.write(*args)
+    end
+
+    def reset!
+      @local_cache = {}
+    end
+  end
+end

data/lib/cache_back/configuration_mixin.rb

@@ -0,0 +1,40 @@
+require 'activesupport'
+
+module CacheBack
+  autoload :ReadMixin, 'cache_back/read_mixin'
+  autoload :WriteMixin, 'cache_back/write_mixin'
+
+  module ConfigurationMixin
+    def cache_back_version(version)
+      @cache_back_version = version.to_s
+    end
+
+    def inherited_cache_back_version
+      if self == ActiveRecord::Base
+        @cache_back_version
+      else
+        @cache_back_version ||= superclass.inherited_cache_back_version
+      end
+    end
+
+    def inherited_cache_back_options
+      if self == ActiveRecord::Base
+        @cache_back_option
+      else
+        @cache_back_option ||= superclass.inherited_cache_back_options
+      end
+    end
+
+    def cache_back_key_for(id)
+      "cache_back/#{name}/version_#{inherited_cache_back_version}/#{id}"
+    end
+
+    def has_cache_back(options = {})
+      @cache_back_version = options.delete(:version) || '1'
+      @cache_back_option = options
+
+      include WriteMixin unless instance_methods.include?('store_in_cache_back')
+      extend ReadMixin unless method_defined?(:find_one_with_cache_back!)
+    end
+  end
+end

data/lib/cache_back/middleware.rb

@@ -0,0 +1,13 @@
+module CacheBack
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      result = @app.call(env)
+      CacheBack.cache.reset!
+      result
+    end
+  end
+end

data/lib/cache_back/read_mixin.rb

@@ -0,0 +1,22 @@
+module CacheBack
+  module ReadMixin
+
+    def self.extended(model_class)
+      class << model_class
+        alias_method_chain :find_one, :cache_back
+      end
+    end
+
+    def find_one_with_cache_back(id, options)
+      record = CacheBack.cache.read(cache_back_key_for(id))
+
+      unless record
+        record = find_one_without_cache_back(id, options)
+        record.store_in_cache_back if record
+      end
+
+      record
+    end
+
+  end
+end

data/lib/cache_back/write_mixin.rb

@@ -0,0 +1,27 @@
+module CacheBack
+  module WriteMixin
+    def shallow_clone
+      clone = self.class.new
+      clone.instance_variable_set("@attributes", instance_variable_get(:@attributes))
+      clone.instance_variable_set("@new_record", new_record?)
+      clone
+    end
+
+    def cache_back_key
+      @cache_back_key ||= new_record? ? nil : self.class.cache_back_key_for(id)
+    end
+
+    def store_in_cache_back
+      CacheBack.cache.write(cache_back_key, shallow_clone, self.class.inherited_cache_back_options) if cache_back_key
+    end
+
+    def remove_from_cache_back
+      CacheBack.cache.delete(cache_back_key) if cache_back_key
+    end
+
+    def self.included(model_class)
+      model_class.after_save :store_in_cache_back
+      model_class.after_destroy :remove_from_cache_back
+    end
+  end
+end

data/lib/cache_back.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'activerecord'
+
+require 'cache_back/configuration_mixin'
+require 'cache_back/cache'
+
+module CacheBack
+  module_function
+
+  def cache
+    Thread.current["cache_back_cache"] ||= Cache.new
+  end
+end
+
+ActiveRecord::Base.extend(CacheBack::ConfigurationMixin)
+ActionController::Dispatcher.middleware.use(CacheBack::Middleware)

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cache_back'
+
+class Test::Unit::TestCase
+end

data/test/test_cache_back.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCacheBack < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: cache_back
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mick Staugaard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A rewrite of cache money
+email: mick@staugaard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/cache_back.rb
+- lib/cache_back/cache.rb
+- lib/cache_back/configuration_mixin.rb
+- lib/cache_back/middleware.rb
+- lib/cache_back/read_mixin.rb
+- lib/cache_back/write_mixin.rb
+- test/helper.rb
+- test/test_cache_back.rb
+has_rdoc: true
+homepage: http://github.com/staugaard/cache_back
+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: A write back caching layer on active record
+test_files: 
+- test/helper.rb
+- test/test_cache_back.rb