sinatra 1.3.1 → 1.3.2

data/CHANGES

@@ -1,8 +1,38 @@
-= 1.3.1 / Not Yet Released
+= 1.3.2 / 2011-12-30
+
+ * Don't automatically add `Rack::CommonLogger` if `Rack::Server` is adding it,
+   too. (Konstantin Haase)
+
+ * Setting `logging` to `nil` will avoid setting up `Rack::NullLogger`.
+   (Konstantin Haase)
+
+ * Route specific params are now available in the block passed to #stream.
+   (Konstantin Haase)
+
+ * Fix bug where rendering a second template in the same request, after the
+   first one raised an exception, skipped the default layout. (Nathan Baum)
+
+ * Fix bug where parameter escaping got enabled when disabling a different
+   protection. (Konstantin Haase)
+
+ * Fix regression: Filters without a pattern may now again manipulate the params
+   hash. (Konstantin Haase)
+
+ * Added examples directory. (Konstantin Haase)
+
+ * Improved documentation. (Gabriel Andretta, Markus Prinz, Erick Zetta, Just
+   Lest, Adam Vaughan, Aleksander Dąbrowski)
+
+ * Improved MagLev support. (Tim Felgentreff)
+
+= 1.3.1 / 2011-10-05
 
  * Support adding more than one callback to the stream object. (Konstantin
    Haase)
 
+ * Fix for infinite loop when streaming on 1.9.2 with Thin from a modular
+   application (Konstantin Haase)
+
 = 1.3.0 / 2011-09-30
 
  * Added `stream` helper method for easily creating streaming APIs, Server
@@ -130,6 +160,13 @@
  * Fix handling of broken query params when displaying exceptions. (Luke
    Jahnke)
 
+= 1.2.8 (backports release) / 2011-12-30
+
+Backported from 1.3.2:
+
+* Fix bug where rendering a second template in the same request after the
+  first one raised an exception skipped the default layout (Nathan Baum)
+
 = 1.2.7 (backports release) / 2011-09-30
 
 Custom changes:

data/Gemfile

@@ -17,11 +17,14 @@ gem 'ci_reporter', :group => :ci
 # Allows stuff like `tilt=1.2.2 bundle install` or `tilt=master ...`.
 # Used by the CI.
 github = "git://github.com/%s.git"
-repos = { 'tilt' => github % "rtomayko/tilt", 'rack' => github % "rack/rack" }
+repos  = {'tilt' => github % "rtomayko/tilt", 'rack' => github % "rack/rack"}
+
 %w[tilt rack].each do |lib|
-  dep = (ENV[lib] || 'stable').sub "#{lib}-", ''
-  dep = nil if dep == 'stable'
-  dep = {:git => repos[lib], :branch => dep} if dep and dep !~ /(\d+\.)+\d+/
+  dep = case ENV[lib]
+        when 'stable', nil then nil
+        when /(\d+\.)+\d+/ then "~> " + ENV[lib].sub("#{lib}-", '')
+        else {:git => repos[lib], :branch => dep}
+        end
   gem lib, dep
 end
 
@@ -29,16 +32,16 @@ gem 'haml', '>= 3.0'
 gem 'sass'
 gem 'builder'
 gem 'erubis'
-gem 'less', '~> 2.0'
 gem 'liquid'
 gem 'slim', '~> 1.0'
 gem 'temple', '!= 0.3.3'
-gem 'RedCloth' if RUBY_VERSION < "1.9.3" and not RUBY_ENGINE.start_with? 'ma'
 gem 'coffee-script', '>= 2.0'
 gem 'rdoc'
 gem 'kramdown'
 gem 'maruku'
 gem 'creole'
+gem 'markaby'
+gem 'radius'
 
 if RUBY_ENGINE == 'jruby'
   gem 'nokogiri', '!= 1.5.0'
@@ -47,10 +50,17 @@ else
   gem 'nokogiri'
 end
 
+if RUBY_ENGINE == "ruby"
+  gem 'less', '~> 2.0'
+else
+  gem 'less', '~> 1.0'
+end
+
 unless RUBY_ENGINE == 'jruby' && JRUBY_VERSION < "1.6.1" && !ENV['TRAVIS']
   # C extensions
   gem 'rdiscount'
-  gem 'redcarpet'
+  platforms(:ruby_18) { gem 'redcarpet' }
+  gem 'RedCloth' unless RUBY_ENGINE == "macruby"
 
   ## bluecloth is broken
   #gem 'bluecloth'
@@ -58,8 +68,6 @@ end
 
 platforms :ruby_18, :jruby do
   gem 'json'
-  gem 'markaby'
-  gem 'radius'
 end
 
 platforms :mri_18 do

data/README.de.rdoc

