roda 3.55.0 → 3.58.0

data/lib/roda/plugins/status_handler.rb

@@ -15,24 +15,53 @@ class Roda
     #   status_handler(403) do
     #     "You are forbidden from seeing that!"
     #   end
+    #
     #   status_handler(404) do
     #     "Where did it go?"
     #   end
     #
+    #   status_handler(405, keep_headers: ['Accept']) do
+    #     "Use a different method!"
+    #   end
+    #
     # Before a block is called, any existing headers on the response will be
-    # cleared.  So if you want to be sure the headers are set even in your block,
-    # you need to reset them in the block.
+    # cleared, unless the +:keep_headers+ option is used.  If the +:keep_headers+
+    # option is used, the value should be an array, and only the headers listed
+    # in the array will be kept.
     module StatusHandler
+      CLEAR_HEADERS = :clear.to_proc
+      private_constant :CLEAR_HEADERS
+
       def self.configure(app)
         app.opts[:status_handler] ||= {}
       end
 
       module ClassMethods
         # Install the given block as a status handler for the given HTTP response code.
-        def status_handler(code, &block)
+        def status_handler(code, opts=OPTS, &block)
           # For backwards compatibility, pass request argument if block accepts argument
           arity = block.arity == 0 ? 0 : 1
-          opts[:status_handler][code] = [define_roda_method(:"_roda_status_handler_#{code}", arity, &block), arity]
+          handle_headers = case keep_headers = opts[:keep_headers]
+          when nil, false
+            CLEAR_HEADERS
+          when Array
+            # :nocov:
+            if Rack.release >= '2.3'
+              keep_headers = keep_headers.map(&:downcase)
+            end
+            # :nocov:
+            lambda{|headers| headers.delete_if{|k,_| !keep_headers.include?(k)}}
+          else
+            raise RodaError, "Invalid :keep_headers option"
+          end
+
+          meth = define_roda_method(:"_roda_status_handler__#{code}", arity, &block)
+          self.opts[:status_handler][code] = define_roda_method(:"_roda_status_handler_#{code}", 1) do |result|
+            res = @_response
+            res.status = result[0]
+            handle_headers.call(res.headers)
+            result.replace(_roda_handle_route{arity == 1 ? send(meth, @_request) : send(meth)})
+          end
         end
 
         # Freeze the hash of status handlers so that there can be no thread safety issues at runtime.
@@ -47,11 +76,8 @@ class Roda
 
         # If routing returns a response we have a handler for, call that handler.
         def _roda_after_20__status_handler(result)
-          if result && (meth, arity = opts[:status_handler][result[0]]; meth) && (v = result[2]).is_a?(Array) && v.empty?
-            res = @_response
-            res.headers.clear
-            res.status = result[0]
-            result.replace(_roda_handle_route{arity == 1 ? send(meth, @_request) : send(meth)})
+          if result && (meth = opts[:status_handler][result[0]]) && (v = result[2]).is_a?(Array) && v.empty?
+            send(meth, result)
           end
         end
       end

data/lib/roda/plugins/symbol_status.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+require 'rack/utils'
+
 class Roda
   module RodaPlugins
     # The symbol_status plugin patches the +status=+ response method to

data/lib/roda/plugins/unescape_path.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+require 'rack/utils'
+
 #
 class Roda
   module RodaPlugins

data/lib/roda/request.rb

@@ -1,6 +1,19 @@
 # frozen-string-literal: true
 
-require "rack"
+# :nocov:
+begin
+  require "rack/version"
+rescue LoadError
+  require "rack"
+else
+  if Rack.release >= '2.3'
+    require "rack/request"
+  else
+    require "rack"
+  end
+end
+# :nocov:
+
 require_relative "cache"
 
 class Roda
@@ -116,6 +129,27 @@ class Roda
           "#<#{self.class.inspect} #{@env["REQUEST_METHOD"]} #{path}>"
         end
 
+        # :nocov:
+        if Rack.release >= '2.3'
+          def http_version
+            # Prefer SERVER_PROTOCOL as it is required in Rack 3.
+            # Still fall back to HTTP_VERSION if SERVER_PROTOCOL
+            # is not set, in case the server in use is not Rack 3
+            # compliant.
+            @env['SERVER_PROTOCOL'] || @env['HTTP_VERSION']
+          end
+        else
+        # :nocov:
+          # What HTTP version the request was submitted with.
+          def http_version
+            # Prefer HTTP_VERSION as it is backwards compatible
+            # with previous Roda versions. Fallback to
+            # SERVER_PROTOCOL for servers that do not set
+            # HTTP_VERSION.
+            @env['HTTP_VERSION'] || @env['SERVER_PROTOCOL']
+          end
+        end
+
         # Does a terminal match on the current path, matching only if the arguments
         # have fully matched the path.  If it matches, the match block is
         # executed, and when the match block returns, the rack response is

data/lib/roda/response.rb

@@ -1,5 +1,10 @@
 # frozen-string-literal: true
 
+begin
+  require 'rack/headers'
+rescue LoadError
+end
+
 class Roda
   # Base class used for Roda responses.  The instance methods for this
   # class are added by Roda::RodaPlugins::Base::ResponseMethods, the class

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 = 55
+  RodaMinorVersion = 58
 
   # 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.55.0
+  version: 3.58.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-12 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.7.0
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-global_expectations
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +227,9 @@ extra_rdoc_files:
 - doc/release_notes/3.53.0.txt
 - doc/release_notes/3.54.0.txt
 - doc/release_notes/3.55.0.txt
+- doc/release_notes/3.56.0.txt
+- doc/release_notes/3.57.0.txt
+- doc/release_notes/3.58.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -275,6 +292,9 @@ files:
 - doc/release_notes/3.53.0.txt
 - doc/release_notes/3.54.0.txt
 - doc/release_notes/3.55.0.txt
+- doc/release_notes/3.56.0.txt
+- doc/release_notes/3.57.0.txt
+- doc/release_notes/3.58.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -318,10 +338,14 @@ files:
 - lib/roda/plugins/error_handler.rb
 - lib/roda/plugins/error_mail.rb
 - lib/roda/plugins/exception_page.rb
+- lib/roda/plugins/filter_common_logger.rb
 - lib/roda/plugins/flash.rb
 - lib/roda/plugins/h.rb
 - lib/roda/plugins/halt.rb
+- lib/roda/plugins/hash_branch_view_subdir.rb
+- lib/roda/plugins/hash_branches.rb
 - lib/roda/plugins/hash_matcher.rb
+- lib/roda/plugins/hash_paths.rb
 - lib/roda/plugins/hash_routes.rb
 - lib/roda/plugins/head.rb
 - lib/roda/plugins/header_matchers.rb
@@ -374,6 +398,7 @@ files:
 - lib/roda/plugins/route_csrf.rb
 - lib/roda/plugins/run_append_slash.rb
 - lib/roda/plugins/run_handler.rb
+- lib/roda/plugins/run_require_slash.rb
 - lib/roda/plugins/sessions.rb
 - lib/roda/plugins/shared_vars.rb
 - lib/roda/plugins/sinatra_helpers.rb
@@ -396,13 +421,13 @@ files:
 - lib/roda/response.rb
 - lib/roda/session_middleware.rb
 - lib/roda/version.rb
-homepage: http://roda.jeremyevans.net
+homepage: https://roda.jeremyevans.net
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jeremyevans/roda/issues
-  changelog_uri: http://roda.jeremyevans.net/rdoc/files/CHANGELOG.html
-  documentation_uri: http://roda.jeremyevans.net/documentation.html
+  changelog_uri: https://roda.jeremyevans.net/rdoc/files/CHANGELOG.html
+  documentation_uri: https://roda.jeremyevans.net/documentation.html
   mailing_list_uri: https://github.com/jeremyevans/roda/discussions
   source_code_uri: https://github.com/jeremyevans/roda
 post_install_message: