sinatra 1.3.2 → 1.3.3

data/README.pt-br.rdoc

@@ -128,7 +128,7 @@ A gem/biblioteca haml é necessária para renderizar templates HAML:
 
 Renderiza <tt>./views/index.haml</tt>.
 
-{Opções Haml}[http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#options]
+{Opções Haml}[http://haml.info/docs/yardoc/file.HAML_REFERENCE.html#options]
 podem ser setadas globalmente através das configurações do sinatra,
 veja {Opções e Configurações}[http://www.sinatrarb.com/configuration.html],
 e substitua em uma requisição individual.

data/README.pt-pt.rdoc

@@ -128,7 +128,7 @@ A gem/biblioteca haml é necessária para renderizar templates HAML:
 
 Renderiza <tt>./views/index.haml</tt>.
 
-{Opções Haml}[http://haml-lang.com/docs/yardoc/file.HAML_REFERENCE.html#options]
+{Opções Haml}[http://haml.info/docs/yardoc/file.HAML_REFERENCE.html#options]
 podem ser definidas globalmente através das configurações do sinatra,
 veja {Opções e Configurações}[http://www.sinatrarb.com/configuration.html],
 e substitua em uma requisição individual.

data/README.rdoc

@@ -5,7 +5,7 @@ effort:
 
   # myapp.rb
   require 'sinatra'
-  
+
   get '/' do
     'Hello world!'
   end
@@ -128,7 +128,7 @@ Other available conditions are +host_name+ and +provides+:
   get '/', :provides => 'html' do
     haml :index
   end
-  
+
   get '/', :provides => ['rss', 'atom', 'xml'] do
     builder :feed
   end
@@ -136,21 +136,21 @@ Other available conditions are +host_name+ and +provides+:
 You can easily define your own conditions:
 
   set(:probability) { |value| condition { rand <= value } }
-  
+
   get '/win_a_car', :probability => 0.1 do
     "You won!"
   end
-  
+
   get '/win_a_car' do
     "Sorry, you lost."
   end
-  
+
 For a condition that takes multiple values use a splat:
 
   set(:auth) do |*roles|   # <- notice the splat here
     condition do
       unless logged_in? && roles.any? {|role| current_user.in_role? role }
-        redirect "/login/", 303 
+        redirect "/login/", 303
       end
     end
   end
@@ -158,11 +158,11 @@ For a condition that takes multiple values use a splat:
   get "/my/account/", :auth => [:user, :admin] do
     "Your Account Details"
   end
-  
+
   get "/only/admin/", :auth => :admin do
     "Only admins are allowed here!"
   end
-  
+
 === Return Values
 
 The return value of a route block determines at least the response body passed
@@ -177,7 +177,7 @@ body object or HTTP status code:
   body (responds to #each)]</tt>
 * An Array with two elements: <tt>[status (Fixnum), response body (responds to
   #each)]</tt>
-* An object that responds to <tt>#each</tt> and passes nothing but strings to 
+* An object that responds to <tt>#each</tt> and passes nothing but strings to
   the given block
 * A Fixnum representing the status code
 
@@ -251,7 +251,7 @@ Use the <tt>:static_cache_control</tt> setting (see below) to add
 
 == Views / Templates
 
-Each template language is exposed as via its own rendering method. These
+Each template language is exposed via its own rendering method. These
 methods simply return a string:
 
   get '/' do
@@ -344,7 +344,7 @@ to use (and to be thread-safe), you should simply require it first:
 
 === Haml Templates
 
-Dependency::        {haml}[http://haml-lang.com/]
+Dependency::        {haml}[http://haml.info/]
 File Extensions::   <tt>.haml</tt>
 Example::           <tt>haml :index, :format => :html5</tt>
 
@@ -559,7 +559,7 @@ Templates may be defined at the end of the source file:
     = yield
 
   @@ index
-  %div.title Hello world!!!!!
+  %div.title Hello world.
 
 NOTE: Inline templates defined in the source file that requires sinatra are
 automatically loaded. Call <tt>enable :inline_templates</tt> explicitly if you
@@ -582,8 +582,8 @@ Templates may also be defined using the top-level <tt>template</tt> method:
   end
 
 If a template named "layout" exists, it will be used each time a template
-is rendered. You can individually disable layouts by passing 
-<tt>:layout => false</tt> or disable them by default via 
+is rendered. You can individually disable layouts by passing
+<tt>:layout => false</tt> or disable them by default via
 <tt>set :haml, :layout => false</tt>:
 
   get '/' do
@@ -659,7 +659,7 @@ Like routes, filters also take conditions:
   before :agent => /Songbird/ do
     # ...
   end
-  
+
   after '/blog/*', :host_name => 'example.com' do
     # ...
   end
@@ -679,6 +679,20 @@ route handlers and templates:
     bar(params[:name])
   end
 
+Alternatively, helper methods can be separately defined in a module:
+
+  module FooUtils
+    def foo(name) "#{name}foo" end
+  end
+
+  module BarUtils
+    def bar(name) "#{name}bar" end
+  end
+
+  helpers FooUtils, BarUtils
+
+The effect is the same as including the modules in the application class.
+
 === Using Sessions
 
 A session is used to keep state during requests. If activated, you have one
@@ -711,7 +725,7 @@ middleware of choice as you would any other middleware:
   end
 
 To improve security, the session data in the cookie is signed with a session
-secret. A random secret is generate for you by Sinatra. However, since this
+secret. A random secret is generated for you by Sinatra. However, since this
 secret will change with every start of your application, you might want to
 set the secret yourself, so all your application instances share it:
 
@@ -798,12 +812,12 @@ access the body:
   get '/foo' do
     body "bar"
   end
-  
+
   after do
     puts body
   end
 
-It is also possible to pass a block to +body+, which will be executed by the 
+It is also possible to pass a block to +body+, which will be executed by the
 Rack handler (this can be used to implement streaming, see "Return Values").
 
 Similar to the body, you can also set the status code and headers:
@@ -838,15 +852,15 @@ creating your own wrapper:
 
 This allows you to implement streaming APIs,
 {Server Sent Events}[http://dev.w3.org/html5/eventsource/] and can be used as
-basis for {WebSockets}[http://en.wikipedia.org/wiki/WebSocket]. It can also be
+the basis for {WebSockets}[http://en.wikipedia.org/wiki/WebSocket]. It can also be
 used to increase throughput if some but not all content depends on a slow
 resource.
 
-Note that the streaming behavior, especially the number of concurrent request,
+Note that the streaming behavior, especially the number of concurrent requests,
 highly depends on the web server used to serve the application. Some servers,
 like WEBRick, might not even support streaming at all. If the server does not
 support streaming, the body will be sent all at once after the block passed to
-+stream+ finished executing. Streaming does not work at all with Shotgun.
++stream+ finishes executing. Streaming does not work at all with Shotgun.
 
 If the optional parameter is set to +keep_open+, it will not call +close+ on
 the stream object, allowing you to close it at any later point in the
@@ -954,12 +968,12 @@ To pass arguments with a redirect, either add them to the query:
 Or use a session:
 
   enable :sessions
-  
+
   get '/foo' do
     session[:secret] = 'foo'
     redirect to('/bar')
   end
-  
+
   get '/bar' do
     session[:secret]
   end
@@ -1006,14 +1020,14 @@ It is also possible to use a
   etag @article.sha1, :weak
 
 These helpers will not do any caching for you, but rather feed the necessary
-information to your cache. If you are looking for a quick reverse-proxy caching solution, 
-try {rack-cache}[http://rtomayko.github.com/rack-cache/]:
+information to your cache. If you are looking for a quick reverse-proxy caching
+solution, try {rack-cache}[http://rtomayko.github.com/rack-cache/]:
 
   require "rack/cache"
   require "sinatra"
-  
+
   use Rack::Cache
-  
+
   get '/' do
     cache_control :public, :max_age => 36000
     sleep 5
@@ -1114,7 +1128,7 @@ Some options, like <tt>script_name</tt> or <tt>path_info</tt>, can also be
 written:
 
   before { request.path_info = "/" }
-  
+
   get "/" do
     "all requests end up here"
   end
@@ -1223,16 +1237,16 @@ Run once, at startup, in any environment:
   configure do
     # setting one option
     set :option, 'value'
-    
+
     # setting multiple options
     set :a => 1, :b => 2
-    
+
     # same as `set :option, true`
     enable :option
-    
+
     # same as `set :option, false`
     disable :option
-    
+
     # you can also have dynamic settings with blocks
     set(:css_dir) { File.join(views, 'css') }
   end
@@ -1268,7 +1282,8 @@ You can access those options via <tt>settings</tt>:
 Sinatra is using
 {Rack::Protection}[https://github.com/rkh/rack-protection#readme] to defend
 you application against common, opportunistic attacks. You can easily disable
-this behavior (which should result in performance gains):
+this behavior (which will open your application to tons of common
+vulnerabilities):
 
   disable :protection
 
@@ -1300,8 +1315,8 @@ You can also hand in an array in order to disable a list of protections:
 
                          settings.add_charsets << "application/foobar"
 
-[app_file]             Path to the main application file, used to detect project root,
-                       views and public folder and inline templates.
+[app_file]             Path to the main application file, used to detect project
+                       root, views and public folder and inline templates.
 
 [bind]                 IP address to bind to (default: 0.0.0.0).
                        Only used for built-in server.
@@ -1347,8 +1362,8 @@ You can also hand in an array in order to disable a list of protections:
                        setting if not set.
 
 [raise_errors]         raise exceptions (will stop application). Enabled
-                       by default when <tt>environment</tt> is set to <tt>"test"</tt>,
-                       disabled otherwise.
+                       by default when <tt>environment</tt> is set to
+                       <tt>"test"</tt>, disabled otherwise.
 
 [run]                  if enabled, Sinatra will handle starting the web server,
                        do not enable if using rackup or other means.
@@ -1367,6 +1382,9 @@ You can also hand in an array in order to disable a list of protections:
 [show_exceptions]      show a stack trace in the browser when an exception
                        happens. Enabled by default when <tt>environment</tt>
                        is set to <tt>"development"</tt>, disabled otherwise.
+                       Can also be set to <tt>:after_handler</tt> to trigger
+                       app-specified error handling before showing a stack
+                       trace in the browser.
 
 [static]               Whether Sinatra should handle serving static files.
                        Disable when using a Server able to do this on its own.
@@ -1388,15 +1406,20 @@ You can also hand in an array in order to disable a list of protections:
 
 == Environments
 
-There are three predefined +environments+: <tt>development</tt>,  <tt>production</tt> and <tt>test</tt>. Environment can be set by RACK_ENV environment variable, and default value is <tt>development</tt>.
+There are three predefined +environments+: <tt>"development"</tt>,
+<tt>"production"</tt> and <tt>"test"</tt>. Environments can be set
+through the +RACK_ENV+ environment variable. The default value is
+<tt>"development"</tt>. In this mode, all templates are reloaded between
+requests. Special <tt>not_found</tt> and <tt>error</tt> handlers are installed
+for this environment so you will see a stack trace in your browser.
+In <tt>"production"</tt> and <tt>"test"</tt> templates are cached by default.
 
-You can also run different environemnt using <tt>-e</tt> option:
+To run different environments use the <tt>-e</tt> option:
 
   ruby my_app.rb -e [ENVIRONMENT]
 
-You can use predefinied methods: +development?+, +test?+ and +production?+, to check which enviroment is set.
-
-+Developemnt+ is default setting. In this mode, all templates are being reloaded between requests. Special <tt>not_found</tt> and <tt>error</tt> handlers are installed for this enviroment, so you will see nice error page. In +production+ and +test+ templates are being cached.
+You can use predefined methods: +development?+, +test?+ and +production?+ to
+check which enviroment is currently set.
 
 == Error Handling
 
@@ -1501,8 +1524,8 @@ with {CodeRack}[http://coderack.org/] or in the
 
 == Testing
 
-Sinatra tests can be written using any Rack-based testing library
-or framework. {Rack::Test}[http://rdoc.info/github/brynary/rack-test/master/frames] 
+Sinatra tests can be written using any Rack-based testing library or framework.
+{Rack::Test}[http://rdoc.info/github/brynary/rack-test/master/frames]
 is recommended:
 
   require 'my_sinatra_app'
@@ -1564,7 +1587,8 @@ available via the top-level DSL. Most top-level apps can be converted to
   of <tt>Sinatra::Base</tt>.
 
 <tt>Sinatra::Base</tt> is a blank slate. Most options are disabled by default,
-including the built-in server. See {Options and Configuration}[http://sinatra.github.com/configuration.html]
+including the built-in server. See
+{Options and Configuration}[http://sinatra.github.com/configuration.html]
 for details on available options and their behavior.
 
 === Modular vs. Classic Style
@@ -1602,10 +1626,10 @@ There are two common options for starting a modular app, actively starting with
 
   # my_app.rb
   require 'sinatra/base'
-  
+
   class MyApp < Sinatra::Base
     # ... app code here ...
-    
+
     # start the server if ruby file executed directly
     run! if app_file == $0
   end
@@ -1630,7 +1654,7 @@ Write your app file:
 
   # app.rb
   require 'sinatra'
-  
+
   get '/' do
     'Hello world!'
   end
@@ -1661,12 +1685,12 @@ endpoint could be another Sinatra application, or any other Rack-based
 application (Rails/Ramaze/Camping/...):
 
   require 'sinatra/base'
-  
+
   class LoginScreen < Sinatra::Base
     enable :sessions
-    
+
     get('/login') { haml :login }
-    
+
     post('/login') do
       if params[:name] == 'admin' && params[:password] == 'admin'
         session['user_name'] = params[:name]
@@ -1675,17 +1699,17 @@ application (Rails/Ramaze/Camping/...):
       end
     end
   end
-  
+
   class MyApp < Sinatra::Base
     # middleware will run before filters
     use LoginScreen
-    
+
     before do
       unless session['user_name']
         halt "Access denied, please <a href='/login'>login</a>."
       end
     end
-    
+
     get('/') { "Hello #{session['user_name']}." }
   end
 
@@ -1737,10 +1761,10 @@ available.
 === Application/Class Scope
 
 Every Sinatra application corresponds to a subclass of <tt>Sinatra::Base</tt>.
-If you are using the top-level DSL (<tt>require 'sinatra'</tt>), then this 
-class is <tt>Sinatra::Application</tt>, otherwise it is the subclass you 
+If you are using the top-level DSL (<tt>require 'sinatra'</tt>), then this
+class is <tt>Sinatra::Application</tt>, otherwise it is the subclass you
 created explicitly. At class level you have methods like +get+ or +before+, but
-you cannot access the +request+ object or the +session+, as there only is a 
+you cannot access the +request+ object or the +session+, as there only is a
 single application class for all requests.
 
 Options created via +set+ are methods at class level:
@@ -1749,7 +1773,7 @@ Options created via +set+ are methods at class level:
       # Hey, I'm in the application scope!
       set :foo, 42
       foo # => 42
-      
+
       get '/foo' do
         # Hey, I'm no longer in the application scope!
       end
@@ -1781,12 +1805,12 @@ scope via the +settings+ helper:
     get '/define_route/:name' do
       # Request scope for '/define_route/:name'
       @value = 42
-      
+
       settings.get("/#{params[:name]}") do
         # Request scope for "/#{params[:name]}"
         @value # => nil (not the same request)
       end
-      
+
       "Route defined!"
     end
   end
@@ -1845,28 +1869,27 @@ The following Ruby versions are officially supported:
   Sinatra 1.4.0 is released.
 
 [ Ruby 1.9.2 ]
-  1.9.2 is fully supported and recommended. Note that Radius and Markaby
-  are currently not 1.9 compatible. Do not use 1.9.2p0, it is known to cause
-  segmentation faults when running Sinatra. Support will continue at least
+  1.9.2 is fully supported and recommended. Do not use 1.9.2p0, it is known to
+  cause segmentation faults when running Sinatra. Support will continue at least
   until the release of Ruby 1.9.4/2.0 and support for the latest 1.9 release
   will continue as long as it is still supported by the Ruby core team.
 
 [ Ruby 1.9.3 ]
-  1.9.3 is fully supported. We recommend waiting for higher patch levels to be
-  released (current one is p0) before using it in production. Please note that
-  switching to 1.9.3 from an earlier version will invalidate all sessions.
+  1.9.3 is fully supported and recommended. Please note that switching to 1.9.3
+  from an earlier version will invalidate all sessions.
 
 [ Rubinius ]
   Rubinius is officially supported (Rubinius >= 1.2.4), everything, including
   all template languages, works. The upcoming 2.0 release is supported as
-  well.
+  well, including 1.9 mode.
 
 [ JRuby ]
-  JRuby is officially supported (JRuby >= 1.6.5). No issues with third party
+  JRuby is officially supported (JRuby >= 1.6.7). No issues with third party
   template libraries are known, however, if you choose to use JRuby, please
   look into JRuby rack handlers, as the Thin web server is not fully supported
   on JRuby. JRuby's support for C extensions is still experimental, which only
-  affects RDiscount, Redcarpet and RedCloth at the moment.
+  affects RDiscount, Redcarpet, RedCloth and Yajl templates as well as Thin
+  and Mongrel at the moment.
 
 We also keep an eye on upcoming Ruby versions.
 
@@ -1915,7 +1938,7 @@ Then, in your project directory, create a +Gemfile+:
 
   source :rubygems
   gem 'sinatra', :git => "git://github.com/sinatra/sinatra.git"
-  
+
   # other dependencies
   gem 'haml'                    # for instance, if you use haml
   gem 'activerecord', '~> 3.0'  # maybe you also need ActiveRecord 3.x
@@ -1971,7 +1994,7 @@ SemVerTag.
 * {Mailing List}[http://groups.google.com/group/sinatrarb/topics]
 * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] on http://freenode.net
 * {Sinatra Book}[http://sinatra-book.gittr.com] Cookbook Tutorial
-* {Sinatra Recipes}[http://recipes.sinatrarb.com/] Community 
+* {Sinatra Recipes}[http://recipes.sinatrarb.com/] Community
   contributed recipes
 * API documentation for the {latest release}[http://rubydoc.info/gems/sinatra]
   or the {current HEAD}[http://rubydoc.info/github/sinatra/sinatra] on