roda 3.28.0 → 3.33.0

data/doc/release_notes/2.22.0.txt

@@ -1,41 +0,0 @@
-= New Features
-
-* An :unsupported_block_result => :raise option is now supported
-  for Roda applications.  This will raise a RodaError if an
-  unsupported value is returned from a match block or the
-  route block.  This can make it easier to discover potential
-  problems in the routing tree.  This option may become the
-  default behavior in Roda 3.
-
-* An :unsupported_matcher => :raise option is now supported for
-  Roda applications.  This will raise a RodaError if you use an
-  unsupported value as a matcher.  This can make it easier to
-  discover potential problems in the routing tree. This option
-  may become the default behavior in Roda 3.
-
-* A :verbatim_string_matcher option is now supported for Roda
-  applications.  This will make all string matchers only match
-  the path verbatim, disallowing the use of a colon for
-  placeholders in the string.  It's recommended that users
-  switch to using separate symbol arguments for placeholders.
-
-  If you enable this option, you need to change code such as:
-
-    r.is "foo/:bar" do |bar|
-    end
-
-  to:
-
-    r.is "foo", :bar do |bar|
-    end
-
-  If you are looking to convert an existing routing tree
-  from using placeholders in strings to separate symbol
-  arguments, you can scan your routing tree for potential
-  usage of placeholders in strings:
-
-    grep ' r\..*['\''"].*:.*['\''"]' app.rb
-
-  This option may become the default behavior in Roda 3, with
-  a plugin added to support the current default behavior of
-  allowing placeholders in string matchers.

data/doc/release_notes/2.23.0.txt

@@ -1,29 +0,0 @@
-= New Features
-
-* An :explicit_cache option has been added to the render plugin.
-  This is similar to the :cache=>false option, but instead of
-  disabling caching completely, this disables caching by default but
-  allows for explicit caching of templates by providing the :cache
-  option to view/render.
-
-  In development mode, Roda now defaults to :explicit_cache=>true
-  instead of :cache=>false.
-
-* An :inherit_cache option has been added to the render plugin,
-  making subclasses of that class start with a dup of the template
-  cache, instead of starting with an empty template cache.  This can
-  result in less memory used.
-
-* Roda#error_email in the error_email plugin now accepts non-Exception
-  arguments (such as strings).  This can be useful in conditions that
-  are errors you may want to notify about, where an exception hasn't
-  been raised.
-
-* Roda#error_email_content has been added to the error_email plugin.
-  This can be used to create the email message, which can be delivered
-  via another mechanism, and may make testing easier.
-
-= Other Improvements
-
-* Roda.freeze in the static_routing plugin now returns self, fixing
-  code such as Roda.freeze.app.

data/doc/release_notes/2.24.0.txt

@@ -1,65 +0,0 @@
-= New Features
-
-* The middleware plugin now accepts a block that can be used to
-  implement configurable middleware.  This allows you to load the
-  Roda application as middleware in another application, and provide
-  options/block that are passed to the block you passed when loading
-  the middleware plugin.  Example:
-
-    class Mid < Roda
-      plugin :middleware do |middleware, *args, &block|
-        middleware.opts[:middleware_args] = args
-        block.call(middleware)
-      end
-    end
-
-    class App < Roda
-      use Mid, :foo, :bar do |middleware|
-        middleware.opts[:middleware_args] << :baz
-      end
-    end
-
-  Note that when passing a block when loading the middleware plugin,
-  using the middleware in another rack application will actually
-  load a subclass of the middleware (Mid in the example above).
-  This allows you to use the Roda middleware multiple times in the
-  same process with different configurations.
-
-* The cookies plugin now accepts options that are used as the default
-  options when setting and deleting cookies:
-
-    plugin :cookies, :path => '/foo', :domain => 'example.com'
-
-* A strip_path_prefix plugin has been added, which can be used to
-  strip prefixes from internal paths.  Internally Sequel stores
-  most paths as absolute paths, but there are cases where this
-  doesn't work well, such as symlink changes and chroot.  This
-  plugin supports those scenarios.
-
-* A disallow_file_uploads plugin has been added, which raises
-  an exception if the user attempts a multipart file upload.
-  More exactly, it makes the application raise an exception if
-  attempting to parse a request body when the user has submitted
-  a multipart file upload.  This is useful if you don't need to
-  support file uploads in your application, or cases where no
-  paths are writable by the application (due to chroot or system call
-  filtering).
-
-* The :freeze_middleware option has been added, which freezes all
-  middleware instances when building the rack application.  This
-  can help find thread safety issues in middleware.
-
-= Other Improvements
-
-* The h plugin is now about 6x faster on ruby 2.3+ due to the use
-  of cgi/escape.
-
-* The static_routing plugin now works with the hooks plugin if the
-  hooks plugin is loaded first.
-
-* The render plugin's render cache is no longer cleared when loading
-  the plugin multiple times.
-
-= Backwards Compatibility
-
-* The h plugin now escapes ' as &#39; instead of &#x27;.

