remi-rack-staticifier 0.1.0 → 0.1.1

data/README.rdoc

@@ -18,8 +18,29 @@ You can use Rack::Staticifier to statically cache responses to your app.
 
 == Install
 
-... coming soon ...
+  $ gem sources -a http://gems.github.com
+  $ sudo gem install remi-rack-staticifier
 
 == Usage
 
-... coming soon ...
+  # this will cache ALL responses in a 'cache' directory
+  use Rack::Staticifier
+
+  # this will cache ALL responses in a 'public/my/cached/stuff' directory
+  use Rack::Staticifier, :root => 'public/my/cached/stuff'
+
+  # this will only cache requests with 'foo' in the URL
+  use Rack::Staticifier do |env, response|
+    env['PATH_INFO'].include?('foo')
+  end
+
+  # this will only cache requests with 'hi' in the response body
+  use Rack::Staticifier do |env, response|
+    # response is a regular Rack response, eg. [200, {}, ['hi there']]
+    body = ''
+    response.last.each {|string| body << string }
+    body.include?('hi')
+  end
+
+  # this will only cache requests with 'foo' in the URL (incase you don't want to pass a block)
+  use Rack::Staticifier, :cache_if => lambda { |env, response| env['PATH_INFO'].include?('foo') }

data/VERSION.yml

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

data/examples/my-sinatra-blog.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+%w( rubygems sinatra rack/staticifier ).each {|lib| require lib }
+
+# sinatra serves out of the public directory by default
+use Rack::Staticifier, :root => 'public' do |env, response|
+  response.first == 200 # only staticly cache 200 responses, meaning /non-existent-page-name should render OK
+end
+
+$posts = {
+  'hello-world' => 'Hello World!',
+  'hi-there'    => 'Hi from my blog post text'
+}
+
+get '/' do
+  "Home Page rendered at #{ Time.now }"
+end
+
+get '/:post.html' do
+  name = params['post']
+  
+  if $posts.keys.include?(name)
+    $posts[name]
+
+  else
+    status 404
+    "Cannot find page: #{ name }" 
+  end
+end

data/lib/rack-staticifier.rb

@@ -1,6 +1,31 @@
 module Rack #:nodoc:
 
-  # Rack::Staticifier doco ...
+  # Rack::Staticifier is Rack middleware for staticly caching responses.
+  #
+  # ==== Usage
+  #
+  #    # this will cache ALL responses in a 'cache' directory
+  #    use Rack::Staticifier
+  #  
+  #    # this will cache ALL responses in a 'public/my/cached/stuff' directory
+  #    use Rack::Staticifier, :root => 'public/my/cached/stuff'
+  #  
+  #    # this will only cache requests with 'foo' in the URL
+  #    use Rack::Staticifier do |env, response|
+  #      env['PATH_INFO'].include?('foo')
+  #    end
+  #  
+  #    # this will only cache requests with 'hi' in the response body
+  #    use Rack::Staticifier do |env, response|
+  #      # response is a regular Rack response, eg. [200, {}, ['hi there']]
+  #      body = ''
+  #      response.last.each {|string| body << string }
+  #      body.include?('hi')
+  #    end
+  #  
+  #    # this will only cache requests with 'foo' in the URL (incase you don't want to pass a block)
+  #    use Rack::Staticifier, :cache_if => lambda { |env, response| env['PATH_INFO'].include?('foo') }
+  #
   class Staticifier
 
     # the Rack application
@@ -37,6 +62,7 @@ module Rack #:nodoc:
 
     def cache_response env, response
       request_path = env['PATH_INFO']
+      request_path << 'index.html' if request_path.end_with?('/')
 
       basename     = ::File.basename request_path
       dirname      = ::File.join config[:root], ::File.dirname(request_path) # TODO grab 'public' from the config options

data/spec/rack-staticifier_spec.rb

@@ -11,6 +11,27 @@ describe Rack::Staticifier do
     @app = lambda {|env| [200, {}, ["hello from #{env['PATH_INFO']}"]] }
   end
 
+  after :all do
+    %w( public cache foo ).each {|dir| FileUtils.rm_rf dir } # clean up!
+  end
+
+  it 'should render index.html for any requests ending in a slash' do
+    app = Rack::Staticifier.new @app
+
+    # for the '/' route
+    File.file?("cache/index.html").should be_false
+    RackBox.request app, "/"
+    File.file?("cache/index.html").should be_true
+    File.read("cache/index.html").should == "hello from /"
+
+    %w( foo/ bar/ ).each do |uri|
+      File.file?("cache/#{uri}index.html").should be_false
+      RackBox.request app, "/#{uri}"
+      File.file?("cache/#{uri}index.html").should be_true
+      File.read("cache/#{uri}index.html").should == "hello from /#{uri}"
+    end
+  end
+
   it 'should cache all requests by default (in cache directory)' do
     app = Rack::Staticifier.new @app
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: remi-rack-staticifier
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - remi
@@ -29,6 +29,7 @@ files:
 - lib/rack
 - lib/rack/staticifier.rb
 - spec/rack-staticifier_spec.rb
+- examples/my-sinatra-blog.rb
 has_rdoc: true
 homepage: http://github.com/remi/rack-staticifier
 post_install_message: