sinatra 0.9.0.5 → 0.9.1

data/AUTHORS

@@ -1,13 +1,13 @@
 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.
+financial support provided by [Heroku](http://heroku.com) and the emotional
+support provided by Adam Wiggins (adamwiggins) of Heroku, 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
+* 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),
@@ -16,7 +16,7 @@ Sinatra would not be possible:
   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.
+* 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.
@@ -27,12 +27,13 @@ Sinatra would not be possible:
 * 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.
+  watch [this](http://www.youtube.com/watch?v=ueaHLHgskkw) just now.
 * 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.
+* Rick Olson (technoweenie) for the killer plug at RailsConf '08.
 * Steven Garcia for the amazing custom artwork you see on 404's and 500's
+* Pat Nakajima (nakajima) for fixing non-nested params in nested params Hash's.
 
 and last but not least:
 

data/CHANGES

@@ -1,3 +1,73 @@
+= 0.9.1 / 2009-03-01
+
+ * Sinatra now runs under Ruby 1.9.1 [#61]
+
+ * Route patterns (splats, :named, or Regexp captures) are now
+   passed as arguments to the block. [#140]
+
+ * The "helpers" method now takes a variable number of modules
+   along with the normal block syntax. [#133]
+
+ * New request-level #forward method for middleware components: passes
+   the env to the downstream app and merges the response status, headers,
+   and body into the current context. [#126]
+
+ * Requests are now automatically forwarded to the downstream app when
+   running as middleware and no matching route is found or all routes
+   pass.
+
+ * New simple API for extensions/plugins to add DSL-level and
+   request-level methods. Use Sinatra.register(mixin) to extend
+   the DSL with all public methods defined in the mixin module;
+   use Sinatra.helpers(mixin) to make all public methods defined
+   in the mixin module available at the request level. [#138]
+   See http://www.sinatrarb.com/extensions.html for details.
+
+ * Named parameters in routes now capture the "." character. This makes
+   routes like "/:path/:filename" match against requests like
+   "/foo/bar.txt"; in this case, "params[:filename]" is "bar.txt".
+   Previously, the route would not match at all.
+
+ * Added request-level "redirect back" to redirect to the referring
+   URL.
+
+ * Added a new "clean_trace" option that causes backtraces dumped
+   to rack.errors and displayed on the development error page to
+   omit framework and core library backtrace lines. The option is
+   enabled by default. [#77]
+
+ * The ERB output buffer is now available to helpers via the @_out_buf
+   instance variable.
+
+ * It's now much easier to test sessions in unit tests by passing a
+   ":session" option to any of the mock request methods. e.g.,
+       get '/', {}, :session => { 'foo' => 'bar' }
+
+ * The testing framework specific files ('sinatra/test/spec',
+   'sinatra/test/bacon', 'sinatra/test/rspec', etc.) have been deprecated.
+   See http://sinatrarb.com/testing.html for instructions on setting up
+   a testing environment with these frameworks.
+
+ * The request-level #send_data method from Sinatra 0.3.3 has been added
+   for compatibility but is deprecated.
+
+ * Fix :provides causing crash on any request when request has no
+   Accept header [#139]
+
+ * Fix that ERB templates were evaluated twice per "erb" call.
+
+ * Fix app-level middleware not being run when the Sinatra application is
+   run as middleware.
+
+ * Fixed some issues with running under Rack's CGI handler caused by
+   writing informational stuff to stdout.
+
+ * Fixed that reloading was sometimes enabled when starting from a
+   rackup file [#110]
+
+ * Fixed that "." in route patterns erroneously matched any character
+   instead of a literal ".". [#124]
+
 = 0.9.0.4 / 2009-01-25
 
  * Using halt with more than 1 args causes ArgumentError [#131]

data/README.rdoc

@@ -10,12 +10,20 @@ effort:
     'Hello world!'
   end
 
-Run with <tt>ruby myapp.rb</tt> and view at <tt>http://localhost:4567</tt>
+Install the gem and run with:
 
-== HTTP Methods
+  sudo gem install sinatra
+  ruby myapp.rb
+
+View at: http://localhost:4567
+
+== Routes
+
+In Sinatra, a route is an HTTP method paired with an URL matching pattern.
+Each route is associated with a block:
 
   get '/' do
-    .. show things ..
+    .. show something ..
   end
 
   post '/' do
@@ -30,26 +38,24 @@ Run with <tt>ruby myapp.rb</tt> and view at <tt>http://localhost:4567</tt>
     .. annihilate something ..
   end
 
-== Routes
-
-Routes are matched based on the order of declaration. The first route that
+Routes are matched in the order they are defined. The first route that
 matches the request is invoked.
 
-Basic routes:
-
-  get '/hi' do
-    ...
-  end
-
 Route patterns may include named parameters, accessible via the
 <tt>params</tt> hash:
 
-  get '/:name' do
+  get '/hello/:name' do
     # matches "GET /foo" and "GET /bar"
     # params[:name] is 'foo' or 'bar'
     "Hello #{params[:name]}!"
   end
 
+You can also access named parameters via block parameters:
+
+  get '/hello/:name' do |n|
+    "Hello #{n}!"
+  end
+
 Route patterns may also include splat (or wildcard) parameters, accessible
 via the <tt>params[:splat]</tt> array.
 
@@ -69,6 +75,12 @@ Route matching with Regular Expressions:
     "Hello, #{params[:captures].first}!"
   end
 
+Or with a block parameter:
+
+  get %r{/hello/([\w]+)} do |c|
+    "Hello, #{c}!"
+  end
+
 Routes may include a variety of matching conditions, such as the user agent:
 
   get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
@@ -86,9 +98,13 @@ a different location by setting the <tt>:public</tt> option:
 
   set :public, File.dirname(__FILE__) + '/static'
 
+Note that the public directory name is not included in the URL. A file
+<tt>./public/css/style.css</tt> is made available as
+<tt>http://example.com/css/style.css</tt>.
+
 == Views / Templates
 
-Templates are assumed to be located directly under a <tt>./views</tt>
+Templates are assumed to be located directly under the <tt>./views</tt>
 directory. To use a different views directory:
 
   set :views, File.dirname(__FILE__) + '/templates'
@@ -141,10 +157,10 @@ Renders <tt>./views/stylesheet.sass</tt>.
 
 Renders the inlined template string.
 
-=== Accessing Variables
+=== Accessing Variables in Templates
 
-Templates are evaluated within the same context as the route blocks. Instance
-variables set in route blocks are available in templates:
+Templates are evaluated within the same context as route handlers. Instance
+variables set in route handlers are direcly accessible by templates:
 
   get '/:id' do
     @foo = Foo.find(params[:id])
@@ -181,13 +197,13 @@ Templates may be defined at the end of the source file:
   @@ 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.
+NOTE: In-file templates defined in the source file that requires sinatra
+are automatically loaded. Call the <tt>use_in_file_templates!</tt>
+method explicitly if you have in-file templates in other source files.
 
-It's also possible to define named templates using the top-level template
-method:
+=== Named Templates
+
+Templates may also be defined using the top-level <tt>template</tt> method:
 
   template :layout do
     "%html\n  =yield\n"
@@ -211,7 +227,7 @@ is rendered. You can disable layouts by passing <tt>:layout => false</tt>.
 == Helpers
 
 Use the top-level <tt>helpers</tt> method to define helper methods for use in
-route blocks and templates:
+route handlers and templates:
 
   helpers do
     def bar(name)
@@ -227,7 +243,7 @@ route blocks and templates:
 
 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.
+filters are accessible by routes and templates:
 
   before do
     @note = 'Hi!'
@@ -249,14 +265,13 @@ You can also specify a body when halting ...
 
   halt 'this will be the body'
 
-Set the status and body ...
+Or set the status and body ...
 
   halt 401, 'go away!'
 
 == Passing
 
-A route can punt processing to the next matching route using the <tt>pass</tt>
-statement:
+A route can punt processing to the next matching route using <tt>pass</tt>:
 
   get '/guess/:who' do
     pass unless params[:who] == 'Frank'
@@ -317,7 +332,7 @@ code is 404, the <tt>not_found</tt> handler is invoked:
 
 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:
+<tt>sinatra.error</tt> Rack variable:
 
   error do
     'Sorry there was a nasty error - ' + env['sinatra.error'].name
@@ -339,8 +354,8 @@ You get this:
 
   So what happened was... something bad
 
-Sinatra installs special not_found and error handlers when running under
-the development environment.
+Sinatra installs special <tt>not_found</tt> and <tt>error</tt> handlers when
+running under the development environment.
 
 == Mime types
 
@@ -386,85 +401,34 @@ typically don't have to +use+ them explicitly.
 
 == Testing
 
-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
+The Sinatra::Test mixin and Sinatra::TestHarness class include a variety of
+helper methods for testing your Sinatra app:
 
-  require 'sinatra'
-  require 'sinatra/test/unit'
   require 'my_sinatra_app'
+  require 'test/unit'
+  require 'sinatra/test'
 
   class MyAppTest < Test::Unit::TestCase
+    include Sinatra::Test
+
     def test_my_default
       get '/'
-      assert_equal 'My Default Page!', @response.body
+      assert_equal 'Hello World!', @response.body
     end
 
-    def test_with_agent
-      get '/', :agent => 'Songbird'
-      assert_equal 'You're in Songbird!', @response.body
+    def test_with_params
+      get '/meet', {:name => 'Frank'}
+      assert_equal 'Hello Frank!', @response.body
     end
 
-    ...
-  end
-
-=== Test::Spec
-
-Install the test-spec gem and require <tt>'sinatra/test/spec'</tt> before
-your app:
-
-  require 'sinatra'
-  require 'sinatra/test/spec'
-  require 'my_sinatra_app'
-
-  describe 'My app' do
-    it "should show a default page" do
-      get '/'
-      should.be.ok
-      body.should.equal 'My Default Page!'
+    def test_with_rack_env
+      get '/', {}, :agent => 'Songbird'
+      assert_equal "You're using Songbird!", @response.body
     end
-
-    ...
   end
 
-=== RSpec
-
-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 '/'
-      @response.should be_ok
-      @response.body.should == 'My Default Page!'
-    end
-
-    ...
-
-  end
-
-=== 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.
+See http://www.sinatrarb.com/testing.html for more on Sinatra::Test and using it
+with other test frameworks such as RSpec, Bacon, and test/spec.
 
 == Command line
 
@@ -480,73 +444,40 @@ Options are:
   -s # specify rack server/handler (default is thin)
   -x # turn on the mutex lock (default is off)
 
-== Contributing
-
-=== Tools
+== The Bleeding Edge
 
-Besides Ruby itself, you only need a text editor, preferably one that supports
-Ruby syntax hilighting. VIM and Emacs are a fine choice on any platform, but
-feel free to use whatever you're familiar with.
+If you would like to use Sinatra's latest bleeding code, create a local
+clone and run your app with the <tt>sinatra/lib</tt> directory on the
+<tt>LOAD_PATH</tt>:
 
-Sinatra uses the Git source code management system. If you're unfamiliar with
-Git, you can find more information and tutorials on http://git.or.cz/ as well
-as http://git-scm.com/.  Scott Chacon created a great series of introductory
-screencasts about Git, which you can find here: http://www.gitcasts.com/
+  cd myapp
+  git clone git://github.com/sinatra/sinatra.git
+  ruby -Isinatra/lib myapp.rb
 
-=== First Time: Cloning The Sinatra Repo
-
-  cd where/you/keep/your/projects
-  git clone git://github.com/bmizerany/sinatra.git
-  cd sinatra
-  cd path/to/your_project
-  ln -s ../sinatra/
-
-=== Updating Your Existing Sinatra Clone
-
-  cd where/you/keep/sinatra
-  git pull
-
-=== Using Edge Sinatra in Your App
-
-at the top of your sinatra_app.rb file:
+Alternatively, you can add the <tt>sinatra/lib<tt> directory to the
+<tt>LOAD_PATH</tt> in your application:
 
   $LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib'
+  require 'rubygems'
   require 'sinatra'
 
   get '/about' do
-    "I'm running on Version " + Sinatra::VERSION
+    "I'm running version " + Sinatra::VERSION
   end
 
-=== Contributing a Patch
-
-There are several ways to do this. Probably the easiest (and preferred) way is
-to fork Sinatra on GitHub (http://github.com/bmizerany/sinatra), push your
-changes to your Sinatra repo, and then send Blake Mizerany (bmizerany on
-GitHub) a pull request.
-
-You can also create a patch file and attach it to a feature request or bug fix
-on the issue tracker (see below) or send it to the mailing list (see Community
-section).
+To update the Sinatra sources in the future:
 
-=== Issue Tracking and Feature Requests
-
-http://sinatra.lighthouseapp.com/
-
-== Community
-
-=== Mailing List
-
-http://groups.google.com/group/sinatrarb
-
-If you have a problem or question, please make sure to include all the
-relevant information in your mail, like the Sinatra version you're using, what
-version of Ruby you have, and so on.
-
-=== IRC Channel
-
-You can find us on the Freenode network in the channel #sinatra
-(irc://chat.freenode.net/#sinatra)
+  cd myproject/sinatra
+  git pull
 
-There's usually someone online at any given time, but we cannot pay attention
-to the channel all the time, so please stick around for a while after asking a
-question.
+== More
+
+* {Project Website}[http://sinatra.github.com/] - Additional documentation,
+  news, and links to other resources.
+* {Contributing}[http://sinatra.github.com/contributing.html] - Find a bug? Need
+  help? Have a patch?
+* {Lighthouse}[http://sinatra.lighthouseapp.com] - Issue tracking and release
+  planning.
+* {Twitter}[http://twitter.com/sinatra]
+* {Mailing List}[http://groups.google.com/group/sinatrarb]
+* {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] on http://freenode.net

data/Rakefile

@@ -1,23 +1,18 @@
-require 'rubygems'
 require 'rake/clean'
+require 'rake/testtask'
 require 'fileutils'
 
-task :default => :test
+task :default => [:test]
+task :spec => :test
 
 # SPECS ===============================================================
 
-desc 'Run specs with story style output'
-task :spec do
-  pattern = ENV['TEST'] || '.*'
-  sh "specrb --testcase '#{pattern}' --specdox -Ilib:test test/*_test.rb"
-end
-
-desc 'Run specs with unit test style output'
-task :test do |t|
-  sh "specrb -Ilib:test test/*_test.rb"
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-rubygems'] if defined? Gem
 end
 
-desc 'Run compatibility specs'
+desc 'Run compatibility specs (requires test/spec)'
 task :compat do |t|
   pattern = ENV['TEST'] || '.*'
   sh "specrb --testcase '#{pattern}' -Ilib:test compat/*_test.rb"
@@ -50,6 +45,7 @@ task :install => package('.gem') do
 end
 
 directory 'dist/'
+CLOBBER.include('dist')
 
 file package('.gem') => %w[dist/ sinatra.gemspec] + spec.files do |f|
   sh "gem build sinatra.gemspec"
@@ -67,11 +63,6 @@ end
 
 # Rubyforge Release / Publish Tasks ==================================
 
-desc 'Publish website to rubyforge'
-task 'publish:doc' => 'doc/api/index.html' do
-  sh 'scp -rp doc/* rubyforge.org:/var/www/gforge-projects/sinatra/'
-end
-
 desc 'Publish gem and tarball to rubyforge'
 task 'publish:gem' => [package('.gem'), package('.tar.gz')] do |t|
   sh <<-end
@@ -84,7 +75,7 @@ end
 # Building docs requires HAML and the hanna gem:
 #   gem install mislav-hanna --source=http://gems.github.com
 
-task 'doc'     => ['doc:api','doc:site']
+task 'doc'     => ['doc:api']
 
 desc 'Generate Hanna RDoc under doc/api'
 task 'doc:api' => ['doc/api/index.html']
@@ -110,47 +101,6 @@ def rdoc_to_html(file_name)
   rdoc.convert(File.read(file_name))
 end
 
-def haml(locals={})
-  require 'haml'
-  template = File.read('doc/template.haml')
-  haml = Haml::Engine.new(template, :format => :html4, :attr_wrapper => '"')
-  haml.render(Object.new, locals)
-end
-
-desc 'Build website HTML and stuff'
-task 'doc:site' => ['doc/index.html', 'doc/book.html']
-
-file 'doc/index.html' => %w[README.rdoc doc/template.haml] do |file|
-  File.open(file.name, 'w') do |file|
-    file << haml(:title => 'Sinatra', :content => rdoc_to_html('README.rdoc'))
-  end
-end
-CLEAN.include 'doc/index.html'
-
-file 'doc/book.html' => ['book/output/sinatra-book.html'] do |file|
-  File.open(file.name, 'w') do |file|
-    book_content = File.read('book/output/sinatra-book.html')
-    file << haml(:title => 'Sinatra Book', :content => book_content)
-  end
-end
-CLEAN.include 'doc/book.html'
-
-file 'book/output/sinatra-book.html' => FileList['book/**'] do |f|
-  unless File.directory?('book')
-    sh 'git clone git://github.com/cschneid/sinatra-book.git book'
-  end
-  sh((<<-SH).strip.gsub(/\s+/, ' '))
-    cd book &&
-    git fetch origin &&
-    git rebase origin/master &&
-    thor book:build
-  SH
-end
-CLEAN.include 'book/output/sinatra-book.html'
-
-desc 'Build the Sinatra book'
-task 'doc:book' => ['book/output/sinatra-book.html']
-
 # Gemspec Helpers ====================================================
 
 def source_version

data/compat/app_test.rb

@@ -8,8 +8,9 @@ context "Sinatra" do
 
   specify "should put all DSL methods on (main)" do
     object = Object.new
-    Sinatra::Application::FORWARD_METHODS.each do |method|
-      object.private_methods.should.include(method)
+    methods = %w[get put post head delete configure template helpers set]
+    methods.each do |method|
+      object.private_methods.map { |m| m.to_sym }.should.include(method.to_sym)
     end
   end
 
@@ -145,25 +146,6 @@ context "Sinatra" do
 
   end
 
-  # Deprecated. WTF was going on here? What's the 1 in [:foo, 1] do?
-  xspecify "should set status then call helper with a var" do
-    helpers do
-      def foo
-        'bah!'
-      end
-    end
-
-    get '/set_body' do
-      stop [404, [:foo, 1]]
-    end
-
-    get_it '/set_body'
-
-    should.be.not_found
-    body.should.equal 'bah!'
-
-  end
-
   specify "should easily set response Content-Type" do
     get '/foo.html' do
       content_type 'text/html', :charset => 'utf-8'