roda 3.32.0 → 3.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a342192f0ab697bea9c4e5b55669644f06fe16e161539b1efc3d10f3c6b9947
-  data.tar.gz: cf01944fe14494efd606cd892cbbbae5b5128f5a1d83c5e411bd4c64cc6e4321
+  metadata.gz: de8c769572875e477058b48557b22861b9de731fa3b00b20a3022a67c929609d
+  data.tar.gz: 5cacc0d7b988bd3dc5bafbc30fcac145f6f67ddcc0e7809e1fc9cd60d8a16273
 SHA512:
-  metadata.gz: e5de72f1385942855bd2c8e1c0f6be5187430d7d83112d7400bc573f045456a445166edfdbb6a7f70779c7b008745e8063bd44274b0111dec95643f87cfe12fe
-  data.tar.gz: b69e2fb41045d19c1f9e79dd2d1a87ca691fcd8de975bd34e37456cd6c5183cd2a6ad6bb59a07594527588d2903ef1bceea5f356a809aef03c01e5f64415246b
+  metadata.gz: 1bf7df28d82f31820cd19c29b5a3f0f3afbbae2c41cf05974b16698c7ffb1725e924491874ddbb3f355a88990d4aab6d5b5b38f2d9c7612a548bfe0e3701ac2e
+  data.tar.gz: 32fca636d6324d29958cbcdf5c949c413eaeda7b74a701032d5766a60ec6b3f2db7ec262268dac697c3b3f5f9b183e127ddf265c7ba5015578969bc7f8be02a2

data/CHANGELOG

