roda 3.83.0 → 3.84.0

data/doc/release_notes/3.46.0.txt

@@ -1,19 +0,0 @@
-= Improvements
-
-* The r.on, r.is, r.get and r.post methods (and other verb methods
-  if using the all_verbs plugin) have now been optimized when using
-  a single string or regexp matcher, or the String or Integer class
-  matcher.  Since those four matchers are the most common types of
-  matchers passed to the methods, this can significantly improve
-  routing performance (about 50% in the r10k benchmark).
-
-  This optimization is automatically applied when freezing
-  applications, if the related methods have not been modified by
-  plugins.
-
-  This optimization does come at the expense of a small decrease
-  in routing performance (3-4%) for unoptimized cases, but the
-  majority of applications will see a overall performance benefit
-  from this change.
-
-* Other minor performance improvements have been made.

data/doc/release_notes/3.47.0.txt

@@ -1,13 +0,0 @@
-= Improvements
-
-* The r.on optimization added in 3.46.0 has been extended to optimize
-  all single argument calls. This results in the following speedups
-  based on argument type:
-
-  * Hash matching: 10%
-  * Array/Symbol/Class matching: 15%
-  * Proc matching: 25%
-  * true matching: 45%
-  * false/nil matching: 65%
-
-* Other minor performance improvements have been made.

data/doc/release_notes/3.48.0.txt

@@ -1,10 +0,0 @@
-= New Features
-
-* A named_routes plugin has been added, for defining named route
-  blocks that you can dispatch to with r.route.  This feature was
-  previously available as part of the multi_route plugin, but there
-  are cases where the r.route method and support for named routes is
-  helpful even when the multi_route plugin is not used (such as when
-  the hash_routes plugin is used instead of the multi_route plugin).
-  The multi_route plugin now depends on the named_routes plugin, so
-  this change should not cause any backwards compatibility issues.

data/doc/release_notes/3.49.0.txt

@@ -1,18 +0,0 @@
-= Improvements
-
-* The r.is optimization added in 3.46.0 has been extended to optimize
-  all single argument calls. This results in the following speedups
-  based on argument type:
-
-  * Hash/Class matching: 20%
-  * Symbol matching: 25%
-  * Array matching: 35%
-  * Proc matching: 50%
-  * false/nil matching: 65%
-
-* Roda now uses defined?(yield) instead of block_given? internally
-  for better performance on CRuby.  defined?(yield) is faster as it is
-  built into the VM, while block_given? is a regular method and has
-  the overhead of calling a regular method.  Note that defined?(yield)
-  is not implemented correctly on JRuby before 9.0.0.0, so this
-  release of Roda drops support for JRuby versions before 9.0.0.0.

data/doc/release_notes/3.5.0.txt

@@ -1,31 +0,0 @@
-= New Features
-
-* A request_aref plugin has been added for configuring the behavior
-  of the [] and []= request methods.  These methods are deprecated
-  in the current version of Rack, but Rack will only print a
-  deprecation warning in verbose mode.  With this plugin, you can
-  choose to never warn, always warn, or raise an exception:
-
-    # Don't emit a warning, allowing for the historical Rack
-    # behavior
-    plugin :request_aref, :allow
-
-    # Always emit a warning when the method is called
-    plugin :request_aref, :warn
-
-    # Raise an exception if the method is called
-    plugin :request_aref, :raise
-
-= Other Improvements
-
-* When using the content_for plugin and calling content_for with a
-  block, convert the result of the block to a string before passing
-  the result to Tilt.  This can fix issues when the template class
-  that Tilt uses does not handle non-String input.
-
-* When using the public plugin with the :gzip option, do not add the
-  Content-Type or Content-Encoding headers if a 304 response is
-  returned.
-
-* Add the spec/views/about directory to the gem, allowing the specs
-  to run correctly using just the files in the gem.

data/doc/release_notes/3.50.0.txt

@@ -1,21 +0,0 @@
-= New Features
-
-* An inject_erb plugin has been added, adding an inject_erb method
-  that allows for injecting content directly into the template output
-  for the template currently being rendered.  This allows you to more
-  easily wrap blocks in templates, by calling methods that accept
-  template blocks and injecting content before and after the block.
-
-* A capture_erb plugin has been added, adding a capture_erb method
-  for capturing a template block in an erb template and returning
-  the content appended during the block as a string, instead of
-  having the content of the template block be included directly into
-  the template output.  This can be combined with the inject_erb
-  plugin to inject modified versions of captured blocks into template
-  output.
-
-* The hash_routes plugin now allows calling hash_branch and hash_path
-  without a block in order to remove the existing route handler. This
-  is designed to be used with code reloading libraries, so that if a
-  route file is deleted, the related hash branches/paths are also
-  removed, without having to reload all route files.

data/doc/release_notes/3.51.0.txt

@@ -1,20 +0,0 @@
-= New Features
-
-* The named_routes plugin now allows calling route without a block
-  to remove the existing route handler.  The multi_run plugin
-  now allows calling run without an app to remove an existing handler.
-  These changes are designed to better support code reloading
-  libraries, so that if the related file is deleted, the related
-  handlers are also removed, without having to reload the entire
-  application.
-
-= Other Improvements
-
-* The error_handler plugin now avoids a method redefinition warning
-  in verbose warning mode.
-
-= Other
-
-* Roda's primary discussion forum is now GitHub Discussions. The
-  ruby-roda Google Group is still available for users who would
-  prefer to use that instead.

data/doc/release_notes/3.52.0.txt

@@ -1,20 +0,0 @@
-= New Features
-
-* The typecast_params plugin now supports a :date_parse_input_handler
-  option that will be called with all input that will be passed to
-  the date parsing methods.  You can use this option to automatically
-  truncate input, if that is perferable to raising an error (which is
-  how recent versions of Ruby handle too-long input).
-
-= Other Improvements
-
-* The path helper methods added by the path plugin now support
-  blocks that use keyword arguments on Ruby 3+.
-
-* The assets plugin now uses OpenSSL::Digest instead of Digest (if
-  available) for calculating SRI digests.  This is faster on Ruby 3+,
-  where Digest no longer uses the faster OpenSSL::Digest automatically
-  if available.
-
-* Roda.freeze now returns self when the multi_route plugin is used.
-  This was broken (not returning self) starting in 3.48.0.

data/doc/release_notes/3.53.0.txt

@@ -1,14 +0,0 @@
-= New Features
-
-* An additional_view_directories plugin has been added, which allows
-  you to specify additional directories to look in for templates.
-  If the template path does not exist when using the default view
-  directory, then each additional view directory will be checked,
-  returning the first path that exists:
-
-    plugin :additional_view_directories, ['admin_views', 'public_views']
-
-= Other Improvements
-
-* The indifferent_params plugin now avoids a deprecation warning when
-  using the rack main branch, which will become Rack 3.

data/doc/release_notes/3.54.0.txt

@@ -1,48 +0,0 @@
-= New Features
-
-* You can now override the type attribute for script tags produced
-  by the assets plugin, by providing a :type attribute when calling
-  the assets method.
-
-= Other Improvements
-
-* Reloading the render plugin after the additional_view_directories
-  plugin no longer removes the additional view directories from
-  the allowed paths for templates.
-
-* When using Rack 3, Roda will now use an instance of Rack::Headers
-  instead of a plain hash for the headers, allowing for compliance
-  with the Rack 3 SPEC (which will require lowercase header keys).
-
-* The public, multi_public, and sinatra_helpers plugin now use
-  Rack::Files instead of Rack::File if available, as Rack::File will
-  be deprecated in Rack 3.0.
-
-* The json_parser plugin no longer rewinds the request body before
-  and after reading it when used with Rack 3.0, as Rack 3.0 has
-  dropped the requirement for rewindable input.
-
-* The run_handler plugin now closes bodies for upstream 404 responses
-  when using the not_found: :pass option.
-
-* The chunked plugin no longer uses Transfer-Encoding: chunked by
-  default.  Requiring the use of Transfer-Encoding: chunked made the
-  plugin only work on HTTP 1.1, and not older or newer versions. The
-  plugin still allows for streaming template bodies as they are being
-  rendered.  To get the previous behavior of forcing the use of
-  Transfer-Encoding: chunked, you can use the :force_chunked_encoding
-  plugin option
-
-* Roda now supports testing with Rack::Lint.  This found multiple
-  violations of the Rack SPEC which are fixed in this version, and
-  should ensure that Roda stays in compliance with the Rack SPEC going
-  forward.
-
-= Backwards Compatibility
-
-* Roda will no longer set the Content-Length header for 205 responses
-  when using Rack <2.0.2, as doing so violates the Rack SPEC for those
-  Rack versions.
-
-* The drop_body plugin now drops response bodies for all 1xx responses,
-  not just for 100 and 101 responses, in compliance with the Rack SPEC.

data/doc/release_notes/3.55.0.txt

@@ -1,12 +0,0 @@
-= New Features
-
-* A :forward_response_headers option has been added to the middleware
-  plugin, which uses the response headers added by the middleware
-  as default response headers even if the middleware does not handle
-  the response. Response headers set by the underlying application
-  take precedence over response headers set by the middleware.
-
-* The render plugin view method now accepts a block and will pass the
-  block to the underlying render method call.  This is useful for
-  rendering a template that yields inside of an existing layout.
-  Previously, you had to nest render calls to do that.

data/doc/release_notes/3.56.0.txt

@@ -1,33 +0,0 @@
-= New Features
-
-* RodaRequest#http_version has been added for determining the HTTP
-  version the request was submitted with.  This will be a string
-  such as "HTTP/1.0", "HTTP/1.1", "HTTP/2", etc. This will use the
-  SERVER_PROTOCOL and HTTP_VERSION entries from the environment to
-  determine which HTTP version is in use.
-
-* The status_handler method in the status_handler plugin now supports
-  a :keep_headers option.  The value for this option should be an
-  array of header names to keep.  All other headers are removed. The
-  default behavior without the option is still to remove all headers.
-
-* A run_require_slash plugin has been added, which will skip
-  dispatching to another rack application if the remaining path is not
-  empty and does not start with a slash.
-
-= Other Improvements
-
-* The status_303 plugin will use 303 as the default redirect status
-  for non-GET requests for HTTP/2 and higher HTTP versions. Previously,
-  it only used 303 for HTTP/1.1.
-
-* The not_allowed plugin now overrides the r.root method to return
-  405 responses to non-GET requests to the root.
-
-* The not_allowed plugin no longer sets the body when returning 405
-  responses using methods such as r.get and r.post. Previously, the
-  body was unintentionally set to the same value as the Allow header.
-
-* When using the Rack master branch (what will become Rack 3), Roda
-  only requires the parts of rack that it uses, instead of requiring
-  rack and relying on autoload to load the parts of rack in use.

data/doc/release_notes/3.57.0.txt

@@ -1,34 +0,0 @@
-= New Features
-
-* hash_branches and hash_paths plugins have been split off from the
-  hash_routes plugin, allowing you to use only those parts instead
-  of all of hash_routes.
-
-  The hash_branches plugin supports the hash_branch class method
-  and r.hash_branches routing method.
-
-  The hash_paths plugin supports the hash_path class method and
-  r.hash_paths routing method.
-  
-  The hash_routes plugin functions as it did previously by
-  requiring the hash_branches and hash_paths plugins. It adds
-  the hash_routes DSL and r.hash_routes routing method.
-
-* A hash_branch_view_subdir has been added.  It builds on the
-  view_options plugin and new hash_branches plugin, automatically
-  appending a view subdirectory for each successful hash branch.
-  This can DRY up code that uses a separate view subdirectory for
-  each branch.
-
-= Other Improvements
-
-* Unprintable characters are now hex escaped in the output of the
-  common_logger plugin.  This can protect users who use software
-  that respects shell escape sequences to view the logs.
-
-= Backwards Compatibility
-
-* The static_routing plugin now depends on the hash_paths plugin
-  instead of the hash_routes plugin, so you will need to update
-  your application to explicitly load the hash_routes plugin if
-  you were relying on static_routing to implicitly load it.

data/doc/release_notes/3.58.0.txt

@@ -1,16 +0,0 @@
-= New Features
-
-* A filter_common_logger plugin has been added, allowing you to skip
-  logging of certain requests in the common_logger plugin. This
-  allows you to only log requests for certain paths, or only log
-  requests for certain types of responses.
-
-= Other Improvements
-
-* The heartbeat plugin is now compatible with recent changes in the
-  rack master branch (what will be rack 3).
-
-* The exception_page plugin will now use Exception#detailed_message
-  on Ruby 3.2+, preserving the did_you_mean and error_highlight
-  information.  Additionally, the display of exception messages
-  has been improved.

data/doc/release_notes/3.59.0.txt

@@ -1,17 +0,0 @@
-= New Features
-
-* An additional_render_engines plugin has been added, for considering
-  multiple render engines for templates. If the template path does not
-  exist for the default render engine, then each additional render
-  engine will be checked, returning the first path that exists:
-
-    plugin :additional_render_engines, ['haml', 'str']
-
-  This is similar to the additional_view_directories plugin added in
-  3.53.0.  Both plugins can be used if you want to consider multiple
-  view directories and multiple render engines.
-
-= Other Improvements
-
-* A typo in a private method name in the delete_empty_headers plugin
-  has been fixed.

data/doc/release_notes/3.6.0.txt

@@ -1,21 +0,0 @@
-= New Features
-
-* An early_hints plugin has been added for senting 103 Early Hint
-  responses.  This is currently only supported on puma 3.11+, and
-  can allow for improved performance by letting the requestor know
-  which related files will be needed by the request.
-
-* An :early_hints option has been added to the assets plugin.  If
-  given, calling the assets method will also issue an early hint
-  for the related assets.
-
-* A :wrap option has been added to the json_parser plugin.  If set
-  to :always, all uploaded json data will be stored using a hash
-  with a "_json" key.  If set to :unless_hash, uploaded json data
-  will only be wrapped in such a matter if it is not already a hash.
-
-  Using the :wrap option can fix problems when using r.params when
-  the uploaded JSON data is an array and not a hash.  However, it
-  does change the behavior of r.POST.  It is possible to handle
-  uploaded JSON array data without the :wrap option by using r.GET
-  and r.POST directly instead of using r.params.

data/doc/release_notes/3.60.0.txt

@@ -1,56 +0,0 @@
-= New Features
-
-* A link_to plugin has been added with a link_to method for
-  creating HTML links.
-
-  The simplest usage of link_to is passing the body and the location
-  to link to as strings:
- 
-    # Instance level
-    link_to("body", "/path")
-    # => "<a href=\"/path\">body</a>"
- 
-  The link_to plugin depends on the path plugin, and allows you to
-  pass symbols for named paths:
- 
-    # Class level
-    path :foo, "/path/to/too"
- 
-    # Instance level
-    link_to("body", :foo)
-    # => "<a href=\"/path/to/foo\">body</a>"
- 
-  It also allows you to pass instances of classes that you have
-  registered with the path plugin:
- 
-    # Class level
-    A = Struct.new(:id)
-    path A do
-      "/path/to/a/#{id}"
-    end
- 
-    # Instance level
-    link_to("body", A.new(1))
-    # => "<a href=\"/path/to/a/1\">body</a>"
- 
-  To set additional HTML attributes on the tag, you can pass them as
-  an options hash:
- 
-    link_to("body", "/path", foo: "bar")
-    # => "<a href=\"/path\" foo=\"bar\">body</a>"
- 
-  If the body is nil, it will be set to the same as the path:
- 
-    link_to(nil, "/path")
-    # => "<a href=\"/path\">/path</a>"
- 
-  The plugin will automatically HTML escape the path and any HTML
-  attribute values, using the h plugin:
- 
-    link_to("body", "/path?a=1&b=2", foo: '"bar"')
-    # => "<a href=\"/path?a=1&amp;b=2\" foo=\"&quot;bar&quot;\">body</a>"
-
-= Other Improvements
-
-* Coverage testing has been expanded to multiple rack versions, instead
-  of just the current rack release.

data/doc/release_notes/3.61.0.txt

