sinatra 1.2.6 → 1.2.7

data/CHANGES

@@ -1,3 +1,36 @@
+= 1.2.7 (backports release) / Not Yet Released
+
+Custom changes:
+
+ * Fix Ruby 1.8.6 issue with Accept header parsing. (Konstantin Haase)
+
+Backported from 1.3.0:
+
+ * Ignore `to_ary` on response bodies. Fixes compatibility to Rails 3.1.
+   (Konstantin Haase)
+
+ * `Sinatra.run!` now prints to stderr rather than stdout. (Andrew Armenia)
+
+ * Automatic `app_file` detection now works in directories containing brackets
+   (Konstantin Haase)
+
+ * Improved documentation. (Emanuele Vicentini, Peter Higgins, Takanori
+   Ishikawa, Konstantin Haase)
+
+ * Also specify charset in Content-Type header for JSON. (Konstantin Haase)
+
+ * Rack handler names will not be converted to lower case internally, this
+   allows you to run Sinatra with custom Rack handlers, like Kirk or Mongrel2.
+   Example: `ruby app.rb -s Mongrel2` (Konstantin Haase)
+
+ * Fix uninitialized instance variable warning. (David Kellum)
+
+ * Command line options now complain if value passed to `-p` is not a valid
+   integer. (Konstantin Haase)
+
+ * Fix handling of broken query params when displaying exceptions. (Luke
+   Jahnke)
+
 = 1.2.6 / 2011-05-01
 
  * Fix broken delegation, backport delegation tests from Sinatra 1.3.
@@ -130,7 +163,7 @@
  * Sinatra now ships with a Gemfile for development dependencies, since it eases
    supporting different platforms, like JRuby. (Konstantin Haase)
 
-= 1.1.4 / 2011-04-13
+= 1.1.4 (backports release) / 2011-04-13
 
  * Compatible with Tilt 1.3. (Konstantin Haase)
 

data/Gemfile

@@ -7,38 +7,40 @@
 # If you have issues with a gem: `bundle install --without-coffee-script`.
 
 RUBY_ENGINE = 'ruby' unless defined? RUBY_ENGINE
-TILT_REPO = "git://github.com/rtomayko/tilt.git"
-
 source :rubygems unless ENV['QUICK']
-gemspec
 
-gem 'rake'
+gem 'rake', '~> 0.8.7'
 gem 'rack-test', '>= 0.5.6'
+gem 'ci_reporter', :group => :ci
 
 # Allows stuff like `tilt=1.2.2 bundle install` or `tilt=master ...`.
 # Used by the CI.
-tilt = (ENV['tilt'] || 'stable').dup
-tilt.sub! 'tilt-', ''
-if tilt != 'stable'
-  tilt = {:git => TILT_REPO, :branch => tilt} unless tilt =~ /(\d+\.)+\d+/
-  gem 'tilt', tilt
+github = "git://github.com/%s.git"
+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 ||= '~> 1.1.0' if lib == 'rack' and RUBY_VERSION == '1.8.6'
+  gem lib, dep
 end
 
-gem 'haml', '>= 3.0', :group => 'haml'
+gem 'haml', '~> 3.0.0', :group => 'haml'
 gem 'builder', :group => 'builder'
 gem 'erubis', :group => 'erubis'
-gem 'less', :group => 'less'
+gem 'less', '~> 1.0', :group => 'less'
 gem 'liquid', :group => 'liquid'
-gem 'nokogiri', :group => 'nokogiri'
 gem 'slim', :group => 'slim'
-gem 'RedCloth', :group => 'redcloth'
-
+gem 'RedCloth', :group => 'redcloth' if RUBY_VERSION < "1.9.3" and RUBY_ENGINE != 'macruby'
 
 if RUBY_VERSION > '1.8.6'
+  if RUBY_ENGINE == 'jruby'
+    gem 'nokogiri', '!= 1.5.0'
+  elsif RUBY_ENGINE != 'maglev'
+    gem 'nokogiri'
+  end
   gem 'coffee-script', '>= 2.0', :group => 'coffee-script'
   gem 'rdoc', :group => 'rdoc'
-else
-  gem 'rack', '~> 1.1.0'
 end
 
 platforms :ruby do

data/README.de.rdoc

@@ -947,7 +947,7 @@ Vergleichbar mit +body+ lassen sich auch Status-Code und Header setzen:
   get '/foo' do
     status 418
     headers \
-      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN"
+      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN",
       "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
     halt "Ich bin ein Teekesselchen"
   end
@@ -1018,7 +1018,7 @@ Um Argumente an ein Redirect weiterzugeben, können sie entweder dem Query
 
 oder eine Session verwendet werden:
 
-  enable :session
+  enable :sessions
   
   get '/foo' do
     session[:secret] = 'foo'
@@ -1561,7 +1561,7 @@ Oder über eine <tt>config.ru</tt>-Datei, die es erlaubt, einen beliebigen
 Rack-Handler zu verwenden:
 
   # config.ru
-  require 'mein_app'
+  require './mein_app'
   run MeineApp
 
 Starte:
@@ -1582,7 +1582,7 @@ Schreibe eine Anwendungsdatei:
 
 sowie eine dazugehörige <tt>config.ru</tt>-Datei:
 
-  require 'app'
+  require './app'
   run Sinatra::Application
 
 

data/README.es.rdoc

@@ -916,7 +916,7 @@ De manera similar, también podés asignar el código de estado y encabezados:
   get '/foo' do
     status 418
     headers \
-      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN"
+      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN",
       "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
     body "I'm a tea pot!"
   end
@@ -983,7 +983,7 @@ búsqueda:
 
 O usar una sesión:
 
-  enable :session
+  enable :sessions
 
   get '/foo' do
     session[:secreto] = 'foo'
@@ -1560,7 +1560,7 @@ Iniciar con:
 O, con un archivo <tt>config.ru</tt>, que permite usar cualquier handler Rack:
 
   # config.ru
-  require 'mi_app'
+  require './mi_app'
   run MiApp
 
 Después ejecutar:
@@ -1580,7 +1580,7 @@ Escribí el archivo de tu aplicación:
 
 Y el <tt>config.ru</tt> correspondiente:
 
-  require 'app'
+  require './app'
   run Sinatra::Application
 
 === ¿Cuándo Usar config.ru?

data/README.fr.rdoc

@@ -940,7 +940,7 @@ retour et les entêtes :
   get '/foo' do
     status 418
     headers \
-      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN"
+      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN",
       "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
     body "I'm a tea pot!"
   end
@@ -1008,7 +1008,7 @@ Pour passer des arguments à une redirection, ajoutez-les soit à la requête :
 
 Ou bien utilisez une session :
 
-  enable :session
+  enable :sessions
 
   get '/foo' do
     session[:secret] = 'foo'
@@ -1595,7 +1595,7 @@ Ou alors avec un fichier <tt>config.ru</tt>, qui permet d'utiliser n'importe
 quel gestionnaire Rack :
 
   # config.ru
-  require 'my_app'
+  require './my_app'
   run MyApp
 
 Exécutez :
@@ -1615,7 +1615,7 @@ Ecrivez votre application :
 
 Et un fichier <tt>config.ru</tt> correspondant :
 
-  require 'app'
+  require './app'
   run Sinatra::Application
 
 === Quand utiliser un fichier config.ru ?

data/README.jp.rdoc

@@ -67,6 +67,12 @@ Sinatraでは、ルートはHTTPメソッドとURLマッチングパターンが
     params[:splat] # => ["path/to/file", "xml"]
   end
 
+ブロックパラーメータを使用した場合:
+
+  get '/download/*.*' do |path, ext|
+    [path, ext] # => ["path/to/file", "xml"]
+  end
+
 正規表現を使ったルート:
 
   get %r{/hello/([\w]+)} do
@@ -990,7 +996,7 @@ Sinatraの開発版を使いたい場合は、ローカルに開発版を落と
   git clone git://github.com/sinatra/sinatra.git
   ruby -Isinatra/lib myapp.rb
 
-<tt>sinatra/lib</tt>ディレクトリをto the<tt>LOAD_PATH</tt>に追加する方法もあります。
+<tt>sinatra/lib</tt>ディレクトリをアプリケーションの<tt>LOAD_PATH</tt>に追加する方法もあります。
 
   $LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib'
   require 'rubygems'

data/README.rdoc

@@ -1,5 +1,8 @@
 = Sinatra
 
+<i>This is a backports release. If you have no reason to remain at Sinatra 1.2,
+please consider upgrading.</i>
+
 Sinatra is a DSL for quickly creating web applications in Ruby with minimal
 effort:
 
@@ -76,6 +79,12 @@ via the <tt>params[:splat]</tt> array:
     params[:splat] # => ["path/to/file", "xml"]
   end
 
+Or with block parameters:
+
+  get '/download/*.*' do |path, ext|
+    [path, ext] # => ["path/to/file", "xml"]
+  end
+
 Route matching with Regular Expressions:
 
   get %r{/hello/([\w]+)} do
@@ -88,6 +97,12 @@ Or with a block parameter:
     "Hello, #{c}!"
   end
 
+Route patterns may have optional parameters:
+
+  get '/posts.?:format?' do
+    # matches "GET /posts" and any extension "GET /posts.json", "GET /posts.xml" etc.
+  end
+
 === Conditions
 
 Routes may include a variety of matching conditions, such as the user agent:
@@ -125,7 +140,25 @@ You can easily define your own conditions:
   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 
+      end
+    end
+  end
 
+  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
@@ -626,7 +659,7 @@ 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= bar.name', :locals => { :bar => foo }
   end
 
 This is typically used when rendering templates as partials from within
@@ -785,9 +818,9 @@ session hash per user session:
 
 Note that <tt>enable :sessions</tt> actually stores all data in a cookie. This
 might not always be what you want (storing lots of data will increase your
-traffic, for instance). You can use any Rack session middleware, in order to
+traffic, for instance). You can use any Rack session middleware: in order to
 do so, do *not* call <tt>enable :sessions</tt>, but instead pull in your
-middleware of choice how you would any other middleware:
+middleware of choice as you would any other middleware:
 
   use Rack::Session::Pool, :expire_after => 2592000
 
@@ -895,7 +928,7 @@ Similar to the body, you can also set the status code and headers:
   get '/foo' do
     status 418
     headers \
-      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN"
+      "Allow"   => "BREW, POST, GET, PROPFIND, WHEN",
       "Refresh" => "Refresh: 20; http://www.ietf.org/rfc/rfc2324.txt"
     body "I'm a tea pot!"
   end
@@ -908,7 +941,9 @@ their current values.
 When using <tt>send_file</tt> or static files you may have mime types Sinatra
 doesn't understand. Use +mime_type+ to register them by file extension:
 
-  mime_type :foo, 'text/foo'
+  configure do
+    mime_type :foo, 'text/foo'
+  end
 
 You can also use it with the +content_type+ helper:
 
@@ -959,7 +994,7 @@ To pass arguments with a redirect, either add them to the query:
 
 Or use a session:
 
-  enable :session
+  enable :sessions
   
   get '/foo' do
     session[:secret] = 'foo'
@@ -1392,10 +1427,16 @@ debugging, URL routing, authentication, and session handling. Sinatra uses
 many of these components automatically based on configuration so you
 typically don't have to +use+ them explicitly.
 
+You can find useful middleware in
+{rack}[https://github.com/rack/rack/tree/master/lib/rack],
+{rack-contrib}[https://github.com/rack/rack-contrib#readme],
+with {CodeRack}[http://coderack.org/] or in the
+{Rack wiki}[https://github.com/rack/rack/wiki/List-of-Middleware].
+
 == Testing
 
 Sinatra tests can be written using any Rack-based testing library
-or framework. {Rack::Test}[http://gitrdoc.com/brynary/rack-test] is
+or framework. {Rack::Test}[http://rdoc.info/github/brynary/rack-test/master/frames] is
 recommended:
 
   require 'my_sinatra_app'
@@ -1425,9 +1466,6 @@ recommended:
     end
   end
 
-NOTE: The built-in Sinatra::Test module and Sinatra::TestHarness class
-are deprecated as of the 0.9.2 release.
-
 == Sinatra::Base - Middleware, Libraries, and Modular Apps
 
 Defining your app at the top-level works well for micro-apps but has
@@ -1435,8 +1473,8 @@ considerable drawbacks when building reusable components such as Rack
 middleware, Rails metal, simple libraries with a server component, or
 even Sinatra extensions. The top-level DSL pollutes the Object namespace
 and assumes a micro-app style configuration (e.g., a single application
-file, ./public and ./views directories, logging, exception detail page,
-etc.). That's where Sinatra::Base comes into play:
+file, <tt>./public</tt> and <tt>./views</tt> directories, logging, exception
+detail page, etc.). That's where <tt>Sinatra::Base</tt> comes into play:
 
   require 'sinatra/base'
 
@@ -1449,15 +1487,15 @@ etc.). That's where Sinatra::Base comes into play:
     end
   end
 
-The methods available to Sinatra::Base subclasses are exactly as those
+The methods available to <tt>Sinatra::Base</tt> subclasses are exactly as those
 available via the top-level DSL. Most top-level apps can be converted to
-Sinatra::Base components with two modifications:
+<tt>Sinatra::Base</tt> components with two modifications:
 
 * Your file should require <tt>sinatra/base</tt> instead of +sinatra+;
   otherwise, all of Sinatra's DSL methods are imported into the main
   namespace.
 * Put your app's routes, error handlers, filters, and options in a subclass
-  of Sinatra::Base.
+  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]
@@ -1512,7 +1550,7 @@ Start with:
 Or with a <tt>config.ru</tt>, which allows using any Rack handler:
 
   # config.ru
-  require 'my_app'
+  require './my_app'
   run MyApp
 
 Run:
@@ -1532,7 +1570,7 @@ Write your app file:
 
 And a corresponding <tt>config.ru</tt>:
 
-  require 'app'
+  require './app'
   run Sinatra::Application
 
 === When to use a config.ru?
@@ -1563,7 +1601,7 @@ application (Rails/Ramaze/Camping/...):
     get('/login') { haml :login }
     
     post('/login') do
-      if params[:name] = 'admin' and params[:password] = 'admin'
+      if params[:name] == 'admin' && params[:password] == 'admin'
         session['user_name'] = params[:name]
       else
         redirect '/login'
@@ -1595,6 +1633,7 @@ assign them to a constant, you can do this with <tt>Sinatra.new</tt>:
 
 It takes the application to inherit from as optional argument:
 
+  # config.ru
   require 'sinatra/base'
 
   controller = Sinatra.new do
@@ -1630,9 +1669,9 @@ available.
 
 === Application/Class Scope
 
-Every Sinatra application corresponds to a subclass of Sinatra::Base. If you
+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
-Sinatra::Application, otherwise it is the subclass you created explicitly. At
+<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 single application class
 for all requests.
@@ -1732,13 +1771,13 @@ It is recommended to install Sinatra on Ruby 1.8.7, 1.9.2, JRuby or Rubinius.
 The following Ruby versions are officially supported:
 
 [ Ruby 1.8.6 ]
-  It is not recommended to use 1.8.6 for Sinatra. However, it will be
-  officially supported until Sinatra 1.3.0 is released. RDoc and CoffeeScript
-  templates are not supported by this Ruby version. 1.8.6 includes a major
-  memory leak in its Hash implementation, which is triggered by Sinatra
-  versions prior to 1.1.1. The current version explicitly prevents this leak
-  at the cost of performance. You will have to downgrade Rack to 1.1.x, as
-  Rack >= 1.2 no longer supports 1.8.6.
+  It is not recommended to use 1.8.6 for Sinatra. However, it is still supported
+  in Sinatra 1.2 (this version), it has been dropped in Sinatra 1.3.0, though.
+  RDoc and CoffeeScript templates are not supported. 1.8.6 includes a major
+  memory leak in its Hash implementation, which is triggered by Sinatra versions
+  prior to 1.1.1. The current version explicitly prevents this leak at the cost
+  of performance. You will have to downgrade Rack to 1.1.x, as Rack >= 1.2 no
+  longer supports 1.8.6.
 
 [ Ruby 1.8.7 ]
   1.8.7 is fully supported, however, if nothing is keeping you from it, we