sinatra 0.3.3 → 0.9.0

data/AUTHORS

@@ -0,0 +1,40 @@
+Sinatra was designed and developed by Blake Mizerany (bmizerany) in
+California. Continued development would not be possible without the ongoing
+financial support provided by Heroku <heroku.com> and the emotional support
+provided by Adam Wiggins (adamwiggins), Chris Wanstrath (defunkt), PJ Hyett (pjhyett), and
+the rest of the Github crew.
+
+Special thanks to the following extraordinary individuals, who-out which
+Sinatra would not be possible:
+
+* Ryan Tomayko (rtomayko) for constantly fixing whitespace errors 60d5006
+* Ezra Zygmuntowicz (ezmobius) for initial help and letting Blake steal
+  some of merbs internal code.
+* Christopher Schneid (cschneid) for The Book, the blog (gittr.com),
+  irclogger.com, and a bunch of useful patches.
+* Markus Prinz (cypher) for patches over the years, caring about
+  the README, and hanging in there when times were rough.
+* Simon Rozet (sr) for a ton of doc patches, HAML options, and all that
+  advocacy stuff he's going to do for 1.0.
+* Erik Kastner (kastner) for fixing MIME_TYPES under Rack 0.5.
+* Ben Bleything (bleything) for caring about HTTP status codes and doc fixes.
+* Igal Koshevoy (igal) for root path detection under Thin/Passenger.
+* Jon Crosby (jcrosby) for coffee breaks, doc fixes, and just because, man.
+* Karel Minarik (karmi) for screaming until the website came back up.
+* Jeremy Evans (jeremyevans) for unbreaking optional path params (twice!)
+* The GitHub guys for stealing Blake's table.
+* Nickolas Means (nmeans) for Sass template support.
+* Victor Hugo Borja (vic) for splat'n routes specs and doco.
+* Avdi Grimm (avdi) for basic RSpec support.
+* Jack Danger Canty for a more accurate root directory and for making me
+  watch this just now: http://www.youtube.com/watch?v=ueaHLHgskkw.
+* Mathew Walker for making escaped paths work with static files.
+* Millions of Us for having the problem that led to Sinatra's conception.
+* Songbird for the problems that helped Sinatra's future become realized.
+* Rick Olsen (technoweenie) for the killer plug at RailsConf '08.
+* Steven Garcia for the amazing custom artwork you see on 404's and 500's
+
+and last but not least:
+
+* Frank Sinatra (chairman of the board) for having so much class he
+  deserves a web-framework named after him.

data/CHANGES

