RubyGems - remi-rack-staticifier - Versions diffs - 0.1.1 → 0.1.3 - Mend

remi-rack-staticifier 0.1.1 → 0.1.3

Files changed (12) hide show

data/VERSION.yml +1 -1
data/bin/staticify +88 -0
data/examples/blog-to-staticify/config.ru +3 -0
data/examples/blog-to-staticify/my-blog.rb +17 -0
data/examples/blog-to-staticify/paths-to-cache +3 -0
data/examples/blog-to-staticify/posts/first.mkd +3 -0
data/examples/blog-to-staticify/posts/second.mkd +5 -0
data/examples/sinatra-blog-with-built-in-caching/my-sinatra-blog.rb +29 -0
data/lib/rack-staticifier.rb +8 -3
data/spec/rack-staticifier_spec.rb +64 -0
metadata +12 -3
data/examples/my-sinatra-blog.rb +0 -28

data/VERSION.yml CHANGED Viewed

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

data/bin/staticify ADDED Viewed

@@ -0,0 +1,88 @@
+#! /usr/bin/env ruby
+#
+# Simple script for staticifying your Rack applications
+#
+# Checks for config.ru / Rails by defualt, otherwise you can:
+#
+#   $ staticify -r myapp.rb --app 'lambda {|env| [200, {}, "hi!"] }' info
+#   $ staticify -r myapp.rb,another-file.rb --app 'Sinatra::Application' get '/'
+#   $ staticify -r myapp --app 'MyApp.new' '/'
+#
+%w( rubygems rackbox optparse fileutils ).each {|lib| require lib }
+require File.dirname(__FILE__) + '/../lib/rack-staticifier'
+def usage
+  puts <<USAGE
+  staticify == %{ For staticifying your Rack applications }
+    Usage:
+      staticify        # print this usage information
+      staticify .      # staticify Rack app in current directory
+USAGE
+end
+if ARGV.empty?
+  usage
+  exit
+end
+#### ==== Option Parsing ==== ####
+files_to_require = []
+ruby_to_run      = nil
+path_to_cache_to = '.site'
+opts = OptionParser.new do |opts|
+  opts.on('-r', '--require [file]') {|x| files_to_require << x }
+  opts.on('-a', '--app [ruby]')     {|x| ruby_to_run = x       }
+  opts.on('-d', '--dir [dir]')      {|x| path_to_cache_to = x  }
+end
+opts.parse! ARGV
+app_directory = ARGV.shift
+unless File.directory? app_directory
+   puts "App directory not found: #{ app_directory }\n\n"
+   usage
+   exit
+end
+FileUtils.cd app_directory
+files_to_require.each {|file| require file }
+if ruby_to_run
+  begin
+    RackBox.app = eval(ruby_to_run)
+  rescue Exception => ex
+    puts "Tried running Ruby code to set Rack app: #{ ruby_to_run.inspect }"
+    raise ex
+  end
+end
+unless RackBox.app(:silent => true)
+  puts "Cannot find your Rack application\n\n"
+  usage
+  exit
+end
+#### ==== Get Routes to Cache ==== ####
+paths_to_cache = []
+while path = gets
+  paths_to_cache << path.strip
+end
+puts "Caching to #{ path_to_cache_to }"
+puts "#{ paths_to_cache.length } paths to cache:"
+#### ==== Cache the Routes ==== ####"
+FileUtils.rm_rf path_to_cache_to
+RackBox.app = Rack::Staticifier.new(RackBox.app, :root => path_to_cache_to)
+paths_to_cache.each do |path|
+  response = RackBox.request path
+  puts "  #{ response.status }  #{ path }"
+end

data/examples/blog-to-staticify/config.ru ADDED Viewed

@@ -0,0 +1,3 @@
+require 'my-blog'
+run Sinatra::Application

