remi-rack-staticifier 0.1.0

data/README.rdoc

@@ -0,0 +1,25 @@
+= Rack::Staticifier
+
+Rack::Staticifier is Rack middleware for staticly caching responses.
+
+There are lots of tools out there already for creating static sites, eg:
+ * Jekyll
+ * StaticMatic
+ * webgen
+
+The problem with these tools, in my opinion, is that they make you code 
+your sites in a certain way.
+
+What if you want to code your blog in Rails or Sinatra or something?
+
+Rack::Staticifier is intended to solve this problem for you.  If you want 
+to code your static site in any Rack-based web framework, go right ahead! 
+You can use Rack::Staticifier to statically cache responses to your app.
+
+== Install
+
+... coming soon ...
+
+== Usage
+
+... coming soon ...

data/Rakefile

@@ -0,0 +1,68 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+puts "\nGem: rack-staticifier\n\n"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'rack-staticifier'
+    s.summary     = ''
+    s.email       = 'remi@remitaylor.com'
+    s.homepage    = 'http://github.com/remi/rack-staticifier'
+    s.description = ''
+    s.authors     = %w( remi )
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*'] 
+    # s.add_dependency 'person-gemname'
+    # s.executables << 'script'
+    # s.rubyforge_project = 'gemname'
+    # s.extra_rdoc_files = %w( README.rdoc )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+# require 'hanna'
+# require 'darkfish-rdoc'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rack-staticifier'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  # rdoc.options += ["--template=#{`allison --path`}"]  # sudo gem install allison
+  # rdoc.options += %w( -f darkfish )                   # sudo gem install darkfish-rdoc
+  # rdoc.options += %w( -T hanna )                      # sudo gem install mislav-hanna
+  rdoc.options += %w( -m README.rdoc ) # the initial page displayed
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('rack-staticifier.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION.yml

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

data/lib/rack-staticifier.rb

@@ -0,0 +1,57 @@
+module Rack #:nodoc:
+
+  # Rack::Staticifier doco ...
+  class Staticifier
+
+    # the Rack application
+    attr_reader :app
+
+    # configuration options
+    attr_reader :config
+
+    def initialize app, config_options = nil, &block
+      @app     = app
+      @config = default_config_options
+
+      config.merge!(config_options) if config_options
+      config[:cache_if] = block     if block
+    end
+
+    def call env
+      response = @app.call env
+      cache_response(env, response) if should_cache_response?(env, response)
+      response
+    end
+
+    private
+
+    def default_config_options
+      { :root => 'cache' }
+    end
+
+    def should_cache_response? env, response
+      return true unless config.keys.include?(:cache_if) and config[:cache_if].respond_to?(:call)
+      should_cache = config[:cache_if].call(env, response)
+      should_cache
+    end
+
+    def cache_response env, response
+      request_path = env['PATH_INFO']
+
+      basename     = ::File.basename request_path
+      dirname      = ::File.join config[:root], ::File.dirname(request_path) # TODO grab 'public' from the config options
+      fullpath     = ::File.join dirname, basename
+
+      FileUtils.mkdir_p(dirname)
+      ::File.open(fullpath, 'w'){|f| f << response_body(response) }
+    end
+
+    def response_body response
+      body = ''
+      response.last.each {|string| body << string } # per the Rack spec, the last object should respond to #each
+      body
+    end
+
+  end
+
+end

data/lib/rack/staticifier.rb

@@ -0,0 +1,2 @@
+# require 'rack/staticifier'
+require 'rack-staticifier'

data/spec/rack-staticifier_spec.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'rackbox'
+require 'fileutils'
+
+require File.dirname(__FILE__) + '/../lib/rack-staticifier'
+
+describe Rack::Staticifier do
+
+  before do
+    %w( public cache foo ).each {|dir| FileUtils.rm_rf dir }
+    @app = lambda {|env| [200, {}, ["hello from #{env['PATH_INFO']}"]] }
+  end
+
+  it 'should cache all requests by default (in cache directory)' do
+    app = Rack::Staticifier.new @app
+
+    %w( foo bar ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_true
+      File.read("cache/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should cache all requests in a custom directory' do
+    app = Rack::Staticifier.new @app, :root => 'foo'
+
+    %w( foo bar ).each do |uri|
+      File.file?("foo/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("foo/#{uri}.html").should be_true
+      File.read("foo/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should cache all requests in a custom subdirectory' do
+    app = Rack::Staticifier.new @app, :root => 'foo/bar'
+
+    %w( foo bar ).each do |uri|
+      File.file?("foo/bar/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("foo/bar/#{uri}.html").should be_true
+      File.read("foo/bar/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should cache requests with slashes in them (create subdirectories)' do
+    app = Rack::Staticifier.new @app, :root => 'foo'
+
+    %w( hi/there a/b/c/1/2/3 totally/neato ).each do |uri|
+      File.file?("foo/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("foo/#{uri}.html").should be_true
+      File.read("foo/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should be able to only cache requests based on request environment' do
+    app = Rack::Staticifier.new @app, :cache_if => lambda {|env,resp| env['PATH_INFO'].include?('cache') }
+
+    %w( hi there crazy/person ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_false
+    end
+
+    %w( cache cache-me please/cache/me ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_true
+      File.read("cache/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should be able to only cache requests based on request environment (by passing a block)' do
+    app = Rack::Staticifier.new(@app){ |env,resp| env['PATH_INFO'].include?('cache') }
+
+    %w( hi there crazy/person ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_false
+    end
+
+    %w( cache cache-me please/cache/me ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_true
+      File.read("cache/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+
+  it 'should be able to only cache requests based on generated response' do
+    app = Rack::Staticifier.new @app, :cache_if => lambda {|env,resp|
+      body = ''
+      resp[2].each {|s| body << s }
+      body.include?("hello from /foo")
+    }
+
+    %w( nope hi not/start/with/foo/x nor-me-foo ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_false
+    end
+
+    %w( foo fooooo foo/bar ).each do |uri|
+      File.file?("cache/#{uri}.html").should be_false
+      RackBox.request app, "/#{uri}.html"
+      File.file?("cache/#{uri}.html").should be_true
+      File.read("cache/#{uri}.html").should == "hello from /#{uri}.html"
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: remi-rack-staticifier
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-06 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- VERSION.yml
+- README.rdoc
+- lib/rack-staticifier.rb
+- lib/rack
+- lib/rack/staticifier.rb
+- spec/rack-staticifier_spec.rb
+has_rdoc: true
+homepage: http://github.com/remi/rack-staticifier
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+