roda 3.53.0 → 3.56.0

data/lib/roda/plugins/run_handler.rb

@@ -35,7 +35,13 @@ class Roda
         def run(app, opts=OPTS)
           res = catch(:halt){super(app)}
           yield res if defined?(yield)
-          throw(:halt, res) unless opts[:not_found] == :pass && res[0] == 404
+          if opts[:not_found] == :pass && res[0] == 404
+            body = res[2]
+            body.close if body.respond_to?(:close)
+            nil
+          else
+            throw(:halt, res)
+          end
         end
       end
     end

data/lib/roda/plugins/run_require_slash.rb

@@ -0,0 +1,46 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The run_require_slash plugin makes +r.run+ a no-op if the remaining
+    # path is not empty and does not start with +/+. The Rack SPEC requires that
+    # +PATH_INFO+ start with a slash if not empty, so this plugin prevents
+    # dispatching to the application with an environment that would violate the
+    # Rack SPEC.
+    #
+    # You are unlikely to want to use this plugin unless are consuming partial
+    # segments of the request path, or using the match_affix plugin to change
+    # how routing is done:
+    #
+    #   plugin :match_affix, "", /(\/|\z)/
+    #   route do |r|
+    #     r.on "/a" do
+    #       r.on "b" do
+    #         r.run App
+    #       end
+    #     end
+    #   end
+    #
+    #   # with run_require_slash: 
+    #   # GET /a/b/e => App not dispatched to
+    #   # GET /a/b => App gets "" as PATH_INFO
+    #
+    #   # with run_require_slash: 
+    #   # GET /a/b/e => App gets "e" as PATH_INFO, violating rack SPEC
+    #   # GET /a/b => App gets "" as PATH_INFO
+    module RunRequireSlash
+      module RequestMethods
+        # Calls the given rack app only if the remaining patch is empty or
+        # starts with a slash.
+        def run(*)
+          if @remaining_path.empty? || @remaining_path.start_with?('/')
+            super
+          end
+        end
+      end
+    end
+
+    register_plugin(:run_require_slash, RunRequireSlash)
+  end
+end

data/lib/roda/plugins/sessions.rb

@@ -14,6 +14,7 @@ require 'base64'
 require 'json'
 require 'securerandom'
 require 'zlib'
+require 'rack/utils'
 
 class Roda
   module RodaPlugins

data/lib/roda/plugins/sinatra_helpers.rb

@@ -1,5 +1,15 @@
 # frozen-string-literal: true
 
+require 'rack/mime'
+begin
+  require 'rack/files'
+rescue LoadError
+  # :nocov:
+  require 'rack/file'
+  # :nocov:
+end
+
+
 #
 class Roda
   module RodaPlugins
@@ -215,6 +225,10 @@ class Roda
       ISO88591_ENCODING = Encoding.find('ISO-8859-1')
       BINARY_ENCODING = Encoding.find('BINARY')
 
+      # :nocov:
+      RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
+      # :nocov:
+
       # Depend on the status_303 plugin.
       def self.load_dependencies(app, _opts = nil)
         app.plugin :status_303
@@ -333,7 +347,7 @@ class Roda
             last_modified(lm)
           end
 
-          file = ::Rack::File.new nil
+          file = RACK_FILES.new nil
           s, h, b = if Rack.release > '2'
             file.serving(self, path)
           else

data/lib/roda/plugins/static.rb

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

data/lib/roda/plugins/status_303.rb

@@ -17,10 +17,13 @@ class Roda
         private
 
         def default_redirect_status
-          if env['HTTP_VERSION'] == 'HTTP/1.1' && !is_get?
-            303
-          else
+          return super if is_get?
+
+          case http_version
+          when 'HTTP/1.0', 'HTTP/0.9', nil
             super
+          else
+            303
           end
         end
       end

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
@@ -37,11 +42,22 @@ class Roda
         # code for non-empty responses and a 404 code for empty responses.
         attr_accessor :status
 
-        # Set the default headers when creating a response.
-        def initialize
-          @headers = {}
-          @body    = []
-          @length  = 0
+        # :nocov:
+        if defined?(Rack::Headers) && Rack::Headers.is_a?(Class)
+          # Set the default headers when creating a response.
+          def initialize
+            @headers = Rack::Headers.new
+            @body    = []
+            @length  = 0
+          end
+        else
+        # :nocov:
+          # Set the default headers when creating a response.
+          def initialize
+            @headers = {}
+            @body    = []
+            @length  = 0
+          end
         end
 
         # Return the response header with the given key. Example:
@@ -96,8 +112,7 @@ class Roda
             if (s == 304 || s == 204 || (s >= 100 && s <= 199))
               h.delete("Content-Type")
             elsif s == 205
-              h.delete("Content-Type")
-              h["Content-Length"] = '0'
+              empty_205_headers(h)
             else
               h["Content-Length"] ||= '0'
             end
@@ -158,6 +173,23 @@ class Roda
 
         private
 
+        # :nocov:
+        if Rack.release < '2.0.2'
+          # Don't use a content length for empty 205 responses on
+          # rack 1, as it violates Rack::Lint in that version.
+          def empty_205_headers(headers)
+            headers.delete("Content-Type")
+            headers.delete("Content-Length")
+          end
+        # :nocov:
+        else
+          # Set the content length for empty 205 responses to 0
+          def empty_205_headers(headers)
+            headers.delete("Content-Type")
+            headers["Content-Length"] = '0'
+          end
+        end
+
         # For each default header, if a header has not already been set for the
         # response, set the header in the response.
         def set_default_headers

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 = 53
+  RodaMinorVersion = 56
 
   # 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.53.0
+  version: 3.56.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-05-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
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sass
+  name: sassc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -211,6 +225,9 @@ extra_rdoc_files:
 - doc/release_notes/3.51.0.txt
 - doc/release_notes/3.52.0.txt
 - 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.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -271,6 +288,9 @@ files:
 - doc/release_notes/3.51.0.txt
 - doc/release_notes/3.52.0.txt
 - 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.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -370,6 +390,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
@@ -392,13 +413,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: 
@@ -416,7 +437,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit