roda 3.28.0 → 3.33.0

data/doc/release_notes/1.3.0.txt

@@ -1,109 +0,0 @@
-= Preparation for Roda 2
-
-* In Roda 2 (the next version), the PATH_INFO and SCRIPT_NAME
-  env variables will not be modified during routing. Instead,
-  Roda will use the static_path_info plugin behavior by default.
-  Users are strongly encouraged to use the static_path_info
-  plugin to make sure their apps will work with Roda 2.
-
-* In Roda 2, Roda#initialize will take the env hash, and #call
-  will take the route block.  The private #_route method will be
-  eliminated.  This should not affect applications, but it will
-  affect plugins that override these methods.
-  
-* The issues mentioned below should all have deprecation warnings,
-  except where noted.
-
-== New Plugins to Replace Deprecated Features
-
-* RodaResponse#set_cookie and #delete_cookie have been moved to the
-  cookies plugin.
-
-* Roda.request_module and .response_module have been moved to the
-  module_include plugin.
-
-* Roda.hash_matcher has been moved to the hash_matcher plugin.
-
-* The :extension hash matcher has been moved to the path_machers
-  plugin.  This plugin also contains new :prefix and :suffix hash
-  matchers.
-
-* The :param and :param! hash matchers have been moved to the
-  param_matchers plugin.
-
-== Other Deprecation Issues
-
-* The :opts render plugin option and :opts option to render and
-  view are now deprecated.  Use the :template_opts option instead.
-
-* RodaRequest#full_path_info has been deprecated, switch to using
-  #path.
-
-* Mutating plugin option hashes for the chunked, default_headers,
-  error_email, json, and render plugins is now deprecated, these
-  option hashes will be frozen in Roda 2.
-
-* The :header hash matcher in the header_matchers plugin now
-  gives a deprecation warning, because in Roda 2, the matcher will
-  yield the value of the header to the block.  To get the new
-  behavior and silence the deprecation warning, you need to set an
-  option:
-
-    Roda.opts[:match_header_yield] = true
-
-* Mutating json_result_classes directly in the json plugin is now
-  deprecated.  You should now pass a :classes option to the plugin
-  specifying the classes to convert, if you want to handle classes
-  other than Array and Hash.  There will not be a deprecation warning
-  if you attempt to mutate json_result_classes.
-
-= New Features
-
-* The Roda.freeze method now freezes internal datastructures to avoid
-  thread safety issues.  The plugins that ship with Roda will freeze
-  their datastructures when Roda.freeze is called.  It is recommended
-  that production applications call freeze on the application after
-  fully loading it, especially if they are using a threaded webserver
-  and a non-MRI ruby.
-
-* A delete_empty_headers plugin has been added that automatically
-  deletes headers set to the empty string.  This makes it simpler to
-  delete default headers if they shouldn't be set for a specific
-  request.
-  
-* A class_delegate method has been added to the delegate plugin. This
-  makes it easier to create instance methods that call class methods.
-
-* Roda::RodaMajorVersion, RodaMinorVersion, and RodaPatchVersion
-  constants have been added.
-
-= Other Improvements
-
-* The error_handler plugin now uses a new response instead of reusing
-  the existing response.  This fixes cases where changing the
-  Content-Type and then raising an exception would result in a error
-  page that used the previously set Content-Type.
-
-* The not_found plugin now clears previous set headers before calling
-  not found.  This fixes cases where Content-Type was set previously,
-  and also fixes an incorrect Content-Length being used for the
-  response.
-
-* The static_path_info plugin now restores the original SCRIPT_NAME
-  and PATH_INFO before returning from r.run, fixing usage with some
-  middleware.
-
-* The multi_run plugin now works when subclassing the app.
-
-* The default_headers plugin is now faster by skipping an unnecessary
-  hash duplication.
-
-* A Gemfile has been added to make development slightly easier.
-
-= Backwards Compatibility
-
-* RodaResponse is no longer a subclass of Rack::Response, it is now a
-  subclass of Object.  This shouldn't have an effect unless you were
-  calling a method on an instance that was defined by Rack::Response
-  and not RodaResponse, but most of those methods would have raised
-  exceptions.

data/doc/release_notes/2.0.0.txt

@@ -1,75 +0,0 @@
-= Backwards Compatibility
-
-* RodaResponse#set_cookie and #delete_cookie have been removed.
-
-* Roda.request_module and .response_module have been removed.
-
-* Roda.hash_matcher has been removed.
-
-* The :extension hash matcher has been removed.
-
-* The :param and :param! hash matchers have been removed.
-
-* RodaRequest#full_path_info has been removed.
-
-* The :opts render plugin option is no longer respected, Use the
-  :template_opts option instead.
-
-* Plugin option hashes for the chunked, default_headers,
-  error_email, and render plugins are now frozen.
-
-* The :header hash matcher in the header_matchers plugin now
-  yields the header value to the block.
-
-* Roda.json_result_classes in the json plugin is now frozen.
-
-* The PATH_INFO and SCRIPT_NAME env variables are no longer modified
-  during routing.
-
-* Roda#initialize now takes an env hash, and #call now takes the
-  route block.  The private #_route method has been removed.
-  
-* RodaRequest#keep_remaining_path/#updating_remaining_path private
-  methods have been removed.
-
-* The render plugin's :layout option is now always set to true or
-  false, specifying whether a layout should be used by default.
-  The template used for a layout is now located as the :template
-  option inside :layout_opts.
-
-= New Plugins
-
-* A padrino_render plugin has been added, which adds render/partial
-  methods that work similarly to Padrino's.
-
-= Other New Features
-
-* A Roda#render_template private method has been added to the render
-  plugin.  All internal users of render should switch to calling
-  render_template.
-
-* The halt plugin now integrates with the symbol_views and json
-  plugins, allowing things like:
-
-    r.halt(:template)
-    r.halt('key'=>'value')
-
-= Other Improvements
-
-* The error_handler plugin now rescues ScriptError in addition to
-  StandardError.  This handles SyntaxError (raised by ERB),
-  LoadError (raised by require), and NotImplementedError (raised
-  by TSort).
-
-* Using a :layout=>true option to the render plugin's view method
-  now uses the default layout template, instead of a template named
-  'true'.  It can be used to force a layout even if the render
-  plugin has been configured to not use a layout by default.
-
-* Roda apps that use the middleware plugin can now be used as regular
-  rack apps.  Previously, using the middleware plugin made it
-  impossible to use the app as a regular rack app.
-
-* Roda#request and #response are now faster.
-
-* Roda avoids creating unnecessary hashes in more places now.

data/doc/release_notes/2.1.0.txt

@@ -1,124 +0,0 @@
-= New Plugins
-
-* A view_options plugin has been added, for branch/route specific
-  setting of view and layout options and locals.  This allows for
-  DRYer code when you want to change the view or layout settings
-  for an entire routing branch.  Options and locals set at the
-  branch or route level have higher priority than those set at
-  the plugin level, but lower priority than those provided as
-  arguments to the render/view methods. Example:
-
-    class App < Roda
-      plugin :view_options
-
-      route do |r|
-        r.on 'albums' do
-          layout_options :template=>'layouts/3_columns'
-          layout_locals :heading=>'Albums'
-          view_options :ext=>'haml'
-          view_locals :name=>'Foo'
-          # ...
-        end
-      end
-    end
-
-  The view_options plugin is also a superset of the previous
-  view_subdirs plugin, and attempts to load view_subdirs will
-  now load view_options.  In addition to set_view_subdir, the
-  view_options plugin now supports append_view_subdir, which
-  will append a subdirectory to an existing subdirectory, which
-  makes it simpler to deal with nested view file hierarchies.
-
-* A static plugin has been added for easily serving static files
-  using Rack::Static.  Example:
-
-    class App < Roda
-      plugin :static, ['/js', '/css']
-      # or:
-      plugin :static, ['/js', '/css'], :root=>'pub'
-    end
-
-= Other New Features
-
-* Roda now supports a :root option for the application that sets
-  the root directory.  This is useful if the application's files
-  are not stored in the process's working directory, which is
-  common for processes containing of multiple Roda applications.
-
-  By setting the :root option, plugins that use the file system
-  will default to making relative paths relative to the :root
-  option instead of the process's working directory.  The
-  assets, render, and static plugins currently support the :root
-  option.  Example:
-
-    class App < Roda
-      opts[:root] = File.dirname(__FILE__)
-    end
-
-* Roda now supports an :add_script_name option for the application,
-  which makes plugins automatically prepend the SCRIPT_NAME for the
-  request's environment to any paths created.  This allows Roda
-  applications to work transparently whenever they are mounted
-  inside of another rack application.
-
-  The assets and path plugins currently recognize the
-  :add_script_name option.  Example:
-
-    class App < Roda
-      opts[:add_script_name] = true
-    end
-
-* The path plugin now adds a Roda#path method, which creates paths
-  based on the type of argument used.  You can register classes
-  with the path plugin by providing Roda.path with a class, which
-  will cause Roda#path to recognize them and handle them accordingly.
-
-  Example:
-
-    class App < Roda
-      plugin :path
-      path(Track){|track| "/albums/#{track.album_id}/tracks/#{track.number}"}
-
-      route do
-        r.get 'tracks/:id' do |track_id|
-          r.redirect(path(Track[track_id]))
-        end
-      end
-    end
-
-= Other Improvements
-
-* add_file in the mailer plugin now adds the files after the email
-  body instead of before.  This fixes some issues where the email
-  body would end up empty, due to issues with the mail gem's API.
-
-  add_file now accepts a block, and the block is called after the
-  file has been attached.  Among other things, this allows you to
-  change the content_type for an attached file:
-
-    add_file 'path/to/file' do
-      response.mail.attachments.last.content_type = 'text/foo'
-    end
-
-* r.multi_route in the multi_route plugin now works if there are
-  no named routes defined.
-
-* A render plugin :locals option is now respected, setting defaults
-  to use for locals in views.  Additionally, a :locals option in
-  the :layout_opts option is now respected for setting locals in
-  layouts.  If both the render plugin option is set and :locals is
-  passed to render/view, the two will be merged together.
-  Previously, providing a :locals option to render/view would cause
-  the plugin level option to be ignored.
-
-= Backwards Compatibility
-
-* Using the render plugin :layout=>nil option now removes any
-  layout template set previously using :layout.  Previously, the
-  layout template would still be kept, but it would not be used
-  by default.
-
-* Accessing attachments after adding a file using add_file in the
-  mailer plugin no longer works, as the adding is now delayed until
-  after the body is set.  You should now pass a block to add_file
-  if you want to access the attachment after it has been added.

data/doc/release_notes/2.10.0.txt

@@ -1,27 +0,0 @@
-= New Features
-
-* The json plugin now accepts a :content_type option, which will
-  override the default Content-Type response header used for
-  responses.
-
-* Stream#write has been added to the streaming plugin, allowing
-  the following type of code to work:
-
-    stream do |out|
-      IO.copy_stream(StringIO.new(content), out)
-    end
-
-= Other Improvements
-
-* Roda now works with ruby 2.3's --enable-frozen-string-literal,
-  and all of the library files are set to use frozen string
-  literals by default.
-
-  Most of roda's plugin-specific dependencies were found to have
-  issues with frozen string literals, and while pull requests have
-  been sent to fix the issues, it's unlikely that you would
-  currently be able to use --enable-frozen-string-literal in
-  production.
-
-* The json plugin will no longer override a Content-Type header if
-  one is already set.

data/doc/release_notes/2.11.0.txt

@@ -1,70 +0,0 @@
-= New Features
-
-* A params_capturing plugin has been added, which makes string and
-  symbol matchers update the request params with the value of the
-  captured segments, using the matcher as the key:
-  
-    plugin :params_capturing
- 
-    route do |r|
-      # GET /foo/123/abc/67
-      r.on("foo/:bar/:baz", :quux) do
-        r[:bar] #=> '123'
-        r[:baz] #=> 'abc'
-        r[:quux] #=> '67'
-      end
-    end
-  
-  Note that this updating of the request params using the matcher as
-  the key is only done if all arguments to the matcher are symbols
-  or strings.
-  
-  All matchers will update the request params by adding all
-  captured segments to the captures key, including
-  symbol and string matchers:
- 
-    r.on(:x, /(\d+)\/(\w+)/, ':y') do
-      r[:x] #=> nil
-      r[:y] #=> nil
-      r[:captures] #=> ["foo", "123", "abc", "67"]
-    end
-  
-  Note that the request params captures entry will be appended to with
-  each nested match:
- 
-    r.on(:w) do
-      r.on(:x) do
-        r.on(:y) do
-          r.on(:z) do
-            r[:captures] # => ["foo", "123", "abc", "67"]
-          end
-        end
-      end
-    end
- 
-  Note that any existing params captures entry will be overwritten
-  by this plugin.  You can use r.GET or r.POST to get the underlying
-  entry, depending on how it was submitted.
-  
-  Also note that the param keys are actually stored in r.params as
-  strings and not symbols (r[] converts the argument to a string
-  before looking it up in r.params).
- 
-  Also note that this plugin will not work correctly if you are using
-  the symbol_matchers plugin with custom symbol matching and are using
-  symbols that capture multiple values or no values.
-
-* A :scope option is now supported by render/view in the render plugin,
-  which allows you to specify the object in which context to evaluate
-  the template.
-
-= Other Improvements
-
-* The assets plugin's support for the Minjs javascript minifier now
-  supports the latest version (0.4.1).
-
-= Backwards Compatibility
-
-* Support for Minjs <0.4.0 has been dropped from the assets plugin.
-  Please upgrade Minjs at the same time you upgrade Roda if you are
-  using both of them.

data/doc/release_notes/2.12.0.txt

@@ -1,40 +0,0 @@
-= New Features
-
-* An optimized_string_matchers plugin has been added, which contains
-  optimized matchers for single strings.  r.on_branch is an optimized
-  version of r.on and r.is_exactly is optimized version of r.is:
-
-    plugin :optimized_string_matchers
-
-    route do |r|
-      r.on_branch "x" do
-        # matches /x and paths starting with /x/
-        r.is_exactly "y" do
-          # matches /x/y
-        end
-      end
-    end
- 
-  Both of these methods will work even if the strings have placeholders,
-  but no captures will be yielded to the blocks.
-
-* The error_handler plugin now has access to the request's
-  remaining_path when handling an error.  You can then compare the
-  remaining_path to path_info to see how much of request was already
-  routed, which can be useful when reporting errors.
-
-= Other Improvements
-
-* String matching for strings without placeholders is now 60% faster
-  as it uses optimized string operations instead of a regexp match.
-
-* Symbol matching is now 60% faster as it uses optimized string
-  operations instead of a regexp match. 
-
-= Backwards Compatibility
-
-* The match methods no longer automatically reset the remaining_path
-  via ensure.  This means that using non-local jumps out of the code
-  such as begin/rescue and throw/catch will not reset remaining_path
-  automatically.  Users that want to reset remaining path in
-  such cases should use their own ensure blocks.