sinatra-base 1.0 → 1.4.0

data/.yardopts

@@ -0,0 +1,4 @@
+--readme README.rdoc
+--title 'Sinatra API Documentation'
+--charset utf-8
+'lib/**/*.rb' - '*.rdoc'

data/AUTHORS

@@ -36,8 +36,23 @@ Sinatra would not be possible:
 * Rick Olson (technoweenie) for the killer plug at RailsConf '08.
 * Steven Garcia for the amazing custom artwork you see on 404's and 500's
 * Pat Nakajima (nakajima) for fixing non-nested params in nested params Hash's.
+* Konstantin Haase for his hard work and ongoing commitment to improving
+  Sinatra, for 1.1.0, 1.2.0 and beyond..
+* Zachary Scott for adding Konstantin to the AUTHORS file. He also did help
+  writing the book, but mainly for adding Konstantin.
+* Gabriel Andretta for having people wonder whether our documentation is
+  actually in English or in Spanish.
+* Vasily Polovnyov, Nickolay Schwarz, Luciano Sousa, Wu Jiang, Mickael Riga,
+  Bernhard Essl, Janos Hardi, Kouhei Yanagita and "burningTyger" for willingly
+  translating whatever ends up in the README.
+* [Wordy](http://www.wordy.com/) for proofreading our README. 73e137d
+* cactus for digging through code and specs, multiple times.
+* Nicolás Sanguinetti (foca) for strong demand of karma and shaping
+  helpers/register.
 
 and last but not least:
 
 * Frank Sinatra (chairman of the board) for having so much class he
   deserves a web-framework named after him.
+
+For a complete list of all contributors to Sinatra itself, run `rake authors`.

data/CHANGES

@@ -1,4 +1,527 @@
-= 1.0 / 2010-01-28 (prerelease)
+= 1.4.0 / Not Yet Released
+
+ * Add support for Yajl templates. (Jamie Hodge)
+
+ * No longer include Sinatra::Delegator in Object, instead extend the main
+   object only. (Konstantin Haase)
+
+ * Add :status option support to send_file. (Konstantin Haase)
+
+ * The `provides` condition now respects an earlier set content type.
+   (Konstantin Haase)
+
+ * Exception#code is only used when :use_code is enabled and displays a warning.
+   Moreover, it will be ignored if the value is not between 400 and 599. You
+   should use Exception#http_status instead. (Konstantin Haase)
+
+ * Status, headers and body will be set correctly in an after filter when using
+   halt in a before filter or route. (Konstantin Haase)
+
+= 1.3.3 / Not Yet Released
+
+ * When keeping a stream open, set up callback/errback correctly to deal with
+   clients closing the connection. (Konstantin Haase)
+
+= 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
+   Sent Events or even WebSockets. See README for more on that topic.
+   (Konstantin Haase)
+
+ * If a HTTP 1.1 client is redirected from a different verb than GET, use 303
+   instead of 302 by default. You may still pass 302 explicitly. Fixes AJAX
+   redirects in Internet Explorer 9 (to be fair, everyone else is doing it
+   wrong and IE is behaving correct). (Konstantin Haase)
+
+ * Added support for HTTP PATCH requests. (Konstantin Haase)
+
+ * Use rack-protection to defend against common opportunistic attacks.
+   (Josh Lane, Jacob Burkhart, Konstantin Haase)
+
+ * Support for Creole templates, Creole is a standardized wiki markup,
+   supported by many wiki implementations. (Konstanin Haase)
+
+ * The `erubis` method has been deprecated. If Erubis is available, Sinatra
+   will automatically use it for rendering ERB templates. `require 'erb'`
+   explicitly to prevent that behavior. (Magnus Holm, Ryan Tomayko, Konstantin
+   Haase)
+
+ * Patterns now match against the escaped URLs rather than the unescaped
+   version. This makes Sinatra confirm with RFC 2396 section 2.2 and RFC 2616
+   section 3.2.3 (escaped reserved characters should not be treated like the
+   unescaped version), meaning that "/:name" will also match `/foo%2Fbar`, but
+   not `/foo/bar`. To avoid incompatibility, pattern matching has been
+   adjusted. Moreover, since we do no longer need to keep an unescaped version
+   of path_info around, we handle all changes to `env['PATH_INFO']` correctly.
+   (Konstantin Haase)
+
+ * `settings.app_file` now defaults to the file subclassing `Sinatra::Base` in
+   modular applications. (Konstantin Haase)
+
+ * Set up `Rack::Logger` or `Rack::NullLogger` depending on whether logging
+   was enabled or not. Also, expose that logger with the `logger` helper
+   method. (Konstantin Haase)
+
+ * The sessions setting may be an options hash now. (Konstantin Haase)
+
+ * Important: Ruby 1.8.6 support has been dropped. This version also depends
+   on at least Rack 1.3.0. This means that it is incompatible with Rails prior
+   to 3.1.0. Please use 1.2.x if you require an earlier version of Ruby or
+   Rack, which we will continue to supply with bug fixes. (Konstantin Haase)
+
+ * Renamed `:public` to `:public_folder` to avoid overriding Ruby's built-in
+   `public` method/keyword. `set(:public, ...)` is still possible but shows a
+   warning. (Konstantin Haase)
+
+ * It is now possible to use a different target class for the top level DSL
+   (aka classic style) than `Sinatra::Application` by setting
+   `Delegator.target`. This was mainly introduced to ease testing. (Konstantin
+   Haase)
+
+ * Error handlers defined for an error class will now also handle subclasses
+   of that class, unless more specific error handlers exist. (Konstantin
+   Haase)
+
+ * Error handling respects Exception#code, again. (Konstantin Haase)
+
+ * Changing a setting will merge hashes: `set(:x, :a => 1); set(:x :b => 2)`
+   will result in `{:a => 1, :b => 2}`. Use `set(:x, {:a => 1}, true)` to
+   avoid this behavior. (Konstantin Haase)
+
+ * Added `request.accept?` and `request.preferred_type` to ease dealing with
+   `Accept` headers. (Konstantin Haase)
+
+ * Added `:static_cache_control` setting to automatically set cache control
+   headers to static files. (Kenichi Nakamura)
+
+ * Added `informal?`, `success?`, `redirect?`, `client_error?`,
+   `server_error?` and `not_found?` helper methods to ease dealing with status
+   codes. (Konstantin Haase)
+
+ * Uses SecureRandom to generate default session secret. (Konstantin Haase)
+
+ * The `attachment` helper will set Content-Type (if it hasn't been set yet)
+   depending on the supplied file name. (Vasiliy Ermolovich)
+
+ * Conditional requests on `etag` helper now work properly for unsafe HTTP
+   methods. (Matthew Schinckel, Konstantin Haase)
+
+ * The `last_modified` helper does not stop execution and change the status code
+   if the status code is something different than 200. (Konstantin Haase)
+
+ * Added support for If-Unmodified-Since header. (Konstantin Haase)
+
+ * `Sinatra::Base.run!` now prints to stderr rather than stdout. (Andrew
+   Armenia)
+
+ * `Sinatra::Base.run!` takes a block allowing access to the Rack handler.
+   (David Waite)
+
+ * Automatic `app_file` detection now works in directories containing brackets
+   (Konstantin Haase)
+
+ * Exception objects are now passed to error handlers. (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)
+
+ * Ignore `to_ary` on response bodies. Fixes compatibility to Rails 3.1.
+   (Konstantin Haase)
+
+ * Middleware setup is now distributed across multiple methods, allowing
+   Sinatra extensions to easily hook into the setup process. (Konstantin
+   Haase)
+
+ * Internal refactoring and minor performance improvements. (Konstantin Haase)
+
+ * Move Sinatra::VERSION to separate file, so it can be checked without
+   loading Sinatra. (Konstantin Haase)
+
+ * 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.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:
+
+ * 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.
+   (Konstantin Haase)
+
+= 1.2.5 / 2011-04-30
+
+ * Restore compatibility with Ruby 1.8.6. (Konstantin Haase)
+
+= 1.2.4 / 2011-04-30
+
+ * Sinatra::Application (classic style) does not use a session secret in
+   development mode, so sessions are not invalidated after every request when
+   using Shotgun. (Konstantin Haase)
+
+ * The request object was shared between multiple Sinatra instances in the
+   same middleware chain. This caused issues if any non-sinatra routing
+   happend in-between two of those instances, or running a request twice
+   against an application (described in the README). The caching was reverted.
+   See GH#239 and GH#256 for more infos. (Konstantin Haase)
+
+ * Fixes issues where the top level DSL was interfering with method_missing
+   proxies. This issue surfaced when Rails 3 was used with older Sass versions
+   and Sinatra >= 1.2.0. (Konstantin Haase)
+
+ * Sinatra::Delegator.delegate is now able to delegate any method names, even
+   those containing special characters. This allows better integration into
+   other programming languages on Rubinius (probably on the JVM, too), like
+   Fancy. (Konstantin Haase)
+
+ * Remove HEAD request logic and let Rack::Head handle it instead. (Paolo
+   "Nusco" Perrotta)
+
+= 1.2.3 / 2011-04-13
+
+ * This release is compatible with Tilt 1.3, it will still work with Tilt 1.2.2,
+   however, if you want to use a newer Tilt version, you have to upgrade to at
+   least this version of Sinatra. (Konstantin Haase)
+
+ * Helpers dealing with time, like `expires`, handle objects that pretend to be
+   numbers, like `ActiveSupport::Duration`, better. (Konstantin Haase)
+
+= 1.2.2 / 2011-04-08
+
+ * The `:provides => :js` condition now matches both `application/javascript`
+   and `text/javascript`. The `:provides => :xml` condition now matches both
+   `application/xml` and `text/xml`. The `Content-Type` header is set
+   accordingly. If the client accepts both, the `application/*` version is
+   preferred, since the `text/*` versions are deprecated. (Konstantin Haase)
+
+ * The `provides` condition now handles wildcards in `Accept` headers correctly.
+   Thus `:provides => :html` matches `text/html`, `text/*` and `*/*`.
+   (Konstantin Haase)
+
+ * When parsing `Accept` headers, `Content-Type` preferences are honored
+   according to RFC 2616 section 14.1. (Konstantin Haase)
+
+ * URIs passed to the `url` helper or `redirect` may now use any schema to be
+   identified as absolute URIs, not only `http` or `https`. (Konstantin Haase)
+
+ * Handles `Content-Type` strings that already contain parameters correctly in
+   `content_type` (example: `content_type "text/plain; charset=utf-16"`).
+   (Konstantin Haase)
+
+ * If a route with an empty pattern is defined (`get("") { ... }`) requests with
+   an empty path info match this route instead of "/". (Konstantin Haase)
+
+ * In development environment, when running under a nested path, the image URIs
+   on the error pages are set properly. (Konstantin Haase)
+
+= 1.2.1 / 2011-03-17
+
+ * Use a generated session secret when using `enable :sessions`. (Konstantin
+   Haase)
+
+ * Fixed a bug where the wrong content type was used if no content type was set
+   and a template engine was used with a different engine for the layout with
+   different default content types, say Less embedded in Slim. (Konstantin
+   Haase)
+
+ * README translations improved (Gabriel Andretta, burningTyger, Sylvain Desvé,
+   Gregor Schmidt)
+
+= 1.2.0 / 2011-03-03
+
+ * Added `slim` rendering method for rendering Slim templates. (Steve
+   Hodgkiss)
+
+ * The `markaby` rendering method now allows passing a block, making inline
+   usage possible. Requires Tilt 1.2 or newer. (Konstantin Haase)
+
+ * All render methods now take a `:layout_engine` option, allowing to use a
+   layout in a different template language. Even more useful than using this
+   directly (`erb :index, :layout_engine => :haml`) is setting this globally for
+   a template engine that otherwise does not support layouts, like Markdown or
+   Textile (`set :markdown, :layout_engine => :erb`). (Konstantin Haase)
+
+ * Before and after filters now support conditions, both with and without
+   patterns (`before '/api/*', :agent => /Songbird/`). (Konstantin Haase)
+
+ * Added a `url` helper method which constructs absolute URLs. Copes with
+   reverse proxies and Rack handlers correctly. Aliased to `to`, so you can
+   write `redirect to('/foo')`. (Konstantin Haase)
+
+ * If running on 1.9, patterns for routes and filters now support named
+   captures: `get(%r{/hi/(?<name>[^/?#]+)}) { "Hi #{params['name']}" }`.
+   (Steve Price)
+
+ * All rendering methods now take a `:scope` option, which renders them in
+   another context. Note that helpers and instance variables will be
+   unavailable if you use this feature. (Paul Walker)
+
+ * The behavior of `redirect` can now be configured with `absolute_redirects`
+   and `prefixed_redirects`. (Konstantin Haase)
+
+ * `send_file` now allows overriding the Last-Modified header, which defaults
+   to the file's mtime, by passing a `:last_modified` option. (Konstantin Haase)
+
+ * You can use your own template lookup method by defining `find_template`.
+   This allows, among other things, using more than one views folder.
+   (Konstantin Haase)
+
+ * Largely improved documentation. (burningTyger, Vasily Polovnyov, Gabriel
+   Andretta, Konstantin Haase)
+
+ * Improved error handling. (cactus, Konstantin Haase)
+
+ * Skip missing template engines in tests correctly. (cactus)
+
+ * Sinatra now ships with a Gemfile for development dependencies, since it eases
+   supporting different platforms, like JRuby. (Konstantin Haase)
+
+= 1.1.4 (backports release) / 2011-04-13
+
+ * Compatible with Tilt 1.3. (Konstantin Haase)
+
+= 1.1.3 / 2011-02-20
+
+ * Fixed issues with `user_agent` condition if the user agent header is missing.
+   (Konstantin Haase)
+
+ * Fix some routing tests that have been skipped by accident (Ross A. Baker)
+
+ * Fix rendering issues with Builder and Nokogiri (Konstantin Haase)
+
+ * Replace last_modified helper with better implementation. (cactus,
+   Konstantin Haase)
+
+ * Fix issue with charset not being set when using `provides` condition.
+   (Konstantin Haase)
+
+ * Fix issue with `render` not picking up all alternative file extensions for
+   a rendering engine - it was not possible to register ".html.erb" without
+   tricks. (Konstantin Haase)
+
+= 1.1.2 / 2010-10-25
+
+Like 1.1.1, but with proper CHANGES file.
+
+= 1.1.1 / 2010-10-25
+
+ * README has been translated to Russian (Nickolay Schwarz, Vasily Polovnyov)
+   and Portuguese (Luciano Sousa).
+
+ * Nested templates without a `:layout` option can now be used from the layout
+   template without causing an infinite loop. (Konstantin Haase)
+
+ * Inline templates are now encoding aware and can therefore be used with
+   unicode characters on Ruby 1.9. Magic comments at the beginning of the file
+   will be honored. (Konstantin Haase)
+
+ * Default `app_file` is set correctly when running with bundler. Using
+   bundler caused Sinatra not to find the `app_file` and therefore not to find
+   the `views` folder on it's own. (Konstantin Haase)
+
+ * Better handling of Content-Type when using `send_file`: If file extension
+   is unknown, fall back to `application/octet-stream` and do not override
+   content type if it has already been set, except if `:type` is passed
+   explicitly (Konstantin Haase)
+
+ * Path is no longer cached if changed between handlers that do pattern
+   matching. This means you can change `request.path_info` in a pattern
+   matching before filter. (Konstantin Haase)
+
+ * Headers set by cache_control now always set max_age as an Integer, making
+   sure it is compatible with RFC2616. (Konstantin Haase)
+
+ * Further improved handling of string encodings on Ruby 1.9, templates now
+   honor default_encoding and URLs support unicode characters. (Konstantin
+   Haase)
+
+= 1.1.0 / 2010-10-24
+
+ * Before and after filters now support pattern matching, including the
+   ability to use captures: "before('/user/:name') { |name| ... }". This
+   avoids manual path checking. No performance loss if patterns are avoided.
+   (Konstantin Haase)
+
+ * It is now possible to render SCSS files with the `scss` method, which
+   behaves exactly like `sass` except for the different file extension and
+   assuming the SCSS syntax. (Pedro Menezes, Konstantin Haase)
+
+ * Added `liquid`, `markdown`, `nokogiri`, `textile`, `rdoc`, `radius`,
+   `markaby`, and `coffee` rendering methods for rendering Liquid, Markdown,
+   Nokogiri, Textile, RDoc, Radius, Markaby and CoffeeScript templates.
+   (Konstantin Haase)
+
+ * Now supports byte-range requests (the HTTP_RANGE header) for static files.
+   Multi-range requests are not supported, however. (Jens Alfke)
+
+ * You can now use #settings method from class and top level for convenience.
+   (Konstantin Haase)
+
+ * Setting multiple values now no longer relies on #to_hash and therefore
+   accepts any Enumerable as parameter. (Simon Rozet)
+
+ * Nested templates default the `layout` option to `false` rather than `true`.
+   This eases the use of partials. If you wanted to render one haml template
+   embedded in another, you had to call `haml :partial, {}, :layout => false`.
+   As you almost never want the partial to be wrapped in the standard layout
+   in this situation, you now only have to call `haml :partial`. Passing in
+   `layout` explicitly is still possible. (Konstantin Haase)
+
+ * If a the return value of one of the render functions is used as a response
+   body and the content type has not been set explicitly, Sinatra chooses a
+   content type corresponding to the rendering engine rather than just using
+   "text/html". (Konstantin Haase)
+
+ * README is now available in Chinese (Wu Jiang), French (Mickael Riga),
+   German (Bernhard Essl, Konstantin Haase, burningTyger), Hungarian (Janos
+   Hardi) and Spanish (Gabriel Andretta). The extremely outdated Japanese
+   README has been updated (Kouhei Yanagita).
+
+ * It is now possible to access Sinatra's template_cache from the outside.
+   (Nick Sutterer)
+
+ * The `last_modified` method now also accepts DateTime instances and makes
+   sure the header will always be set to a string. (Konstantin Haase)
+
+ * 599 now is a legal status code. (Steve Shreeve)
+
+ * This release is compatible with Ruby 1.9.2. Sinatra was trying to read
+   non existent files Ruby added to the call stack. (Shota Fukumori,
+   Konstantin Haase)
+
+ * Prevents a memory leak on 1.8.6 in production mode. Note, however, that
+   this is due to a bug in 1.8.6 and request will have the additional overhead
+   of parsing templates again on that version. It is recommended to use at
+   least Ruby 1.8.7. (Konstantin Haase)
+
+ * Compares last modified date correctly. `last_modified` was halting only
+   when the 'If-Modified-Since' header date was equal to the time specified.
+   Now, it halts when is equal or later than the time specified (Gabriel
+   Andretta).
+
+ * Sinatra is now usable in combination with Rails 3. When mounting a Sinatra
+   application under a subpath in Rails 3, the PATH_INFO is not prefixed with
+   a slash and no routes did match. (José Valim)
+
+ * Better handling of encodings in 1.9, defaults params encoding to UTF-8.
+   (Konstantin Haase)
+
+ * `show_exeptions` handling is now triggered after custom error handlers, if
+   it is set to `:after_handlers`, thus not disabling those handler in
+   development mode. (pangel, Konstantin Haase)
+
+ * Added ability to handle weighted HTTP_ACCEPT headers. (Davide D'Agostino)
+
+ * `send_file` now always respects the `:type` option if set. Previously it
+   was discarded if no matching mime type was found, which made it impossible
+   to directly pass a mime type. (Konstantin Haase)
+
+ * `redirect` always redirects to an absolute URI, even if a relative URI was
+   passed. Ensures compatibility with RFC 2616 section 14.30. (Jean-Philippe
+   Garcia Ballester, Anthony Williams)
+
+ * Broken examples for using Erubis, Haml and Test::Unit in README have been
+   fixed. (Nick Sutterer, Doug Ireton, Jason Stewart, Eric Marden)
+
+ * Sinatra now handles SIGTERM correctly. (Patrick Collison)
+
+ * Fixes an issue with inline templates in modular applications that manually
+   call `run!`. (Konstantin Haase)
+
+ * Spaces after inline template names are now ignored (Konstantin Haase)
+
+ * It's now possible to use Sinatra with different package management
+   systems defining a custom require. (Konstantin Haase)
+
+ * Lighthouse has been dropped in favor of GitHub issues.
+
+ * Tilt is now a dependency and therefore no longer ships bundled with
+   Sinatra. (Ryan Tomayko, Konstantin Haase)
+
+ * Sinatra now depends on Rack 1.1 or higher. Rack 1.0 is no longer supported.
+   (Konstantin Haase)
+
+= 1.0 / 2010-03-23
 
  * It's now possible to register blocks to run after each request using
    after filters. After filters run at the end of each request, after