perma_cache 0.0.3

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swo
+*.swn
+*.swp
+

data/.ruby-gemset

@@ -0,0 +1 @@
+perma_cache

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Sharpe
+
+MIT License
+
+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.md

@@ -0,0 +1,64 @@
+# PermaCache
+
+Provides a dsl to add pull-through caching to a given method while
+also provding an interface to overwrite that cache when necessary.
+
+Useful for expensive objects that you want to write-once on the backend
+while still allowing your frontend to rebuild the object if the
+cache clears for any reason
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'perma_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perma_cache
+
+## Usage
+
+```
+class SomeKlass
+  include PermaCache
+  def slow_method
+    sleep 2
+    1
+  end
+  perma_cache :slow_method
+end
+```
+
+```
+> Benchmark.measure{ puts SomeKlass.new.slow_method }.real
+1
+=> 2.003525972366333
+> Benchmark.measure{ puts SomeKlass.new.slow_method }.real
+1
+=> 0.001032114028930664
+> Benchmark.measure{ puts SomeKlass.new.slow_method! }.real
+1
+=> 2.0027248859405518
+```
+
+## Testing
+
+Run tests with:
+```
+rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the test Suite
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/perma_cache.rb

@@ -0,0 +1,98 @@
+require 'active_support/core_ext/module/aliasing'
+
+require "perma_cache/version"
+
+module PermaCache
+  class UndefinedCache < StandardError ; end
+
+  def self.version= v
+    @version = v
+  end
+
+  def self.version
+    @version || 1
+  end
+
+  def self.cache
+    @cache || raise(UndefinedCache, "Please define a cache object: (PermaCache.cache = Rails.cache)")
+  end
+
+  def self.cache= c
+    @cache = c
+  end
+
+  def self.build_key_from_object(obj)
+    # Don't want to add this to Object
+    Array.new.tap do |arr|
+      if obj.respond_to?(:cache_key)
+        arr << obj.cache_key
+      else
+        arr << obj.class.name
+
+        if obj.respond_to?(:id)
+          arr << obj.id
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def perma_cache(method_name, options = {})
+      class_eval do
+        define_method "#{method_name}_base_key" do
+          key = []
+          key << "perma_cache"
+          key << "v#{PermaCache.version}"
+
+          key << PermaCache.build_key_from_object(self)
+
+          if options[:obj]
+            key << PermaCache.build_key_from_object(send(options[:obj]))
+          end
+
+          key << method_name
+
+          if options[:version]
+            key << "v#{options[:version]}"
+          end
+
+          key = key.flatten.reject do |k|
+            (k.empty? rescue nil) ||
+            (k.nil? rescue nil)
+          end.join('/')
+
+          key
+        end
+
+        define_method "#{method_name}_perma_cache_key" do
+          [
+            send("#{method_name}_base_key"),
+            (send("#{method_name}_key") rescue nil)
+          ].compact.join('/').gsub(' ','_')
+        end
+
+        define_method "#{method_name}!" do
+          send("#{method_name}_without_perma_cache").tap do |result|
+            PermaCache.cache.write(send("#{method_name}_perma_cache_key"), result, :expires_in => options[:expires_in])
+          end
+        end
+
+        define_method "#{method_name}_get_perma_cache" do
+          PermaCache.cache.read(send("#{method_name}_perma_cache_key"))
+        end
+
+        define_method "#{method_name}_with_perma_cache" do
+          send("#{method_name}_get_perma_cache") ||
+          send("#{method_name}!")
+        end
+
+        alias_method_chain method_name, :perma_cache
+      end
+    end
+  end
+end
+

data/lib/perma_cache/version.rb

@@ -0,0 +1,3 @@
+module PermaCache
+  VERSION = "0.0.3"
+end

data/perma_cache.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perma_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "perma_cache"
+  spec.version       = PermaCache::VERSION
+  spec.authors       = ["Josh Sharpe"]
+  spec.email         = ["josh.m.sharpe@gmail.com"]
+  spec.description   = %q{It's a perma cache, duh}
+  spec.summary       = %q{It's a perma cache, duh}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha", "< 1.0"
+  spec.add_development_dependency "debugger"
+end
+

data/test/perma_cache_test.rb

@@ -0,0 +1,154 @@
+require 'test_helper'
+
+class KlassOne
+  include PermaCache
+
+  def method1
+    sleep 1
+    1
+  end
+  perma_cache :method1
+
+  def method2
+    sleep 1
+    2
+  end
+  perma_cache :method2, :obj => :other_klass
+  def method2_key
+    "more things"
+  end
+
+  def method3
+    sleep 1
+    3
+  end
+  perma_cache :method3, :version => 2, :expires_in => 5
+
+  def other_klass
+    KlassTwo.new
+  end
+end
+
+class KlassTwo
+  def cache_key
+    "some_other_class/123"
+  end
+end
+
+class KlassThree
+  def id
+    234
+  end
+end
+
+class PermaCacheTest < Test::Unit::TestCase
+
+  context "build_key_from_object" do
+    context  "for a class" do
+      context "That responds to cache_key" do
+        should "have a correct key" do
+          klass = KlassTwo
+          assert klass.new.respond_to?(:cache_key)
+          assert_equal ["some_other_class/123"], PermaCache.build_key_from_object(klass.new)
+        end
+      end
+      context "that doesn't respond to cache_key" do
+        should "have a correct key" do
+          klass = KlassOne
+          assert !klass.new.respond_to?(:cache_key)
+          assert_equal ["KlassOne"], PermaCache.build_key_from_object(klass.new)
+        end
+      end
+      context "that doesn't respond to cache key and responds to id" do
+        should "have a correct key" do
+          klass = KlassThree
+          assert !klass.new.respond_to?(:cache_key)
+          assert klass.new.respond_to?(:id)
+          assert_equal ["KlassThree", 234], PermaCache.build_key_from_object(klass.new)
+        end
+      end
+    end
+  end
+
+  context "calling cache" do
+    context "without setting a cache source" do
+      setup do
+        PermaCache.send :remove_instance_variable, :@cache
+      end
+      should "raise" do
+        assert_raises PermaCache::UndefinedCache do
+          PermaCache.cache
+        end
+      end
+    end
+    context "after setting a cache source" do
+      setup do
+        PermaCache.cache = 123
+      end
+      should "return that cache source" do
+        assert_equal 123, PermaCache.cache
+      end
+    end
+  end
+
+  context "KlassOne" do
+    should "have some additional methods defined" do
+      obj = KlassOne.new
+      assert obj.respond_to?(:method1_perma_cache_key)
+      assert obj.respond_to?(:method1!)
+      assert obj.respond_to?(:method1_with_perma_cache)
+    end
+
+    should "calling #method1 should write and return the result if the cache is empty" do
+      obj = KlassOne.new
+      cache_obj = mock
+      cache_obj.expects(:read).with(obj.method1_perma_cache_key).once.returns(nil)
+      cache_obj.expects(:write).with(obj.method1_perma_cache_key, 1, :expires_in => nil).once
+      PermaCache.cache = cache_obj
+      obj.expects(:sleep).with(1).once
+      assert_equal 1, obj.method1
+    end
+
+    should "calling #method1 should read the cache, but not write it, if the cache is present" do
+      obj = KlassOne.new
+      cache_obj = mock
+      cache_obj.expects(:read).with(obj.method1_perma_cache_key).once.returns(123)
+      cache_obj.expects(:write).never
+      PermaCache.cache = cache_obj
+      obj.expects(:sleep).never
+      assert_equal 123, obj.method1
+    end
+
+    should "calling #method1! should write the cache, but not read from it" do
+      obj = KlassOne.new
+      cache_obj = mock
+      cache_obj.expects(:read).never
+      cache_obj.expects(:write).with(obj.method1_perma_cache_key, 1, :expires_in => nil).once
+      PermaCache.cache = cache_obj
+      obj.expects(:sleep).with(1).once
+      assert_equal 1, obj.method1!
+    end
+  end
+  context "version option" do
+    should "add that key/value to the cache key" do
+      assert_equal "perma_cache/v1/KlassOne/method3/v2", KlassOne.new.method3_perma_cache_key
+    end
+  end
+  context "user defined keys" do
+    should "should append themselves to the cache key" do
+      assert_equal "perma_cache/v1/KlassOne/some_other_class/123/method2/more_things", KlassOne.new.method2_perma_cache_key
+    end
+  end
+  context "setting expires_in" do
+    should "pass the value through to #write" do
+      obj = KlassOne.new
+      cache_obj = mock
+      cache_obj.expects(:read).with(obj.method3_perma_cache_key).returns(nil).once
+      cache_obj.expects(:write).with(obj.method3_perma_cache_key, 3, :expires_in => 5).once
+      obj.expects(:sleep).with(1).once
+      PermaCache.cache = cache_obj
+      obj.method3
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require "rubygems"
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'debugger'
+
+require 'bundler/setup'
+require 'perma_cache'
+

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: perma_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Josh Sharpe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It's a perma cache, duh
+email:
+- josh.m.sharpe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/perma_cache.rb
+- lib/perma_cache/version.rb
+- perma_cache.gemspec
+- test/perma_cache_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: It's a perma cache, duh
+test_files:
+- test/perma_cache_test.rb
+- test/test_helper.rb