rack-per_request_cache 1.0.0

data/README.md

@@ -0,0 +1,23 @@
+# Rack::PerRequestCache
+
+Simple module for caching arbitrary objects / constructs during a request.
+
+## Usage (Sinatra, Padrino, ...)
+
+    require 'rack/per_request_cache'
+    use Rack::PerRequestCache
+
+## Rails
+
+    # Gemfile
+    gem 'rack-per_request_cache', require: 'rack/per_request_cache'
+
+    # config/application.rb
+    config.use 'Rack::PerRequestCache'
+
+## Caveats
+
+If Rack::PerRequestCache.clear_cache is not called, then no caching is performed.
+When hooked up as a middleware (see above), then the cache is enable dy default during
+the request lifecycle.
+

data/lib/rack/per_request_cache.rb

@@ -0,0 +1,33 @@
+module Rack
+  class PerRequestCache
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      self.class.initialize_cache
+      @app.call env
+    ensure
+      self.class.clear_cache
+    end
+
+    # Cache management and accessor methods
+    class << self
+      def initialize_cache
+        @cache = {}
+      end
+
+      def clear_cache
+        @cache = nil
+      end
+
+      def cached(key, &block)
+        return yield if @cache.nil?
+        return @cache[key] if @cache.has_key?(key)
+
+        @cache[key] = yield
+      end
+    end
+  end
+end

data/spec/per_request_cache_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe PerRequestCache do
+  before do
+    PerRequestCache.clear_cache
+    @executor = mock("Executor", :stub! => "something")
+  end
+
+  it "doesn't not store the result if the cache wasn't initialized" do
+    @executor.should_receive(:something).twice.and_return 23
+
+    PerRequestCache.cached(:abc) { @executor.something }.should == 23
+    PerRequestCache.cached(:abc) { @executor.something }.should == 23
+  end
+
+  context "when cache enabled" do
+    before do
+      PerRequestCache.initialize_cache
+    end
+
+    it "uses the stored result if it exists" do
+      @executor.should_receive(:something).once.and_return 23
+
+      PerRequestCache.cached(:abc) { @executor.something }.should == 23
+      PerRequestCache.cached(:abc) { @executor.something }.should == 23
+    end
+
+    it "uses the stored result if it's nil" do
+      @executor.should_receive(:something).once.and_return nil
+
+      PerRequestCache.cached(:abc) { @executor.something }.should be_nil
+      PerRequestCache.cached(:abc) { @executor.something }.should be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: rack-per_request_cache
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Sommer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70254076172460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70254076172460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70254076171320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70254076171320
+description: Module for caching arbitrary objects / constructs during a request.
+email: tom@trikeapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/rack/per_request_cache.rb
+- spec/per_request_cache_spec.rb
+homepage: https://github.com/tricycle/rack-per_request_cache
+licenses: []
+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.10
+signing_key: 
+specification_version: 2
+summary: Module for caching arbitrary objects / constructs during a request.
+test_files:
+- spec/per_request_cache_spec.rb