rack-revalidate-while-cache 0.0.1

data/README.rdoc

@@ -0,0 +1,12 @@
+= Rack::CacheWhileRevalidate
+
+== Idea
+
+Often, for caching, you don't care if the data is a little stale, you're content to serve the stale data and silently revalidate the cache in the background.
+
+== Usage
+
+In your builder (or rackup or whatever), make sure you first off:
+<tt>use Rack::Capabilities</tt>
+ 
+Then, wherever your <tt>Rack::Cache</tt> usage occurs, put <tt>use Rack::CacheWhileRevalidate</tt> directly before it (NB). That's it!

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-revalidate-while-cache"
+    gem.summary = %Q{Rack middleware for periodic cache regeneration}
+    gem.email = "joshbuddy@gmail.com"
+    gem.homepage = "http://github.com/joshbuddy/rack-regenerate"
+    gem.authors = ["Joshua Hull"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'rack-regenerate'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/lib/rack_cache_while_revalidate.rb

@@ -0,0 +1,41 @@
+require 'rack/cache'
+require 'thread'
+
+module Rack
+  class CacheWhileRevalidate
+    
+    def initialize(app, debug = false)
+      @app = app
+      
+      @queue = Queue.new
+      
+      Thread.new do
+        while true
+          begin
+            env = @queue.pop
+            @app.call(env)
+          rescue Exception => e
+            puts "e: #{e.inspect}"
+          end
+        end
+      end
+    end
+    
+    def call(env)
+      
+      cache = Rack::Capabilities.after(self)
+      request = Rack::Cache::Request.new(env.dup)
+
+      cache.instance_variable_set(:@request, request)
+      
+      if (request.get? || request.head?) && !env['HTTP_EXPECT'] && (entry = cache.metastore.lookup(request, cache.entitystore)) && cache.send(:fresh_enough?, entry)
+        @queue << env
+        entry.to_a
+      else
+        @app.call(env)
+      end
+      
+    end
+    
+  end
+end

data/rack-revalidate-while-cache.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-revalidate-while-cache}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Hull"]
+  s.date = %q{2009-12-03}
+  s.email = %q{joshbuddy@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "lib/rack_cache_while_revalidate.rb",
+    "rack-revalidate-while-cache.gemspec",
+    "spec/rack_cache_while_revalidate_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/joshbuddy/rack-regenerate}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack middleware for periodic cache regeneration}
+  s.test_files = [
+    "spec/rack_cache_while_revalidate_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/rack_cache_while_revalidate_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+
+def build_builder(app)
+  Rack::Builder.new {
+
+    use Rack::Capabilities
+    use Rack::CacheWhileRevalidate
+    use Rack::Cache,
+      :verbose     => true,
+      :metastore   => 'heap:/',
+      :entitystore => 'heap:/'
+
+    run app
+  }
+end
+
+
+describe "Rack Cache While Revalidate" do
+  
+  it "should pass uncached requests through normally" do
+    app = mock('app')
+    app.should_receive(:call).and_return [200, {}, ['oh yeah']]
+    
+    builder = build_builder(app)
+    builder.call(Rack::MockRequest.env_for("http://127.0.0.1/testing")).last.should == ['oh yeah']
+  end
+  
+  it "should serve stale requests while continuing on with the original request" do
+    app = mock('app')
+    app.should_receive(:call).and_return { sleep(2); [200, {'Cache-Control' => 'max-age=1'}, ['oh yeah']]}
+    builder = build_builder(app)
+    builder.call(Rack::MockRequest.env_for("http://127.0.0.1/testing")).last.should == ['oh yeah']
+    start_time = Time.new.to_f
+    builder.call(Rack::MockRequest.env_for("http://127.0.0.1/testing")).last.should == ['oh yeah']
+    (Time.new.to_f - start_time).should < 1
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'spec'
+require 'rubygems'
+require 'rack/cache'
+require 'rack-capabilities'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack_cache_while_revalidate'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rack-revalidate-while-cache
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: joshbuddy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/rack_cache_while_revalidate.rb
+- rack-revalidate-while-cache.gemspec
+- spec/rack_cache_while_revalidate_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/joshbuddy/rack-regenerate
+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: Rack middleware for periodic cache regeneration
+test_files: 
+- spec/rack_cache_while_revalidate_spec.rb
+- spec/spec_helper.rb