data/doc/release_notes/2.25.0.txt

@@ -1,14 +0,0 @@
-= New Features
-
-* An error_mail plugin has been added for reporting exceptions raised
-  via email.  This is similar to the existing error_email plugin, but
-  uses the mail library instead of net/smtp directly.  If you are
-  already using the mail library and the error_email plugin in your
-  application, it's recommended to switch to the error_mail plugin.
-  Example:
-
-    plugin :error_mail, :to=>'to@example.com', :from=>'from@example.com'
-    plugin :error_handler do |e|
-      error_mail(e)
-      'Internal Server Error'
-    end

data/doc/release_notes/2.26.0.txt

@@ -1,13 +0,0 @@
-= New Features
-
-* The csrf plugin now supports a :skip_middleware option, which adds
-  the methods without adding the middleware.  This is designed for
-  cases where you are using multiple rack apps, where the rack_csrf
-  middleware is loaded in an earlier rack app, and you want to avoid
-  the duplicate CSRF checks.
-
-= Other Improvements
-
-* The type_routing plugin now supports using multiple extensions
-  where one extension is a suffix of another extension, such as
-  using gz and tar.gz.

data/doc/release_notes/2.27.0.txt

@@ -1,56 +0,0 @@
-= New Features
-
-* String and Integer class matchers have been added.  The
-  String class matches any non-empty segment and yields it as a
-  string.  This is the same as the behavior of the symbol matchers,
-  but without the duplication.  So instead of:
-
-    r.is "album", :album_name do |album_name|
-    end
-
-  you can now do:
-
-    r.is "album", String do |album_name|
-    end
-
-  This makes it a bit more intuitive that you want to match
-  any string, and avoids the redundancy between the symbol
-  name and block argument name.
-
-  The Integer class matches any integer segment (\d+) and yields it
-  as an integer:
-
-    r.is "album", Integer do |album_id|
-      # does not match "/albums/foo"
-      # matches "/albums/1", yielding 1 (not "1")
-    end
-
-  Previously, the :d matcher in the symbol_matchers plugin could
-  be used to only match integer segments, but it yielded results
-  as strings and not integers, so you still needed to convert the
-  type manually.  Using Integer is a bit more intuitive than
-  using :d, and it handles the type conversion for you.
-
-* A class_matchers plugin has been added for matching additional
-  classes, with user-specified regexps and type conversion.  For
-  example, if you want to match YYYY-MM-DD segments and yield
-  them to the match blocks as ruby Date objects, you can do:
-
-    plugin :class_matchers
-
-    class_matcher(Date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
-      [Date.new(y.to_i, m.to_i, d.to_i)]
-    end
-
-  and then in your routing tree, you can do:
-
-    r.on "posts", Date do |date|
-      # does not match "/posts/foo" or "/posts/2017-01"
-      # matches "/posts/2017-01-13", yielding Date.new(2017, 1, 13)
-    end
-
-= Backwards Compatibility
-
-* If you were using the Integer and String classes as matchers
-  before and expected them to always match, you'll need to
-  change your code to use true instead.

data/doc/release_notes/2.28.0.txt

@@ -1,17 +0,0 @@
-= New Features
-
-* A status_303 plugin has been added, which changes the default
-  redirect status from 302 to 303 if the HTTP version is 1.1 and
-  the request is not a GET request.
-
-= Other Improvements
-
-* Roda is now optimized for ruby 2.3+ using frozen string literals
-  instead of constant references.  This improves performance on ruby
-  2.3+, and decreases performance on ruby <2.3.
-
-= Backwards Compatibility
-
-* Many now unused internal constants are now deprecated, and
-  attempting to access them will result in deprecation warnings
-  on ruby 2.3+.

data/doc/release_notes/2.29.0.txt

@@ -1,156 +0,0 @@
-= Deprecated Features
-
-Roda 2.29.0 will be the last minor release of Roda 2.  Roda 3.0.0
-will be released next month and will remove support for the following
-deprecated features.  All of these features will have deprecation
-warnings if used in Roda 2.29.0.
-
-* The use of placeholders in string matchers is now deprecated.
-  So code such as:
-
-    r.get "users/:user_id" do |id|
-    end
-
-  should be switched to using a class matcher such as String or
-  Integer:
-
-    r.get "users", Integer do |id|
-    end
-
-  or a symbol matcher:
-
-    r.get "users", :user_id do |id|
-    end
-
-  If you really want to keep support for placeholders in string
-  matchers, the support is available in the new
-  placeholder_string_matchers plugin.
-
-* The :format, :opt, and :optd default symbol matchers are now
-  deprecated in the symbol_matchers plugin.  These matchers
-  only made sense when placeholder string matchers are used,
-  which will no longer be the default behavior in Roda 3. These
-  methods can be defined manually if you are going to use the
-  placeholder_string_matchers plugin and still want to use
-  these symbol matchers:
-
-    symbol_matcher(:format, /(?:\.(\w+))?/)
-    symbol_matcher(:opt, /(?:\/([^\/]+))?/)
-    symbol_matcher(:optd, /(?:\/(\d+))?/)
-
-* Ignoring unsupported match block return values is now deprecated.
-  Doing so can hide errors and make debugging more difficult.  If you
-  get a deprecation warning related to this, just make sure the match
-  block returns nil or false to specify the match block return value
-  should be ignored.
-
-* Treating unsupported matchers as always matching is now deprecated.
-  Doing so can hide errors and make debugging more difficult. If you
-  get a deprecation warning related to this, switch the matcher to
-  true instead of an unsupported object.
-
-* The render plugin's handling of plugin level locals and merging of
-  template and layout locals is now deprecated.  Users of these
-  features should switch to the new render_locals plugin.
-
-* The view_options plugin's handling of per-branch view and layout
-  locals is now deprecated.  Users of these feature should switch to
-  the new branch_locals plugin.
-
-* The render plugin's support for Erubis escaping is now deprecated.
-  In Roda 3, the render plugin :escape option will use Erubi escaping.
-  Switch to using :escape=>:erubi temporarily to avoid the deprecation
-  warning.
-
-* Using the render plugin to render a template that is outside one of
-  the allowed paths is now deprecated unless the :check_paths option
-  has been set to false.  In Roda 3, the default behavior will change
-  to checking that template files are in one of the allowed paths.
-
-* The :ext option in the render plugin is now deprecated, users should
-  switch to using the :engine option, which has always had priority.
-
-* Using the :cache=>true option to the view/render method in the
-  render plugin is now deprecated if the :cache=>nil/false option
-  was given when loading the plugin.  In Roda 3, the default behavior
-  will change so that the :cache=>nil/false plugin option still
-  allows caching via the :cache=>true method option.  Users can use
-  the :explicit_cache=>true render plugin option instead of the
-  :cache=>nil render plugin option to work around the deprecation
-  warning.
-
-* Attempting to use multi_route while routing with a namespace that
-  hasn't yet been defined is now deprecated.  The previous behavior
-  was to ignore undefined namespaces, but that is more likely to
-  hide an error than be desired behavior.  In Roda 3, using an
-  undefined namespace will raise an error.
-
-* The streaming plugin's support for EventMachine is now deprecated,
-  as is related support for Stream#callback.  The streaming plugin
-  will be much simpler in Roda 3 by dropping this support.
-
-* Calling content_for in the content_for plugin multiple times with
-  the same argument is now deprecated unless the content_for
-  plugin :append option is used to specify behavior.  The default
-  behavior in Roda 3 will change to appending to the existing
-  content instead of overwriting the existing content.
-
-* The :host matcher in the header_matchers plugin is now deprecated
-  when using a regexp value unless the :host_matcher_captures app
-  option is used.  In Roda 3, the :host matcher will automatically
-  yield any regexp captures to the match block.
-
-* The :header matcher in the header_matchers plugin is now deprecated
-  unless the :header_matcher_prefix app option is used.  In Roda 3,
-  the :header matcher will always prefix the argument given with
-  HTTP_.
-
-* The websockets plugin is now deprecated.  It was one of the less
-  commonly used plugins, and the tests for it were subject to race
-  conditions and failed occassionally, and even when they worked
-  they almost doubled the testing time.  Anyone wanting to use it
-  should consider maintaining it as an external plugin.
-
-* The per_thread_caching, static_path_info, and view_subdirs
-  plugins are now deprecated.  static_path_info has been a no-op since
-  Roda 3, view_subdirs is just an alias for view_options, and
-  per_thread_caching doesn't change behavior and is unlikely to
-  significantly increase performance.
-
-* Additional internal constants are now deprecated. Deprecation
-  warnings for accessing these constants will only be displayed on
-  ruby 2.3+.
-
-= Forward Compatibility
-
-Roda 3.0.0 will also include some behavior changes which will not
-have deprecation warnings:
-
-* Ruby 1.8.7 support will be dropped.  Ruby 1.9.2 will be the new
-  minimum supported version.
-
-* Subclassing a Roda app that uses the render plugin will always
-  use a copy of the superclass's template cache.
-
-* The assets plugin will default to using subresource integrity
-  using SHA256 for compiled assets, and using SHA256 instead of
-  SHA1 for compiled asset hashes.
-
-* Using an Roda app as middleware will now always use a subclass
-  of the app for the middleware.
-
-* public_send will be used instead of send internally unless it is
-  expected that private methods will be called.
-
-* The match methods added by the symbol_matchers and hash_matchers
-  plugins will be private instead of public.
-
-= New Features
-
-* The render plugin now has the :layout_opts=>:views plugin option
-  respect the :root app option.
-
-* RodaPlugins::OPTS and RodaPlugins::EMPTY_ARRAY have been added.
-  These are a frozen empty hash and a frozen empty array, and
-  they are designed for use in plugins so that similar objects are
-  not needed to be defined separately in each plugin.

data/doc/release_notes/2.3.0.txt

@@ -1,109 +0,0 @@
-= New Plugins
-
-* A json_parser plugin has been added, for parsing request bodies in
-  JSON format.  This is faster than using a middleware to perform
-  the same task.  This plugin supports a :parser option to use a
-  custom JSON parser, an :include_request option to include the
-  request when calling the parser, and a :error_handler option for
-  a proc to call with the request if there is an error when parsing.
-  Example:
-
-    plugin :json_parser,
-      :parser=>JSON.method(:parse),
-      :include_request=>false,
-      :error_handler=>proc{|r| r.halt [400, {}, []]} 
-
-* A path_rewriter plugin has been added, allowing for the rewriting
-  of paths before routing.  This allows you to rewrite just the
-  routing path (the default), or PATH_INFO as well as the routing
-  path (if the :path_info option is used).  This is useful if you
-  want to internally treat one path exactly the same as another
-  path.
-
-  By default, path rewriting is done on prefixes, so any path that
-  starts with the prefix will be rewritten.  You can pass a
-  Regexp when rewriting the path for more complete control.
-
-  Examples:
-
-    plugin :path_rewriter
-    rewrite_path '/a', '/b'
-    # GET /a treated as GET /b
-    # GET /a/c treated as GET /b/c
-
-    rewrite_path /\A\/c\z/, '/d'
-    # GET /c treated as GET /d
-    # GET /c/e no change
-
-* A precompiled_templates plugin has been added, for precompiling
-  templates before starting the application.  This can save a
-  substantial amount of memory if you are using large templates or
-  a large number of small templates in conjunction when using
-  application preloading with a forking webserver.  Example:
-
-    plugin :precompile_templates
-    precompile_templates "views/\*\*/*.erb"
-    precompile_templates "views/users/_*.erb", :locals=>[:user]
-
-* A heartbeat plugin has been added, for easily handling
-  heartbeat/status requests.  If a heartbeat/status request comes in,
-  it will get a 200 response with a body of "OK".  This is designed
-  for automated systems that check if the application is functioning.
-  The default heartbeat path is /heartbeat, but you can choose a
-  different one using the :path option.
-
-    plugin :heartbeat, :path=>'/heartbeat'
-
-= Other New Features
-
-* The json plugin now supports a :serializer option to use a custom
-  serializer.  Additionally, it now supports a :include_request
-  option to include the request when calling the serializer.
-
-* In the render plugin, the render/view methods now support a
-  :cache=>false option to not cache the template.  This can be useful
-  for large but rarely used templates, or where a new template object
-  is created for every render/view call.
-
-* In the render plugin, the render/view methods now support a
-  :cache_key option to force a specific cache key.  Manually setting
-  cache keys can result in improved performance, as automatically
-  determining the cache key can be a relatively expensive operation.
-
-* The render plugin now supports a :engine_opts option, to specify
-  per-template engine options.  :engine options should be a hash
-  keyed by render engine strings, with values being hashes of
-  template options.
-
-* In the mailer plugin, a no_mail! method is now supported when
-  mailing, which will skip the current mail.  This makes it easier
-  to delay the decision about actually sending the email till it is
-  time to send the email, which makes it easier to avoid race
-  conditions if you are using a job queue for mailing.
-
-= Other Improvements
-
-* Roda avoids rehashing hashes at runtime in some places, for a minor
-  speedup.
-
-* If the :template_block is given to render/view, default to not
-  caching the template, since it is likely the template block is
-  specific to the request.  Allow for the :cache=>true option to be
-  used to force the caching of the template.
-
-* Roda now returns a 404 response for unmatched GET requests when
-  using the assets and json plugins where r.assets is the last
-  method called in a route block.
-
-= Backwards Compatibility
-
-* In the render plugin, the :ext option to the plugin and to the
-  render/view methods is now replaced by the :engine option.
-  Previously, :engine was used by default if :ext was not given. In
-  general, there is no need for two separate options, the engine is
-  used as the extension by Tilt.
-
-  In general, this is a backwards compatible change, except when
-  both :ext and :engine were specified differently as plugin options,
-  and an inline template is used with render or view without either
-  the :ext or :engine options being specified.