roda 3.109.0 → 3.110.0

data/lib/roda/request.rb

@@ -109,10 +109,10 @@ class Roda
         # rack response array of status, headers, and body.  If no argument
         # is given, uses the current response.
         #
-        #   r.halt [200, {'Content-Type'=>'text/html'}, ['Hello World!']]
+        #   r.halt [200, {'content-type'=>'text/html'}, ['Hello World!']]
         #   
         #   response.status = 200
-        #   response['Content-Type'] = 'text/html'
+        #   response['content-type'] = 'text/html'
         #   response.write 'Hello World!'
         #   r.halt
         def halt(res=response.finish)
@@ -328,7 +328,7 @@ class Roda
         #     # matches
         #   end
         #
-        # This is usuable inside other match blocks:
+        # This is usable inside other match blocks:
         #
         #   [r.request_method, r.remaining_path]
         #   # => ['GET', '/foo/']
@@ -512,7 +512,7 @@ class Roda
           end
         end
 
-        # Match the given symbol if any segment matches.
+        # Match for any nonempty segment.
         def _match_symbol(sym=nil)
           rp = @remaining_path
           if rp.getbyte(0) == 47
@@ -635,7 +635,7 @@ class Roda
         # For non-GET requests, redirects to the current path, which will
         # trigger a GET request.  This is to make the common case where
         # a POST request will redirect to a GET request at the same location
-        # will work fine.
+        # work fine.
         #
         # If the current request is a GET request, raise an error, as otherwise
         # it is easy to create an infinite redirect.
@@ -654,7 +654,7 @@ class Roda
           302
         end
 
-        # Whether the current path is considered empty.
+        # Whether the remaining path is considered empty.
         def empty_path?
           @remaining_path.empty?
         end
@@ -723,13 +723,14 @@ class Roda
           end
         end
 
-        # How to handle block results that are not nil, false, or a String.
+        # Handle block results that are not nil, false, or a String.
         # By default raises an exception.
         def unsupported_block_result(result)
           raise RodaError, "unsupported block result: #{result.inspect}"
         end
 
         # Handle an unsupported matcher.
+        # By default raises an exception.
         def unsupported_matcher(matcher)
           raise RodaError, "unsupported matcher: #{matcher.inspect}"
         end

data/lib/roda/response.rb

@@ -10,6 +10,7 @@ class Roda
   # headers used internally by Roda can be lower case on Rack 3, so that it is
   # possible to use a plain hash of response headers instead of using Rack::Headers.
   module RodaResponseHeaders
+    # RODA4: switch all constant access to downcased strings
     downcase = defined?(Rack::Headers) && Rack::Headers.is_a?(Class)
 
     %w'Allow Cache-Control Content-Disposition Content-Encoding Content-Length
@@ -65,14 +66,14 @@ class Roda
 
         # Return the response header with the given key. Example:
         #
-        #   response['Content-Type'] # => 'text/html'
+        #   response['content-type'] # => 'text/html'
         def [](key)
           @headers[key]
         end
 
         # Set the response header with the given key to the given value.
         #
-        #   response['Content-Type'] = 'application/json'
+        #   response['content-type'] = 'application/json'
         def []=(key, value)
           @headers[key] = value
         end
@@ -97,13 +98,13 @@ class Roda
         # for the current response.  If the status has not been set,
         # uses the return value of default_status if the body has
         # been written to, otherwise uses a 404 status.
-        # Adds the Content-Length header to the size of the response body.
+        # Adds the content-length header to the size of the response body.
         #
         # Example:
         #
         #   response.finish
         #   #  => [200,
-        #   #      {'Content-Type'=>'text/html', 'Content-Length'=>'0'},
+        #   #      {'content-type'=>'text/html', 'content-length'=>'0'},
         #   #      []]
         def finish
           b = @body
@@ -129,7 +130,7 @@ class Roda
 
         # Return the rack response array using a given body.  Assumes a
         # 200 response status unless status has been explicitly set,
-        # and doesn't add the Content-Length header or use the existing
+        # and doesn't add the content-length header or use the existing
         # body.
         def finish_with_body(body)
           set_default_headers
@@ -151,8 +152,8 @@ class Roda
         # Set the Location header to the given path, and the status
         # to the given status.  Example:
         #
