serve 0.9.10 → 0.10.0

data/lib/serve/version.rb

@@ -1,13 +1,8 @@
 module Serve #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 9
-    TINY  = 10
-    
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
-  
   def self.version
-    VERSION::STRING
+    @version ||= begin
+      filename = File.join(File.dirname(__FILE__), '..', '..', 'VERSION')
+      IO.read(filename).strip
+    end
   end
 end

data/lib/serve/webrick/extensions.rb

@@ -1,7 +1,10 @@
+# Portions from Rails, Copyright (c) 2004-2008 David Heinemeier Hansson
+require 'active_support/memoizable'
+
 module Serve #:nodoc:
   module WEBrick #:nodoc:
+    
     module FileHandlerExtensions #:nodoc:
-      
       def self.included(base)
         base.extend(self)
         base.class_eval do
@@ -11,22 +14,84 @@ module Serve #:nodoc:
       end
       
       def search_file_with_auto_appending(req, res, basename)
-        if result = search_file_without_auto_appending(req, res, basename)
-          return result
-        end
-        extensions = @config[:AppendExtensions]
-        basename = $1 if basename =~ %r{^(.*?)/$}
-        if extensions
-          extensions.each do |ext|
-            if result = search_file_without_auto_appending(req, res, "#{basename}.#{ext}")
-              return result
-            end
-          end
-        end
-        return nil
+        full_path = File.join(res.filename, basename)
+        return basename if File.file?(full_path)
+        return nil if File.directory?(full_path)
+        Serve.resolve_file(Dir.pwd, req.path)
       end
-      
     end
+    
+  end
+end
+
+WEBrick::HTTPRequest.module_eval do
+  extend ActiveSupport::Memoizable
+
+  alias headers header
+
+  # Returns the \host for this request, such as "example.com".
+  def raw_host_with_port
+    @host + ':' + @port.to_s
+  end
+
+  # Returns 'https://' if this is an SSL request and 'http://' otherwise.
+  def protocol
+    ssl? ? 'https://' : 'http://'
+  end
+  memoize :protocol
+
+  # Is this an SSL request?
+  def ssl?
+    meta_vars['HTTPS'] == 'on'
+  end
+
+  def params
+    query.inject({}) {|m, (k,v)| m[k.to_s.to_sym] = v; m}
+  end
+
+  # Returns the host for this request, such as example.com.
+  def host
+    raw_host_with_port.sub(/:\d+$/, '')
+  end
+  memoize :host
+
+  # Returns a \host:\port string for this request, such as "example.com" or
+  # "example.com:8080".
+  def host_with_port
+    "#{host}#{port_string}"
+  end
+  memoize :host_with_port
+
+  # Returns the port number of this request as an integer.
+  def port
+    if raw_host_with_port =~ /:(\d+)$/
+      $1.to_i
+    else
+      standard_port
+    end
+  end
+  memoize :port
+
+  # Returns the standard \port number for this request's protocol.
+  def standard_port
+    case protocol
+      when 'https://' then 443
+      else 80
+    end
+  end
+
+  # Returns a \port suffix like ":8080" if the \port number of this request
+  # is not the default HTTP \port 80 or HTTPS \port 443.
+  def port_string
+    port == standard_port ? '' : ":#{port}"
+  end
+end
+
+WEBrick::HTTPResponse.module_eval do
+  alias headers header
+  
+  def redirect(url, status)
+    set_redirect(::WEBrick::HTTPStatus[status.to_i], url)
   end
 end
 

data/lib/serve/webrick/server.rb

@@ -0,0 +1,17 @@
+module Serve #:nodoc:
+  module WEBrick
+    class Server < ::WEBrick::HTTPServer #:nodoc:
+      def self.register_handlers
+        extensions = []
+        Serve::FileTypeHandler.handlers.each do |ext, handler|
+          extensions << ext
+          handler_servlet = Class.new(Serve::WEBrick::Servlet) do
+            define_method(:handler) { handler }
+          end
+          ::WEBrick::HTTPServlet::FileHandler.add_handler(ext, handler_servlet)
+        end
+        extensions
+      end
+    end
+  end
+end