@@ -0,0 +1,189 @@
+= 0.9.0 / 2009-01-18
+
+ * Works with and requires Rack >= 0.9.1
+
+ * Multiple Sinatra applications can now co-exist peacefully within a
+   single process. The new "Sinatra::Base" class can be subclassed to
+   establish a blank-slate Rack application or middleware component.
+   Documentation on using these features is forth-coming; the following
+   provides the basic gist: http://gist.github.com/38605
+
+ * Parameters with subscripts are now parsed into a nested/recursive
+   Hash structure. e.g., "post[title]=Hello&post[body]=World" yields
+   params: {'post' => {'title' => 'Hello', 'body' => 'World'}}.
+
+ * Regular expressions may now be used in route pattens; captures are
+   available at "params[:captures]".
+
+ * New ":provides" route condition takes an array of mime types and
+   matches only when an Accept request header is present with a
+   corresponding type. [cypher]
+
+ * New request-level "pass" method; immediately exits the current block
+   and passes control to the next matching route.
+
+ * The request-level "body" method now takes a block; evaluation is
+   deferred until an attempt is made to read the body. The block must
+   return a String or Array.
+
+ * New "route conditions" system for attaching rules for when a route
+   matches. The :agent and :host route options now use this system.
+
+ * New "dump_errors" option controls whether the backtrace is dumped to
+   rack.errors when an exception is raised from a route. The option is
+   enabled by default for top-level apps.
+
+ * Better default "app_file", "root", "public", and "views" location
+   detection; changes to "root" and "app_file" automatically cascade to
+   other options that depend on them.
+
+ * Error mappings are now split into two distinct layers: exception
+   mappings and custom error pages. Exception mappings are registered
+   with "error(Exception)" and are run only when the app raises an
+   exception. Custom error pages are registered with "error(status_code)",
+   where "status_code" is an integer, and are run any time the response
+   has the status code specified. It's also possible to register an error
+   page for a range of status codes: "error(500..599)".
+
+ * In-file templates are now automatically imported from the file that
+   requires 'sinatra'. The use_in_file_templates! method is still available
+   for loading templates from other files.
+
+ * Sinatra's testing support is no longer dependent on Test::Unit. Requiring
+   'sinatra/test' adds the Sinatra::Test module and Sinatra::TestHarness
+   class, which can be used with any test framework. The 'sinatra/test/unit',
+   'sinatra/test/spec', 'sinatra/test/rspec', or 'sinatra/test/bacon' files
+   can be required to setup a framework-specific testing environment. See the
+   README for more information.
+
+ * Added support for Bacon (test framework). The 'sinatra/test/bacon' file
+   can be required to setup Sinatra test helpers on Bacon::Context.
+
+ * Deprecated "set_option" and "set_options"; use "set" instead.
+
+ * Deprecated the "env" option ("options.env"); use "environment" instead.
+
+ * Deprecated the request level "stop" method; use "halt" instead.
+
+ * Deprecated the request level "entity_tag" method; use "etag" instead.
+   Both "entity_tag" and "etag" were previously supported.
+
+ * Deprecated the request level "headers" method (HTTP response headers);
+   use "response['Header-Name']" instead.
+
+ * Deprecated "Sinatra.application"; use "Sinatra::Application" instead.
+
+ * Deprecated setting Sinatra.application = nil to reset an application.
+   This should no longer be necessary.
+
+ * Deprecated "Sinatra.default_options"; use
+   "Sinatra::Default.set(key, value)" instead.
+
+ * Deprecated the "ServerError" exception. All Exceptions are now
+   treated as internal server errors and result in a 500 response
+   status.
+
+ * Deprecated the "get_it", "post_it", "put_it", "delete_it", and "head_it"
+   test helper methods. Use "get", "post", "put", "delete", and "head",
+   respectively, instead.
+
+ * Removed Event and EventContext classes. Applications are defined in a
+   subclass of Sinatra::Base; each request is processed within an
+   instance.
+
+= 0.3.3 / 2009-01-06
+
+ * Pin to Rack 0.4.0 (this is the last release on Rack 0.4)
+
+ * Log unhandled exception backtraces to rack.errors.
+
+ * Use RACK_ENV environment variable to establish Sinatra
+   environment when given. Thin sets this when started with
+   the -e argument.
+
+ * BUG: raising Sinatra::NotFound resulted in a 500 response
+   code instead of 404.
+
+ * BUG: use_in_file_templates! fails with CR/LF (#45)
+
+ * BUG: Sinatra detects the app file and root path when run under
+   thin/passenger.
+
+= 0.3.2
+
+ * BUG: Static and send_file read entire file into String before
+   sending. Updated to stream with 8K chunks instead.
+
+ * Rake tasks and assets for building basic documentation website.
+   See http://sinatra.rubyforge.org
+
+ * Various minor doc fixes.
+
+= 0.3.1
+
+ * Unbreak optional path parameters [jeremyevans]
+
+= 0.3.0
+
+ * Add sinatra.gemspec w/ support for github gem builds. Forks can now
+   enable the build gem option in github to get free username-sinatra.gem
+   builds: gem install username-sinatra.gem --source=http://gems.github.com/
+
+ * Require rack-0.4 gem; removes frozen rack dir.
+
+ * Basic RSpec support; require 'sinatra/test/rspec' instead of
+   'sinatra/test/spec' to use. [avdi]
+
+ * before filters can modify request environment vars used for
+   routing (e.g., PATH_INFO, REQUEST_METHOD, etc.) for URL rewriting
+   type functionality.
+
+ * In-file templates now uses @@ instead of ## as template separator.
+
+ * Top-level environment test predicates: development?, test?, production?
+
+ * Top-level "set", "enable", and "disable" methods for tweaking
+   app options. [rtomayko]
+
+ * Top-level "use" method for building Rack middleware pipelines
+   leading to app. See README for usage. [rtomayko]
+
+ * New "reload" option - set false to disable reloading in development.
+
+ * New "host" option - host/ip to bind to [cschneid]
+
+ * New "app_file" option - override the file to reload in development
+   mode [cschneid]
+
+ * Development error/not_found page cleanup [sr, adamwiggins]
+
+ * Remove a bunch of core extensions (String#to_param, String#from_param,
+   Hash#from_params, Hash#to_params, Hash#symbolize_keys, Hash#pass)
+
+ * Various grammar and formatting fixes to README; additions on
+   community and contributing [cypher]
+
+ * Build RDoc using Hanna template: http://sinatrarb.rubyforge.org/api
+
+ * Specs, documentation and fixes for splat'n routes [vic]
+
+ * Fix whitespace errors across all source files. [rtomayko]
+
+ * Fix streaming issues with Mongrel (body not closed). [bmizerany]
+
+ * Fix various issues with environment not being set properly (configure
+   blocks not running, error pages not registering, etc.) [cypher]
+
+ * Fix to allow locals to be passed to ERB templates [cschneid]
+
+ * Fix locking issues causing random errors during reload in development.
+
+ * Fix for escaped paths not resolving static files [Matthew Walker]
+
+= 0.2.1
+
+ * File upload fix and minor tweaks.
+
+= 0.2.0
+
+ * Initial gem release of 0.2 codebase.

data/README.rdoc

@@ -1,9 +1,7 @@
 = Sinatra
 
 Sinatra is a DSL for quickly creating web-applications in Ruby with minimal
-effort.
-
-== Sample App
+effort:
 
   # myapp.rb
   require 'rubygems'
@@ -32,78 +30,80 @@ Run with <tt>ruby myapp.rb</tt> and view at <tt>http://localhost:4567</tt>
     .. annihilate something ..
   end
 
-  head '/' do
-
-  end
-
-NOTE: <tt>put</tt> and <tt>delete</tt> are also triggered when a
-<tt>_method</tt> parameter is set to PUT or DELETE and the HTTP request method
-is POST
-
 == Routes
 
 Routes are matched based on the order of declaration. The first route that
 matches the request is invoked.
 
-Simple:
+Basic routes:
 
   get '/hi' do
     ...
   end
 
-Named parameters:
+Route patterns may include named parameters, accessible via the
+<tt>params</tt> hash:
 
   get '/:name' do
-    # matches /sinatra and the like and sets params[:name]
+    # matches "GET /foo" and "GET /bar"
+    # params[:name] is 'foo' or 'bar'
+    "Hello #{params[:name]}!"
   end
 
-Splat parameters:
+Route patterns may also include splat (or wildcard) parameters, accessible
+via the <tt>params[:splat]</tt> array.
 
   get '/say/*/to/*' do
     # matches /say/hello/to/world
-    params["splat"] # => ["hello", "world"]
+    params[:splat] # => ["hello", "world"]
   end
 
   get '/download/*.*' do
     # matches /download/path/to/file.xml
-    params["splat"] # => ["path/to/file", "xml"]
+    params[:splat] # => ["path/to/file", "xml"]
+  end
+
+Route matching with Regular Expressions:
+
+  get %r{/hello/([\w]+)} do
+    "Hello, #{params[:captures].first}!"
   end
 
-User agent matching:
+Routes may include a variety of matching conditions, such as the user agent:
 
   get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
     "You're using Songbird version #{params[:agent][0]}"
   end
 
   get '/foo' do
-    # matches non-songbird browsers
+    # Matches non-songbird browsers
   end
 
-== Static files
+== Static Files
 
-Put all of your static content in the ./public directory
+Static files are served from the <tt>./public</tt> directory. You can specify
+a different location by setting the <tt>:public</tt> option:
 
-  root
-    \ public
+  set :public, File.dirname(__FILE__) + '/static'
 
-If a file exists that maps to the REQUEST_PATH then it is served and the
-request ends. Otherwise, Sinatra will look for an event that matches the
-path.
+== Views / Templates
 
-== Views
+Templates are assumed to be located directly under a <tt>./views</tt>
+directory. To use a different views directory:
 
-Views are searched for in a "views" directory in the same location as
-your main application.
+  set :views, File.dirname(__FILE__) + '/templates'
 
 === Haml Templates
 
+The haml gem/library is required to render HAML templates:
+
   get '/' do
     haml :index
   end
 
 Renders <tt>./views/index.haml</tt>.
 
-=== Erb
+=== Erb Templates
 
   get '/' do
     erb :index
@@ -111,11 +111,20 @@ Renders <tt>./views/index.haml</tt>.
 
 Renders <tt>./views/index.erb</tt>
 
-=== Builder
+=== Builder Templates
+
+The builder gem/library is required to render builder templates:
+
+  get '/' do
+    content_type 'application/xml', :charset => 'utf-8'
+    builder :index
+  end
+
+Renders <tt>./views/index.builder</tt>.
 
-See Sinatra::Builder
+=== Sass Templates
 
-=== Sass
+The sass gem/library is required to render Sass templates:
 
   get '/stylesheet.css' do
     content_type 'text/css', :charset => 'utf-8'
@@ -134,9 +143,8 @@ Renders the inlined template string.
 
 === Accessing Variables
 
-Templates are evaluated within the Sinatra::EventContext instance
-used to evaluate event blocks. Instance variables set in event
-blocks can be accessed direcly in views:
+Templates are evaluated within the same context as the route blocks. Instance
+variables set in route blocks are available in templates:
 
   get '/:id' do
     @foo = Foo.find(params[:id])
@@ -157,27 +165,32 @@ other templates.
 
 Templates may be defined at the end of the source file:
 
+  require 'rubygems'
+  require 'sinatra'
+
   get '/' do
     haml :index
   end
 
-  use_in_file_templates!
-
   __END__
 
   @@ layout
-  X
-  = yield
-  X
+  %html
+    = yield
 
   @@ index
   %div.title Hello world!!!!!
 
+NOTE:  Sinatra will automaticly load any in-file-templates in the
+source file that first required sinatra.  If you have in-file-templates
+in another source file you will need to explicitly call
++use_in_file_templates! on main in that file.
+
 It's also possible to define named templates using the top-level template
 method:
 
   template :layout do
-    "X\n=yield\nX"
+    "%html\n  =yield\n"
   end
 
   template :index do
@@ -188,10 +201,17 @@ method:
     haml :index
   end
 
+If a template named "layout" exists, it will be used each time a template
+is rendered. You can disable layouts by passing <tt>:layout => false</tt>.
+
+  get '/' do
+    haml :index, :layout => !request.xhr?
+  end
+
 == Helpers
 
-The top-level <tt>helpers</tt> method takes a block and extends all
-EventContext instances with the methods defined:
+Use the top-level <tt>helpers</tt> method to define helper methods for use in
+route blocks and templates:
 
   helpers do
     def bar(name)
@@ -205,95 +225,89 @@ EventContext instances with the methods defined:
 
 == Filters
 
-These are run in Sinatra::EventContext before every event.
+Before filters are evaluated before each request within the context of the
+request and can modify the request and response. Instance variables set in
+filters are accessible by routes and templates.
 
   before do
-    .. this code will run before each event ..
+    @note = 'Hi!'
+    request.path_info = '/foo/bar/baz'
   end
 
-== Halt!
-
-To immediately stop a request during a before filter or event use:
-
-  throw :halt
-
-Set the body to the result of a helper method
-
-  throw :halt, :helper_method
-
-Set the body to the result of a helper method after sending it parameters from
-the local scope
-
-  throw :halt, [:helper_method, foo, bar]
+  get '/foo/*' do
+    @note #=> 'Hi!'
+    params[:splat] #=> 'bar/baz'
+  end
 
-Set the body to a simple string
+== Halting
 
-  throw :halt, 'this will be the body'
+To immediately stop a request during a before filter or route use:
 
-Set status then the body
+  halt
 
-  throw :halt, [401, 'go away!']
+You can also specify a body when halting ...
 
-Set the status then call a helper method with params from local scope
+  halt 'this will be the body'
 
-  throw :halt, [401, [:helper_method, foo, bar]]
+Set the status and body ...
 
-Run a proc inside the Sinatra::EventContext instance and set the body to the
-result
+  halt 401, 'go away!'
 
-  throw :halt, lambda { puts 'In a proc!'; 'I just wrote to $stdout!' }
+== Passing
 
-Create you own to_result
+A route can punt processing to the next matching route using the <tt>pass</tt>
+statement:
 
-  class MyResultObject
-    def to_result(event_context, *args)
-      event_context.body = 'This will be the body!
-    end
+  get '/guess/:who' do
+    pass unless params[:who] == 'Frank'
+    "You got me!"
   end
 
-  get '/' do
-    throw :halt, MyResultObject.new
+  get '/guess/*' do
+    "You missed!"
   end
 
-Get the gist?  If you want more fun with this then checkout <tt>to_result</tt>
-on Array, Symbol, Fixnum, NilClass.
+The route block is immediately exited and control continues with the next
+matching route. If no matching route is found, a 404 is returned.
 
 == Configuration and Reloading
 
 Sinatra supports multiple environments and reloading. Reloading happens
-before every request when running under the :development environment. Wrap
-your configurations in <tt>configure</tt> (i.e. Database connections, Constants,
-etc.) to protect them from reloading or to target specific environments.
+before each request when running under the <tt>:development</tt>
+environment. Wrap your configurations (e.g., database connections, constants,
+etc.) in <tt>configure</tt> blocks to protect them from reloading or to
+target specific environments.
 
-All environments:
+Run once, at startup, in any environment:
 
   configure do
     ...
   end
 
-Production:
+Run only when the environment (RACK_ENV environment variable) is set to
+<tt>:production</tt>.
 
   configure :production do
     ...
   end
 
-Two at a time:
+Run when the environment (RACK_ENV environment variable) is set to
+either <tt>:production</tt> or <tt>:test</tt>.
 
   configure :production, :test do
     ...
   end
 
-This is also really nifty for error handling.
-
 == Error handling
 
-Error handlers run inside the current Sinatra::EventContext instance, which
-means you get all the goodies it has to offer (i.e. haml, erb, throw :halt,
-etc.)
+Error handlers run within the same context as routes and before filters, which
+means you get all the goodies it has to offer, like <tt>haml</tt>, <tt>erb</tt>,
+<tt>halt</tt>, etc.
 
 === Not Found
 
-When Sinatra::NotFound is raised, the not_found handler is invoked:
+When a <tt>Sinatra::NotFound</tt> exception is raised, or the response's status
+code is 404, the <tt>not_found</tt> handler is invoked:
 
   not_found do
     'This is nowhere to be found'
@@ -301,14 +315,12 @@ When Sinatra::NotFound is raised, the not_found handler is invoked:
 
 === Error
 
-By default, the +error+ handler is invoked on Sinatra::ServerError or when
-an unknown error occurs.
-
-The exception can be obtained from the 'sinatra.error' variable in
-request.env.
+The +error+ handler is invoked any time an exception is raised from a route
+block or before filter. The exception object can be obtained from the
+'sinatra.error' Rack variable:
 
   error do
-    'Sorry there was a nasty error - ' + request.env['sinatra.error'].name
+    'Sorry there was a nasty error - ' + env['sinatra.error'].name
   end
 
 Custom errors:
@@ -328,12 +340,12 @@ You get this:
   So what happened was... something bad
 
 Sinatra installs special not_found and error handlers when running under
-the development.
+the development environment.
 
 == Mime types
 
-When using send_file or static files you may have mime types Sinatra doesn't
-understand.  Use +mime+ in those cases.
+When using <tt>send_file</tt> or static files you may have mime types Sinatra
+doesn't understand. Use +mime+ to register them by file extension:
 
   mime :foo, 'text/foo'
 
@@ -374,59 +386,61 @@ typically don't have to +use+ them explicitly.
 
 == Testing
 
-=== Test/Unit
+The Sinatra::Test module includes a variety of helper methods for testing
+your Sinatra app. Sinatra includes support for Test::Unit, test-spec, RSpec,
+and Bacon through separate source files.
+
+=== Test::Unit
 
-  require 'rubygems'
   require 'sinatra'
   require 'sinatra/test/unit'
   require 'my_sinatra_app'
 
   class MyAppTest < Test::Unit::TestCase
-
     def test_my_default
-      get_it '/'
+      get '/'
       assert_equal 'My Default Page!', @response.body
     end
 
     def test_with_agent
-      get_it '/', :agent => 'Songbird'
+      get '/', :agent => 'Songbird'
       assert_equal 'You're in Songbird!', @response.body
     end
 
     ...
-
   end
 
-=== Test/Spec
+=== Test::Spec
+
+Install the test-spec gem and require <tt>'sinatra/test/spec'</tt> before
+your app:
 
-  require 'rubygems'
   require 'sinatra'
   require 'sinatra/test/spec'
   require 'my_sinatra_app'
 
   describe 'My app' do
-
     it "should show a default page" do
-      get_it '/'
+      get '/'
       should.be.ok
       body.should.equal 'My Default Page!'
     end
 
     ...
-
   end
 
 === RSpec
 
-  require 'rubygems'
-  require 'spec'
+Install the rspec gem and require <tt>'sinatra/test/rspec'</tt> before
+your app:
+
   require 'sinatra'
   require 'sinatra/test/rspec'
   require 'my_sinatra_app'
 
   describe 'My app' do
     it 'should show a default page' do
-      get_it '/'
+      get '/'
       @response.should be_ok
       @response.body.should == 'My Default Page!'
     end
@@ -435,20 +449,35 @@ typically don't have to +use+ them explicitly.
 
   end
 
-See Sinatra::Test::Methods for more information on +get_it+, +post_it+,
-+put_it+, and friends.
+=== Bacon
+
+  require 'sinatra'
+  require 'sinatra/test/bacon'
+  require 'my_sinatra_app'
+
+  describe 'My app' do
+    it 'should be ok' do
+      get '/'
+      should.be.ok
+      body.should == 'Im OK'
+    end
+  end
+
+See Sinatra::Test for more information on +get+, +post+, +put+, and
+friends.
 
 == Command line
 
 Sinatra applications can be run directly:
 
-  ruby myapp.rb [-h] [-x] [-p PORT] [-e ENVIRONMENT]
+  ruby myapp.rb [-h] [-x] [-e ENVIRONMENT] [-p PORT] [-s HANDLER]
 
 Options are:
 
   -h # help
   -p # set the port (default is 4567)
   -e # set the environment (default is development)
+  -s # specify rack server/handler (default is thin)
   -x # turn on the mutex lock (default is off)
 
 == Contributing
@@ -481,7 +510,7 @@ screencasts about Git, which you can find here: http://www.gitcasts.com/
 
 at the top of your sinatra_app.rb file:
 
-  $:.unshift File.dirname(__FILE__) + '/sinatra/lib'
+  $LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib'
   require 'sinatra'
 
   get '/about' do