hanami-router 2.2.0.rc1 → 2.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dbd5cec52e1e7a0d2ac82066294bf3846b58b4c8bacd3555d6f0f1a3e6cb873
-  data.tar.gz: e96f0ff6c694e0964325d012f18c055a892af912e5f6dd3ba35f0bec13173fa0
+  metadata.gz: dd6e74eeead3378e5b8697f4a3d6ff3883a71c140ace0699a9bb30aa2b3f303d
+  data.tar.gz: dd4a259ce71090ed517152b0203896274c25d893afaf68768a118c1c77300c53
 SHA512:
-  metadata.gz: 8dc08ace41fd84808b9706c2a4d07de0c45f3c206eb858020e8fa7970005e6eeefb721a8654bd86379d8389c71d813b9406ffb4c47eecde4c97558baf6eff3e2
-  data.tar.gz: e28b53acd76af8d279ca365cfa8c9901ce5fc5d789736eef5cd7925e9ecb89845e58caaa9548ebefe2050b792a7704880c84bb2b27adf27c0c6df288b5bd3969
+  metadata.gz: cd35252d98f215ec28a0676a3a36db818af56b78d3e46b84f2e02bff14a9e49422c6fd89b4a3f6313929f3cbaedd2f193b9f35dd15b7c03b5a1252405f424e8d
+  data.tar.gz: 23f275b9f2fbd71d68453e69c00983f9729e98fd3b16e3b51866bfb27b73dab0678d7c204e7ba63d6b9d24dc5a5f1e1f91b88567ee0ec315c5bc1fd2669ae9fb

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 Rack compatible HTTP router for Ruby
 
