rack-request_cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fbb99d5069d5d499e79f9e72351d064a650728b
+  data.tar.gz: c57dd1abeb722eaee2cfb2db2826c9fa3b7b2411
+SHA512:
+  metadata.gz: 0bd31c1a12294388ef66267cc11a0f5f09136e71b94cf3de7d402a953d7abeba1757a7dc61453c11aae65773b31c4da1d8f8e6854002fdcdffbb9ad370ada506
+  data.tar.gz: fd1e2669fb4871c9d762dc3b407515e072b5ad519dc19c7573a41f5c97db0d9f2d5ae221784b589fa3c4d8fda9c1329050b3bd2086598e80f67bc95b125bef4d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Marshall
+
+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,44 @@
+# RackRequestCache
+
+[![Build Status](https://secure.travis-ci.org/amarshall/rack-request_cache.png?branch=master)](https://travis-ci.org/amarshall/rack-request_cache)
+[![Code Climate rating](https://codeclimate.com/github/amarshall/rack-request_cache.png)](https://codeclimate.com/github/amarshall/rack-request_cache)
+[![Gem Version](https://badge.fury.io/rb/rack-request_cache.png)](https://rubygems.org/gems/rack-request_cache)
+
+Provides a caching layer that exists only within a single Rack request. The middleware itself is thread-safe; each thread has its own cache.
+
+## Installation
+
+Install as usual: `gem install rack-request_cache` or add `gem 'rack-request_cache'` to your Gemfile. Note that Ruby 2.0 is required.
+
+## Usage
+
+Add the middleware to your app (likely in your `config.ru`):
+
+```ruby
+require 'rack/request_cache'
+
+use Rack::RequestCache
+run MyApp
+```
+
+Then, whenever you wish to cache something:
+
+```ruby
+Rack::RequestCache.cache do
+  expensive_operation
+end
+```
+
+## Contributing
+
+Contributions are welcome. Please be sure that your pull requests are atomic so they can be considered and accepted separately.
+
+1. Fork it
+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 new Pull Request
+
+## Credits & License
+
+Copyright © 2013 J. Andrew Marshall. License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w'
+end
+
+task :default => :spec

data/lib/rack-request_cache.rb

@@ -0,0 +1 @@
+require 'rack/request_cache'

data/lib/rack/request_cache.rb

@@ -0,0 +1,26 @@
+require 'rack/request_cache/version'
+require 'rack/request_cache/cache'
+require 'thread_variable'
+
+module Rack
+  class RequestCache
+    extend ThreadVariable
+    thread_variable :cache_store
+
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      self.class.cache_store ||= Cache.new
+      @app.call env
+    ensure
+      self.class.clear!
+    end
+
+    def self.cache *args, █ cache_store.cache(*args, &block); end
+    def self.clear!; cache_store.clear!; end
+    def self.fetch *args; cache_store.fetch(*args); end
+    def self.has_key? *args; cache_store.has_key?(*args); end
+  end
+end

data/lib/rack/request_cache/cache.rb

@@ -0,0 +1,27 @@
+module Rack
+  class RequestCache
+    class Cache
+      def initialize
+        @cache = {}
+      end
+
+      def cache key
+        raise ArgumentError, 'no block given' unless block_given?
+        return @cache[key] if @cache.has_key? key
+        @cache[key] = yield.freeze
+      end
+
+      def clear!
+        @cache.clear
+      end
+
+      def fetch key
+        @cache.fetch key
+      end
+
+      def has_key? key
+        @cache.has_key? key
+      end
+    end
+  end
+end

data/lib/rack/request_cache/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class RequestCache
+    VERSION = '0.1.0'
+  end
+end

data/rack-request_cache.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/request_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rack-request_cache'
+  spec.version       = Rack::RequestCache::VERSION
+  spec.authors       = ['Andrew Marshall']
+  spec.email         = ['andrew@johnandrewmarshall.com']
+  spec.description   = %q(Provides a caching layer that exists only within a single Rack request.)
+  spec.summary       = %q(Provides a caching layer that exists only within a single Rack request.)
+  spec.homepage      = 'http://johnandrewmarshall.com/projects/rack-request_cache'
+  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 'rack'
+  spec.add_dependency 'thread_variable'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/rack/request_cache/cache_spec.rb

@@ -0,0 +1,117 @@
+require 'rack/request_cache/cache'
+
+describe Rack::RequestCache::Cache do
+  it "can store multiple keys" do
+    cache = Rack::RequestCache::Cache.new
+
+    cache.cache(:foo) { :bar }
+    cache.cache(:baz) { :qux }
+
+    expect(cache.fetch(:foo)).to eq :bar
+    expect(cache.fetch(:baz)).to eq :qux
+  end
+
+  it "does not allow mutating the cached value" do
+    cache = Rack::RequestCache::Cache.new
+    value = 'foobar'
+
+    returned = cache.cache(:key) { value }
+    expect do
+      value << 'baz'
+    end.to raise_error RuntimeError, /frozen/
+    expect do
+      returned << 'baz'
+    end.to raise_error RuntimeError, /frozen/
+
+    expect(cache.fetch(:key)).to eq 'foobar'
+  end
+
+  describe "#cache" do
+    it "returns the result of the block" do
+      test_object = double
+      result = double
+      cache = Rack::RequestCache::Cache.new
+
+      expect(test_object).to receive(:expensive_operation).once
+                             .and_return(result)
+      returned = cache.cache(:key) { test_object.expensive_operation }
+
+      expect(returned).to eq result
+    end
+
+    it "caches the return value of the block" do
+      test_object = double
+      result = double
+      cache = Rack::RequestCache::Cache.new
+
+      expect(test_object).to receive(:expensive_operation).once
+                             .and_return(result)
+      returned_1 = cache.cache(:key) { test_object.expensive_operation }
+      returned_2 = cache.cache(:key) { test_object.expensive_operation }
+
+      expect(returned_1).to eq result
+      expect(returned_2).to eq result
+    end
+
+    it "caches falsey values" do
+      test_object = double
+      result = nil
+      cache = Rack::RequestCache::Cache.new
+
+      expect(test_object).to receive(:expensive_operation).once
+                             .and_return(result)
+      cache.cache(:key) { test_object.expensive_operation }
+      cache.cache(:key) { test_object.expensive_operation }
+    end
+
+    it "raises an ArgumentError when no block is given" do
+      cache = Rack::RequestCache::Cache.new
+      expect do
+        cache.cache(:key)
+      end.to raise_error ArgumentError, 'no block given'
+    end
+  end
+
+  describe "#clear!" do
+    it "removes all keys & values from the cache" do
+      cache = Rack::RequestCache::Cache.new
+
+      cache.cache(:foo) {}
+      cache.cache(:bar) {}
+
+      cache.clear!
+
+      expect(cache.has_key?(:foo)).to eq false
+      expect(cache.has_key?(:bar)).to eq false
+    end
+  end
+
+  describe "#fetch" do
+    it "returns the cached result for the key when one exists" do
+      value = double
+      cache = Rack::RequestCache::Cache.new
+
+      cache.cache(:key) { value }
+
+      expect(cache.fetch(:key)).to eq value
+    end
+
+    it "raises a KeyError when the key does not exist" do
+      cache = Rack::RequestCache::Cache.new
+      expect{ cache.fetch(:key) }.to raise_error KeyError
+    end
+  end
+
+  describe "#has_key?" do
+    it "returns true when the key has been cached" do
+      cache = Rack::RequestCache::Cache.new
+      cache.cache(:key) {}
+      expect(cache.has_key?(:key)).to eq true
+    end
+
+    it "returns false when the key has not been cached" do
+      cache = Rack::RequestCache::Cache.new
+      expect(cache.has_key?(:key)).to eq false
+    end
+  end
+end

data/spec/rack/request_cache_spec.rb

@@ -0,0 +1,86 @@
+require 'rack/request_cache'
+
+require 'rack/builder'
+require 'rack/lint'
+require 'rack/mock'
+require 'rack/response'
+
+describe Rack::RequestCache do
+  def join_body body_obj
+    body = ''
+    body_obj.each { |s| body << s }
+    body
+  end
+
+  def unfreezable_double *args
+    double(*args).tap { |d| d.stub(:freeze).and_return d }
+  end
+
+  it "is a Rack middleware" do
+    app = Rack::Builder.app do
+      use Rack::Lint
+      use Rack::RequestCache
+      run ->(env) { [418, { 'A-Header' => 'Stuff' }, ['the body']] }
+    end
+
+    request = Rack::MockRequest.env_for '/'
+    status, headers, body_obj = app.call request
+    body = join_body(body_obj)
+
+    expect(status).to eq 418
+    expect(headers).to eq ({ 'A-Header' => 'Stuff' })
+    expect(body).to eq 'the body'
+  end
+
+  it "clears the cache after the request ends" do
+    app = ->(env) do
+      Rack::RequestCache.cache(:foo) { 'bar' }
+      expect(Rack::RequestCache.fetch(:foo)).to eq 'bar'
+    end
+
+    request_cache = Rack::RequestCache.new app
+    request_cache.call({})
+
+    expect(Rack::RequestCache.has_key?(:foo)).to eq false
+  end
+
+  it "clears the cache when the request raises an error, reraising it" do
+    exception_class = Class.new Exception
+    app = ->(env) do
+      Rack::RequestCache.cache(:foo) { 'bar' }
+      expect(Rack::RequestCache.fetch(:foo)).to eq 'bar'
+      raise exception_class
+    end
+
+    request_cache = Rack::RequestCache.new app
+    expect { request_cache.call({}) }.to raise_error exception_class
+
+    expect(Rack::RequestCache.has_key?(:foo)).to eq false
+  end
+
+  it "is thread safe" do
+    q1 = Queue.new
+    q2 = Queue.new
+    app = ->(env) do
+      Rack::RequestCache.cache(:foo) { env }
+      env.queue.pop
+      expect(Rack::RequestCache.fetch(:foo)).to eq env
+      env.queue.pop
+    end
+    env_1 = unfreezable_double 'one', queue: q1
+    env_2 = unfreezable_double 'two', queue: q2
+
+    request_cache = Rack::RequestCache.new app
+
+    thread_1 = Thread.new { request_cache.call env_1 }
+    thread_2 = Thread.new { request_cache.call env_2 }
+
+    q1 << nil
+    q2 << nil
+    q1 << nil
+    q2 << nil
+
+    thread_1.join
+    thread_2.join
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rack-request_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thread_variable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Provides a caching layer that exists only within a single Rack request.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-request_cache.rb
+- lib/rack/request_cache.rb
+- lib/rack/request_cache/cache.rb
+- lib/rack/request_cache/version.rb
+- rack-request_cache.gemspec
+- spec/rack/request_cache/cache_spec.rb
+- spec/rack/request_cache_spec.rb
+homepage: http://johnandrewmarshall.com/projects/rack-request_cache
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Provides a caching layer that exists only within a single Rack request.
+test_files:
+- spec/rack/request_cache/cache_spec.rb
+- spec/rack/request_cache_spec.rb
+has_rdoc: