roda 3.35.0 → 3.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370e18bb1d1cfb9fb8b0c10fda1a4f57161a39c6d733b628ddd60058d231f896
-  data.tar.gz: fe0c8ddb499cdbafb0f047d9445fca726f742e38674f90731f3421132c373365
+  metadata.gz: 8e87645db18482f3ad97d106e268d76b2567d074490f37d7e99d52d06e4e5483
+  data.tar.gz: b84b082c2f27fcbd31254cb80de5e6610b7417e722eaf3dc3d8753a4604a0701
 SHA512:
-  metadata.gz: 60db0b47d97ae40437e0396bc795ac360194bd88067e6611cf277888d054e3c41786eb062f4ab31d6683cb4755a3a27d148a576236c77a4d46db67fc2accc7e1
-  data.tar.gz: 44745afaa29ccee2d51a132f7b7be4da6818191814a9ff8a2afd52f34636789cb0e4d22eb63ade49ea0411470a73b05a1996c7bb70cc7edf04264fb2fddadb83
+  metadata.gz: 3b21d6fa4b33c029a8b23a8ec437e70e2799e3f2bec27239d3cbfc5a1a4bb8cd82fc95309ad27d22243695298535b02687b0948218df1f7a1a0812242079e3b7
+  data.tar.gz: 3dc9629b16a4d9f496cee61bc40396f6893bfe114666ba7554327cd052946719410e2f4e89a27388cea291fd7b5ba1bcd37c669aa1dfc7b64c48a6622bafb013

data/CHANGELOG

@@ -1,3 +1,39 @@
+= 3.40.0 (2021-01-14)
+
+* Add freeze_template_caches! to the precompile_templates plugin, which ensures all templates are precompiled, and speeds up template access (jeremyevans)
+
+* Add precompile_views to the precompile_templates plugin, which precompiles the optimized render methods (jeremyevans)
+
+* Have RodaCache#freeze return the frozen internal hash (which no longer needs a mutex for thread-safety) (jeremyevans)
+
+* Speed up the view method in the render plugin even more when freezing the application (jeremyevans)
+
+* Speed up the view method in the render plugin when called with a single argument (jeremyevans)
+
+= 3.39.0 (2020-12-15)
+
+* Speed up relative_path plugin if relative_path or relative_prefix is called more than once (jeremyevans)
+
+* Avoid method redefinition warnings in verbose warning mode (jeremyevans)
+
+* Make typecast_params.convert! handle explicit nil values the same as missing values (jeremyevans)
+
+= 3.38.0 (2020-11-16)
+
+* Make error_email and error_mail plugins rescue invalid parameter errors when preparing the email body (jeremyevans)
+
+= 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)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2020 Jeremy Evans
+Copyright (c) 2014-2021 Jeremy Evans
 Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
 Copyright (c) 2008-2009 Christian Neukirchen
 

data/doc/release_notes/3.3.0.txt

@@ -248,7 +248,7 @@
   Note that if there are multiple conversion errors raised inside a
   convert! or convert_each!  block, they are recorded and a single
   Roda::RodaPlugins::TypecastParams::Error instance is raised after
-  processing the block.  TypecastParams::Error#params_names can be
+  processing the block.  TypecastParams::Error#param_names can be
   called on the exception to get an array of all parameter names
   with conversion issues, and TypecastParams::Error#all_errors
   can be used to get an array of all Error instances.

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/doc/release_notes/3.38.0.txt

@@ -0,0 +1,5 @@
+= Improvements
+
+* The error_email and error_mail plugins now rescue invalid parameter
+  errors when preparing the email body, because you generally don't
+  want your error handler to raise an exception.

data/doc/release_notes/3.39.0.txt

@@ -0,0 +1,16 @@
+= Improvements
+
+* The relative_path plugin is now faster if you are calling
+  relative_path or relative_prefix more than once when handling a
+  request.
+
+* The typecast_params.convert! method in the typecast_params plugin
+  now handles explicit nil values the same as missing values.
+  Explicit nil values do not generally occur in normal Rack parameter
+  parsing, but they can occur when using the json_parser plugin to
+  parse JSON requests.
+
+* Roda now avoids method redefinition warnings in verbose mode by
+  using a self alias.  As Ruby 3 is dropping uninitialized instance
+  variable warnings, Roda will be verbose warning free if you are
+  using Ruby 3.

data/doc/release_notes/3.40.0.txt

@@ -0,0 +1,24 @@
+= New Features
+
+* A precompile_views method has been added to the
+  precompile_templates plugin.  This method works with Roda's
+  optimized compiled view methods, allowing additional memory
+  sharing between parent and child processes.
+
+* A freeze_template_caches! method has been added to the
+  precompile_templates plugin.  This freezes the template caches,
+  preventing the compilation of additional templates, useful for
+  enforcing that only precompiled templates are used.  Additionally,
+  this speeds up access to the template caches.
+
+* RodaCache#freeze now returns the frozen internal hash, which can
+  then be accessed without a mutex. Previously, freeze only froze
+  the receiver and not the internal hash, so it didn't have the
+  expected effect.
+
+= Other Improvements
+
+* The view method in the render plugin is now faster in most cases
+  when a single argument is used.  When freezing the application,
+  an additional optimization is performed to increase the
+  performance of the view method even further.

data/lib/roda.rb

@@ -114,6 +114,7 @@ class Roda
                 alias_method meth, temp_method
                 undef_method temp_method
                 private meth
+                alias_method meth, meth
                 meth = :"#{meth}_arity"
               elsif required_args > 1
                 b = block
@@ -144,6 +145,7 @@ class Roda
 
           define_method(meth, &block)
           private meth
+          alias_method meth, meth
 
           if arity_meth
             required_args, optional_args, rest, keyword = _define_roda_method_arg_numbers(instance_method(meth))
@@ -167,6 +169,7 @@ class Roda
               send(meth, *a)
             end
             private arity_meth
+            alias_method arity_meth, arity_meth
           end
 
           call_meth
@@ -199,6 +202,7 @@ class Roda
 
                 private
 
+                alias set_default_headers set_default_headers
                 def set_default_headers
                   @headers['Content-Type'] ||= 'text/html'
                 end
@@ -403,6 +407,7 @@ class Roda
               class_eval("def _roda_before; #{meths.join(';')} end", __FILE__, __LINE__)
             end
             private :_roda_before
+            alias_method :_roda_before, :_roda_before
           end
         end
 
@@ -419,6 +424,7 @@ class Roda
               class_eval("def _roda_after(res); #{meths.map{|s| "#{s}(res)"}.join(';')} end", __FILE__, __LINE__)
             end
             private :_roda_after
+            alias_method :_roda_after, :_roda_after
           end
         end
 

data/lib/roda/cache.rb

@@ -22,6 +22,13 @@ class Roda
       @mutex.synchronize{@hash[key] = value}
     end
 
+    # Return the frozen internal hash.  The internal hash can then
+    # be accessed directly since it is frozen and there are no
+    # thread safety issues.
+    def freeze
+      @hash.freeze
+    end
+
     private
 
     # Create a copy of the cache with a separate mutex.

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/default_headers.rb

@@ -33,6 +33,7 @@ class Roda
             response_class.class_eval(<<-END, __FILE__, __LINE__+1)
               private
 
+              alias set_default_headers set_default_headers
               def set_default_headers
                 h = @headers
                 #{headers.map{|k,v| "h[#{k.inspect}] ||= #{v.inspect}"}.join('; ')}

data/lib/roda/plugins/error_email.rb

@@ -54,6 +54,13 @@ class Roda
         :body=>lambda do |s, e|
           format = lambda{|h| h.map{|k, v| "#{k.inspect} => #{v.inspect}"}.sort.join("\n")}
 
+          begin
+            params = s.request.params
+            params = (format[params] unless params.empty?)
+          rescue
+            params = 'Invalid Parameters!'
+          end
+
           message = String.new
           message << <<END
 Path: #{s.request.path}
@@ -73,12 +80,12 @@ ENV:
 #{format[s.env]}
 END
 
-          unless s.request.params.empty?
+          if params
             message << <<END
 
 Params:
 
-#{format[s.request.params]}
+#{params}
 END
           end
 

data/lib/roda/plugins/error_mail.rb

@@ -71,6 +71,13 @@ class Roda
 
           format = lambda{|h| h.map{|k, v| "#{k.inspect} => #{v.inspect}"}.sort.join("\n")}
 
+          begin
+            params = request.params
+            params = (format[params] unless params.empty?)
+          rescue
+            params = 'Invalid Parameters!'
+          end
+
           message = String.new
           message << <<END
 Path: #{request.path}
@@ -91,12 +98,12 @@ ENV:
 #{format[env]}
 END
 
-          unless request.params.empty?
+          if params
             message << <<END
 
 Params:
 
-#{format[request.params]}
+#{params}
 END
           end
 

data/lib/roda/plugins/mail_processor.rb

@@ -476,6 +476,8 @@ class Roda
 
         undef_method :match_rcpt
         undef_method :match_text
+        undef_method :match_body
+        undef_method :match_subject
 
         # Same as +header+, but also mark the message as being handled.
         def handle_header(key, value=nil)

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/precompile_templates.rb

@@ -13,32 +13,33 @@ class Roda
     # all of the child processes can use the same precompiled templates, which
     # saves memory.
     #
-    # After loading the plugin, you can call +precompile_templates+ with
-    # the pattern of templates you would like to precompile:
+    # Another advantage of the precompile_templates plugin is that after
+    # template precompilation, access to the template file in the file system is
+    # no longer needed, so this can be used with security features that do not
+    # allow access to the template files at runtime.
+    #
+    # After loading the plugin, you should call precompile_views with an array
+    # of views to compile, using the same argument you are passing to view or
+    # render:
     #
     #   plugin :precompile_templates
-    #   precompile_templates "views/\*\*/*.erb"
+    #   precompile_views %w'view1 view2'
+    #   
+    # If the view requires local variables, you should call precompile_views with a second
+    # argument for the local variables:
     #
-    # That will precompile all erb template files in the views directory or
-    # any subdirectory.
+    #   plugin :precompile_templates
+    #   precompile_views :view3, [:local_var1, :local_var2]
     #
-    # If the templates use local variables, you need to specify which local
-    # variables to precompile, which should be an array of symbols:
+    # After all templates are precompiled, you can optionally use freeze_template_caches!,
+    # which will freeze the template caches so that any template compilation at runtime
+    # will result in an error.  This also speeds up template cache access, since the
+    # template caches no longer need a mutex.
     #
-    #   precompile_templates 'views/users/_*.erb', locals: [:user]
+    #   freeze_template_caches!
     #
     # Note that you should use Tilt 2.0.1+ if you are using this plugin, so
     # that locals are handled in the same order.
-    #
-    # You can specify other render options when calling +precompile_templates+,
-    # including +:cache_key+, +:template_class+, and +:template_opts+.  If you
-    # are passing any of those options to render/view for the template, you
-    # should pass the same options when precompiling the template.
-    #
-    # To compile inline templates, just pass a single hash containing an :inline
-    # to +precompile_templates+:
-    #
-    #   precompile_templates inline: some_template_string
     module PrecompileTemplates
       # Load the render plugin as precompile_templates depends on it.
       def self.load_dependencies(app, opts=OPTS)
@@ -46,8 +47,49 @@ class Roda
       end
 
       module ClassMethods
-        # Precompile the templates using the given options.  See PrecompileTemplates
-        # for details.
+        # Freeze the template caches.  Should be called after precompiling all templates during
+        # application startup, if you don't want to allow templates to be cached at runtime.
+        # In addition to ensuring that no templates are compiled at runtime, this also speeds
+        # up rendering by freezing the template caches, so that a mutex is not needed to access
+        # them.
+        def freeze_template_caches!
+          _freeze_layout_method
+
+          opts[:render] = render_opts.merge(
+            :cache=>render_opts[:cache].freeze,
+            :template_method_cache=>render_opts[:template_method_cache].freeze,
+          ).freeze
+          self::RodaCompiledTemplates.freeze
+
+          nil
+        end
+
+        # Precompile the templates using the given options.  Note that this doesn't
+        # handle optimized template methods supported in newer versions of Roda, but
+        # there are still cases where makes sense to use it.
+        #
+        # You can call +precompile_templates+ with the pattern of templates you would
+        # like to precompile:
+        #
+        #   precompile_templates "views/**/*.erb"
+        #
+        # That will precompile all erb template files in the views directory or
+        # any subdirectory.
+        #
+        # If the templates use local variables, you need to specify which local
+        # variables to precompile, which should be an array of symbols:
+        #
+        #   precompile_templates 'views/users/_*.erb', locals: [:user]
+        #
+        # You can specify other render options when calling +precompile_templates+,
+        # including +:cache_key+, +:template_class+, and +:template_opts+.  If you
+        # are passing any of those options to render/view for the template, you
+        # should pass the same options when precompiling the template.
+        #
+        # To compile inline templates, just pass a single hash containing an :inline
+        # to +precompile_templates+:
+        #
+        #   precompile_templates inline: some_template_string
         def precompile_templates(pattern, opts=OPTS)
           if pattern.is_a?(Hash)
             opts = pattern.merge(opts)
@@ -68,7 +110,40 @@ class Roda
           instance = allocate
           compile_opts.each do |compile_opt|
             template = instance.send(:retrieve_template, compile_opt)
-            Render.tilt_template_compiled_method(template, locals, self)
+            begin
+              Render.tilt_template_compiled_method(template, locals, self)
+            rescue NotImplementedError
+              # When freezing template caches, you may want to precompile a template for a
+              # template type that doesn't support template precompilation, just to populate
+              # the cache.  Tilt rescues NotImplementedError in this case, which we can ignore.
+              nil
+            end
+          end
+
+          nil
+        end
+
+        # Precompile the given views with the given locals, handling optimized template methods.
+        def precompile_views(views, locals=EMPTY_ARRAY)
+          instance = allocate
+          views = Array(views)
+
+          if locals.empty?
+            opts = OPTS
+          else
+            locals_hash = {}
+            locals.each{|k| locals_hash[k] = nil}
+            opts = {:locals=>locals_hash}
+          end
+
+          views.each do |view|
+            instance.send(:retrieve_template, instance.send(:render_template_opts, view, opts))
+          end
+
+          if locals_hash
+            views.each do |view|
+              instance.send(:_optimized_render_method_for_locals, view, locals_hash)
+            end
           end
 
           nil

data/lib/roda/plugins/public.rb

@@ -60,21 +60,7 @@ class Roda
       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))
-
-            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
+          public_serve_with(roda_class.opts[:public_server])
         end
 
         private
@@ -101,6 +87,22 @@ 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

data/lib/roda/plugins/relative_path.rb

@@ -41,6 +41,7 @@ class Roda
         # Return a relative prefix to append to an absolute path to a relative path
         # based on the current path of the request.
         def relative_prefix
+          return @_relative_prefix if @_relative_prefix
           env = @_request.env
           script_name = env["SCRIPT_NAME"]
           path_info = env["PATH_INFO"]
@@ -50,16 +51,16 @@ class Roda
           case script_name.getbyte(0)
           when nil # SCRIPT_NAME empty
             unless path_info.getbyte(0) == 47 # PATH_INFO starts with /
-              return ''
+              return(@_relative_prefix = '')
             end
           when 47 # SCRIPT_NAME starts with /
             # nothing
           else
-            return ''
+            return(@_relative_prefix = '')
           end
 
           slash_count = script_name.count('/') + path_info.count('/')
-          if slash_count > 1
+          @_relative_prefix = if slash_count > 1
             ("../" * (slash_count - 2)) << ".."
           else
             "."

data/lib/roda/plugins/render.rb

@@ -106,7 +106,7 @@ class Roda
     # :template_block :: Pass this block when creating the underlying template,
     #                    ignored when using :inline.  Disables caching of the
     #                    template by default.
-    # :template_class :: Provides the template class to use, inside of using
+    # :template_class :: Provides the template class to use, instead of using
     #                    Tilt or <tt>Tilt[:engine]</tt>.
     #
     # Here's an example of using these options:
@@ -333,6 +333,25 @@ class Roda
       end
 
       module ClassMethods
+        # :nocov:
+        if COMPILED_METHOD_SUPPORT
+        # :nocov:
+          # If using compiled methods and there is an optimized layout, speed up
+          # access to the layout method to improve the performance of view.
+          def freeze
+            begin
+              _freeze_layout_method
+            rescue
+              # This is only for optimization, if any errors occur, they can be ignored.
+              # One possibility for error is the app doesn't use a layout, but doesn't
+              # specifically set the :layout=>false plugin option.
+              nil
+            end
+
+            super
+          end
+        end
+
         # Copy the rendering options into the subclass, duping
         # them as necessary to prevent changes in the subclass
         # affecting the parent class.
@@ -352,6 +371,27 @@ class Roda
         def render_opts
           opts[:render]
         end
+
+        private
+
+        # Precompile the layout method, to reduce method calls to look it up at runtime.
+        def _freeze_layout_method
+          if render_opts[:layout]
+            instance = allocate
+            instance.send(:retrieve_template, instance.send(:view_layout_opts, OPTS))
+
+            # :nocov:
+            if COMPILED_METHOD_SUPPORT
+            # :nocov:
+              if (layout_template = render_opts[:optimize_layout]) && !opts[:render][:optimized_layout_method_created]
+                instance.send(:retrieve_template, :template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
+                layout_method = opts[:render][:template_method_cache][:_roda_layout]
+                define_method(:_layout_method){layout_method}
+                opts[:render] = opts[:render].merge(:optimized_layout_method_created=>true)
+              end
+            end
+          end
+        end
       end
 
       module InstanceMethods
@@ -379,15 +419,19 @@ class Roda
           if optimized_template
             content = send(optimized_template, OPTS)
 
-            render_opts = self.class.opts[:render]
-            if layout_template = render_opts[:optimize_layout]
-              method_cache = render_opts[:template_method_cache]
-              unless layout_method = method_cache[:_roda_layout]
-                retrieve_template(:template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
-                layout_method = method_cache[:_roda_layout]
-              end
+            # First, check if the optimized layout method has already been created,
+            # and use it if so.  This way avoids the extra conditional and local variable
+            # assignments in the next section.
+            if layout_method = _layout_method
+              return send(layout_method, OPTS){content}
+            end
 
-              if layout_method
+            # If we have an optimized template method but no optimized layout method, create the
+            # optimized layout method if possible and use it.  If you can't create the optimized
+            # layout method, fall through to the slower approach.
+            if layout_template = self.class.opts[:render][:optimize_layout]
+              retrieve_template(:template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
+              if layout_method = _layout_method
                 return send(layout_method, OPTS){content}
               end
             end
@@ -428,6 +472,11 @@ class Roda
             method_cache[template]
           end
 
+          # Return a symbol containing the optimized layout method
+          def _layout_method
+            self.class.opts[:render][:template_method_cache][:_roda_layout]
+          end
+
           # Use an optimized render path for templates with a hash of locals.  Returns the result
           # of the template render if the optimized path is used, or nil if the optimized
           # path is not used and the long method needs to be used.
@@ -471,11 +520,15 @@ class Roda
           end
         else
           # :nocov:
-          def _cached_template_method(template)
+          def _cached_template_method(_)
             nil
           end
 
-          def _cached_template_method_key(template)
+          def _cached_template_method_key(_)
+            nil
+          end
+
+          def _layout_method
             nil
           end
 

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: {
@@ -137,6 +141,7 @@ class Roda
           app::RodaRequest.send(:define_method, type) do |&block|
             on_type(type, &block)
           end
+          app::RodaRequest.send(:alias_method, type, type)
         end
 
         app.opts[:type_routing] = config.freeze
@@ -195,6 +200,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

@@ -229,7 +229,7 @@ class Roda
     #
     # Note that if there are multiple conversion Error raised inside a +convert!+ or +convert_each!+ 
     # block, they are recorded and a single TypecastParams::Error instance is raised after
-    # processing the block.  TypecastParams::Error#params_names can be called on the exception to
+    # processing the block.  TypecastParams::Error#param_names can be called on the exception to
     # get an array of all parameter names with conversion issues, and TypecastParams::Error#all_errors
     # can be used to get an array of all Error instances.
     #
@@ -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
@@ -725,7 +724,7 @@ class Roda
               raise Error, "parameter #{param_name(nil)} is not a hash" if do_raise
               return
             end
-            present = @obj.has_key?(key)
+            present = !@obj[key].nil?
           when Integer
             unless @obj.is_a?(Array)
               raise Error, "parameter #{param_name(nil)} is not an array" if do_raise

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 = 35
+  RodaMinorVersion = 40
 
   # 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.35.0
+  version: 3.40.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -174,16 +174,8 @@ extra_rdoc_files:
 - MIT-LICENSE
 - CHANGELOG
 - doc/conventions.rdoc
-- doc/release_notes/3.7.0.txt
 - doc/release_notes/3.0.0.txt
 - doc/release_notes/3.1.0.txt
-- doc/release_notes/3.2.0.txt
-- doc/release_notes/3.3.0.txt
-- doc/release_notes/3.4.0.txt
-- doc/release_notes/3.5.0.txt
-- doc/release_notes/3.6.0.txt
-- doc/release_notes/3.8.0.txt
-- doc/release_notes/3.9.0.txt
 - doc/release_notes/3.10.0.txt
 - doc/release_notes/3.11.0.txt
 - doc/release_notes/3.12.0.txt
@@ -195,6 +187,7 @@ extra_rdoc_files:
 - doc/release_notes/3.17.0.txt
 - doc/release_notes/3.18.0.txt
 - doc/release_notes/3.19.0.txt
+- doc/release_notes/3.2.0.txt
 - doc/release_notes/3.20.0.txt
 - doc/release_notes/3.21.0.txt
 - doc/release_notes/3.22.0.txt
@@ -205,12 +198,24 @@ extra_rdoc_files:
 - doc/release_notes/3.27.0.txt
 - doc/release_notes/3.28.0.txt
 - doc/release_notes/3.29.0.txt
+- doc/release_notes/3.3.0.txt
 - 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.38.0.txt
+- doc/release_notes/3.39.0.txt
+- doc/release_notes/3.4.0.txt
+- doc/release_notes/3.40.0.txt
+- doc/release_notes/3.5.0.txt
+- doc/release_notes/3.6.0.txt
+- doc/release_notes/3.7.0.txt
+- doc/release_notes/3.8.0.txt
+- doc/release_notes/3.9.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -247,7 +252,12 @@ files:
 - 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.38.0.txt
+- doc/release_notes/3.39.0.txt
 - doc/release_notes/3.4.0.txt
+- doc/release_notes/3.40.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
@@ -273,6 +283,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
@@ -307,6 +318,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
@@ -384,7 +396,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit