hanami-router 2.3.0.beta2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9e51f6dddcf337224f949ca5f28c79b82702f6743a9aef5fbecdfebd5efcb9
-  data.tar.gz: 3d02dfc438dac3cd1f07a62934c0c81059db209123a1a0f7a639c30885013a63
+  metadata.gz: 5bc038728052f6719d7a3c7ecfbfbb02a5b5d730ab95bafdb1a8415602faa861
+  data.tar.gz: 961ad5a29c273a42526261c5305d41dc21530c16baf20ed01c106ab7c8b635ff
 SHA512:
-  metadata.gz: 27585ee48b5a0070bf60044676b7c6473093b139c6d92a34bc204df51e87acb643933e9cc92a38ace8ad31da701f58db480dad0da288bf21270376613e192a1f
-  data.tar.gz: 6e170d49fd689cad6fe447cf8bb1e93c76e50254751a108c85bf8b0c07c269673aa617f99a87197a1d7d89b169297ca6b752bea994c118663613b431535ba601
+  metadata.gz: 723502c7e0e4dd4beba5de8a1c3e77dd8e912103f833dc709f7c8f001702a54b93128222768721b4391ce4ee3e1a7d951046bdcb67132b406d6582159394bdd6
+  data.tar.gz: 646f78f7b642bffc4ff8be39e6c7fff011ade92ee8154651d66aafe1b803de0e4901151a01a962af6832c3ace23d4f27167186cdac26de1a29cc3453f02b2ca2

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 Rack compatible HTTP router for Ruby
 
+## v2.3.0 - 2025-11-12
+
+### Changed
+
+- Allow scopes to be given a custom name prefix, with `as:`. This prefix is given to any named routes within the scope. (@timriley in #286)
+- Allow route names given to `as:` to specify their own _prefix_, which goes before any name prefixes added by the scopes the route is nested within. To specify a prefix, provide an array to `as:`. (@timriley in #286)
+
+  ```ruby
+  scope "backend" do
+    scope "admin", as: :secret do
+      get "/cats/new", to: ->(*) { [200, {}, ["OK"]] }, as: [:new, :cat]
+    end
+  end
+
+  router.path(:new_backend_secret_cat)
+  # => "/backend/admin/cats/new
+  ```
+- As part of Rack v2/v3 compatibility, improve coordination between `Hanami::Middleware::BodyParser` and `Hanami::Router` regarding access of the request body. (@timriley in #287)
+
+  `BodyParser` will now make `env["rack.input"]` rewindable, and rewind the body after accessing it, ensuring downstream users can still read `"rack.input"` if needed. `Router` will only attempt to make `"rack.input"` rewindable if it hasn’t already been made so.
+- Change `Hanami::Middleware::BodyParser::Parser` to refer to `media_types` instead of `mime_types`. (@timriley in #289)
+
+  A body parser subclass should now look like this:
+
+  ```ruby
+  class CustomParser < Hanami::Middleware::BodyParser::Parser
+    def self.media_types = ["application/custom"]
+    def parse(body)
+      body # Your parsing logic here
+    end
+  end
+  ```
+- Allow `Hanami::Middleware::BodyParser` to be initialized with a single body parser, instead of requiring an array. (@timriley in #288)
+
+  ```ruby
+  Hanami::Middleware::BodyParser.new(app, MyCustomParser)
+  ```
+
 ## v2.3.0.beta2 - 2025-10-17
 
 ### Changed

data/README.md

@@ -6,8 +6,6 @@ Rack compatible, lightweight, and fast HTTP Router for Ruby and [Hanami](http://
 
 [![Gem Version](https://badge.fury.io/rb/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
 [![CI](https://github.com/hanami/router/actions/workflows/ci.yml/badge.svg)](https://github.com/hanami/router/actions?query=workflow%3Aci+branch%3Amain)
-[![Test Coverage](https://codecov.io/gh/hanami/router/branch/main/graph/badge.svg)](https://codecov.io/gh/hanami/router)
-[![Depfu](https://badges.depfu.com/badges/5f6b8e8fa3b0d082539f0b0f84d55960/overview.svg)](https://depfu.com/github/hanami/router?project=Bundler)
 
 ## Contact
 
@@ -20,8 +18,6 @@ Rack compatible, lightweight, and fast HTTP Router for Ruby and [Hanami](http://
 
 ## Installation
 
-__Hanami::Router__ supports Ruby (MRI) 3.1.+
-
 Add this line to your application's Gemfile:
 
 ```ruby

data/hanami-router.gemspec

@@ -7,8 +7,8 @@ require "hanami/router/version"
 Gem::Specification.new do |spec|
   spec.name          = "hanami-router"
   spec.version       = Hanami::Router::VERSION
-  spec.authors       = ["Luca Guidi"]
-  spec.email         = ["me@lucaguidi.com"]
+  spec.authors       = ["Hanakai team"]
+  spec.email         = ["info@hanakai.org"]
   spec.description   = "Rack compatible HTTP router for Ruby"
   spec.summary       = "Rack compatible HTTP router for Ruby and Hanami"
   spec.homepage      = "http://hanamirb.org"

data/lib/hanami/middleware/body_parser/class_interface.rb

@@ -53,22 +53,22 @@ module Hanami
         # @api private
         # @since 2.0.0
         def build_parsers(parser_specs, registry = {})
-          return DEFAULT_BODY_PARSERS if parser_specs.empty?
-
           parsers = Array(parser_specs).flatten(0)
 
+          return DEFAULT_BODY_PARSERS if parsers.empty?
+
           parsers.each_with_object(registry) do |spec, memo|
             if spec.is_a?(Hash) && spec.size > 1
               spec.each do |key, value|
                 build_parsers([key => [value]], memo)
               end
             else
-              name, *mime_types = Array(*spec).flatten(0)
+              name, *media_types = Array(*spec).flatten(0)
 
-              parser = build(name, mime_types: mime_types.flatten)
+              parser = build(name, media_types: media_types.flatten)
 
-              parser.mime_types.each do |mime|
-                memo[mime] = parser
+              parser.media_types.each do |type|
+                memo[type] = parser
               end
             end
           end
@@ -78,7 +78,7 @@ module Hanami
 
         # @api private
         # @since 1.3.0
-        PARSER_METHODS = %i[mime_types parse].freeze
+        PARSER_METHODS = %i[media_types parse].freeze
 
         # @api private
         # @since 2.0.0

data/lib/hanami/middleware/body_parser/form_parser.rb

@@ -9,17 +9,12 @@ module Hanami
       # @since 2.0.1
       # @api private
       class FormParser < Parser
-        # @since 2.0.1
         # @api private
-        MIME_TYPES = [
-          "multipart/form-data"
-        ].freeze
+        MEDIA_TYPES = ["multipart/form-data"].freeze
 
         # @since 2.0.1
         # @api private
-        def self.mime_types
-          MIME_TYPES
-        end
+        def self.media_types = MEDIA_TYPES
 
         # Parse a multipart body payload (form file uploading)
         #

data/lib/hanami/middleware/body_parser/json_parser.rb

@@ -9,11 +9,11 @@ module Hanami
       # @since 1.3.0
       # @api private
       class JsonParser < Parser
-        # @since 1.3.0
         # @api private
-        def self.mime_types
-          ["application/json", "application/vnd.api+json"]
-        end
+        MEDIA_TYPES = ["application/json", "application/vnd.api+json"].freeze
+
+        # @api private
+        def self.media_types = MEDIA_TYPES
 
         # Parse a json string
         #

data/lib/hanami/middleware/body_parser/parser.rb

@@ -7,11 +7,14 @@ module Hanami
       #
       # @since 2.0.0
       class Parser
-        DEFAULT_MIME_TYPES = [].freeze
+        class << self
+          def media_types = []
+          alias_method :mime_types, :media_types
+        end
 
-        # Return supported mime types
+        # Return supported media types
         #
-        # @return [Array<String>] supported MIME types
+        # @return [Array<String>] supported media types
         #
         # @abstract
         # @since 2.0.0
@@ -20,15 +23,16 @@ module Hanami
         #   require "hanami/middleware/body_parser"
         #
         #   class XMLParser < Hanami::Middleware::BodyParser::Parser
-        #     def self.mime_types
+        #     def self.media_types
         #       ["application/xml", "text/xml"]
         #     end
         #   end
-        attr_reader :mime_types
+        attr_reader :media_types
+        alias_method :mime_types, :media_types
 
         # @api private
-        def initialize(mime_types: DEFAULT_MIME_TYPES)
-          @mime_types = self.class.mime_types + mime_types
+        def initialize(media_types: [])
+          @media_types = self.class.media_types + media_types
         end
 
         # Parse raw HTTP request body

data/lib/hanami/middleware/body_parser.rb

@@ -39,23 +39,31 @@ module Hanami
       end
 
       def call(env)
-        body = env[RACK_INPUT]&.read
-        return @app.call(env) if body.nil? || body.empty?
+        return @app.call(env) if env.key?(Router::ROUTER_PARSED_BODY)
 
-        # Somebody might try to read this stream
-        Rack::RewindableInput.new(env[RACK_INPUT]).rewind
+        input = env[RACK_INPUT]
+        return @app.call(env) unless input
 
-        if (parser = @parsers[media_type(env)])
-          env[Router::ROUTER_PARSED_BODY] = parser.parse(body, env)
-          env[ROUTER_PARAMS] = _symbolize(env[Router::ROUTER_PARSED_BODY])
-        end
+        parser = @parsers[media_type(env)]
+        return @app.call(env) unless parser
+
+        # The input in Rack 3 is not rewindable. For compatbility with Rack 2, make the input
+        # rewindable, rewind it for reading, then rewind once more before returning to the app.
+        input = env[RACK_INPUT] = Rack::RewindableInput.new(input) unless input.respond_to?(:rewind)
+        input.rewind
+        body = input.read
+        input.rewind
+
+        return @app.call(env) if body.nil? || body.empty?
+
+        env[Router::ROUTER_PARSED_BODY] = parser.parse(body, env)
+        env[ROUTER_PARAMS] = _symbolize(env[Router::ROUTER_PARSED_BODY])
 
         @app.call(env)
       end
 
       private
 
-      # @api private
       def _symbolize(body)
         if body.is_a?(::Hash)
           Router::Params.deep_symbolize(body)
@@ -64,14 +72,6 @@ module Hanami
         end
       end
 
-      # @api private
-      def _parse(env, body)
-        @parsers[
-          media_type(env)
-        ].parse(body)
-      end
-
-      # @api private
       def media_type(env)
         ct = content_type(env)
         return unless ct
@@ -79,7 +79,6 @@ module Hanami
         ct.split(MEDIA_TYPE_MATCHER, 2).first.downcase
       end
 
-      # @api private
       def content_type(env)
         content_type = env[CONTENT_TYPE]
         content_type.nil? || content_type.empty? ? nil : content_type

data/lib/hanami/router/version.rb

@@ -8,6 +8,6 @@ module Hanami
     #
     # @since 0.1.0
     # @api public
-    VERSION = "2.3.0.beta2"
+    VERSION = "2.3.0"
   end
 end

data/lib/hanami/router.rb

@@ -107,12 +107,10 @@ module Hanami
         return not_allowed(env) || not_found(env)
       end
 
-      # Rack 3 no longer requires "rack.input" to be rewindable. Force input to be
-      # rewindable to maintain Rack 2 behavior.
-      #
-      # @since 2.2.0
-      if Hanami::Router.rack_3? && env[::Rack::RACK_INPUT]
-        env[::Rack::RACK_INPUT] = Rack::RewindableInput.new(env[::Rack::RACK_INPUT])
+      # Rack 3 no longer requires "rack.input" to be rewindable. Force input to be rewindable to
+      # maintain Rack 2 behavior while we're still supporting both.
+      if (input = env[::Rack::RACK_INPUT]) && !input.respond_to?(:rewind)
+        env[::Rack::RACK_INPUT] = Rack::RewindableInput.new(input)
       end
 
       endpoint.call(
@@ -167,7 +165,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -203,6 +202,19 @@ module Hanami
     #   router.path(:welcome) # => "/"
     #   router.url(:welcome)  # => #<URI::HTTP http://localhost/>
     #
+    # @example Named route with prefix inside scope
+    #   require "hanami/router"
+    #
+    #   router = Hanami::Router.new do
+    #     scope "backend" do
+    #       scope "admin", as: :secret do
+    #         get "/cats/new", to: ->(*) { [200, {}, ["OK"]] }, as: [:new, :cat]
+    #       end
+    #     end
+    #   end
+    #
+    #   router.path(:new_backend_secret_cat) # => "/backend/admin/cats/new
+    #
     # @example Constraints
     #   require "hanami/router"
     #
@@ -218,7 +230,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -236,7 +249,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -254,7 +268,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -272,7 +287,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -290,7 +306,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -308,7 +325,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -326,7 +344,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -344,7 +363,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param constraints [Hash] a set of constraints for path variables
     # @param blk [Proc] the anonymous proc to be used as endpoint for the route
     #
@@ -362,7 +382,8 @@ module Hanami
     #
     # @param path [String] the relative URL to be matched
     # @param to [#call] the Rack endpoint
-    # @param as [Symbol] a unique name for the route
+    # @param as [Symbol, Array<Symbol>] a unique name for the route, or a ["prefix", "name"] array,
+    #   to add a prefix to the name when nested within scopes.
     # @param code [Integer] a HTTP status code to use for the redirect
     #
     # @raise [Hanami::Router::UnknownHTTPStatusCodeError] when an unknown redirect code is given
@@ -379,6 +400,7 @@ module Hanami
     # inherit the given path as path prefix and as a named routes prefix.
     #
     # @param path [String] the scope path to be used as a path prefix
+    # @param as: [String, Symbol] the name prefix to use for nested routes
     # @param blk [Proc] the routes definitions withing the scope
     #
     # @since 2.0.0
@@ -395,13 +417,13 @@ module Hanami
     #   end
     #
     #   router.path(:v1_users) # => "/v1/users"
-    def scope(path, &blk)
+    def scope(path, as: nil, &blk)
       path_prefix = @path_prefix
       name_prefix = @name_prefix
 
       begin
         @path_prefix = @path_prefix.join(path.to_s)
-        @name_prefix = @name_prefix.join(path.to_s)
+        @name_prefix = @name_prefix.join((as || path).to_s)
         instance_eval(&blk)
       ensure
         @path_prefix = path_prefix
@@ -818,15 +840,13 @@ module Hanami
       end
 
       if as
-        as = prefixed_underscored_name(as)
+        as = prefixed_name(as)
         add_named_route(path, as, constraints)
       end
 
       if inspect?
         @inspector.add_route(
-          Route.new(
-            http_method: http_method, path: path, to: to || endpoint, as: as, constraints: constraints, blk: blk
-          )
+          Route.new(http_method:, path:, to: to || endpoint, as:, constraints:, blk:)
         )
       end
     end
@@ -862,8 +882,8 @@ module Hanami
 
     # @since 2.0.0
     # @api private
-    def add_named_route(path, as, constraints)
-      @url_helpers.add(as, Segment.fabricate(path, **constraints))
+    def add_named_route(path, name, constraints)
+      @url_helpers.add(name, Segment.fabricate(path, **constraints))
     end
 
     # @since 2.0.0
@@ -890,13 +910,32 @@ module Hanami
       @path_prefix.join(path).to_s
     end
 
-    # @since x.x.x
     # @api private
-    def prefixed_underscored_name(name)
-      @name_prefix
-        .relative_join(name, PREFIXED_NAME_SEPARATOR)
-        .gsub(UNDERSCORED_NAME_REGEXP, "_")
-        .to_sym
+    def prefixed_name(name)
+      prefix, suffix = name_parts(name)
+
+      name = @name_prefix.relative_join(suffix, PREFIXED_NAME_SEPARATOR).to_s
+      name = prefix + PREFIXED_NAME_SEPARATOR + name if prefix
+
+      normalized_name(name)
+    end
+
+    # Returns a [prefix, suffix] array for a given route name.
+    #
+    # @api private
+    def name_parts(name)
+      name = Array(name)
+
+      if name.size < 2
+        [nil, name.first&.to_s]
+      else
+        [name.first&.to_s, name[1..].join("_")]
+      end
+    end
+
+    # @api private
+    def normalized_name(name)
+      name.gsub(UNDERSCORED_NAME_REGEXP, "_").to_sym
     end
 
     # Returns a new instance of Hanami::Router with the modified options.

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.3.0.beta2
+  version: 2.3.0
 platform: ruby
 authors:
-- Luca Guidi
+- Hanakai team
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -157,7 +157,7 @@ dependencies:
         version: '1.0'
 description: Rack compatible HTTP router for Ruby
 email:
-- me@lucaguidi.com
+- info@hanakai.org
 executables: []
 extensions: []
 extra_rdoc_files: []