rack 0.9.1 → 1.0.0

data/COPYING

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Christian Neukirchen <purl.org/net/chneukirchen>
+Copyright (c) 2007, 2008, 2009 Christian Neukirchen <purl.org/net/chneukirchen>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/RDOX

@@ -4,6 +4,7 @@
 * should rechallenge if incorrect credentials are specified
 * should return application output if correct credentials are specified
 * should return 400 Bad Request if different auth scheme used
+* realm as optional constructor arg
 
 == Rack::Auth::Digest::MD5
 * should challenge when no credentials are specified
@@ -15,15 +16,19 @@
 * should return 400 Bad Request if incorrect qop given
 * should return 400 Bad Request if incorrect uri given
 * should return 400 Bad Request if different auth scheme used
+* should not require credentials for unprotected path
+* should challenge when no credentials are specified for protected path
+* should return application output if correct credentials given for protected path
+* should return application output if correct credentials given for POST
+* should return application output if correct credentials given for PUT (using method override of POST)
+* realm as optional constructor arg
 
 == Rack::Auth::OpenID
-* realm uri should be absolute and have a path
-* uri options should be absolute
-* return_to should be absolute and be under the realm
-* extensions should be a module
+* realm uri should be valid
+* should be able to check if a uri is within the realm (empty)
+* return_to should be valid
 * extensions should have required constants defined
 * extensions should have Request and Response defined and inherit from OpenID::Extension
-* extensions should have NS_URI defined and be a string of an absolute http uri
 
 == Rack::Builder
 * chains apps by default
@@ -53,6 +58,16 @@
 * should set status
 * shutdown
 
+== Rack::Chunked
+* chunks responses with no Content-Length
+* chunks empty bodies properly
+* does not modify response when Content-Length header present
+* does not modify response when client is HTTP/1.0
+* does not modify response when Transfer-Encoding header already present
+* does not modify response when status code is 100
+* does not modify response when status code is 204
+* does not modify response when status code is 304
+
 == Rack::CommonLogger
 * should log to rack.errors by default
 * should log to anything with <<
@@ -70,6 +85,12 @@
 * does not set Content-Length on 304 responses
 * does not set Content-Length when Transfer-Encoding is chunked
 
+== Rack::ContentType
+* sets Content-Type to default text/html if none is set
+* sets Content-Type to chosen default if none is set
+* does not change Content-Type if it is already set
+* case insensitive detection of Content-Type
+
 == Rack::Deflater
 * should be able to deflate bodies that respond to each
 * should be able to deflate String bodies
@@ -106,11 +127,14 @@
 * does not allow directory traversal with encoded periods
 * 404s if it can't find the file
 * detects SystemCallErrors
+* returns bodies that respond to #to_path
 
 == Rack::Handler
 * has registered default handlers
-* should get unregistered handler by name
+* handler that doesn't exist should raise a NameError
+* should get unregistered, but already required, handler by name
 * should register custom handler
+* should not need registration for properly coded handlers even if not already required
 
 == Rack::Head
 * response (empty)
@@ -131,6 +155,7 @@
 * notices input handling errors
 * notices error handling errors
 * notices HEAD errors
+* passes valid read calls
 
 == Rack::Lint::InputWrapper
 * delegates :size to underlying IO object
@@ -146,6 +171,11 @@
 * should be flippable
 * should provide crashing for testing purposes
 
+== Rack::Lock
+* should call synchronize on lock
+* should set multithread flag to false
+* should reset original multithread flag when exiting lock
+
 == Rack::MethodOverride
 * should not affect GET requests
 * _method parameter should modify REQUEST_METHOD for POST requests
@@ -159,6 +189,7 @@
 * should be able to only return the environment
 * should provide sensible defaults
 * should allow GET/POST/PUT/DELETE
+* should set content length
 * should allow posting
 * should use all parts of an URL
 * should behave valid according to the Rack spec
@@ -197,7 +228,7 @@
 * can parse POST data with explicit content type
 * does not parse POST data when media type is not form-data
 * rewinds input after parsing POST data
-* does not rewind unwindable CGI input
+* cleans up Safari's ajax POST body
 * can get value by key from params with #[]
 * can set value to key on params with #[]=
 * values_at answers values by keys in order given
@@ -214,10 +245,14 @@
 * can parse multipart form data
 * can parse big multipart form data
 * can detect invalid multipart form data