@@ -1,3 +1,35 @@
+= 3.37.0 (2020-10-16)
+
+* Add custom_matchers plugin, for supporting arbitrary objects as matchers (jeremyevans)
+
+= 3.36.0 (2020-09-14)
+
+* Add multi_public plugin, for serving files from multiple public directories (jeremyevans)
+
+* Support report-to directive in the content_security_policy plugin (jeremyevans)
+
+* Add Vary response header when using type_routing plugin with Accept request header to prevent caching issues (jeremyevans)
+
+= 3.35.0 (2020-08-14)
+
+* Add r plugin for r method for accessing request, useful when r local variable is not in scope (jeremyevans)
+
+* Warn when loading a plugin with arguments or a block if the plugin does not accept arguments or block (jeremyevans)
+
+= 3.34.0 (2020-07-14)
+
+* Remove unnecessary conditionals (jeremyevans)
+
+* Allow loading the match_affix plugin with a single argument (jeremyevans)
+
+* Do not include pre/post context sections if empty in the exception_page plugin (jeremyevans)
+
+= 3.33.0 (2020-06-16)
+
+* Add :brotli option to public plugin to supplement it to serve brotli-compressed files like :gzip does for gzipped files (hmdne) (#194)
+
+* Add url method to path plugin, similar to path but returning the entire URL (jeremyevans)
+
 = 3.32.0 (2020-05-15)
 
 * Make :dependencies option in assets plugin work correctly with render plugin template caching (jeremyevans) (#191)

data/doc/conventions.rdoc

@@ -15,6 +15,8 @@ For a small application, the following directory layout is recommended:
   Rakefile
   app_name.rb
   assets/
+  config.ru
+  db.rb
   migrate/
   models.rb
   models/
@@ -25,6 +27,8 @@ For a small application, the following directory layout is recommended:
 +app_name.rb+ should contain the Roda application, and should reflect the name of your application.
 So, if your application is named +FooBar+, you should use +foo_bar.rb+.
 
++config.ru+ should contain the code the webserver uses to determine which application to run.
+
 +views/+ should contain your template files.  This assumes you are using the +render+ plugin
 and server-side rendering.  If you are creating a single page application and just serving
 JSON, then you won't need a +views+ directory.  For small applications, all view files should be
@@ -36,7 +40,11 @@ Again, for pure JSON applications, you won't need a +public+ directory.
 +assets/+ should contain the source files for your CSS and javascript assets.  If you are
 not using the +assets+ plugin, you won't need an +assets+ directory.
 
-+models.rb+ should contain all code related to your database/ORM.  This file should be required
++db.rb+ should contain the minimum code to setup a database connection, without loading any of
+the applications models.  This can be required in cases where you don't want the models loaded,
+such as when running migrations. This file should be required by +models.rb+.
+
++models.rb+ should contain all code related to your ORM.  This file should be required
 by +app_name.rb+.  This keeps your model code separate from your web code, making it easier
 to use outside of your web code. It allows you to get an IRB shell for accessing your models
 via <tt>irb -r ./models</tt>, without loading the Roda application.
@@ -46,7 +54,7 @@ via <tt>irb -r ./models</tt>, without loading the Roda application.
 +migrate/+ should create your database migration files, if you are using an ORM that uses
 migrations.
 
-+spec/+ should contain your specifications/tests.  For a small application, it's recommended
++spec/+ (or +test/+ should contain your specifications/tests.  For a small application, it's recommended
 to a have a single file for your model tests, and a single file for your web/integration tests.
 
 +Rakefile+ should contain the rake tasks for the application.  The convention is that the
@@ -83,7 +91,8 @@ The routes used by the +hash_routes+ or +multi_run+ should be stored in routing
 directory, with one file per prefix.
 
 For specs/tests, you should have +spec/models/+ and +spec/web/+, with one file per model in +spec/models/+
-and one file per prefix in +spec/web/+.
+and one file per prefix in +spec/web/+. Substitute +spec+ with +test+ if that is what you are using as the
+name of the directory.
 
 You should have a separate view subdirectory per prefix. If you are using +hash_routes+ and +view_options+ plugins,
 use +set_view_subdir+ in your routing files to specify the subdirectory to use, so it doesn't need to be
@@ -105,7 +114,7 @@ subdirectories in the +routes/+ directory, and nested subdirectories in the +vie
 For a small application, the convention in Roda is to layout your Roda application file (+app_name.rb+) like this:
 
   require 'roda'
-  require './models'
+  require_relative 'models'
 
   class AppName < Roda
     SOME_CONSTANT = 1
@@ -138,24 +147,24 @@ used in your route block or views.
 For larger applications, there are some slight changes to the Roda application file layout:
 
   require 'roda'
-  require './models'
+  require_relative 'models'
 
   class AppName < Roda
     SOME_CONSTANT = 1
 
     use SomeMiddleware
 
-    plugin :render, escape: true
+    plugin :render, escape: true, layout: './layout'
     plugin :assets
     plugin :view_options
     plugin :hash_routes
-    Dir['./routes/*.rb'].each{|f| require f}
+    Dir['routes/*.rb'].each{|f| require_relative f}
 
     route do |r|
       r.hash_routes
     end
 
-    Dir['./helpers/*.rb'].each{|f| require f}
+    Dir['helpers/*.rb'].each{|f| require_relative f}
   end
 
 After loading the +view_options+ and +hash_routes+ plugin, you require all of your

data/doc/release_notes/3.33.0.txt

@@ -0,0 +1,8 @@
+= New Features
+
+* The path plugin now supports a url method, allowing for returning
+  the entire URL instead of just the path for class-based paths.
+
+* The public plugin now supports a :brotli option that will directly
+  serve brotli-compressed files (with .br extension) similar to how the
+  :gzip option directly serves gzipped files (with the .gz extension).

data/doc/release_notes/3.34.0.txt

@@ -0,0 +1,17 @@
+= Improvements
+
+* Multiple unneeded conditionals have been removed.
+
+* pre_content and post_context sections in backtraces are no longer
+  included in the exception_page plugin output if they would be
+  empty.
+
+* The match_affix plugin can be loaded again with a single argument.
+  It was originally designed to accept a single argument, but a bug
+  introduced in 2.29.0 made it require two arguments.
+
+* Core Roda and all plugins that ship with Roda now have 100% branch
+  coverage.
+
+* The sinatra_helpers plugin no longer emits statement not reached
+  warnings in verbose mode.

data/doc/release_notes/3.35.0.txt

@@ -0,0 +1,12 @@
+= New Features
+
+* An r plugin has been added.  This plugin adds an r method for the
+  request, useful for allowing the use of r.halt and r.redirect even
+  in methods where the r local variable is not in scope.
+
+= Other Improvements
+
+* Attempting to load a plugin with an argument or block when the plugin
+  does not accept arguments or a block now warns.  This is because a
+  future update to support a block or an optional argument could break
+  the call.

data/doc/release_notes/3.36.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* A multi_public plugin has been added, which allows serving static
+  files from multiple separate directories.  This is especially
+  useful when there are different access control requirements per
+  directory.
+  
+* The content_security_policy now supports a
+  content_security_policy.report_to method to set the
+  report-to directive.
+
+= Other Improvements
+
+* When using the type_routing plugin and performing type routing
+  using the Accept request header, the Vary response header will be
+  added or updated so that http caches do not cache a response for one
+  type and serve it for a different type.

data/doc/release_notes/3.37.0.txt

@@ -0,0 +1,42 @@
+= New Features
+
+* A custom_matchers plugin has been added, which allows using
+  arbitrary objects as matchers, as long as the matcher has been
+  registered.  You can register matchers using the custom_matcher
+  class method, which takes the class of the matcher, and a block
+  which is yielded the matcher object.  The block should return
+  nil or false if the matcher doesn't match, and any other value
+  if the matcher does match.  Example:
+
+    plugin :custom_matchers
+    method_segment = Struct.new(:request_method, :next_segment)
+    custom_matcher(method_segment) do |matcher|
+      # self is the request instance ("r" yielded in the route block below)
+      if matcher.request_method == self.request_method
+        match(matcher.next_segment)
+      end
+    end
+ 
+    get_foo = method_segment.new('GET', 'foo')
+    post_any = method_segment.new('POST', String)
+    route do |r|
+      r.on('baz') do
+        r.on(get_foo) do
+          # GET method, /baz/foo prefix
+        end
+ 
+        r.is(post_any) do |seg|
+          # for POST /baz/bar, seg is "bar"
+        end
+      end
+ 
+      r.on('quux') do
+        r.is(get_foo) do
+          # GET method, /quux/foo route
+        end
+ 
+        r.on(post_any) do |seg|
+          # for POST /quux/xyz, seg is "xyz"
+        end
+      end
+    end

data/lib/roda.rb

@@ -272,6 +272,12 @@ class Roda
           raise RodaError, "Cannot add a plugin to a frozen Roda class" if frozen?
           plugin = RodaPlugins.load_plugin(plugin) if plugin.is_a?(Symbol)
           raise RodaError, "Invalid plugin type: #{plugin.class.inspect}" unless plugin.is_a?(Module)
+
+          if !plugin.respond_to?(:load_dependencies) && !plugin.respond_to?(:configure) && (!args.empty? || block)
+            # RODA4: switch from warning to error
+            RodaPlugins.warn("Plugin #{plugin} does not accept arguments or a block, but arguments or a block was passed when loading this. This will raise an error in Roda 4.")
+          end
+
           plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
           include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
           extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)

data/lib/roda/plugins/all_verbs.rb

@@ -34,7 +34,9 @@ class Roda
     module AllVerbs
       module RequestMethods
         %w'delete head options link patch put trace unlink'.each do |verb|
+          # :nocov:
           if ::Rack::Request.method_defined?("#{verb}?")
+          # :nocov:
             class_eval(<<-END, __FILE__, __LINE__+1)
               def #{verb}(*args, &block)
                 _verb(args, &block) if #{verb}?

data/lib/roda/plugins/backtracking_array.rb

@@ -33,9 +33,7 @@ class Roda
         # elements.  If the remaining elements could not be
         # matched, reset the state and continue to the next
         # entry in the array.
-        def _match_array(arg, rest=nil)
-          return super unless rest
-
+        def _match_array(arg, rest)
           path = @remaining_path
           captures = @captures
           caps = captures.dup

data/lib/roda/plugins/class_level_routing.rb

@@ -56,7 +56,6 @@ class Roda
       # currently have a routing block, setup an empty routing block so that things will still work if
       # a routing block isn't added.
       def self.configure(app)
-        app.route{} unless app.route_block
         app.opts[:class_level_routes] ||= []
       end
 

data/lib/roda/plugins/content_security_policy.rb

@@ -56,6 +56,7 @@ class Roda
     # * media_src
     # * object_src
     # * plugin_types
+    # * report_to
     # * report_uri
     # * require_sri_for
     # * sandbox
@@ -123,6 +124,7 @@ class Roda
         media-src
         object-src
         plugin-types
+        report-to
         report-uri
         require-sri-for
         sandbox
@@ -145,9 +147,7 @@ class Roda
           # add_* method name adds to the setting value, or clears setting if no values
           # are given.
           define_method("add_#{meth}") do |*args|
-            if args.empty?
-              @opts[setting]
-            else
+            unless args.empty?
               @opts[setting] ||= EMPTY_ARRAY
               @opts[setting] += args
               @opts[setting].freeze

data/lib/roda/plugins/custom_matchers.rb

@@ -0,0 +1,87 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The custom_matchers plugin supports using arbitrary objects
+    # as matchers, as long as the application has been configured
+    # to accept such objects.
+    #
+    # After loading the plugin, support for custom matchers can be
+    # configured using the +custom_matcher+ class method.  This
+    # method is generally passed the class of the object you want
+    # to use as a custom matcher, as well as a block.  The block
+    # will be called in the context of the request instance
+    # with the specific matcher used in the match method.
+    #
+    # Blocks can append to the captures in order to yield the appropriate
+    # values to match blocks, or call request methods that append to the
+    # captures.
+    #
+    # Example:
+    #
+    #   plugin :custom_matchers
+    #   method_segment = Struct.new(:request_method, :next_segment)
+    #   custom_matcher(method_segment) do |matcher|
+    #     # self is the request instance ("r" yielded in the route block below)
+    #     if matcher.request_method == self.request_method
+    #       match(matcher.next_segment)
+    #     end
+    #   end
+    #
+    #   get_foo = method_segment.new('GET', 'foo') 
+    #   post_any = method_segment.new('POST', String) 
+    #   route do |r|
+    #     r.on('baz') do
+    #       r.on(get_foo) do
+    #         # GET method, /baz/foo prefix
+    #       end
+    #
+    #       r.is(post_any) do |seg|
+    #         # for POST /baz/bar, seg is "bar"
+    #       end
+    #     end
+    #
+    #     r.on('quux') do
+    #       r.is(get_foo) do
+    #         # GET method, /quux/foo route
+    #       end
+    #
+    #       r.on(post_any) do |seg|
+    #         # for POST /quux/xyz, seg is "xyz"
+    #       end
+    #     end
+    #   end
+    module CustomMatchers
+      def self.configure(app)
+        app.opts[:custom_matchers] ||= OPTS
+      end
+
+      module ClassMethods
+        def custom_matcher(match_class, &block)
+          custom_matchers = Hash[opts[:custom_matchers]]
+          meth = custom_matchers[match_class] = custom_matchers[match_class] || :"_custom_matcher_#{match_class}"
+          opts[:custom_matchers] = custom_matchers.freeze
+          self::RodaRequest.send(:define_method, meth, &block)
+          nil
+        end
+      end
+
+      module RequestMethods
+        # Try custom matchers before calling super
+        def unsupported_matcher(matcher)
+          roda_class.opts[:custom_matchers].each do |match_class, meth|
+            if match_class === matcher
+              return send(meth, matcher)
+            end
+          end
+
+          super
+        end
+      end
+    end
+
+    register_plugin(:custom_matchers, CustomMatchers)
+  end
+end
+

data/lib/roda/plugins/disallow_file_uploads.rb

@@ -1,6 +1,8 @@
 # frozen-string-literal: true
 
+# :nocov:
 raise LoadError, "disallow_file_uploads plugin not supported on Rack <1.6" if Rack.release < '1.6'
+# :nocov:
 
 #
 class Roda

data/lib/roda/plugins/exception_page.rb

@@ -252,11 +252,21 @@ END
                 begin
                   lineno -= 1
                   lines = ::File.readlines(filename)
-                  pre_lineno = frame[:pre_context_lineno] = [lineno-context, 0].max
-                  frame[:pre_context] = lines[pre_lineno...lineno]
-                  frame[:context_line] = lines[lineno].chomp
-                  post_lineno = frame[:post_context_lineno] = [lineno+context, lines.size].min
-                  frame[:post_context] = lines[lineno+1..post_lineno]
+                  if line = lines[lineno]
+                    pre_lineno = [lineno-context, 0].max
+                    if (pre_context = lines[pre_lineno...lineno]) && !pre_context.empty?
+                      frame[:pre_context_lineno] = pre_lineno
+                      frame[:pre_context] = pre_context
+                    end
+
+                    post_lineno = [lineno+context, lines.size].min
+                    if (post_context = lines[lineno+1..post_lineno]) && !post_context.empty?
+                      frame[:post_context_lineno] = post_lineno
+                      frame[:post_context] = post_context
+                    end
+
+                    frame[:context_line] = line.chomp
+                  end
                 rescue
                 end
 

data/lib/roda/plugins/match_affix.rb

@@ -28,7 +28,7 @@ class Roda
     #
     # This plugin automatically loads the placeholder_string_matchers plugin.
     module MatchAffix
-      def self.load_dependencies(app, _prefix, _suffix)
+      def self.load_dependencies(app, _prefix, _suffix=nil)
         app.plugin :placeholder_string_matchers
       end
 

data/lib/roda/plugins/multi_public.rb

@@ -0,0 +1,87 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The multi_public plugin adds an +r.multi_public+ method that accepts an argument specifying
+    # a directory from which to serve static files.  It is similar to the public plugin, but
+    # allows for multiple separate directories.
+    #
+    # Here's an example of using the multi_public plugin to serve 3 different types of files
+    # from 3 different directories:
+    #
+    #   plugin :multi_public,
+    #     img:  'static/images',
+    #     font: 'assets/fonts',
+    #     form: 'static/forms/pdfs'
+    #
+    #   r.route do
+    #     r.on "images" do
+    #       r.multi_public(:img)
+    #     end
+    #
+    #     r.on "fonts" do
+    #       r.multi_public(:font)
+    #     end
+    #
+    #     r.on "forms" do
+    #       r.multi_public(:form)
+    #     end
+    #   end
+    #
+    # It is possible to simplify the routing tree for this using string keys and an array
+    # matcher:
+    # 
+    #   plugin :multi_public,
+    #     'images' => 'static/images',
+    #     'fonts'  => 'assets/fonts',
+    #     'forms'  => 'static/forms/pdfs'
+    #
+    #   r.route do
+    #     r.on %w"images fonts forms" do |dir|
+    #       r.multi_public(dir)
+    #     end
+    #   end
+    #
+    # You can provide custom headers and default mime type for each directory using an array
+    # of three elements as the value, with the first element being the path, the second
+    # being the custom headers, and the third being the default mime type:
+    #
+    #   plugin :multi_public,
+    #     'images' => ['static/images', {'Cache-Control'=>'max-age=86400'}, nil],
+    #     'fonts'  => ['assets/fonts', {'Cache-Control'=>'max-age=31536000'}, 'font/ttf'],
+    #     'forms'  => ['static/forms/pdfs', nil, 'application/pdf']
+    #
+    #   r.route do
+    #     r.on %w"images fonts forms" do |dir|
+    #       r.multi_public(dir)
+    #     end
+    #   end
+    module MultiPublic
+      def self.load_dependencies(app, _, opts=OPTS)
+        app.plugin(:public, opts)
+      end
+
+      # Use the given directories to setup servers.  Any opts are passed to the public plugin.
+      def self.configure(app, directories, _=OPTS)
+        roots = app.opts[:multi_public_servers] = (app.opts[:multi_public_servers] || {}).dup
+        directories.each do |key, path|
+          path, headers, mime = path
+          roots[key] = ::Rack::File.new(app.expand_path(path), headers||{}, mime||'text/plain')
+        end
+        roots.freeze
+      end
+
+      module RequestMethods
+        # Serve files from the directory corresponding to the given key if the file exists and
+        # this is a GET request.
+        def multi_public(key)
+          public_serve_with(roda_class.opts[:multi_public_servers].fetch(key))
+        end
+      end
+    end
+
+    register_plugin(:multi_public, MultiPublic)
+  end
+end
+

data/lib/roda/plugins/not_allowed.rb

@@ -104,7 +104,9 @@ class Roda
         # arguments, record the verb used.  If given an argument, add an is
         # check with the arguments.
         %w'get post delete head options link patch put trace unlink'.each do |verb|
+          # :nocov:
           if ::Rack::Request.method_defined?("#{verb}?")
+          # :nocov:
             class_eval(<<-END, __FILE__, __LINE__+1)
               def #{verb}(*args, &block)
                 if (empty = args.empty?) && @_is_verbs

data/lib/roda/plugins/path.rb

@@ -10,7 +10,8 @@ class Roda
     #
     # Additionally, you can call the +path+ class method with a class and a block, and it will register
     # the class.  You can then call the +path+ instance method with an instance of that class, and it will
-    # execute the block in the context of the route block scope with the arguments provided to path.
+    # execute the block in the context of the route block scope with the arguments provided to path. You
+    # can call the +url+ instance method with the same arguments as the +path+ method to get the full URL.
     #
     # Example:
     #
@@ -46,11 +47,11 @@ class Roda
     #
     #     r.post 'quux' do
     #       bar = Quux[1]
-    #       r.redirect path(quux, '/bar') # /quux/1/bar
+    #       r.redirect url(quux, '/bar') # http://example.com/quux/1/bar
     #     end
     #   end
     #
-    # The path method accepts the following options when not called with a class:
+    # The path class method accepts the following options when not called with a class:
     #
     # :add_script_name :: Prefix the path generated with SCRIPT_NAME. This defaults to the app's
     #                     :add_script_name option.
@@ -62,7 +63,7 @@ class Roda
     #         method.  If a Symbol or String, uses the value as the url method name.
     # :url_only :: Do not create a path method, just a url method.
     #
-    # Note that if :add_script_name, :url, or :url_only is used, the path method will also create a
+    # Note that if :add_script_name, :relative, :url, or :url_only is used, the path method will also create a
     # <tt>_*_path</tt> private method.
     module Path
       DEFAULT_PORTS = {'http' => 80, 'https' => 443}.freeze
@@ -165,14 +166,8 @@ class Roda
             end
 
             url_block = lambda do |*a, &blk|
-              r = request
-              scheme = r.scheme
-              port = r.port
-              uri = ["#{scheme}://#{r.host}#{":#{port}" unless DEFAULT_PORTS[scheme] == port}"]
-              uri << request.script_name.to_s if add_script_name
               # Allow calling private _method to get path
-              uri << send(_meth, *a, &blk)
-              File.join(uri)
+              "#{_base_url}#{request.script_name if add_script_name}#{send(_meth, *a, &blk)}"
             end
 
             define_method(url_meth, &url_block)
@@ -207,6 +202,21 @@ class Roda
           path = request.script_name.to_s + path if opts[:add_script_name]
           path
         end
+
+        # Similar to #path, but returns a complete URL.
+        def url(*args, &block)
+          "#{_base_url}#{path(*args, &block)}"
+        end
+
+        private
+
+        # The string to prepend to the path to make the path a URL.
+        def _base_url
+          r = @_request
+          scheme = r.scheme
+          port = r.port
+          "#{scheme}://#{r.host}#{":#{port}" unless DEFAULT_PORTS[scheme] == port}"
+        end
       end
     end
 

data/lib/roda/plugins/public.rb

@@ -42,6 +42,8 @@ class Roda
       # :default_mime :: The default mime type to use if the mime type is not recognized.
       # :gzip :: Whether to serve already gzipped files with a .gz extension for clients
       #          supporting gzipped transfer encoding.
+      # :brotli :: Whether to serve already brotli-compressed files with a .br extension
+      #            for clients supporting brotli transfer encoding.
       # :headers :: A hash of headers to use for statically served files
       # :root :: Use this option for the root of the public directory (default: "public")
       def self.configure(app, opts={})
@@ -52,41 +54,13 @@ class Roda
         end
         app.opts[:public_server] = ::Rack::File.new(app.opts[:public_root], opts[:headers]||{}, opts[:default_mime] || 'text/plain')
         app.opts[:public_gzip] = opts[:gzip]
+        app.opts[:public_brotli] = opts[:brotli]
       end
 
       module RequestMethods
         # Serve files from the public directory if the file exists and this is a GET request.
         def public
-          if is_get?
-            path = PARSER.unescape(real_remaining_path)
-            return if path.include?("\0")
-
-            roda_opts = roda_class.opts
-            server = roda_opts[:public_server]
-            path = ::File.join(server.root, *public_path_segments(path))
-
-            if roda_opts[:public_gzip] && env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/
-              gzip_path = path + '.gz'
-
-              if public_file_readable?(gzip_path)
-                res = public_serve(server, gzip_path)
-                headers = res[1]
-
-                unless res[0] == 304
-                  if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-                    headers['Content-Type'] = mime_type
-                  end
-                  headers['Content-Encoding'] = 'gzip'
-                end
-
-                halt res
-              end
-            end
-
-            if public_file_readable?(path)
-              halt public_serve(server, path)
-            end
-          end
+          public_serve_with(roda_class.opts[:public_server])
         end
 
         private
@@ -113,6 +87,40 @@ class Roda
           # :nocov:
         end
 
+        def public_serve_with(server)
+          return unless is_get?
+          path = PARSER.unescape(real_remaining_path)
+          return if path.include?("\0")
+
+          roda_opts = roda_class.opts
+          path = ::File.join(server.root, *public_path_segments(path))
+
+          public_serve_compressed(server, path, '.br', 'br') if roda_opts[:public_brotli]
+          public_serve_compressed(server, path, '.gz', 'gzip') if roda_opts[:public_gzip]
+
+          if public_file_readable?(path)
+            halt public_serve(server, path)
+          end
+        end
+
+        def public_serve_compressed(server, path, suffix, encoding)
+          if env['HTTP_ACCEPT_ENCODING'] =~ /\b#{encoding}\b/
+            compressed_path = path + suffix
+
+            if public_file_readable?(compressed_path)
+              res = public_serve(server, compressed_path)
+              headers = res[1]
+
+              unless res[0] == 304
+                headers['Content-Type'] = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+                headers['Content-Encoding'] = encoding
+              end
+
+              halt res
+            end
+          end
+        end
+
         if ::Rack.release > '2'
           # Serve the given path using the given Rack::File server.
           def public_serve(server, path)

data/lib/roda/plugins/r.rb

@@ -0,0 +1,35 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The r plugin adds an +r+ instance method that will return the request.
+    # This allows you to use common Roda idioms such as +r.halt+ and
+    # +r.redirect+ even when +r+ isn't a local variable in scope. Example:
+    # 
+    #   plugin :r
+    #
+    #   def foo
+    #     r.redirect "/bar"
+    #   end
+    #
+    #   route do |r|
+    #     r.get "foo" do
+    #       foo
+    #     end
+    #     r.get "bar" do
+    #       "bar"
+    #     end
+    #   end
+    module R
+      module InstanceMethods
+        # The request object.
+        def r
+          @_request
+        end
+      end
+    end
+
+    register_plugin(:r, R)
+  end
+end

data/lib/roda/plugins/render.rb

@@ -287,7 +287,9 @@ class Roda
           false
         end
 
+        # :nocov:
         if COMPILED_METHOD_SUPPORT
+        # :nocov:
           # Compile a method in the given module with the given name that will
           # call the compiled template method, updating the compiled template method
           def define_compiled_method(roda_class, method_name, locals_keys=EMPTY_ARRAY)
@@ -337,7 +339,9 @@ class Roda
         def inherited(subclass)
           super
           opts = subclass.opts[:render] = subclass.opts[:render].dup
+          # :nocov:
           if COMPILED_METHOD_SUPPORT
+          # :nocov:
             opts[:template_method_cache] = (opts[:cache_class] || RodaCache).new
           end
           opts[:cache] = opts[:cache].dup

data/lib/roda/plugins/render_locals.rb

@@ -43,7 +43,9 @@ class Roda
       module InstanceMethods
         private
 
+        # :nocov:
         if Render::COMPILED_METHOD_SUPPORT
+        # :nocov:
           # Disable use of cached templates, since it assumes a render/view call with no
           # options will have no locals.
           def _cached_template_method(template)

data/lib/roda/plugins/sinatra_helpers.rb

@@ -374,7 +374,7 @@ class Roda
 
       module ResponseMethods
         # Set or retrieve the response status code.
-        def status(value = (return @status; nil))
+        def status(value = nil || (return @status))
           @status = value
         end
 
@@ -401,7 +401,7 @@ class Roda
 
         # Set multiple response headers with Hash, or return the headers if no
         # argument is given.
-        def headers(hash = (return @headers; nil))
+        def headers(hash = nil || (return @headers))
           @headers.merge!(hash)
         end
 
@@ -412,7 +412,7 @@ class Roda
 
         # Set the Content-Type of the response body given a media type or file
         # extension.  See plugin documentation for options.
-        def content_type(type = (return @headers["Content-Type"]; nil), opts = OPTS)
+        def content_type(type = nil || (return @headers["Content-Type"]), opts = OPTS)
           unless (mime_type = mime_type(type) || opts[:default])
             raise RodaError, "Unknown media type: #{type}"
           end
@@ -478,7 +478,7 @@ class Roda
         # If a type and value are given, set the value in Rack's MIME registry.
         # If only a type is given, lookup the type in Rack's MIME registry and
         # return it.
-        def mime_type(type=(return; nil), value = nil)
+        def mime_type(type=nil || (return), value = nil)
           return type.to_s if type.to_s.include?('/')
           type = ".#{type}" unless type.to_s[0] == ?.
           if value

data/lib/roda/plugins/type_routing.rb

@@ -4,7 +4,7 @@
 class Roda
   module RodaPlugins
     # This plugin makes it easier to to respond to specific request data types. User agents can request
-    # specific data types by either supplying an appropriate +Accept+ header
+    # specific data types by either supplying an appropriate +Accept+ request header
     # or by appending it as file extension to the path.
     #
     # Example:
@@ -50,6 +50,10 @@ class Roda
     # Content-Type header will be set to Roda's default (which you can override via
     # the default_headers plugin).
     #
+    # If the type routing is based on the +Accept+ request header and not the file extension,
+    # then an appropriate +Vary+ header will be set or appended to, so that HTTP caches do
+    # not serve the same result for requests with different +Accept+ headers.
+    #
     # To match custom extensions, use the :types option:
     #
     #   plugin :type_routing, types: {
@@ -195,6 +199,7 @@ class Roda
           @env['HTTP_ACCEPT'].to_s.split(/\s*,\s*/).map do |part|
             mime, _= part.split(/\s*;\s*/, 2)
             if sym = mimes[mime]
+              response['Vary'] = (vary = response['Vary']) ? "#{vary}, Accept" : 'Accept'
               return sym
             end
           end

data/lib/roda/plugins/typecast_params.rb

@@ -609,10 +609,9 @@ class Roda
             when nil
               keys = (0...@obj.length)
 
-              valid = case @obj
-              when Array
+              valid = if @obj.is_a?(Array)
                 true
-              when Hash
+              else
                 keys = keys.map(&:to_s)
                 keys.all?{|k| @obj.has_key?(k)}
               end
@@ -742,9 +741,7 @@ class Roda
             return
           end
 
-          if v = self[key]
-            v.subkey(keys, do_raise)
-          end
+          self[key].subkey(keys, do_raise)
         rescue => e
           handle_error(key, reason, e)
         end
@@ -808,10 +805,10 @@ class Roda
           @nested_params = nil
 
           if capturing_started
-            # Unset capturing if capturing was not already started.
+            # Unset capturing if capturing was already started.
             @capture = nil
           else
-            # If capturing was already started, update cached nested params
+            # If capturing was not already started, update cached nested params
             # before resetting symbolize setting. 
             @nested_params = nested_params
           end
@@ -878,7 +875,7 @@ class Roda
         def handle_error(key, reason, e, do_raise=false)
           case e
           when String
-            handle_error(key, reason, Error.new(e), do_raise=false)
+            handle_error(key, reason, Error.new(e), do_raise)
           when Error, ArgumentError
             if @capture && (le = @capture.last) && le == e
               raise e if do_raise

data/lib/roda/plugins/view_options.rb

@@ -126,7 +126,9 @@ class Roda
 
         private
 
+        # :nocov:
         if Render::COMPILED_METHOD_SUPPORT
+        # :nocov:
           # Return nil if using custom view or layout options.
           # If using a view subdir, prefix the template key with the subdir.
           def _cached_template_method_key(template)

data/lib/roda/request.rb

@@ -466,10 +466,8 @@ class Roda
           rp = @remaining_path
           if rp.getbyte(0) == 47
             if last = rp.index('/', 1)
-              if last > 1
-                @captures << rp[1, last-1]
-                @remaining_path = rp[last, rp.length]
-              end
+              @captures << rp[1, last-1]
+              @remaining_path = rp[last, rp.length]
             elsif rp.length > 1
               @captures << rp[1,rp.length]
               @remaining_path = ""

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 32
+  RodaMinorVersion = 37
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.32.0
+  version: 3.37.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -208,6 +208,11 @@ extra_rdoc_files:
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
 - doc/release_notes/3.32.0.txt
+- doc/release_notes/3.33.0.txt
+- doc/release_notes/3.34.0.txt
+- doc/release_notes/3.35.0.txt
+- doc/release_notes/3.36.0.txt
+- doc/release_notes/3.37.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -241,6 +246,11 @@ files:
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
 - doc/release_notes/3.32.0.txt
+- doc/release_notes/3.33.0.txt
+- doc/release_notes/3.34.0.txt
+- doc/release_notes/3.35.0.txt
+- doc/release_notes/3.36.0.txt
+- doc/release_notes/3.37.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
@@ -267,6 +277,7 @@ files:
 - lib/roda/plugins/content_security_policy.rb
 - lib/roda/plugins/cookies.rb
 - lib/roda/plugins/csrf.rb
+- lib/roda/plugins/custom_matchers.rb
 - lib/roda/plugins/default_headers.rb
 - lib/roda/plugins/default_status.rb
 - lib/roda/plugins/delay_build.rb
@@ -301,6 +312,7 @@ files:
 - lib/roda/plugins/middleware.rb
 - lib/roda/plugins/middleware_stack.rb
 - lib/roda/plugins/module_include.rb
+- lib/roda/plugins/multi_public.rb
 - lib/roda/plugins/multi_route.rb
 - lib/roda/plugins/multi_run.rb
 - lib/roda/plugins/multi_view.rb
@@ -320,6 +332,7 @@ files:
 - lib/roda/plugins/placeholder_string_matchers.rb
 - lib/roda/plugins/precompile_templates.rb
 - lib/roda/plugins/public.rb
+- lib/roda/plugins/r.rb
 - lib/roda/plugins/relative_path.rb
 - lib/roda/plugins/render.rb
 - lib/roda/plugins/render_each.rb
@@ -377,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit