Syd-sinatra 0.3.2 → 0.9.0.2

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,20 +143,19 @@ 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])
-    haml '%h1== @foo.name'
+    haml '%h1= @foo.name'
   end
 
 Or, specify an explicit Hash of local variables:
 
   get '/:id' do
     foo = Foo.find(params[:id])
-    haml '%h1== foo.name', :locals => { :foo => foo }
+    haml '%h1= foo.name', :locals => { :foo => foo }
   end
 
 This is typically used when rendering templates as partials from within
@@ -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

data/Rakefile

@@ -8,13 +8,19 @@ task :default => :test
 
 desc 'Run specs with story style output'
 task :spec do
-  sh 'specrb --specdox -Ilib:test test/*_test.rb'
+  pattern = ENV['TEST'] || '.*'
+  sh "specrb --testcase '#{pattern}' --specdox -Ilib:test test/*_test.rb"
 end
 
 desc 'Run specs with unit test style output'
-task :test => FileList['test/*_test.rb'] do |t|
-  suite = t.prerequisites.map{|f| "-r#{f.chomp('.rb')}"}.join(' ')
-  sh "ruby -Ilib:test #{suite} -e ''", :verbose => false
+task :test do |t|
+  sh "specrb -Ilib:test test/*_test.rb"
+end
+
+desc 'Run compatibility specs'
+task :compat do |t|
+  pattern = ENV['TEST'] || '.*'
+  sh "specrb --testcase '#{pattern}' -Ilib:test compat/*_test.rb"
 end
 
 # PACKAGING ============================================================
@@ -51,7 +57,12 @@ file package('.gem') => %w[dist/ sinatra.gemspec] + spec.files do |f|
 end
 
 file package('.tar.gz') => %w[dist/] + spec.files do |f|
-  sh "git archive --format=tar HEAD | gzip > #{f.name}"
+  sh <<-SH
+    git archive \
+      --prefix=sinatra-#{source_version}/ \
+      --format=tar \
+      HEAD | gzip > #{f.name}
+  SH
 end
 
 # Rubyforge Release / Publish Tasks ==================================
@@ -61,6 +72,7 @@ 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
     rubyforge add_release sinatra sinatra #{spec.version} #{package('.gem')} &&
@@ -141,11 +153,23 @@ task 'doc:book' => ['book/output/sinatra-book.html']
 
 # Gemspec Helpers ====================================================
 
-file 'sinatra.gemspec' => FileList['{lib,test,images}/**','Rakefile'] do |f|
+def source_version
+  line = File.read('lib/sinatra/base.rb')[/^\s*VERSION = .*/]
+  line.match(/.*VERSION = '(.*)'/)[1]
+end
+
+project_files =
+  FileList[
+    '{lib,test,compat,images}/**',
+    'Rakefile', 'CHANGES', 'README.rdoc'
+  ]
+file 'sinatra.gemspec' => project_files do |f|
   # read spec file and split out manifest section
   spec = File.read(f.name)
-  parts = spec.split("  # = MANIFEST =\n")
-  fail 'bad spec' if parts.length != 3
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+  # replace version and date
+  head.sub!(/\.version = '.*'/, ".version = '#{source_version}'")
+  head.sub!(/\.date = '.*'/, ".date = '#{Date.today.to_s}'")
   # determine file list from git ls-files
   files = `git ls-files`.
     split("\n").
@@ -155,8 +179,8 @@ file 'sinatra.gemspec' => FileList['{lib,test,images}/**','Rakefile'] do |f|
     map{ |file| "    #{file}" }.
     join("\n")
   # piece file back together and write...
-  parts[1] = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = parts.join("  # = MANIFEST =\n")
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head,manifest,tail].join("  # = MANIFEST =\n")
   File.open(f.name, 'w') { |io| io.write(spec) }
   puts "updated #{f.name}"
 end

data/{test → compat}/app_test.rb

@@ -108,7 +108,9 @@ context "Sinatra" do
   end
 
   specify "renders a body with a redirect" do
-    Sinatra::EventContext.any_instance.expects(:foo).returns('blah')
+    helpers do
+      def foo ; 'blah' ; end
+    end
     get "/" do
       redirect 'foo', :foo
     end
@@ -130,13 +132,10 @@ context "Sinatra" do
   end
 
   specify "stop sets content and ends event" do
-
-    Sinatra::EventContext.any_instance.expects(:foo).never
-
     get '/set_body' do
       stop 'Hello!'
       stop 'World!'
-      foo
+      fail 'stop should have halted'
     end
 
     get_it '/set_body'
@@ -146,8 +145,13 @@ context "Sinatra" do
 
   end
 
-  specify "should set status then call helper with a var" do
-    Sinatra::EventContext.any_instance.expects(:foo).once.with(1).returns('bah!')
+  # 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]]
@@ -252,8 +256,6 @@ context "Sinatra" do
     assert_equal 'puted', body
   end
 
-  # Some Ajax libraries downcase the _method parameter value. Make
-  # sure we can handle that.
   specify "rewrites POSTs with lowercase _method param to PUT" do
     put '/' do
       'puted'
@@ -262,7 +264,6 @@ context "Sinatra" do
     body.should.equal 'puted'
   end
 
-  # Ignore any _method parameters specified in GET requests or on the query string in POST requests.
   specify "does not rewrite GETs with _method param to PUT" do
     get '/' do
       'getted'