cache_shoe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eddbae252fc203acd85d51eb3c106cb34f0fcd5
+  data.tar.gz: 641516d5d6a8c54260cd4bcbd7373fa101702506
+SHA512:
+  metadata.gz: 4c0770ef7fd891dcb80b98fb5ec85b11ebf0c659eab815d792a6cf06f5dd6b04109a601bc7092de533fe6e08657db52c48a7d4b58db415ae2246f3c87630b002
+  data.tar.gz: d3ad26f6b649979717c191ad968a5a0ae4dcb2c46a41bc0c8a2a37127ff713e8f53bf0b164a060db5fce348014d77995bd6928f52b5b04e72fa35a0691a82816

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1
+- 2.2
+- ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff Deville
+
+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,32 @@
+# CacheShoe
+[![Build Status](https://travis-ci.org/promptworks/cache_shoe.png?branch=master)](https://travis-ci.org/promptworks/cache_shoe)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cache_shoe'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cache_shoe
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cache_shoe/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: [:spec]
+
+RSpec::Core::RakeTask.new(:spec)

data/cache_shoe.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_shoe"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Jeff Deville"]
+  spec.email         = ["jeffdeville@gmail.com"]
+  spec.summary       = %q{Easily add caching and invalidation to RESTful clients}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/promptworks/cache_shoe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rspec-given"
+  spec.add_development_dependency "activesupport"
+end

data/lib/cache_shoe.rb

@@ -0,0 +1,162 @@
+require 'logger'
+
+module CacheShoe
+  PASS_THROUGH = :_pass_through
+
+  Configuration = Struct.new(:cache, :on_cache, :on_cache_clear, :logger) do
+    def logger
+      @logger ||= Logger.new(StringIO.new)
+    end
+  end
+
+  def self.included(base)
+    class << base
+      prepend ClassMethods
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.new
+    yield @config if block_given?
+    @config
+  end
+
+  private
+
+  def self.get_cache_args(key_extractor, *args)
+    case key_extractor
+    when PASS_THROUGH then args
+    when Proc         then [key_extractor.call(*args)]
+    when Symbol       then [args.first.send(key_extractor)]
+    else
+      fail "Can't create a cache key from #{key_extractor.inspect}"
+    end
+  end
+
+  # Any way to delete this?  Does the rails cache give us
+  # any of this for free?
+  def self.cache_key(class_name, method_id, args)
+    [class_name,
+     method_id,
+     (args.empty? ? 'empty' : CacheShoe.digest(args))
+     ].join("::")
+  end
+
+  def self.digest(obj)
+    resolve_cache_key(obj).to_s.downcase
+  end
+
+  def self.resolve_cache_key(obj)
+    case obj
+    when ::Array then obj.map { |v| resolve_cache_key v }
+    when ::Hash
+      obj.each_with_object({}) do |(k, v), memo|
+        memo[resolve_cache_key(k)] = resolve_cache_key(v)
+      end
+    else
+      obj
+    end
+  end
+
+  def self.on_cache_hit(key_val)
+    if config.on_cache
+      config.on_cache.call(key_val, :hit)
+    end
+    logger.info "cache hit #{key_val}"
+  end
+
+  def self.on_cache_miss(key_val)
+    if config.on_cache
+      config.on_cache.call(key_val, :miss)
+    end
+    logger.info "cache miss #{key_val}"
+  end
+
+  def self.set_cache(key_val, cache_val)
+    cache.write(key_val, nil_wrapper(cache_val))
+    nil_wrapper(cache_val)
+  end
+
+  def self.cache_method_clear(key)
+    cache.delete(key)
+  end
+
+  def self.cache
+    config.cache
+  end
+
+  def self.logger
+    config.logger
+  end
+
+  # Wrap result in an Array, so that if the cached method returns nil,
+  # that nil will be cached
+  def self.nil_wrapper(value)
+    [value]
+  end
+
+  def self.nil_unwrapper(wrapped_result)
+    wrapped_result.first
+  end
+
+  def self.on_cache_clear(
+    class_name, cached_method, clearing_method, key_extractors, *args)
+    Array(key_extractors).each do |key_extractor|
+      begin
+        cache_args = get_cache_args(key_extractor, *args)
+        cached_key = cache_key(class_name, cached_method, cache_args)
+        logger.info "Clearing cache from #{clearing_method}: #{cached_key}"
+        if config.on_cache_clear
+          config.on_cache_clear.call(
+          cached_key, clearing_method)
+        end
+        cache_method_clear cached_key
+      rescue
+        logger.error "Failed to clear cache from #{self.class.name}." \
+          "#{clearing_method}, because the key extractor raised"
+      end
+    end
+  end
+
+  module ClassMethods
+    module Helpers
+      # Move the CacheShoe methods here
+      def wrap_the_method_to_cache(method_id)
+        define_method method_id do |*args, &blk|
+          class_name = self.class.name
+          key_val = CacheShoe.cache_key(class_name, method_id, args)
+
+          cache_hit = true
+          result = CacheShoe.cache.fetch(key_val) do
+            cache_hit = false
+            CacheShoe.on_cache_miss key_val
+            CacheShoe.nil_wrapper super(*args, &blk)
+          end
+          CacheShoe.on_cache_hit(key_val) if cache_hit
+          CacheShoe.nil_unwrapper result
+        end
+      end
+
+      def create_cache_clear_wrapper_methods(cached_method, clear_on)
+        clear_on.each do |clearing_method, key_extractors|
+          define_method clearing_method do |*args, &blk|
+            class_name = self.class.name
+            CacheShoe.on_cache_clear(
+              class_name, cached_method,
+            clearing_method, key_extractors, *args)
+            super(*args, &blk)
+          end
+        end
+      end
+    end
+
+    def cache_method(method_to_cache, clear_on: {})
+      dyn_module = Module.new do
+        extend Helpers
+        wrap_the_method_to_cache(method_to_cache)
+        create_cache_clear_wrapper_methods(method_to_cache, clear_on)
+      end
+      prepend(dyn_module)
+    end
+  end
+end

data/spec/cache_shoe_spec.rb

@@ -0,0 +1,117 @@
+require 'spec_helper'
+
+describe "when caching a service-style object" do
+  Given { CacheShoe.config.cache.clear }
+  Given(:thing) { Thing.new(123, 'name') }
+
+  shared_examples_for "caching" do
+    context "read caching" do
+      context "when nil, it should cache the nil" do
+        Given { service_ex.read("INVALID_ID") }          # cache the nil
+        When(:result) { service_ex.read("INVALID_ID") }  # now hit the cache
+        Then  { service_ex.read_calls == 1 }
+      end
+
+      context "when not nil, it should cache that" do
+        Given { service_ex.create thing }
+        When  { 2.times { service_ex.read(thing.id) } }
+        Then  { service_ex.read_calls == 1 }
+      end
+    end
+
+    context "when creating it wipes the cache" do
+      Given { service_ex.read(123) } # populate the cache with nil
+      When { service_ex.create thing }
+      Given(:result) { service_ex.read(123) }
+      Then { result == thing } # verify cache was updated
+      And  { service_ex.read_calls == 2 }
+    end
+
+    context "when deleting it wipes the cache" do
+      Given do
+        service_ex.create thing
+        # Populate the cache
+        service_ex.read 123
+      end
+
+      When(:result) do
+        service_ex.delete 123
+        service_ex.read(123)
+      end
+
+      Then { service_ex.read_calls == 2 }
+      And { result.nil? }
+    end
+  end
+
+  context "when using procs to clearing the cache" do
+    Given(:service_ex) { ProcServiceExample.new }
+    it_should_behave_like "caching"
+  end
+
+  context "when using symbol keys to clear the cache" do
+    Given(:service_ex) { KeyServiceExample.new }
+    it_should_behave_like "caching"
+  end
+
+  context "when caching multiple methods" do
+    Given(:service_ex) { CacheTwoMethodsExample.new }
+    it_should_behave_like "caching"
+
+    shared_context "create thing and cache the reads" do
+      Given do
+        service_ex.create thing
+        service_ex.read 123
+        service_ex.read_hash(id: 123)
+      end
+    end
+
+    context "caching works" do
+      include_context "create thing and cache the reads"
+      When(:result) do
+        [service_ex.read(123), service_ex.read_hash(id: 123)]
+      end
+
+      Then { service_ex.read_hash_calls == 1 }
+      And { service_ex.read_calls == 1 }
+    end
+
+    context "cache clearing works" do
+      include_context "create thing and cache the reads"
+      When(:result) do
+        service_ex.delete 123
+        [service_ex.read(123), service_ex.read_hash(id: 123)]
+      end
+
+      Then { service_ex.read_hash_calls == 2 }
+      And { service_ex.read_calls == 2 }
+      And { result.all?(&:nil?) }
+    end
+  end
+
+  context "when clearing multiple keys" do
+    Given(:service_ex) { MultiKeyClearExample.new }
+    it_should_behave_like "caching"
+
+    context "ensure both keys are cleared" do
+      Given do
+        service_ex.read thing.id
+        service_ex.read thing.name
+      end
+
+      When { service_ex.create thing }
+      Given(:result) do
+        [service_ex.read(thing.id), service_ex.read(thing.name)]
+      end
+
+      Then { result.all? { |result| result == thing } }
+      And  { service_ex.read_calls == 4 }
+    end
+  end
+
+  context "when the cache methods raise" do
+    Given(:service_ex) { BrokenExample.new }
+    When(:result) { service_ex.create thing }
+    Then { service_ex.create_calls == 1 }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec/given'
+
+require 'cache_shoe'
+require 'active_support/cache'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+Dir[File.join(
+  File.expand_path("../../spec/support/**/*.rb", __FILE__)
+)].sort.each { |f| require f }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/cacheify.rb

@@ -0,0 +1,52 @@
+RSpec.configure do |config|
+  CACHE_ACTIONS = {}
+
+  CacheShoe.config.on_cache = lambda do |cache_key, cache_hit|
+    CACHE_ACTIONS[cache_key] ||= []
+    CACHE_ACTIONS[cache_key] << { read: cache_hit }
+  end
+
+  CacheShoe.config.on_cache_clear = lambda do |cache_key, trigger_method|
+    CACHE_ACTIONS[cache_key] ||= []
+    CACHE_ACTIONS[cache_key] << { trigger_method => :clear }
+  end
+
+  config.before :all do
+    CacheShoe.config.cache = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  config.before :each do
+    CacheShoe.config.cache.clear
+    CACHE_ACTIONS.clear
+  end
+
+  config.after :each do
+    if example.exception
+      p "-" * 30
+      p "Cache Actions"
+      pp CACHE_ACTIONS
+      p "-" * 30
+    end
+  end
+end
+
+RSpec::Matchers.define :have_cached do |*expected_cache_pattern|
+  class << self
+    attr_accessor :cache_key, :actual_cache_pattern
+  end
+
+  match do |service_instance, method, *args|
+    self.cache_key = CacheShoe.cache_key(
+      service_instance.class.name, method, args)
+    self.actual_cache_pattern =
+      (CACHE_ACTIONS[cache_key] || [{}]).flatten
+
+    actual_cache_pattern == expected_cache_pattern
+  end
+
+  failure_message_for_should do |_service_instance, _method, *_args|
+    "Expected cache pattern: #{expected_cache_pattern}, but got: " \
+      "#{actual_cache_pattern} for " \
+      "cache_key #{cache_key}"
+  end
+end

data/spec/support/demo_classes.rb

@@ -0,0 +1,84 @@
+class Thing < Struct.new(:id, :name)
+end
+
+class BaseServiceExample
+  attr_accessor :create_calls, :read_calls,
+    :delete_calls, :storage
+
+  def initialize
+    self.create_calls = self.read_calls = self.delete_calls = 0
+    self.storage = {}
+  end
+
+  def create(thing)
+    @create_calls += 1
+    @storage[thing.id] = thing
+    thing
+  end
+
+  def read(id)
+    @read_calls += 1
+    @storage[id]
+  end
+
+  def delete(id)
+    @delete_calls += 1
+    @storage.delete(id)
+  end
+end
+
+class ProcServiceExample < BaseServiceExample
+  include CacheShoe
+  cache_method :read, clear_on: {
+    create: -> (thing) { thing.id }, delete: -> (id) { id }
+  }
+end
+
+class CacheTwoMethodsExample < BaseServiceExample
+  attr_accessor :read_hash_calls
+  include CacheShoe
+  cache_method :read, clear_on: {
+    create: -> (thing) { thing.id }, delete: -> (id) { id }
+  }
+
+  cache_method :read_hash, clear_on: {
+    create: -> (thing) { { id: thing.id } }, delete: -> (id) { { id: id } }
+  }
+
+  def initialize
+    self.read_hash_calls = 0
+    super
+  end
+
+  def read_hash(inputs)
+    @read_hash_calls += 1
+    @storage[inputs[:id]]
+  end
+end
+
+class KeyServiceExample < BaseServiceExample
+  include CacheShoe
+  cache_method :read, clear_on: { create: :id, delete: PASS_THROUGH }
+end
+
+class MultiKeyClearExample < BaseServiceExample
+  include CacheShoe
+  cache_method :read, clear_on: {
+    create: [:id, :name],
+    delete: PASS_THROUGH
+  }
+
+  def create(thing)
+    @create_calls += 1
+    @storage[thing.id] = thing
+    @storage[thing.name] = thing
+    thing
+  end
+end
+
+class BrokenExample < BaseServiceExample
+  include CacheShoe
+  cache_method :read, clear_on: {
+    create: -> (_thing) { fail 'I am broken!' }
+  }
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cache_shoe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Deville
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily add caching and invalidation to RESTful clients
+email:
+- jeffdeville@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_shoe.gemspec
+- lib/cache_shoe.rb
+- spec/cache_shoe_spec.rb
+- spec/spec_helper.rb
+- spec/support/cacheify.rb
+- spec/support/demo_classes.rb
+homepage: https://github.com/promptworks/cache_shoe
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Easily add caching and invalidation to RESTful clients
+test_files:
+- spec/cache_shoe_spec.rb
+- spec/spec_helper.rb
+- spec/support/cacheify.rb
+- spec/support/demo_classes.rb