-        #   response.redirect('foo', 301)
-        #   response.redirect('bar')
+        #   response.redirect('/foo', 301)
+        #   response.redirect('/bar')
         def redirect(path, status = 302)
           @headers[RodaResponseHeaders::LOCATION] = path
           @status  = status
@@ -181,6 +182,7 @@ class Roda
 
           # Use Rack::Headers for headers by default on Rack 3
           def _initialize_headers
+            # RODA4: Use {} always, add plugin for using Rack::Headers
             Rack::Headers.new
           end
         else

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 = 109
+  RodaMinorVersion = 110
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/lib/roda.rb

@@ -1,6 +1,5 @@
 # frozen-string-literal: true
 
-require "thread"
 require_relative "roda/request"
 require_relative "roda/response"
 require_relative "roda/plugins"
@@ -96,6 +95,7 @@ class Roda
         # Support for the :check_arity and :check_dynamic_arity options will be
         # removed in Roda 4.
         def define_roda_method(meth, expected_arity, &block)
+          # RODA4: Make expected_arity optional, remove from callers
           if meth.is_a?(String)
             meth = roda_method_name(meth)
           end
@@ -301,15 +301,14 @@ class Roda
         # class has been subclassed, as doing so can break the subclasses.
         #
         #   Roda.plugin PluginModule
-        #   Roda.plugin :csrf
+        #   Roda.plugin :route_csrf
         def plugin(plugin, *args, &block)
           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.")
+            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.", uplevel: 1)
           end
 
           plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
@@ -342,7 +341,7 @@ class Roda
         # times will overwrite the previous routing.
         def route(&block)
           unless block
-            RodaPlugins.warn "no block passed to Roda.route"
+            RodaPlugins.warn("no block passed to Roda.route", uplevel: 1)
             return
           end
 
@@ -353,8 +352,7 @@ class Roda
           @app = nil
         end
 
-        # Add a middleware to use for the rack application.  Must be
-        # called before calling #route to have an effect. Example:
+        # Add a middleware to use for the rack application. Example:
         #
         #   Roda.use Rack::ShowExceptions
         def use(*args, &block)
@@ -372,6 +370,7 @@ class Roda
         # and whether the callable accepts keyword arguments (true, false
         # or :required).
         def _define_roda_method_arg_numbers(callable)
+          # RODA4: Remove
           optional_args = 0
           rest = false
           keyword = false
@@ -403,7 +402,9 @@ class Roda
 
         # The base rack app to use, before middleware is added.
         def base_rack_app_callable(new_api=true)
+          # RODA4.1: Remove
           if new_api
+            # RODA4: Inline this behavior
             lambda{|env| new(env)._roda_handle_main_route}
           else
             block = @rack_app_route_block
@@ -428,6 +429,7 @@ class Roda
         # which can include route blocks that are delegated to by the main route block.
         # Can be modified by plugins.
         def convert_route_block(block)
+          # RODA4.1: Remove
           block
         end
 
@@ -471,6 +473,7 @@ class Roda
         # if any before hooks are defined.
         # Can be modified by plugins.
         def rack_app_route_block(block)
+          # RODA4.1: Remove
           block
         end
 
@@ -481,7 +484,7 @@ class Roda
             break if mod == InstanceMethods
             meths = mod.instance_methods(false)
             if meths.include?(:call) && !(meths.include?(:_roda_handle_main_route) || meths.include?(:_roda_run_main_route))
-            RodaPlugins.warn <<WARNING
+            RodaPlugins.warn(<<WARNING, uplevel: 1)
 Falling back to using #call for dispatching for #{self}, due to #call override in #{mod}.
 #{mod} should be fixed to adjust to Roda's new dispatch API, and override _roda_handle_main_route or _roda_run_main_route
 WARNING
@@ -567,7 +570,7 @@ WARNING
           @_request.env
         end
 
-        # The class-level options hash.  This should probably not be
+        # The class-level options hash.  This should not be
         # modified at the instance level. Example:
         #
         #   Roda.plugin :render

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.109.0
+  version: 3.110.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -215,6 +215,7 @@ files:
 - lib/roda/plugins/exception_page.rb
 - lib/roda/plugins/filter_common_logger.rb
 - lib/roda/plugins/flash.rb
+- lib/roda/plugins/freeze_request_response.rb
 - lib/roda/plugins/h.rb
 - lib/roda/plugins/halt.rb
 - lib/roda/plugins/hash_branch_view_subdir.rb