+* shouldn't try to interpret binary as utf8
 * should work around buggy 1.8.* Tempfile equality
 * does conform to the Rack spec
 * should parse Accept-Encoding correctly
 * should provide ip information
+* memoizes itself to reduce the cost of repetitive initialization
+* should allow subclass request to be instantiated after parent request
+* should allow parent request to be instantiated after subclass request
 
 == Rack::Response
 * has sensible default values
@@ -226,13 +261,61 @@
 * can set cookies
 * formats the Cookie expiration date accordingly to RFC 2109
 * can set secure cookies
+* can set http only cookies
 * can delete cookies
+* can do redirects
 * has a useful constructor
 * has a constructor that can take a block
 * doesn't return invalid responses
 * knows if it's empty
 * should provide access to the HTTP status
 * should provide access to the HTTP headers
+* does not add or change Content-Length when #finish()ing
+* updates Content-Length when body appended to using #write
+
+== Rack::RewindableInput
+=== given an IO object that is already rewindable
+* should be able to handle to read()
+* should be able to handle to read(nil)
+* should be able to handle to read(length)
+* should be able to handle to read(length, buffer)
+* should be able to handle to read(nil, buffer)
+* should rewind to the beginning when #rewind is called
+* should be able to handle gets
+* should be able to handle each
+* should not buffer into a Tempfile if no data has been read yet
+* should buffer into a Tempfile when data has been consumed for the first time
+* should close the underlying tempfile upon calling #close
+* should be possibel to call #close when no data has been buffered yet (empty)
+* should be possible to call #close multiple times (empty)
+=== given an IO object that is not rewindable
+* should be able to handle to read()
+* should be able to handle to read(nil)
+* should be able to handle to read(length)
+* should be able to handle to read(length, buffer)
+* should be able to handle to read(nil, buffer)
+* should rewind to the beginning when #rewind is called
+* should be able to handle gets
+* should be able to handle each
+* should not buffer into a Tempfile if no data has been read yet
+* should buffer into a Tempfile when data has been consumed for the first time
+* should close the underlying tempfile upon calling #close
+* should be possibel to call #close when no data has been buffered yet (empty)
+* should be possible to call #close multiple times (empty)
+=== given an IO object whose rewind method raises Errno::ESPIPE
+* should be able to handle to read()
+* should be able to handle to read(nil)
+* should be able to handle to read(length)
+* should be able to handle to read(length, buffer)
+* should be able to handle to read(nil, buffer)
+* should rewind to the beginning when #rewind is called
+* should be able to handle gets
+* should be able to handle each
+* should not buffer into a Tempfile if no data has been read yet
+* should buffer into a Tempfile when data has been consumed for the first time
+* should close the underlying tempfile upon calling #close
+* should be possibel to call #close when no data has been buffered yet (empty)
+* should be possible to call #close multiple times (empty)
 
 == Rack::Session::Cookie
 * creates a new cookie
@@ -244,21 +327,25 @@
 * ignores tampered with session cookies
 
 == Rack::Session::Memcache
-* startup (empty)
+* MemCache can connect to existing server (empty)
 * faults on no connection
 * creates a new cookie
 * determines session from a cookie
-* survives broken cookies
+* survives nonexistant cookies
 * maintains freshness
-* multithread: should cleanly merge sessions
-* shutdown
+* deletes cookies with :drop option
+* provides new session id with :renew option
+* omits cookie with :defer option
+* multithread: should cleanly merge sessions (empty)
 
 == Rack::Session::Pool
 * creates a new cookie
 * determines session from a cookie
-* survives broken cookies
-* maintains freshness
-* multithread: should merge sessions
+* survives nonexistant cookies
+* deletes cookies with :drop option
+* provides new session id with :renew option
+* omits cookie with :defer option
+* multithread: should merge sessions (empty)
 
 == Rack::ShowExceptions
 * catches exceptions
@@ -294,8 +381,10 @@
 * should escape correctly
 * should unescape correctly
 * should parse query strings correctly
+* should parse nested query strings correctly
 * should build query strings correctly
 * should figure out which encodings are acceptable
+* should return the bytesize of String
 
 == Rack::Utils::HeaderHash
 * should retain header case
@@ -303,13 +392,23 @@
 * should merge case-insensitively
 * should overwrite case insensitively and assume the new key's case
 * should be converted to real Hash
+* should convert Array values to Strings when converting to Hash
 
 == Rack::Utils::Context
-* should perform checks on both arguments
 * should set context correctly
 * should alter app on recontexting
 * should run different apps
 