@@ -1,24 +0,0 @@
-= Improvements
-
-* The typecast_params plugin now limits input bytesize for integer,
-  float, and date/time typecasts.  If the input is over the allowed
-  bytesize, typecasting will fail.  This prevents issues with trying
-  to typecast arbitrarily large input.
-
-* The default Integer class matcher now limits integer segments to
-  100 characters by default, also to prevent issues with typecasting
-  arbitrarily large input.  Segments larger than 100 characters will
-  no longer be matched by the Integer class matcher.
-
-= Backwards Compatibility
-
-* If the input bytesize limits in the typecast_params plugin cause
-  issues in your application, you can use the :skip_bytesize_checking
-  option when loading the plugin to disable the checks.
-
-* If the default Integer class matcher limit causes problems in your
-  application, you can use the class_matchers plugin to override the
-  matcher to not use a limit:
-
-    plugin :class_matchers
-    class_matcher(Integer, /(\d+)/){|a| [a.to_i]}

data/doc/release_notes/3.62.0.txt

@@ -1,41 +0,0 @@
-= New Features
-
-* An Integer_matcher_max plugin has been added for setting the
-  maximum value matched by the Integer matcher (the minimum is
-  always 0, since the Integer matcher does not match negative
-  integers).  The default maximum value when using the plugin
-  is 2**63-1, the maximum value for a signed 64-bit integer.
-  You can specify a different maximum value by passing an argument
-  when loading the plugin.
-
-* A typecast_params_sized_integers plugin has been added for
-  converting parameters to integers only if the integer is within a
-  specific size.  By default, the plugin supports 8-bit, 16-bit,
-  32-bit, and 64-bit signed and unsigned integer types, with the
-  following typecast_params methods added by the plugin:
-
-    * int8, uint8, pos_int8, pos_uint8, Integer8, Integeru8
-    * int16, uint16, pos_int16, pos_uint16, Integer16, Integeru16
-    * int32, uint32, pos_int32, pos_uint32, Integer32, Integeru32
-    * int64, uint64, pos_int64, pos_uint64, Integer64, Integeru64
-
-  You can override what sizes are added by default by using the
-  :sizes option.  You can also specify a :default_size option,
-  in which case the default int, pos_int, and Integer conversions
-  will use the given size.  So if you want to change the default
-  typecast_params integer conversion behavior to only support
-  integer values that can fit in 64-bit signed integers, you can
-  use:
-
-    plugin :typecast_params_sized_integers, sizes: [64],
-      default_size: 64
-
-= Other Improvements
-
-* The block passed to the class_matcher method in the class_matchers
-  plugin can now return nil/false to signal that it should not match.
-  This is useful when the regexp argument provided matches segments
-  not valid for the class.
-
-* RodaRequest#matched_path now works correctly when using the
-  unescape_path plugin.

data/doc/release_notes/3.63.0.txt

@@ -1,36 +0,0 @@
-= New Features
-
-* An autoload_hash_branches plugin has been added for autoloading
-  route files for each hash branch, instead of requiring the route
-  files be loaded up front.  For example, to automatically load a
-  route file for a hash branch on the first request to that branch:
-
-    plugin :autoload_hash_branches
-    autoload_hash_branch('branch_name', '/path/to/file')
-    autoload_hash_branch('namespace', 'branch_name', '/path/to/file')
-
-  The route file loaded should define the expected hash branch.
-
-  It is common to have route files stored in a directory, with the
-  file name matching the branch name.  In that case, you can set
-  autoloading for all route files in a given directory:
-
-    plugin :autoload_hash_branches
-    autoload_hash_branch_dir('/path/to/dir')
-    autoload_hash_branch_dir('namespace', '/path/to/dir')
-
-  Note that autoloading hash branches does not work if the application
-  is frozen.  This plugin should only be used in development mode for
-  faster startup, or when running tests on a subset of the application
-  in order to avoid loading parts of the application unrelated to what
-  is being tested.
-
-* The mailer plugin now supports a :terminal plugin option to make
-  the r.mail method force a terminal match, similar to how r.get
-  and other HTTP verb methods work in standard Roda.  This behavior
-  will become the default in Roda 4.
-
-= Other Improvements
-
-* The mailer plugin now correctly sets the content_type of the body
-  for emails with attachments when using mail 2.8.0+.