data/examples/blog-to-staticify/my-blog.rb ADDED Viewed

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+%w( rubygems sinatra maruku ).each {|lib| require lib }
+get '/' do
+  "welcome to my blog!"
+end
+get '/:name.html' do
+  file = File.join File.dirname(__FILE__), 'posts', "#{ params['name'] }.mkd"
+  if File.file? file
+    Maruku.new(File.read(file)).to_html
+  else
+    status 404
+    "Not Found!  #{ params['name'] }"
+  end
+end

data/examples/blog-to-staticify/paths-to-cache ADDED Viewed

@@ -0,0 +1,3 @@
+#! /bin/bash
+echo '/'
+ls posts/* | xargs -L 1 basename | sed 's|\(.*\)\.mkd|\/\1.html|g'

data/examples/blog-to-staticify/posts/first.mkd ADDED Viewed

@@ -0,0 +1,3 @@
+# First Post!
+hi!

data/examples/blog-to-staticify/posts/second.mkd ADDED Viewed

@@ -0,0 +1,5 @@
+# Totally
+## Awesome
+    post about nothing

data/examples/sinatra-blog-with-built-in-caching/my-sinatra-blog.rb ADDED Viewed

@@ -0,0 +1,29 @@
+#! /usr/bin/env ruby
+# %w( rubygems sinatra rack/staticifier ).each {|lib| require lib }
+%w( rubygems sinatra ).each {|lib| require lib }
+require File.dirname(__FILE__) + '/../lib/rack-staticifier'
+use Rack::Staticifier
+set :public, 'cache'
+$posts = {
+  'hello-world' => '<html><body>Hello World!</body></html>',
+  '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 CHANGED Viewed

@@ -28,6 +28,8 @@ module Rack #:nodoc:
   #
   class Staticifier
+    STATUS_CODES_NOT_TO_CACHE = [ 304 ]
     # the Rack application
     attr_reader :app
@@ -35,7 +37,7 @@ module Rack #:nodoc:
     attr_reader :config
     def initialize app, config_options = nil, &block
-      @app     = app
+      @app    = app
       @config = default_config_options
       config.merge!(config_options) if config_options
@@ -55,7 +57,10 @@ module Rack #:nodoc:
     end
     def should_cache_response? env, response
-      return true unless config.keys.include?(:cache_if) and config[:cache_if].respond_to?(:call)
+      return false if STATUS_CODES_NOT_TO_CACHE.include?(response.first) # there are certain HTTP Status Codes we should never cache
+      return false if response.last.respond_to?(:to_path) # we don't cache Rack::File's
+      return true unless config.keys.include?(:cache_if) and config[:cache_if].respond_to?(:call) # true if no cache_if / block
       should_cache = config[:cache_if].call(env, response)
       should_cache
     end
@@ -65,7 +70,7 @@ module Rack #:nodoc:
       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
+      dirname      = ::File.join config[:root], ::File.dirname(request_path)
       fullpath     = ::File.join dirname, basename
       FileUtils.mkdir_p(dirname)

data/spec/rack-staticifier_spec.rb CHANGED Viewed

@@ -130,5 +130,69 @@ describe Rack::Staticifier do
       File.read("cache/#{uri}.html").should == "hello from /#{uri}.html"
     end
   end
+  it 'should not be cache a Rack::File (#to_path)' do
+    pending "either RackBox or Rack::MockRequest isn't happy about running this"
+=begin
+1)
+TypeError in 'Rack::Staticifier should not be cache a Rack::File (#to_path)'
+can't convert nil into String
+/usr/lib/ruby/gems/1.8/gems/rack-1.0.0/lib/rack/file.rb:81:in `initialize'
+/usr/lib/ruby/gems/1.8/gems/rack-1.0.0/lib/rack/file.rb:81:in `open'
+/usr/lib/ruby/gems/1.8/gems/rack-1.0.0/lib/rack/file.rb:81:in `each'
+/usr/lib/ruby/gems/1.8/gems/rack-1.0.0/lib/rack/mock.rb:126:in `initialize'
+/usr/lib/ruby/gems/1.8/gems/remi-rackbox-1.1.5/lib/rackbox/rack/sticky_sessions.rb:40:in `new'
+/usr/lib/ruby/gems/1.8/gems/remi-rackbox-1.1.5/lib/rackbox/rack/sticky_sessions.rb:40:in `request'
+/usr/lib/ruby/gems/1.8/gems/rack-1.0.0/lib/rack/mock.rb:55:in `get'
+/usr/lib/ruby/gems/1.8/gems/remi-rackbox-1.1.5/lib/rackbox/rackbox.rb:84:in `send'
+/usr/lib/ruby/gems/1.8/gems/remi-rackbox-1.1.5/lib/rackbox/rackbox.rb:84:in `request'
+./spec/rack-staticifier_spec.rb:137:
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_methods.rb:37:in `instance_eval'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_methods.rb:37:in `execute'
+/usr/lib/ruby/1.8/timeout.rb:53:in `timeout'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_methods.rb:34:in `execute'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_group_methods.rb:208:in `execute_examples'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_group_methods.rb:206:in `each'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_group_methods.rb:206:in `execute_examples'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/example/example_group_methods.rb:104:in `run'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/runner/example_group_runner.rb:23:in `run'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/runner/example_group_runner.rb:22:in `each'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/runner/example_group_runner.rb:22:in `run'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/runner/options.rb:117:in `run_examples'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/lib/spec/runner/command_line.rb:9:in `run'
+/usr/lib/ruby/gems/1.8/gems/rspec-1.2.2/bin/spec:4:
+/usr/bin/spec:19:in `load'
+/usr/bin/spec:19:
+=end
+    app = lambda {|env| [200, {}, Rack::File.new(__FILE__)] }
+    File.file?("cache/foo.html").should be_false
+    RackBox.request app, "/foo.html"
+    File.file?("cache/foo.html").should be_false # shouldn't be cached!
+    # just double check ...
+    app = lambda {|env| [200, {}, ["cache me!"]] }
+    File.file?("cache/foo.html").should be_false
+    RackBox.request app, "/foo.html"
+    File.file?("cache/foo.html").should be_true # normal #each should be cached
+  end
+  it 'should not cache responses with certain HTTP Status Codes' do
+    Rack::Staticifier::STATUS_CODES_NOT_TO_CACHE.each do |code|
+      app = lambda {|env| [code, {}, ["not cached"]] }
+      File.file?("foo.html").should be_false
+      RackBox.request app, "/foo.html"
+      File.file?("foo.html").should be_false # shouldn't be cached!
+    end
+    # this assumes that 304 will always be in STATUS_CODES_NOT_TO_CACHE ... want to double check!
+    app = lambda {|env| [304, {}, ["not cached"]] }
+    File.file?("foo.html").should be_false
+    RackBox.request app, "/foo.html"
+    File.file?("foo.html").should be_false # shouldn't be cached!
+  end
+  it 'should be able to customize the name of the cached file (?)'
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: remi-rack-staticifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - remi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2009-05-06 00:00:00 -07:00
+date: 2009-05-07 00:00:00 -07:00
 default_executable:
 dependencies: []
@@ -29,7 +29,16 @@ files:
 - lib/rack
 - lib/rack/staticifier.rb
 - spec/rack-staticifier_spec.rb
-- examples/my-sinatra-blog.rb
+- bin/staticify
+- examples/sinatra-blog-with-built-in-caching
+- examples/sinatra-blog-with-built-in-caching/my-sinatra-blog.rb
+- examples/blog-to-staticify
+- examples/blog-to-staticify/posts
+- examples/blog-to-staticify/posts/first.mkd
+- examples/blog-to-staticify/posts/second.mkd
+- examples/blog-to-staticify/my-blog.rb
+- examples/blog-to-staticify/config.ru
+- examples/blog-to-staticify/paths-to-cache
 has_rdoc: true
 homepage: http://github.com/remi/rack-staticifier
 post_install_message:

data/examples/my-sinatra-blog.rb DELETED Viewed

@@ -1,28 +0,0 @@
-#! /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