+== Rack::Utils::Multipart
+* should return nil if content type is not multipart
+* should parse multipart upload with text file
+* should parse multipart upload with nested parameters
+* should parse multipart upload with binary file
+* should parse multipart upload with empty file
+* should not include file params if no file was selected
+* should parse IE multipart upload and clean up filename
+* rewinds input after parsing upload
+
 == Rack::Handler::WEBrick
 * should respond
 * should be a WEBrick
@@ -321,4 +420,4 @@
 * should correctly set cookies
 * should provide a .run
 
-244 specifications, 4 empty (1004 requirements), 0 failures
+330 specifications, 13 empty (1183 requirements), 0 failures

data/README

@@ -9,6 +9,24 @@ middleware) into a single method call.
 The exact details of this are described in the Rack specification,
 which all Rack applications should conform to.
 
+== Specification changes in this release
+
+With Rack 1.0, the Rack specification (found in SPEC) changed in the
+following backward-incompatible ways.  This was done to properly
+support Ruby 1.9 and to deprecate some problematic techniques:
+
+* Rack::VERSION has been pushed to [1,0].
+* Header values must be Strings now, split on "\n".
+* rack.input must be rewindable and support reading into a buffer,
+  wrap with Rack::RewindableInput if it isn't.
+* Content-Length can be missing, in this case chunked transfer
+  encoding is used.
+* Bodies can now additionally respond to #to_path with a filename to
+  be served.
+* String bodies are deprecated and will not work with Ruby 1.9, use an
+  Array with a single String instead.
+* rack.session is now specified.
+
 == Supported web servers
 
 The included *handlers* connect all kinds of web servers to Rack:
@@ -25,7 +43,8 @@ The included *handlers* connect all kinds of web servers to Rack:
 These web servers include Rack handlers in their distributions:
 * Ebb
 * Fuzed
-* Phusion Passenger (which is mod_rack for Apache)
+* Phusion Passenger (which is mod_rack for Apache and for nginx)
+* Unicorn
 
 Any valid Rack app will run the same on all these handlers, without
 changing anything.
@@ -36,6 +55,7 @@ The included *adapters* connect Rack with existing Ruby web frameworks:
 * Camping
 
 These frameworks include Rack adapters in their distributions:
+* Camping
 * Coset
 * Halcyon
 * Mack
@@ -44,13 +64,15 @@ These frameworks include Rack adapters in their distributions:
 * Racktools::SimpleApplication
 * Ramaze
 * Ruby on Rails
+* Rum
 * Sinatra
 * Sin
 * Vintage
 * Waves
+* Wee
 
 Current links to these projects can be found at
-http://ramaze.net/#other-frameworks
+http://wiki.ramaze.net/Home#other-frameworks
 
 == Available middleware
 
@@ -140,10 +162,11 @@ installation and test-spec.
 To run the test suite completely, you need:
 
   * camping
-  * mongrel
   * fcgi
-  * ruby-openid
   * memcache-client
+  * mongrel
+  * ruby-openid
+  * thin
 
 The full set of tests test FCGI access with lighttpd (on port
 9203) so you will need lighttpd installed as well as the FCGI
@@ -227,6 +250,28 @@ run on port 11211) and memcache-client installed.
 * January 9th, 2009: Sixth public release 0.9.1.
   * Fix directory traversal exploits in Rack::File and Rack::Directory.
 
+* April 25th, 2009: Seventh public release 1.0.0.
+  * SPEC change: Rack::VERSION has been pushed to [1,0].
+  * SPEC change: header values must be Strings now, split on "\n".
+  * SPEC change: Content-Length can be missing, in this case chunked transfer
+    encoding is used.
+  * SPEC change: rack.input must be rewindable and support reading into
+    a buffer, wrap with Rack::RewindableInput if it isn't.
+  * SPEC change: rack.session is now specified.
+  * SPEC change: Bodies can now additionally respond to #to_path with
+    a filename to be served.
+  * NOTE: String bodies break in 1.9, use an Array consisting of a
+    single String instead.
+  * New middleware Rack::Lock.
+  * New middleware Rack::ContentType.
+  * Rack::Reloader has been rewritten.
+  * Major update to Rack::Auth::OpenID.
+  * Support for nested parameter parsing in Rack::Response.
+  * Support for redirects in Rack::Response.
+  * HttpOnly cookie support in Rack::Response.
+  * The Rakefile has been rewritten.
+  * Many bugfixes and small improvements.
+
 == Contact
 
 Please mail bugs, suggestions and patches to