data/lib/serve/webrick/servlet.rb

@@ -0,0 +1,19 @@
+module Serve #:nodoc:
+  module WEBrick
+    class Servlet < ::WEBrick::HTTPServlet::AbstractServlet #:nodoc:
+      def do_GET(req, res)
+        begin
+          path = Serve.resolve_file(Dir.pwd, req.path)
+          handler.new(Dir.pwd, path).process(req, res)
+        rescue StandardError => ex
+          raise
+        rescue Exception => ex
+          @logger.error(ex)
+          raise ::WEBrick::HTTPStatus::InternalServerError, ex.message
+        end
+      end
+      
+      alias do_POST do_GET
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,6 @@
+require 'serve/rails'
+
+ActionController::Routing::RouteSet::Mapper.send :include, Serve::Rails::Routing::MapperExtensions
+ActionController::AbstractResponse.module_eval do
+  attr_accessor :cache_timeout
+end

data/spec/{serve_application_spec.rb → application_spec.rb}

@@ -1,4 +1,5 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'serve/application'
 
 describe Serve::Application do
   
@@ -21,19 +22,19 @@ describe Serve::Application do
     end
     
     it "should parse with only the port" do
-      @app.parse(["2000"])[:port].should == "2000"
+      @app.parse(["2000"])[:port].should == 2000
     end
     
     it "should parse with the port and address" do
       @app.parse(["1.1.1.1", "2000"]).should ==
-        @defopts.update(:address => "1.1.1.1", :port=>"2000")
+        @defopts.update(:address => "1.1.1.1", :port=>2000)
       @app.parse(["1.1.1.1:2000"]).should ==
-        @defopts.update(:address => "1.1.1.1", :port=>"2000")
+        @defopts.update(:address => "1.1.1.1", :port=>2000)
     end
     
     it "should parse with the port, address, and protocol" do
       @app.parse(["http://1.1.1.1:2000"]).should ==
-        @defopts.update(:address => "1.1.1.1", :port=>"2000")
+        @defopts.update(:address => "1.1.1.1", :port=>2000)
     end
     
     it "should parse help" do

data/spec/response_cache_spec.rb