data/doc/release_notes/3.64.0.txt

@@ -1,26 +0,0 @@
-= New Features
-
-* An erb_h plugin has been added for faster HTML escaping using
-  erb/escape.  erb 4 added erb/escape and it is included in Ruby 3.2.
-
-  The erb_h plugin is added as a separate plugin because it changes
-  the behavior of the h method. The h method added by the h plugin
-  will always return a new string, but the h method added by the
-  erb_h plugin will return the argument if the argument is a
-  string that does not need escaping.  By avoiding unnecessary
-  string allocations, use of the erb_h plugin can speed up HTML
-  escaping.
-
-= Other Improvements
-
-* The autoload_hash_branches plugin added in Roda 3.63.0 will now
-  eagerly load the hash branches when freezing the application,
-  allowing the application to continue to work after being frozen.
-  Additionally, file paths for the hash branches will now be
-  automatically expanded, allowing the use of relative file paths.
-
-= Backwards Compatibility
-
-* The expanding of file paths in the autoload_hash_branches plugin
-  can break applications that were providing relative paths and
-  expecting them to be looked up using the Ruby load path.

data/doc/release_notes/3.65.0.txt

@@ -1,12 +0,0 @@
-= New Features
-
-* An autoload_named_routes plugin has been added for autoloading files
-  for a named route setup by the named_routes plugin when there is a
-  request for that route.
-
-= Other Improvements
-
-* The path method in the path plugin now supports a :class_name option.
-  You can set this option to true and use a class name String/Symbol
-  to register paths for classes without referencing the related class,
-  useful when autoloading the class.

data/doc/release_notes/3.66.0.txt

@@ -1,23 +0,0 @@
-= New Features
-
-* A render_coverage plugin has been added, which will cause compiled
-  template code to be saved to a folder and loaded using load instead
-  of eval. This allows for coverage to work for the compiled template
-  code in Ruby versions before 3.2.  It can also allow for verbose
-  syntax warnings in compiled template code (ignored by eval), and
-  can also be useful for static analysis of compiled template code.
-  This plugin requires tilt 2.1+.
-
-* The exception_page plugin now supports exception_page_{css,js}
-  instance methods for overriding the CSS and JavaScript on the
-  generated exception page.
-
-= Other Improvements
-
-* Using inline templates (render/view :inline option) no longer keeps
-  a reference to the Roda instance that caches the template.
-
-= Backwards Compatibility
-
-* The Render::TemplateMtimeWrapper API has changed.  Any external
-  use of this class needs to be updated.

data/doc/release_notes/3.67.0.txt

@@ -1,25 +0,0 @@
-= New Feature
-
-* A custom_block_results plugin has been added for custom handling
-  of block results.  This allows routing blocks to return
-  arbitrary objects instead of just String, nil, and false, and
-  to have custom handling for them. For example, if you want to
-  be able to have your routing blocks return the status code to use,
-  you could do:
-
-    plugin :custom_block_results
-
-    handle_block_result Integer do |result|
-      response.status_code = result
-    end
-
-    route do |r|
-      200
-    end
-
-  While the expected use of the handle_block_result method is with
-  class arguments, you can use any argument that implements an
-  appropriate === method.
-
-  The symbol_views and json plugins, which support additional block
-  results, now use the custom_block_results plugin internally.

data/doc/release_notes/3.68.0.txt

@@ -1,21 +0,0 @@
-= New Feature
-
-* Roda.run in the multi_run plugin now accepts blocks, to allow
-  autoloading of apps to dispatch to:
-
-    class App < Roda
-      plugin :multi_run
-
-      run("other_app"){OtherApp}
-
-      route do |r|
-        r.multi_run
-      end
-    end
-
-  With the above example, the block is not evaluated until a
-  request for the /other_app branch is received.  If OtherApp is
-  autoloaded, this can speed up application startup and partial
-  testing. When freezing the application (for production use),
-  the block is eagerly loaded, so that requests to the
-  /other_app branch do not call the block on every request.