@@ -237,7 +282,7 @@ Mailing list archives are available at
 
 There is a bug tracker at <http://rack.lighthouseapp.com/>.
 
-Git repository (patches rebased on master are most welcome):
+Git repository (send Git patches to the mailing list):
 * http://github.com/rack/rack
 * http://git.vuxu.org/cgi-bin/gitweb.cgi?p=rack.git
 
@@ -262,8 +307,10 @@ would like to thank:
 * Luc Heinrich for the Cookie sessions, the static file handler and bugfixes.
 * Armin Ronacher, for the logo and racktools.
 * Aredridel, Ben Alpert, Dan Kubb, Daniel Roethlisberger, Matt Todd,
-  Tom Robinson, and Phil Hagelberg for bug fixing and other
-  improvements.
+  Tom Robinson, Phil Hagelberg, and S. Brent Faulkner for bug fixing
+  and other improvements.
+* Brian Candler, for Rack::ContentType.
+* Graham Batty, for improved handler loading.
 * Stephen Bannasch, for bug reports and documentation.
 * Gary Wright, for proposing a better Rack::Response interface.
 * Jonathan Buch, for improvements regarding Rack::Response.

data/Rakefile

@@ -6,36 +6,36 @@ require 'rake/testtask'
 desc "Run all the tests"
 task :default => [:test]
 
-desc "Do predistribution stuff"
-task :predist => [:chmod, :changelog, :rdoc]
-
 
 desc "Make an archive as .tar.gz"
-task :dist => [:fulltest, :predist] do
+task :dist => [:chmod, :changelog, :rdoc, "SPEC", "rack.gemspec"] do
+  FileUtils.touch("RDOX")
   sh "git archive --format=tar --prefix=#{release}/ HEAD^{tree} >#{release}.tar"
-  sh "pax -waf #{release}.tar -s ':^:#{release}/:' RDOX SPEC ChangeLog doc"
+  sh "pax -waf #{release}.tar -s ':^:#{release}/:' RDOX SPEC ChangeLog doc rack.gemspec"
   sh "gzip -f -9 #{release}.tar"
 end
 
-# Helper to retrieve the "revision number" of the git tree.
-def git_tree_version
-  if File.directory?(".git")
-    @tree_version ||= `git describe`.strip.sub('-', '.')
-    @tree_version << ".0"  unless @tree_version.count('.') == 2
-  else
-    $: << "lib"
-    require 'rack'
-    @tree_version = Rack.release
-  end
-  @tree_version
+desc "Make an official release"
+task :officialrelease do
+  puts "Official build for #{release}..."
+  sh "rm -rf stage"
+  sh "git clone --shared . stage"
+  sh "cd stage && rake officialrelease_really"
+  sh "mv stage/#{release}.tar.gz stage/#{release}.gem ."
+end
+
+task :officialrelease_really => [:fulltest, "RDOX", "SPEC", :dist, :gem] do
+  sh "sha1sum #{release}.tar.gz #{release}.gem"
 end
 
-def gem_version
-  git_tree_version.gsub(/-.*/, '')
+
+def version
+  abort "You need to pass VERSION=... to build packages."  unless ENV["VERSION"]
+  ENV["VERSION"]
 end
 
 def release
-  "rack-#{git_tree_version}"
+  "rack-#{version}"
 end
 
 def manifest
@@ -96,22 +96,17 @@ end
 
 begin
   require 'rubygems'
-
-  require 'rake'
-  require 'rake/clean'
-  require 'rake/packagetask'
-  require 'rake/gempackagetask'
-  require 'fileutils'
 rescue LoadError
   # Too bad.
 else
-  spec = Gem::Specification.new do |s|
-    s.name            = "rack"
-    s.version         = gem_version
-    s.platform        = Gem::Platform::RUBY
-    s.summary         = "a modular Ruby webserver interface"
-
-    s.description = <<-EOF
+  task "rack.gemspec" do
+    spec = Gem::Specification.new do |s|
+      s.name            = "rack"
+      s.version         = version
+      s.platform        = Gem::Platform::RUBY
+      s.summary         = "a modular Ruby webserver interface"
+      
+      s.description = <<-EOF
 Rack provides minimal, modular and adaptable interface for developing
 web applications in Ruby.  By wrapping HTTP requests and responses in
 the simplest way possible, it unifies and distills the API for web