+## v2.3.0.beta1 - 2025-10-03
+
+### Changed
+
+- [Kyle Plump, Tim Riley] Support Rack 3 in addition to Rack 2 (#277)
+- [Sven Schwyn] Convert -, +, ~, and . to underscore in URL helper names (#280)
+- [inouire] Allow redirects to absolute URLs: `redirect "/redirect", to: "https://hanamirb.org/"` (#282)
+
+## v2.2.0 - 2024-11-05
+
+### Changed
+
+- [Damian C. Rossney, Kyle Plump] Scopes with a dynamic segment (e.g. `scope ":locale" do`) and containing a `root` route will no longer match the root route for requests with a trailing slash. This makes the behavior consistent with scopes using static strings. (#273)
+
+### Fixed
+
+- [Damian C. Rossney, Kyle Plump] Support paths with different variable names in same path location (#273)
+
 ## v2.2.0.rc1 - 2024-10-29
 
 ## v2.2.0.beta2 - 2024-09-25

data/README.md

@@ -157,6 +157,8 @@ end
 Hanami::Router.new do
   get "/redirect_destination", to: ->(env) { [200, {}, ["Redirect destination!"]] }
   redirect "/legacy",          to: "/redirect_destination"
+  redirect "/learn-more",      to: "https://hanamirb.org/"
+  redirect "/chat",            to: URI("xmpp://myapp.net/")
 end
 ```
 
@@ -349,12 +351,17 @@ __Hanami::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Contributing
 
-1. Fork it
+1. Fork this repo to your account and clone it locally (`git clone git@github.com:your-pseudo/your-cloned-repo.git`)
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Install the dependencies (`bundle install`)
+4. Run tests, they should all pass (`./script/ci`)
+5. Make your changes & check that the tests still pass. Add some test cases if needed.
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request on Github with some context on what you're trying to fix or to improve with this contribution
+
+Thank you for contributing! 
 
 ## Copyright
 
-Copyright © 2014–2024 Hanami Team – Released under MIT License
+Copyright © 2014–2025 Hanami Team – Released under MIT License

data/hanami-router.gemspec

@@ -20,13 +20,14 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.required_ruby_version = ">= 3.1"
 
-  spec.add_dependency "rack",               "~> 2.0"
+  spec.add_dependency "rack",               ">= 2.0"
   spec.add_dependency "mustermann",         "~> 3.0"
   spec.add_dependency "mustermann-contrib", "~> 3.0"
+  spec.add_dependency "csv",                "~> 3.3"
 
   spec.add_development_dependency "bundler",   ">= 1.6", "< 3"
   spec.add_development_dependency "rake",      "~> 13"
-  spec.add_development_dependency "rack-test", "~> 1.0"
+  spec.add_development_dependency "rack-test", "~> 2.0"
   spec.add_development_dependency "rspec",     "~> 3.8"
 
   spec.add_development_dependency "rubocop", "~> 1.0"

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

@@ -100,11 +100,13 @@ module Hanami
 
           begin
             require "hanami/middleware/body_parser/#{parser_name}_parser"
-          rescue LoadError; end
+          rescue LoadError
+          end
 
           begin
             parser = load_parser!("#{classify(parser_name)}Parser")
-          rescue NameError; end
+          rescue NameError
+          end
 
           parser
         ensure

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

@@ -30,6 +30,8 @@ module Hanami
         # @since 2.0.1
         # @api private
         def parse(*, env)
+          # Rewind to ensure successful parsing (required for Rack 3's `.parse_multipart`).
+          env[::Rack::RACK_INPUT].rewind if env[::Rack::RACK_INPUT].respond_to?(:rewind)
           ::Rack::Multipart.parse_multipart(env)
         rescue StandardError => exception
           raise BodyParsingError.new(exception.message)

data/lib/hanami/middleware/body_parser.rb

@@ -39,10 +39,11 @@ module Hanami
       end
 
       def call(env)
-        body = env[RACK_INPUT].read
-        return @app.call(env) if body.empty?
+        body = env[RACK_INPUT]&.read
+        return @app.call(env) if body.nil? || body.empty?
 
-        env[RACK_INPUT].rewind # somebody might try to read this stream
+        # Somebody might try to read this stream
+        Rack::RewindableInput.new(env[RACK_INPUT]).rewind
 
         if (parser = @parsers[media_type(env)])
           env[Router::ROUTER_PARSED_BODY] = parser.parse(body, env)

data/lib/hanami/router/block.rb

@@ -66,6 +66,7 @@ module Hanami
         # @since 2.0.0
         def call
           body = instance_exec(&@blk)
+
           [status, headers, [body]]
         end
       end

data/lib/hanami/router/formatter/csv.rb

@@ -37,7 +37,7 @@ module Hanami
         # @api private
         # @since 2.0.0
         def call(routes, **csv_opts)
-          ::CSV.generate(**DEFAULT_OPTIONS.merge(csv_opts)) do |csv|
+          ::CSV.generate(**DEFAULT_OPTIONS, **csv_opts) do |csv|
             csv << HEADERS if csv.write_headers?
             routes.reduce(csv) do |acc, route|
               route.head? ? acc : acc << row(route)

data/lib/hanami/router/leaf.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "mustermann/rails"
+
+module Hanami
+  class Router
+    class Leaf
+      # Trie Leaf
+      #
+      # @api private
+      # @since 2.2.0
+      attr_reader :to, :params
+
+      # @api private
+      # @since 2.2.0
+      def initialize(route, to, constraints)
+        @route = route
+        @to = to
+        @constraints = constraints
+        @params = nil
+      end
+
+      # @api private
+      # @since 2.2.0
+      def match(path)
+        match = matcher.match(path)
+
+        @params = match.named_captures if match
+
+        match
+      end
+
+      private
+
+      # @api private
+      # @since 2.2.0
+      def matcher
+        @matcher ||= Mustermann.new(@route, type: :rails, version: "5.0", capture: @constraints)
+      end
+    end
+  end
+end

data/lib/hanami/router/node.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "hanami/router/segment"
+require "hanami/router/leaf"
 
 module Hanami
   class Router
@@ -18,15 +18,14 @@ module Hanami
       def initialize
         @variable = nil
         @fixed = nil
-        @to = nil
+        @leaves = nil
       end
 
       # @api private
       # @since 2.0.0
-      def put(segment, constraints)
+      def put(segment)
         if variable?(segment)
-          @variable ||= {}
-          @variable[segment_for(segment, constraints)] ||= self.class.new
+          @variable ||= self.class.new
         else
           @fixed ||= {}
           @fixed[segment] ||= self.class.new
@@ -35,36 +34,21 @@ module Hanami
 
       # @api private
       # @since 2.0.0
-      #
-      def get(segment) # rubocop:disable Metrics/PerceivedComplexity
-        return unless @variable || @fixed
-
-        found = nil
-        captured = nil
-
-        found = @fixed&.fetch(segment, nil)
-        return [found, nil] if found
-
-        @variable&.each do |matcher, node|
-          break if found
-
-          captured = matcher.match(segment)
-          found = node if captured
-        end
-
-        [found, captured&.named_captures]
+      def get(segment)
+        @fixed&.fetch(segment, nil) || @variable
       end
 
       # @api private
       # @since 2.0.0
-      def leaf?
-        @to
+      def leaf!(route, to, constraints)
+        @leaves ||= []
+        @leaves << Leaf.new(route, to, constraints)
       end
 
       # @api private
-      # @since 2.0.0
-      def leaf!(to)
-        @to = to
+      # @since 2.2.0
+      def match(path)
+        @leaves&.find { |leaf| leaf.match(path) }
       end
 
       private
@@ -74,18 +58,6 @@ module Hanami
       def variable?(segment)
         Router::ROUTE_VARIABLE_MATCHER.match?(segment)
       end
-
-      # @api private
-      # @since 2.0.0
-      def segment_for(segment, constraints)
-        Segment.fabricate(segment, **constraints)
-      end
-
-      # @api private
-      # @since 2.0.0
-      def fixed?(matcher)
-        matcher.names.empty?
-      end
     end
   end
 end

data/lib/hanami/router/rack_utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Router
+    # @since 2.2.0
+    # @api private
+    def self.rack_3?
+      defined?(Rack::Headers)
+    end
+  end
+end

data/lib/hanami/router/trie.rb

@@ -21,33 +21,26 @@ module Hanami
 
       # @api private
       # @since 2.0.0
-      def add(path, to, constraints)
+      def add(route, to, constraints)
+        segments = segments_from(route)
         node = @root
-        for_each_segment(path) do |segment|
-          node = node.put(segment, constraints)
+
+        segments.each do |segment|
+          node = node.put(segment)
         end
 
-        node.leaf!(to)
+        node.leaf!(route, to, constraints)
       end
 
       # @api private
       # @since 2.0.0
       def find(path)
+        segments = segments_from(path)
         node = @root
-        params = {}
-
-        for_each_segment(path) do |segment|
-          break unless node
 
-          child, captures = node.get(segment)
-          params.merge!(captures) if captures
-
-          node = child
-        end
+        return unless segments.all? { |segment| node = node.get(segment) }
 
-        return [node.to, params] if node&.leaf?
-
-        nil
+        node.match(path)&.then { |found| [found.to, found.params] }
       end
 
       private
@@ -58,10 +51,11 @@ module Hanami
       private_constant :SEGMENT_SEPARATOR
 
       # @api private
-      # @since 2.0.0
-      def for_each_segment(path, &blk)
+      # @since 2.2.0
+      def segments_from(path)
         _, *segments = path.split(SEGMENT_SEPARATOR)
-        segments.each(&blk)
+
+        segments
       end
     end
   end

data/lib/hanami/router/version.rb

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

data/lib/hanami/router.rb

@@ -22,6 +22,7 @@ module Hanami
     require "hanami/router/url_helpers"
     require "hanami/router/globbed_path"
     require "hanami/router/mounted_path"
+    require "hanami/router/rack_utils"
 
     # URL helpers for other Hanami integrations
     #
@@ -106,6 +107,14 @@ 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])
+      end
+
       endpoint.call(
         _params(env, params)
       ).to_a
@@ -693,6 +702,10 @@ module Hanami
     # @api private
     PREFIXED_NAME_SEPARATOR = "_"
 
+    # @since x.x.x
+    # @api private
+    UNDERSCORED_NAME_REGEXP = /[-+~.]/
+
     # @since 2.0.0
     # @api private
     ROOT_PATH = "/"
@@ -739,7 +752,11 @@ module Hanami
 
     # @since 2.0.0
     # @api private
-    HTTP_HEADER_LOCATION = "Location"
+    HTTP_HEADER_LOCATION = Hanami::Router.rack_3? ? "location" : "Location"
+
+    # @since 2.2.0
+    # @api private
+    HTTP_HEADER_ALLOW = Hanami::Router.rack_3? ? "allow" : "Allow"
 
     # @since 2.0.0
     # @api private
@@ -762,7 +779,7 @@ module Hanami
         HTTP_STATUS_NOT_ALLOWED,
         {
           ::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH,
-          "Allow" => allowed_http_methods.join(", ")
+          HTTP_HEADER_ALLOW => allowed_http_methods.join(", ")
         },
         [HTTP_BODY_NOT_ALLOWED]
       ]
@@ -774,12 +791,13 @@ module Hanami
     # @since 2.0.0
     NOT_FOUND = ->(*) {
       [HTTP_STATUS_NOT_FOUND, {::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_FOUND_LENGTH}, [HTTP_BODY_NOT_FOUND]]
-    }.freeze
+    }
 
     # @since 2.0.0
     # @api private
     def lookup(env)
       endpoint = fixed(env)
+
       return [endpoint, {}] if endpoint
 
       variable(env) || globbed_or_mounted(env)
@@ -800,7 +818,7 @@ module Hanami
       end
 
       if as
-        as = prefixed_name(as)
+        as = prefixed_underscored_name(as)
         add_named_route(path, as, constraints)
       end
 
@@ -872,10 +890,13 @@ module Hanami
       @path_prefix.join(path).to_s
     end
 
-    # @since 2.0.0
+    # @since x.x.x
     # @api private
-    def prefixed_name(name)
-      @name_prefix.relative_join(name, PREFIXED_NAME_SEPARATOR).to_sym
+    def prefixed_underscored_name(name)
+      @name_prefix
+        .relative_join(name, PREFIXED_NAME_SEPARATOR)
+        .gsub(UNDERSCORED_NAME_REGEXP, "_")
+        .to_sym
     end
 
     # Returns a new instance of Hanami::Router with the modified options.
@@ -907,7 +928,13 @@ module Hanami
         raise UnknownHTTPStatusCodeError.new(code)
       end
 
-      destination = prefixed_path(to)
+      destination = if to.is_a?(URI)
+                      to.to_s
+                    elsif to.start_with?("http://") || to.start_with?("https://")
+                      to
+                    else
+                      prefixed_path(to)
+                    end
       Redirect.new(destination, code, ->(*) { [code, {HTTP_HEADER_LOCATION => destination}, [body]] })
     end
 
@@ -925,6 +952,7 @@ module Hanami
       env[PARAMS].merge!(::Rack::Utils.parse_nested_query(env[::Rack::QUERY_STRING]))
       env[PARAMS].merge!(params)
       env[PARAMS] = Params.deep_symbolize(env[PARAMS])
+
       env
     end
 

metadata

@@ -1,27 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.2.0.rc1
+  version: 2.3.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-29 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -52,6 +51,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +105,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -171,10 +184,12 @@ files:
 - lib/hanami/router/formatter/human_friendly.rb
 - lib/hanami/router/globbed_path.rb
 - lib/hanami/router/inspector.rb
+- lib/hanami/router/leaf.rb
 - lib/hanami/router/mounted_path.rb
 - lib/hanami/router/node.rb
 - lib/hanami/router/params.rb
 - lib/hanami/router/prefix.rb
+- lib/hanami/router/rack_utils.rb
 - lib/hanami/router/recognized_route.rb
 - lib/hanami/router/redirect.rb
 - lib/hanami/router/route.rb
@@ -187,7 +202,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,8 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami
 test_files: []