@@ -1953,9 +1953,9 @@ SemVer und SemVerTag.
 * {Mailing-Liste}[http://groups.google.com/group/sinatrarb]
 * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] auf http://freenode.net
 * {Sinatra Book}[http://sinatra-book.gittr.com] Kochbuch Tutorial
-* {Sinatra Book Contrib}[http://sinatra-book-contrib.com/] Sinatra-Rezepte aus
+* {Sinatra Recipes}[http://recipes.sinatrarb.com/] Sinatra-Rezepte aus
   der Community
 * API Dokumentation für die {aktuelle Version}[http://rubydoc.info/gems/sinatra]
   oder für {HEAD}[http://rubydoc.info/github/sinatra/sinatra] auf
   http://rubydoc.info
-* {CI Server}[http://ci.rkh.im/view/Sinatra/]
+* {CI Server}[http://ci.rkh.im/view/Sinatra/]

data/README.es.rdoc

@@ -874,7 +874,7 @@ número de peticiones concurrentes, depende del servidor web utilizado para
 servir la aplicación.  Puede que algunos servidores, como es el caso de
 WEBRick, no soporten streaming directamente, así el cuerpo de la respuesta será
 enviado completamente de una vez cuando el bloque pasado a +stream+ finalice su
-ejecución.
+ejecución.  Si estás usando Shotgun, el streaming no va a funcionar.
 
 Cuando se pasa +keep_open+ como parámetro, no se va a enviar el mensaje
 +close+ al objeto de stream. Queda en vos cerrarlo en el punto de ejecución
@@ -916,11 +916,16 @@ para <tt>Sinatra::Application</tt>.  Si heredaste de
 <tt>Sinatra::Base</tt>, probablemente quieras habilitarlo manualmente:
 
   class MiApp < Sinatra::Base
-    configure(:production, :development) do
+    configure :production, :development do
       enable :logging
     end
   end
 
+Para evitar que se inicialice cualquier middleware de logging, configurá
++logging+ a +nil+.  Tené en cuenta que, cuando hagas esto, +logger+ va a
+devolver +nil+.  Un caso común es cuando querés usar tu propio logger. Sinatra
+va a usar lo que encuentre en <tt>env['rack.logger']</tt>.
+
 === Tipos Mime
 
 Cuando usás <tt>send_file</tt> o archivos estáticos tal vez tengas tipos mime
@@ -1300,7 +1305,7 @@ Podés acceder a estas opciones utilizando el método <tt>settings</tt>:
     ...
   end
 
-==== Configurando la Protección de Ataques
+=== Configurando la Protección de Ataques
 
 Sinatra usa {Rack::Protection}[https://github.com/rkh/rack-protection#readme]
 para defender a tu aplicación de los ataques más comunes.  Tenés que tener en
@@ -1316,7 +1321,7 @@ También es posible desactivar una única capa de defensa:
 
 O varias:
 
-  set :protections, :except => [:path_traversal, :session_hijacking]
+  set :protection, :except => [:path_traversal, :session_hijacking]
 
 === Configuraciones Disponibles
 
@@ -1340,9 +1345,9 @@ O varias:
 
                          settings.add_charsets << "application/foobar"
 
-[app_file]             archivo principal de la aplicación, se utiliza para
-                       detectar la raíz del proyecto, el directorio de las
-                       vistas y el público así como las plantillas inline.
+[app_file]             path del archivo principal de la aplicación, se utiliza
+                       para detectar la raíz del proyecto, el directorio de las
+                       vistas y el público, así como las plantillas inline.
 
 [bind]                 dirección IP que utilizará el servidor integrado (por
                        defecto: 0.0.0.0).
@@ -1382,15 +1387,24 @@ O varias:
                        sección sobre la configuración de protección de ataques
                        más arriba.
 
-[public_folder]        directorio desde donde se sirven los archivos públicos.
+[public_folder]        path del directorio desde donde se sirven los archivos
+                       públicos.  Solo se utiliza cuando se sirven archivos
+                       estáticos (ver la opción <tt>static</tt>).  Si no
+                       está presente, se infiere del valor de la opción
+                       <tt>app_file</tt>.
 
 [reload_templates]     define si se recargan las plantillas entre peticiones.
 
                        Se encuentra activado en el entorno de desarrollo.
 
-[root]                 directorio raíz del proyecto.
+[root]                 path del directorio raíz del proyecto.  Si no está
+                       presente, se infiere del valor de la opción
+                       <tt>app_file</tt>.
 
-[raise_errors]         elevar excepciones (detiene la aplicación).
+[raise_errors]         elevar excepciones (detiene la aplicación).  Se
+                       encuentra activada por defecto cuando el valor de
+                       <tt>environment</tt>  es <tt>"test"</tt>.  En caso
+                       contrario estará desactivada.
 
 [run]                  cuando está habilitada, Sinatra se va a encargar de
                        iniciar el servidor web, no la habilités cuando estés
@@ -1403,9 +1417,14 @@ O varias:
                        integrado.  Por defecto: ['thin', 'mongrel', 'webrick'],
                        el orden establece la prioridad.
 
-[sessions]             habilita sesiones basadas en cookies.
+[sessions]             habilita el soporte de sesiones basadas en cookies a
+                       través de <tt>Rack::Session::Cookie</tt>.  Ver la
+                       sección 'Usando Sesiones' para más información.
 
-[show_exceptions]      muestra un stack trace en el navegador.
+[show_exceptions]      muestra un stack trace en el navegador cuando ocurre una
+                       excepción.  Se encuentra activada por defecto cuando el
+                       valor de <tt>environment</tt> es <tt>"development"</tt>.
+                       En caso contrario estará desactivada.
 
 [static]               define si Sinatra debe encargarse de servir archivos
                        estáticos.
@@ -1424,7 +1443,9 @@ O varias:
                        utilizar un array cuando se asignan múltiples valores: 
                        <tt>set :static_cache_control, [:public, :max_age => 300]</tt>.
 
-[views]                directorio de las vistas.
+[views]                path del directorio de las vistas.  Si no está presente,
+                       se infiere del valor de la opción <tt>app_file</tt>.
+
 
 == Manejo de Errores
 
@@ -1882,22 +1903,31 @@ Las siguientes versiones de Ruby son soportadas oficialmente:
   ya no se corregirán errores por más que se reciban reportes de los mismos.
 
 [ Ruby 1.9.2 ]
-  1.9.2 es soportado y recomendado.  Tené en cuenta que Radius y Markaby no
-  son compatibles con 1.9 actualmente.  Además, no usés 1.9.2p0, porque produce
-  fallos de segmentación cuando se ejecuta Sinatra.
+  1.9.2 es soportado y recomendado.  Tené en cuenta que Radius y Markaby no son
+  compatibles con 1.9 actualmente.  Además, no usés 1.9.2p0, porque se producen
+  fallos de segmentación cuando se ejecuta Sinatra.  El soporte se mantendrá al
+  menos hasta que se libere la versión 1.9.4/2.0 de Ruby.  El soporte para la
+  última versión de la serie 1.9 se mantendrá mientras lo haga el core team de
+  Ruby.
+
+[ Ruby 1.9.3 ]
+  1.9.3 es soportado completamente.  De todas maneras, recomendamos esperar a
+  que se liberen niveles de parche superiores (el actual es p0) antes de usarlo
+  en producción.  Es importante notar que el cambio desde una versión anterior a
+  1.9.3 va a invalidar todas las sesiones.
 
 [ Rubinius ]
-  Rubinius es soportado oficialmente (Rubinius >= 1.2.4).  Todo
-  funciona correctamente, incluyendo los lenguajes de plantillas.
+  Rubinius es soportado oficialmente (Rubinius >= 1.2.4).  Todo funciona
+  correctamente, incluyendo los lenguajes de plantillas.  La próxima versión,
+  2.0, también es soportada.
 
 [ JRuby ]
-  JRuby es soportado oficialmente (JRuby >= 1.6.3).  No se conocen
-  problemas con librerías de plantillas de terceras partes.  Sin
-  embargo, si elegís usar JRuby, deberías examinar sus Rack handlers
-  porque el servidor web Thin no es soportado completamente.  El
-  soporte de JRuby para extensiones C se encuentra en una etapa
-  experimental, sin embargo, de momento solamente RDiscount y Redcarpted
-  se ven afectadas.
+  JRuby es soportado oficialmente (JRuby >= 1.6.5).  No se conocen problemas
+  con librerías de plantillas de terceras partes.  Sin embargo, si elegís usar
+  JRuby, deberías examinar sus Rack handlers porque el servidor web Thin no es
+  soportado completamente.  El soporte de JRuby para extensiones C se encuentra
+  en una etapa experimental, sin embargo, de momento solamente RDiscount,
+  Redcarpet y RedCloth se ven afectadas.
 
 Siempre le prestamos atención a las nuevas versiones de Ruby.
 
@@ -1913,10 +1943,10 @@ No estar soportada oficialmente, significa que si las cosas solamente se rompen
 ahí y no en una plataforma soportada, asumimos que no es nuestro problema sino
 el suyo.
 
-Nuestro servidor CI también se ejecuta sobre ruby-head (que será la
-próxima versión 1.9.4).  Como está en movimiento constante, no podemos
-garantizar nada.  De todas formas, podés contar con que 1.9.4-p0 sea
-soportada.
+Nuestro servidor CI también se ejecuta sobre ruby-head (que será la próxima
+versión 2.0.0) y la rama 1.9.4.  Como están en movimiento constante, no podemos
+garantizar nada.  De todas formas, podés contar con que tanto 1.9.4-p0 como
+2.0.0-p0 sea soportadas.
 
 Sinatra debería funcionar en cualquier sistema operativo soportado por la
 implementación de Ruby elegida.
@@ -2004,7 +2034,7 @@ siguiendo las especificaciones SemVer y SemVerTag.
 * {Lista de Correo}[http://groups.google.com/group/sinatrarb/topics]
 * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] en http://freenode.net
 * {Sinatra Book}[http://sinatra-book.gittr.com] Tutorial (en inglés).
-* {Sinatra Book Contrib}[http://sinatra-book-contrib.com/] Recetas contribuidas
+* {Sinatra Recipes}[http://recipes.sinatrarb.com/] Recetas contribuidas
   por la comunidad (en inglés).
 * Documentación de la API para la
   {última versión liberada}[http://rubydoc.info/gems/sinatra] o para la

data/README.fr.rdoc

@@ -1,4 +1,5 @@
 = Sinatra
+
 <i>Attention : Ce document correspond à la traduction de la version anglaise et
 il n'est peut être plus à jour.</i>
 
@@ -1974,7 +1975,7 @@ SemVer que SemVerTag.
 * {IRC : #sinatra}[irc://chat.freenode.net/#sinatra] sur http://freenode.net
 * {IRC : #sinatra}[irc://chat.freenode.net/#sinatra] on http://freenode.net
 * {Sinatra Book}[http://sinatra-book.gittr.com] Tutoriels et recettes
-* {Sinatra Book Contrib}[http://sinatra-book-contrib.com/] Recettes contribuées
+* {Sinatra Recipes}[http://recipes.sinatrarb.com/] Recettes contribuées
   par la communauté
 * Documentation API de la {dernière version}[http://rubydoc.info/gems/sinatra]
   ou du {HEAD courant}[http://rubydoc.info/github/sinatra/sinatra] sur

data/README.jp.rdoc

@@ -376,6 +376,7 @@ textileからメソッドを呼び出すことも、localsに変数を渡すこ
 RDocテンプレートを使うにはRDocライブラリが必要です:
 
   # rdoc/markup/to_htmlを読み込みます
+  require "rdoc"
   require "rdoc/markup/to_html"
 
   get '/' do

data/README.rdoc

@@ -264,7 +264,7 @@ Instead of a template name, you can also just pass in the template content
 directly:
 
   get '/' do
-    code = "<%= Time.now >"
+    code = "<%= Time.now %>"
     erb code
   end
 
@@ -846,7 +846,7 @@ Note that the streaming behavior, especially the number of concurrent request,
 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.
++stream+ finished 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
@@ -885,11 +885,16 @@ default, so if you inherit from <tt>Sinatra::Base</tt>, you probably want to
 enable it yourself:
 
   class MyApp < Sinatra::Base
-    configure(:production, :development) do
+    configure :production, :development do
       enable :logging
     end
   end
 
+To avoid any logging middleware to be set up, set the +logging+ setting to
++nil+. However, keep in mind that +logger+ will in that case return +nil+. A
+common use case is when you want to set your own logger. Sinatra will use
+whatever it will find in <tt>env['rack.logger']</tt>.
+
 === Mime Types
 
 When using <tt>send_file</tt> or static files you may have mime types Sinatra
@@ -1273,7 +1278,7 @@ To skip a single defense layer, set +protection+ to an options hash:
 
 You can also hand in an array in order to disable a list of protections:
 
-  set :protections, :except => [:path_traversal, :session_hijacking]
+  set :protection, :except => [:path_traversal, :session_hijacking]
 
 === Available Settings
 
@@ -1295,7 +1300,7 @@ You can also hand in an array in order to disable a list of protections:
 
                          settings.add_charsets << "application/foobar"
 
-[app_file]             main application file, used to detect project root,
+[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).
@@ -1322,7 +1327,7 @@ You can also hand in an array in order to disable a list of protections:
 
 [port]                 Port to listen on. Only used for built-in server.
 
-[prefixed_redirects]   Whether or not to insert <tt>request.script_name</tt> 
+[prefixed_redirects]   Whether or not to insert <tt>request.script_name</tt>
                        into redirects if no absolute path is given. That way
                        <tt>redirect '/foo'</tt> would behave like
                        <tt>redirect to('/foo')</tt>. Disabled per default.
@@ -1330,14 +1335,20 @@ You can also hand in an array in order to disable a list of protections:
 [protection]           Whether or not to enable web attack protections. See
                        protection section above.
 
-[public_folder]        folder public files are served from
+[public_folder]        Path to the folder public files are served from. Only
+                       used if static file serving is enabled (see
+                       <tt>static</tt> setting below). Inferred from
+                       <tt>app_file</tt> setting if not set.
 
 [reload_templates]     whether or not to reload templates between requests.
                        Enabled in development mode.
 
-[root]                 project root folder.
+[root]                 Path to project root folder. Inferred from +app_file+
+                       setting if not set.
 
-[raise_errors]         raise exceptions (will stop application).
+[raise_errors]         raise exceptions (will stop application). Enabled
+                       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.
@@ -1346,12 +1357,16 @@ You can also hand in an array in order to disable a list of protections:
                        do not change this setting!
 
 [server]               server or list of servers to use for built-in server.
-                       defaults to ['thin', 'mongrel', 'webrick'], order 
+                       defaults to ['thin', 'mongrel', 'webrick'], order
                        indicates priority.
 
-[sessions]             enable cookie based sessions.
+[sessions]             enable cookie based sessions support using
+                       <tt>Rack::Session::Cookie</tt>. See 'Using Sessions'
+                       section for more information.
 
-[show_exceptions]      show a stack trace in the browser.
+[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.
 
 [static]               Whether Sinatra should handle serving static files.
                        Disable when using a Server able to do this on its own.
@@ -1368,7 +1383,20 @@ You can also hand in an array in order to disable a list of protections:
 [threaded]             If set to +true+, will tell Thin to use
                        <tt>EventMachine.defer</tt> for processing the request.
 
-[views]                views folder.
+[views]                Path to the views folder. Inferred from <tt>app_file</tt>
+                       setting if not set.
+
+== 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>.
+
+You can also run different environemnt using <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.
 
 == Error Handling
 
@@ -1824,20 +1852,21 @@ The following Ruby versions are officially supported:
   will continue as long as it is still supported by the Ruby core team.
 
 [ Ruby 1.9.3 ]
-  While we test against 1.9.3 we do not know of anyone using it in
-  production yet, and as with 1.9.2, you might want to be careful with
-  patch level zero.
+  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.
 
 [ Rubinius ]
   Rubinius is officially supported (Rubinius >= 1.2.4), everything, including
-  all template languages, works.
+  all template languages, works. The upcoming 2.0 release is supported as
+  well.
 
 [ JRuby ]
-  JRuby is officially supported (JRuby >= 1.6.3). No issues with third party
+  JRuby is officially supported (JRuby >= 1.6.5). 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 and Redcarpet at the moment.
+  affects RDiscount, Redcarpet and RedCloth at the moment.
 
 We also keep an eye on upcoming Ruby versions.
 
@@ -1852,9 +1881,9 @@ known to run Sinatra:
 Not being officially supported means if things only break there and not on a
 supported platform, we assume it's not our issue but theirs.
 
-We also run our CI against ruby-head (the upcoming 1.9.4), but we can't
-guarantee anything, since it is constantly moving. Expect 1.9.4p0 to be
-supported.
+We also run our CI against ruby-head (the upcoming 2.0.0) and the 1.9.4
+branch, but we can't guarantee anything, since it is constantly moving. Expect
+both 1.9.4p0 and 2.0.0p0 to be supported.
 
 Sinatra should work on any operating system supported by the chosen Ruby
 implementation.
@@ -1942,7 +1971,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 Book Contrib}[http://sinatra-book-contrib.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

data/README.ru.rdoc

@@ -232,7 +232,7 @@ Thin - это более производительный и функциона
 содержимое шаблона
 
   get '/' do
-    code = "<%= Time.now >"
+    code = "<%= Time.now %>"
     erb code
   end
 
@@ -1779,7 +1779,7 @@ SemVerTag.
 * {Группы рассылки}[http://groups.google.com/group/sinatrarb/topics]
 * {IRC: #sinatra}[irc://chat.freenode.net/#sinatra] на http://freenode.net
 * {Sinatra Book}[http://sinatra-book.gittr.com] учебник и сборник рецептов
-* {Sinatra Book Contrib}[http://sinatra-book-contrib.com/] сборник рецептов
+* {Sinatra Recipes}[http://recipes.sinatrarb.com/] сборник рецептов
 * API документация к {последнему релизу}[http://rubydoc.info/gems/sinatra]
   или {текущему HEAD}[http://rubydoc.info/github/sinatra/sinatra] на
   http://rubydoc.info

data/README.zh.rdoc

@@ -492,6 +492,7 @@ Rack body对象或者HTTP状态码：
 需要引入 <tt>RDoc</tt> gem/library 以渲染RDoc模板：
 
   # 需要在你的应用中引入rdoc/markup/to_html
+  require "rdoc"
   require "rdoc/markup/to_html"
 
   get '/' do

data/Rakefile

@@ -164,6 +164,10 @@ if defined?(Gem)
   end
 
   task 'release' => ['test', package('.gem')] do
+    if File.read("CHANGES") =~ /= \d\.\d\.\d . not yet released$/i
+      fail 'please update changes first'
+    end
+
     sh <<-SH
       gem install #{package('.gem')} --local &&
       gem push #{package('.gem')}  &&

data/examples/chat.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby -I ../lib -I lib
+# coding: utf-8
+require 'sinatra'
+set :server, 'thin'
+connections = []
+
+get '/' do
+  halt erb(:login) unless params[:user]
+  erb :chat, :locals => { :user => params[:user].gsub(/\W/, '') }
+end
+
+get '/stream', :provides => 'text/event-stream' do
+  stream :keep_open do |out|
+    connections << out
+    out.callback { connections.delete(out) }
+  end
+end
+
+post '/' do
+  connections.each { |out| out << "data: #{params[:msg]}\n\n" }
+  204 # response without entity body
+end
+
+__END__
+
+@@ layout
+<html>
+  <head> 
+    <title>Super Simple Chat with Sinatra</title> 
+    <meta charset="utf-8" />
+    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script> 
+  </head> 
+  <body><%= yield %></body>
+</html>
+
+@@ login
+<form action='/'>
+  <label for='user'>User Name:</label>
+  <input name='user' value='' />
+  <input type='submit' value="GO!" />
+</form>
+
+@@ chat
+<pre id='chat'></pre>
+
+<script>
+  // reading
+  var es = new EventSource('/stream');
+  es.onmessage = function(e) { $('#chat').append(e.data + "\n") };
+
+  // writing
+  $("form").live("submit", function(e) {
+    $.post('/', {msg: "<%= user %>: " + $('#msg').val()});
+    $('#msg').val(''); $('#msg').focus();
+    e.preventDefault();
+  });
+</script>
+
+<form>
+  <input id='msg' placeholder='type message here...' />
+</form>

data/examples/simple.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby -I ../lib -I lib
+require 'sinatra'
+get('/') { 'this is a simple app' }

data/examples/stream.ru

@@ -0,0 +1,26 @@
+# this example does *not* work properly with WEBrick
+#
+# run *one* of these:
+#
+#   rackup -s mongrel stream.ru   # gem install mongrel
+#   thin -R stream.ru start       # gem install thin
+#   unicorn stream.ru             # gem install unicorn
+#   puma stream.ru                # gem install puma
+
+require 'sinatra/base'
+
+class Stream < Sinatra::Base
+  get '/' do
+    content_type :txt
+
+    stream do |out|
+      out << "It's gonna be legen -\n"
+      sleep 0.5
+      out << " (wait for it) \n"
+      sleep 1
+      out << "- dary!\n"
+    end
+  end
+end
+
+run Stream

data/lib/sinatra/base.rb

@@ -51,8 +51,8 @@ module Sinatra
     private
 
     def accept_entry(entry)
-      type, *options = entry.gsub(/\s/, '').split(';')
-      quality = 0 # we sort smalles first
+      type, *options = entry.delete(' ').split(';')
+      quality = 0 # we sort smallest first
       options.delete_if { |e| quality = 1 - e[2..-1].to_f if e.start_with? 'q=' }
       [type, [quality, type.count('*'), 1 - options.size]]
     end
@@ -287,8 +287,18 @@ module Sinatra
     # The close parameter specifies whether Stream#close should be called
     # after the block has been executed. This is only relevant for evented
     # servers like Thin or Rainbows.
-    def stream(keep_open = false, &block)
+    def stream(keep_open = false)
       scheduler = env['async.callback'] ? EventMachine : Stream
+      current   = @params.dup
+      block     = proc do |out|
+        begin
+          original, @params = @params, current
+          yield(out)
+        ensure
+          @params = original if original
+        end
+      end
+
       body Stream.new(scheduler, keep_open, &block)
     end
 
@@ -311,7 +321,7 @@ module Sinatra
         hash = {}
       end
 
-      values = values.map { |value| value.to_s.tr('_','-') }
+      values.map! { |value| value.to_s.tr('_','-') }
       hash.each do |key, value|
         key = key.to_s.tr('_', '-')
         value = value.to_i if key == "max-age"
@@ -619,11 +629,14 @@ module Sinatra
       scope           = options.delete(:scope)         || self
 
       # compile and render template
-      layout_was      = @default_layout
-      @default_layout = false
-      template        = compile_template(engine, data, options, views)
-      output          = template.render(scope, locals, &block)
-      @default_layout = layout_was
+      begin
+        layout_was      = @default_layout
+        @default_layout = false
+        template        = compile_template(engine, data, options, views)
+        output          = template.render(scope, locals, &block)
+      ensure
+        @default_layout = layout_was
+      end
 
       # render layout
       if layout
@@ -794,35 +807,22 @@ module Sinatra
     #
     # Returns pass block.
     def process_route(pattern, keys, conditions, block = nil, values = [])
-      @original_params ||= @params
       route = @request.path_info
       route = '/' if route.empty? and not settings.empty_path_info?
-      if match = pattern.match(route)
-        values += match.captures.to_a.map { |v| force_encoding URI.decode(v) if v }
-        params =
-          if keys.any?
-            keys.zip(values).inject({}) do |hash,(k,v)|
-              if k == 'splat'
-                (hash[k] ||= []) << v
-              else
-                hash[k] = v
-              end
-              hash
-            end
-          elsif values.any?
-            {'captures' => values}
-          else
-            {}
-          end
-        @params = @original_params.merge(params)
-        @block_params = values
-        catch(:pass) do
-          conditions.each { |c| throw :pass if c.bind(self).call == false }
-          block ? block[self, @block_params] : yield(self, @block_params)
-        end
+      return unless match = pattern.match(route)
+      values += match.captures.to_a.map { |v| force_encoding URI.decode(v) if v }
+
+      if values.any?
+        original, @params = params, params.merge('splat' => [], 'captures' => values)
+        keys.zip(values) { |k,v| (@params[k] ||= '') << v if v }
+      end
+
+      catch(:pass) do
+        conditions.each { |c| throw :pass if c.bind(self).call == false }
+        block ? block[self, values] : yield(self, values)
       end
     ensure
-      @params = @original_params
+      @params = original if original
     end
 
     # No matching route was found or all routes passed. The default
@@ -1350,21 +1350,34 @@ module Sinatra
 
       def setup_logging(builder)
         if logging?
-          builder.use Rack::CommonLogger
-          if logging.respond_to? :to_int
-            builder.use Rack::Logger, logging
-          else
-            builder.use Rack::Logger
-          end
+          setup_common_logger(builder)
+          setup_custom_logger(builder)
+        elsif logging == false
+          setup_null_logger(builder)
+        end
+      end
+
+      def setup_null_logger(builder)
+        builder.use Rack::NullLogger
+      end
+
+      def setup_common_logger(builder)
+        return if ["development", "deployment", nil].include? ENV["RACK_ENV"]
+        builder.use Rack::CommonLogger
+      end
+
+      def setup_custom_logger(builder)
+        if logging.respond_to? :to_int
+          builder.use Rack::Logger, logging
         else
-          builder.use Rack::NullLogger
+          builder.use Rack::Logger
         end
       end
 
       def setup_protection(builder)
         return unless protection?
         options = Hash === protection ? protection.dup : {}
-        options[:except] = Array(options[:except] || :escaped_params)
+        options[:except] = Array options[:except]
         options[:except] += [:session_hijacking, :remote_token] unless sessions?
         builder.use Rack::Protection, options
       end

data/lib/sinatra/main.rb

@@ -13,11 +13,11 @@ module Sinatra
     if run? && ARGV.any?
       require 'optparse'
       OptionParser.new { |op|
-        op.on('-x')        {       set :lock, true }
-        op.on('-e env')    { |val| set :environment, val.to_sym }
-        op.on('-s server') { |val| set :server, val }
-        op.on('-p port')   { |val| set :port, Integer(val) }
-        op.on('-o addr')   { |val| set :bind, val }
+        op.on('-p port',   'set the port (default is 4567)')                { |val| set :port, Integer(val) }
+        op.on('-o addr',   'set the host (default is 0.0.0.0)')             { |val| set :bind, val }
+        op.on('-e env',    'set the environment (default is development)')  { |val| set :environment, val.to_sym }
+        op.on('-s server', 'specify rack server/handler (default is thin)') { |val| set :server, val }
+        op.on('-x',        'turn on the mutex lock (default is off)')       {       set :lock, true }
       }.parse!(ARGV.dup)
     end
   end

data/lib/sinatra/version.rb

@@ -1,3 +1,3 @@
 module Sinatra
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
 end

data/sinatra.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new 'sinatra', Sinatra::VERSION do |s|
   s.extra_rdoc_files  = s.files.select { |p| p =~ /^README/ } << 'LICENSE'
   s.rdoc_options      = %w[--line-numbers --inline-source --title Sinatra --main README.rdoc]
 
-  s.add_dependency 'rack',            '~> 1.3', '>= 1.3.4'
-  s.add_dependency 'rack-protection', '~> 1.1', '>= 1.1.2'
+  s.add_dependency 'rack',            '~> 1.3', '>= 1.3.6'
+  s.add_dependency 'rack-protection', '~> 1.2'
   s.add_dependency 'tilt',            '~> 1.3', '>= 1.3.3'
 end

data/test/coffee_test.rb

@@ -71,7 +71,7 @@ class CoffeeTest < Test::Unit::TestCase
   it "passes coffee options to the coffee engine" do
     coffee_app { coffee "alert 'Aye!'\n", :no_wrap => true }
     assert ok?
-    assert_equal "alert('Aye!');", body
+    assert_body "alert('Aye!');"
   end
 
   it "passes default coffee options to the coffee engine" do
@@ -83,7 +83,7 @@ class CoffeeTest < Test::Unit::TestCase
     end
     get '/'
     assert ok?
-    assert_equal "alert('Aye!');", body
+    assert_body "alert('Aye!');"
   end
 end
 

data/test/filter_test.rb

@@ -380,6 +380,26 @@ class AfterFilterTest < Test::Unit::TestCase
     assert ran
   end
 
+  it 'can add params' do
+    mock_app do
+      before { params['foo'] = 'bar' }
+      get('/') { params['foo'] }
+    end
+
+    get '/'
+    assert_body 'bar'
+  end
+
+  it 'can remove params' do
+    mock_app do
+      before { params.delete('foo') }
+      get('/') { params['foo'].to_s }
+    end
+
+    get '/?foo=bar'
+    assert_body ''
+  end
+
   it 'is possible to apply user_agent conditions to after filters with no path' do
     ran = false
     mock_app do

data/test/helper.rb

@@ -69,7 +69,11 @@ class Test::Unit::TestCase
   end
 
   def assert_body(value)
-    assert_equal value.lstrip.gsub(/\s*\n\s*/, ""), body.lstrip.gsub(/\s*\n\s*/, "")
+    if value.respond_to? :to_str
+      assert_equal value.lstrip.gsub(/\s*\n\s*/, ""), body.lstrip.gsub(/\s*\n\s*/, "")
+    else
+      assert_match value, body
+    end
   end
 
   def assert_status(expected)

data/test/helpers_test.rb

@@ -1711,6 +1711,16 @@ class HelpersTest < Test::Unit::TestCase
       assert !io.string.include?("INFO -- : Program started")
       assert !io.string.include?("WARN -- : Nothing to do")
     end
+
+    it 'does not create a logger when logging is set to nil' do
+      mock_app do
+        set :logging, nil
+        get('/') { logger.inspect }
+      end
+
+      get '/'
+      assert_body 'nil'
+    end
   end
 
   module ::HelperOne; def one; '1'; end; end

data/test/integration/app.rb

@@ -0,0 +1,6 @@
+require 'sinatra'
+
+get '/app_file' do
+  content_type :txt
+  settings.app_file
+end

data/test/integration_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../helper', __FILE__)
+require 'rbconfig'
+require 'open-uri'
+require 'timeout'
+
+class IntegrationTest < Test::Unit::TestCase
+  def app_file
+    File.expand_path('../integration/app.rb', __FILE__)
+  end
+
+  def port
+    5000 + (Process.pid % 1000)
+  end
+
+  def command
+    cmd = ['exec']
+    if RbConfig.respond_to? :ruby
+      cmd << RbConfig.ruby.inspect
+    else
+      file, dir = RbConfig::CONFIG.values_at('ruby_install_name', 'bindir')
+      cmd << File.expand_path(file, dir).inspect
+    end
+    cmd << "-I" << File.expand_path('../../lib', __FILE__).inspect
+    cmd << app_file.inspect << '-p' << port << '2>&1'
+    cmd.join(" ")
+  end
+
+  def display_output(pipe)
+    out = ""
+    loop { out <<  pipe.read_nonblock(1) }
+  rescue
+    $stderr.puts command, out unless out.empty?
+  end
+
+  def kill(pid, signal = "TERM")
+    Process.kill(signal, pid)
+  rescue NotImplementedError
+    system "kill -s #{signal} #{pid}"
+  end
+
+  def with_server
+    pipe = IO.popen(command)
+    error = nil
+    Timeout.timeout(120) do
+      begin
+        yield
+      rescue Errno::ECONNREFUSED => e
+        error = e
+        sleep 0.1
+        retry
+      end
+    end
+    kill(pipe.pid) if pipe
+  rescue Timeout::Error => e
+    display_output pipe
+    kill(pipe.pid, "KILL") if pipe
+    raise error || e
+  end
+
+  it 'starts a top level application' do
+    with_server do
+      assert_equal open("http://127.0.0.1:#{port}/app_file").read, app_file
+    end
+  end
+end

data/test/less_test.rb

@@ -16,7 +16,7 @@ class LessTest < Test::Unit::TestCase
   it 'renders inline Less strings' do
     less_app { less "@white_color: #fff; #main { background-color: @white_color }" }
     assert ok?
-    assert_body "#main {background-color: #ffffff;}"
+    assert_equal "#main{background-color:#ffffff;}", body.gsub(/\s/, "")
   end
 
   it 'defaults content type to css' do
@@ -45,13 +45,13 @@ class LessTest < Test::Unit::TestCase
   it 'renders .less files in views path' do
     less_app { less :hello }
     assert ok?
-    assert_body "#main {background-color: #ffffff;}"
+    assert_equal "#main{background-color:#ffffff;}", body.gsub(/\s/, "")
   end
 
   it 'ignores the layout option' do
     less_app { less :hello, :layout => :layout2 }
     assert ok?
-    assert_body "#main {background-color: #ffffff;}"
+    assert_equal "#main{background-color:#ffffff;}", body.gsub(/\s/, "")
   end
 
   it "raises error if template not found" do

data/test/rdoc_test.rb

@@ -1,6 +1,7 @@
 require File.expand_path('../helper', __FILE__)
 
 begin
+require 'rdoc'
 require 'rdoc/markup/to_html'
 
 class RdocTest < Test::Unit::TestCase
@@ -15,13 +16,13 @@ class RdocTest < Test::Unit::TestCase
   it 'renders inline rdoc strings' do
     rdoc_app { rdoc '= Hiya' }
     assert ok?
-    assert_body "<h1>Hiya</h1>"
+    assert_body /<h1[^>]*>Hiya<\/h1>/
   end
 
   it 'renders .rdoc files in views path' do
     rdoc_app { rdoc :hello }
     assert ok?
-    assert_body "<h1>Hello From RDoc</h1>"
+    assert_body /<h1[^>]*>Hello From RDoc<\/h1>/
   end
 
   it "raises error if template not found" do

data/test/static_test.rb

@@ -36,7 +36,6 @@ class StaticTest < Test::Unit::TestCase
     head "/#{File.basename(__FILE__)}"
     assert ok?
     assert_equal '', body
-    assert_equal File.size(__FILE__).to_s, response['Content-Length']
     assert response.headers.include?('Last-Modified')
   end
 

data/test/streaming_test.rb

@@ -112,4 +112,12 @@ class StreamingTest < Test::Unit::TestCase
     stream = Stream.new { |out| out.callback { out.close }}
     stream.each { |str| }
   end
+
+  it 'gives access to route specific params' do
+    mock_app do
+      get('/:name') { stream { |o| o << params[:name] }}
+    end
+    get '/foo'
+    assert_body 'foo'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -12,11 +12,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-05 00:00:00.000000000Z
+date: 2011-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2156366140 !ruby/object:Gem::Requirement
+  requirement: &2153237200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -24,27 +24,24 @@ dependencies:
         version: '1.3'
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 1.3.6
   type: :runtime
   prerelease: false
-  version_requirements: *2156366140
+  version_requirements: *2153237200
 - !ruby/object:Gem::Dependency
   name: rack-protection
-  requirement: &2156364800 !ruby/object:Gem::Requirement
+  requirement: &2153236060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2156364800
+  version_requirements: *2153236060
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2156363420 !ruby/object:Gem::Requirement
+  requirement: &2153235320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +52,7 @@ dependencies:
         version: 1.3.3
   type: :runtime
   prerelease: false
-  version_requirements: *2156363420
+  version_requirements: *2153235320
 description: Sinatra is a DSL for quickly creating web applications in Ruby with minimal
   effort.
 email: sinatrarb@googlegroups.com
@@ -90,6 +87,9 @@ files:
 - README.ru.rdoc
 - README.zh.rdoc
 - Rakefile
+- examples/chat.rb
+- examples/simple.rb
+- examples/stream.ru
 - lib/sinatra.rb
 - lib/sinatra/base.rb
 - lib/sinatra/images/404.png
@@ -111,6 +111,8 @@ files:
 - test/haml_test.rb
 - test/helper.rb
 - test/helpers_test.rb
+- test/integration/app.rb
+- test/integration_test.rb
 - test/less_test.rb
 - test/liquid_test.rb
 - test/mapped_error_test.rb
@@ -196,12 +198,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2805773660361067313
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2805773660361067313
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -220,6 +228,7 @@ test_files:
 - test/filter_test.rb
 - test/haml_test.rb
 - test/helpers_test.rb
+- test/integration_test.rb
 - test/less_test.rb
 - test/liquid_test.rb
 - test/mapped_error_test.rb