@@ -121,68 +116,49 @@ middleware) into a single method call.
 Also see http://rack.rubyforge.org.
     EOF
 
-    s.files           = manifest + %w(SPEC RDOX)
-    s.bindir          = 'bin'
-    s.executables     << 'rackup'
-    s.require_path    = 'lib'
-    s.has_rdoc        = true
-    s.extra_rdoc_files = ['README', 'SPEC', 'RDOX', 'KNOWN-ISSUES']
-    s.test_files      = Dir['test/{test,spec}_*.rb']
-
-    s.author          = 'Christian Neukirchen'
-    s.email           = 'chneukirchen@gmail.com'
-    s.homepage        = 'http://rack.rubyforge.org'
-    s.rubyforge_project = 'rack'
-
-    #s.add_development_dependency 'test-spec'
-
-    #s.add_development_dependency 'camping'
-    #s.add_development_dependency 'fcgi'
-    #s.add_development_dependency 'memcache-client'
-    #s.add_development_dependency 'mongrel'
-    #s.add_development_dependency 'ruby-openid', '~> 2.0.0'
-    #s.add_development_dependency 'thin'
+      s.files           = manifest + %w(SPEC RDOX rack.gemspec)
+      s.bindir          = 'bin'
+      s.executables     << 'rackup'
+      s.require_path    = 'lib'
+      s.has_rdoc        = true
+      s.extra_rdoc_files = ['README', 'SPEC', 'RDOX', 'KNOWN-ISSUES']
+      s.test_files      = Dir['test/{test,spec}_*.rb']
+      
+      s.author          = 'Christian Neukirchen'
+      s.email           = 'chneukirchen@gmail.com'
+      s.homepage        = 'http://rack.rubyforge.org'
+      s.rubyforge_project = 'rack'
+      
+      s.add_development_dependency 'test-spec'
+      
+      s.add_development_dependency 'camping'
+      s.add_development_dependency 'fcgi'
+      s.add_development_dependency 'memcache-client'
+      s.add_development_dependency 'mongrel'
+      s.add_development_dependency 'ruby-openid', '~> 2.0.0'
+      s.add_development_dependency 'thin'
+    end
+
+    File.open("rack.gemspec", "w") { |f| f << spec.to_ruby }
   end
 
-  Rake::GemPackageTask.new(spec) do |p|
-    p.gem_spec = spec
-    p.need_tar = false
-    p.need_zip = false
+  task :gem => ["rack.gemspec", "SPEC"] do
+    FileUtils.touch("RDOX")
+    sh "gem build rack.gemspec"
   end
 end
 
 desc "Generate RDoc documentation"
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.options << '--line-numbers' << '--inline-source' <<
-    '--main' << 'README' <<
-    '--title' << 'Rack Documentation' <<
-    '--charset' << 'utf-8'
-  rdoc.rdoc_dir = "doc"
-  rdoc.rdoc_files.include 'README'
-  rdoc.rdoc_files.include 'KNOWN-ISSUES'
-  rdoc.rdoc_files.include 'SPEC'
-  rdoc.rdoc_files.include 'RDOX'
-  rdoc.rdoc_files.include('lib/rack.rb')
-  rdoc.rdoc_files.include('lib/rack/*.rb')
-  rdoc.rdoc_files.include('lib/rack/*/*.rb')
+task :rdoc do
+  sh(*%w{rdoc --line-numbers --main README 
+              --title 'Rack\ Documentation' --charset utf-8 -U -o doc} +
+              %w{README KNOWN-ISSUES SPEC RDOX} +
+              Dir["lib/**/*.rb"])
 end
-task :rdoc => ["SPEC", "RDOX"]
 
 task :pushsite => [:rdoc] do
+  sh "cd site && git gc"
   sh "rsync -avz doc/ chneukirchen@rack.rubyforge.org:/var/www/gforge-projects/rack/doc/"
   sh "rsync -avz site/ chneukirchen@rack.rubyforge.org:/var/www/gforge-projects/rack/"
-end
-
-begin
-  require 'rcov/rcovtask'
-
-  Rcov::RcovTask.new do |t|
-    t.test_files = FileList['test/{spec,test}_*.rb']
-    t.verbose = true     # uncomment to see the executed command
-    t.rcov_opts = ["--text-report",
-                   "-Ilib:test",
-                   "--include-file", "^lib,^test",
-                   "--exclude-only", "^/usr,^/home/.*/src,active_"]
-  end
-rescue LoadError
+  sh "cd site && git push"
 end