@@ -0,0 +1,248 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Serve::ResponseCache do
+  class SilentLogger
+    def method_missing(*args); end
+  end
+  
+  class TestRequest < Struct.new(:body, :env)
+  end
+  
+  class TestResponse < Struct.new(:body, :headers, :cache_timeout)
+    def initialize(body = '', headers = {})
+      self.body = body
+      self.headers = headers
+    end
+  end
+  
+  before :all do
+    @dir = File.expand_path("#{File.expand_path(File.dirname(__FILE__))}/tmp/cache")
+    @baddir = File.expand_path("#{File.expand_path(File.dirname(__FILE__))}/tmp/badcache")
+  end
+  
+  before :each do
+    FileUtils.rm_rf @baddir
+    @cache = Serve::ResponseCache.new(
+      :directory => @dir,
+      :perform_caching => true
+    )
+    @cache.clear
+  end
+  
+  after :each do
+    FileUtils.rm_rf @dir if File.exists? @dir
+  end
+  
+  it 'should initialize with defaults' do
+    @cache = Serve::ResponseCache.new
+    @cache.expire_time.should == 5.minutes
+    @cache.default_extension.should == '.yml'
+  end
+  
+  it 'should initialize with options' do
+    @cache = Serve::ResponseCache.new(
+      :directory         => "test",
+      :expire_time       => 5,
+      :default_extension => ".xhtml",
+      :perform_caching   => false,
+      :logger            => SilentLogger.new
+    )
+    @cache.directory.should == "test"
+    @cache.expire_time.should == 5
+    @cache.default_extension.should == ".xhtml"
+    @cache.perform_caching.should == false
+    @cache.logger.should be_kind_of(SilentLogger)
+  end
+  
+  it 'should cache response' do
+    ['test/me', '/test/me', 'test/me/', '/test/me/', 'test//me'].each do |url|
+      @cache.clear
+      response = response('content', 'Last-Modified' => 'Tue, 27 Feb 2007 06:13:43 GMT')
+      response.cache_timeout = Time.gm(2007, 2, 8, 17, 37, 9)
+      @cache.cache_response(url, response)
+      name = "#{@dir}/test/me.yml"
+      File.exists?(name).should == true
+      file(name).should == "--- \nexpires: 2007-02-08 17:37:09 Z\nheaders: \n  Last-Modified: Tue, 27 Feb 2007 06:13:43 GMT\n" 
+      data_name = "#{@dir}/test/me.data"
+      file(data_name).should == "content" 
+    end
+  end
+  
+  it 'cache response with extension' do
+    @cache.cache_response("styles.css", response('content'))
+    File.exists?("#{@dir}/styles.css.yml").should == true
+  end
+  
+  it 'cache response without caching' do
+    @cache.perform_caching = false
+    @cache.cache_response('test', response('content'))
+    File.exists?("#{@dir}/test.yml").should == false
+  end
+  
+  it 'update response' do
+    @cache.cache_response('/test/me', response('content'))
+    ['test/me', '/test/me', 'test/me/', '/test/me/', 'test//me'].each do |url|
+      @cache.update_response(url, response, TestRequest).body.should == 'content'
+    end
+  end
+
+  it 'update response nonexistant' do
+    @cache.update_response('nothing/here', response, TestRequest).body.should == ''
+  end
+  
+  it 'update response without caching' do
+    @cache.cache_response('/test/me', response('content'))
+    @cache.perform_caching = false
+     @cache.update_response('/test/me', response, TestRequest).body.should == ''
+  end
+  
+  it 'cache' do
+    result = @cache.cache_response('test', response('content', 'Content-Type' => 'text/plain'))
+    cached = @cache.update_response('test', response, TestRequest)
+    cached.body.should == 'content'
+    cached.headers['Content-Type'].should == 'text/plain'
+    result.should be_kind_of(TestResponse)
+  end
+  
+  it 'expire response' do
+    @cache.cache_response('test', response('content'))
+    @cache.expire_response('test')
+    @cache.update_response('test', response, TestRequest).body.should == ''
+  end
+  
+  it 'clear' do
+    @cache.cache_response('test1', response('content'))
+    @cache.cache_response('test2', response('content'))
+    Dir["#{@dir}/*"].size.should == 4
+    
+    @cache.clear
+    Dir["#{@dir}/*"].size.should == 0
+  end
+  
+  it 'response_cached?' do
+    @cache.response_cached?('test').should == false
+    result = @cache.cache_response('test', response('content'))
+    @cache.response_cached?('test').should == true
+  end
+  
+  it 'response_cached? should not answer true when response is cached but preform_caching option is false' do
+    @cache.cache_response('test', response('content'))
+    @cache.perform_caching = false
+    @cache.response_cached?('test').should == false
+  end
+  
+  it 'response_cached? with timeout' do
+    @cache.expire_time = 1
+    result = @cache.cache_response('test', response('content'))
+    sleep 1.5
+    @cache.response_cached?('test').should == false
+  end
+  
+  it 'response_cached? timeout with response setting' do
+    @cache.expire_time = 1
+    response = response('content')
+    response.cache_timeout = 3.seconds
+    result = @cache.cache_response('test', response)
+    sleep 1.5
+    @cache.response_cached?('test').should == true
+    sleep 2
+    @cache.response_cached?('test').should == false
+  end
+  
+  it 'send using x_sendfile header' do
+    @cache.use_x_sendfile = true
+    result = @cache.cache_response('test', response('content', 'Content-Type' => 'text/plain'))
+    cached = @cache.update_response('test', response, TestRequest)
+    cached.body.should == ''
+    cached.headers['X-Sendfile'].should == "#{@dir}/test.data"
+    cached.headers['Content-Type'].should == 'text/plain'
+    result.should be_kind_of(TestResponse) 
+  end
+  
+  it 'send cached page with last modified' do
+    last_modified = Time.now.httpdate
+    result = @cache.cache_response('test', response('content', 'Last-Modified' => last_modified))
+    request = TestRequest.new
+    request.env = { 'HTTP_IF_MODIFIED_SINCE' => last_modified }
+    second_call = @cache.update_response('test', response, request)
+    second_call.headers['Status'].should match(/^304/)
+    second_call.body.should == ''
+    result.should be_kind_of(TestResponse)
+  end
+  
+  it 'send cached page with old last modified' do
+    last_modified = Time.now.httpdate
+    result = @cache.cache_response('test', response('content', 'Last-Modified' => last_modified))
+    request = TestRequest.new
+    request.env = { 'HTTP_IF_MODIFIED_SINCE' => 5.minutes.ago.httpdate }
+    second_call = @cache.update_response('test', response, request)
+    second_call.body.should == 'content'
+    result.should be_kind_of(TestResponse) 
+  end
+  
+  it 'not cached if metadata empty' do
+    FileUtils.makedirs(@dir)
+    File.open("#{@dir}/test_me.yml", 'w') { }
+    @cache.response_cached?('/test_me').should == false
+  end
+
+  it 'not cached if metadata broken' do
+    FileUtils.makedirs(@dir)
+    File.open("#{@dir}/test_me.yml", 'w') {|f| f.puts '::: bad yaml file:::' }
+    @cache.response_cached?('/test_me').should == false
+  end
+  
+  it 'not cached if metadata not hash' do
+    FileUtils.makedirs(@dir)
+    File.open("#{@dir}/test_me.yml", 'w') {|f| f.puts ':symbol' }
+    @cache.response_cached?('/test_me').should == false
+  end
+  
+  it 'not cached if metadata has no expire' do
+    FileUtils.makedirs(@dir)
+    File.open("#{@dir}/test_me.yml", 'w') { |f| f.puts "--- \nheaders: \n  Last-Modified: Tue, 27 Feb 2007 06:13:43 GMT\n" }
+    @cache.response_cached?('/test_me').should == false
+  end  
+  
+  it 'cache cant write outside dir' do
+    @cache.cache_response('../badcache/cache_cant_write_outside_dir', response('content'))
+    File.exist?("#{@baddir}/cache_cant_write_outside_dir.yml").should == false
+  end
+  
+  it 'cache cannot read outside dir' do
+    FileUtils.makedirs(@baddir)
+    @cache.cache_response('/test_me', response('content'))
+    File.rename "#{@dir}/test_me.yml", "#{@baddir}/test_me.yml"
+    File.rename "#{@dir}/test_me.data", "#{@baddir}/test_me.data"
+    @cache.response_cached?('/../badcache/test_me').should == false
+  end
+  
+  it 'cache cannot expire outside dir' do
+    FileUtils.makedirs(@baddir)
+    @cache.cache_response('/test_me', response('content'))
+    File.rename "#{@dir}/test_me.yml", "#{@baddir}/test_me.yml"
+    File.rename "#{@dir}/test_me.data", "#{@baddir}/test_me.data"
+    @cache.expire_response('/../badcache/test_me')
+    File.exist?("#{@baddir}/test_me.yml").should == true
+    File.exist?("#{@baddir}/test_me.data").should == true
+  end  
+
+  it 'should store indexes correctly' do
+    @cache.cache_response('/', response('content')) 
+    @cache.response_cached?('_site-root').should == true
+    @cache.response_cached?('/') .should == true
+    File.exist?("#{@dir}/../cache.yml").should == false
+    File.exist?("#{@dir}/../cache.data").should == false
+  end 
+
+  private
+
+    def file(filename)
+      open(filename) { |f| f.read } rescue ''
+    end
+
+    def response(*args)
+      TestResponse.new(*args)
+    end
+
+end