hanami-router 2.0.2 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8591e8a6f364610506f486230b6d68f371ddc256d8e4a8c799702298974a9614
-  data.tar.gz: e3a7aef5d85e5dda768ea06f1c55c88d9c1fab0990e09dbe680911497734a76c
+  metadata.gz: 5a8c8c2f5afa3afa7c514d2f73a471bb8e0276173d830e796527ddfbb9dc2e9f
+  data.tar.gz: e4976449349a55717ec2d1e4adf8e63391a4c0899eb48e14303050a83ca58dcc
 SHA512:
-  metadata.gz: b3b1ad34d5f2d4ccf94c5cf040353e6971152c92743212006a7001dc3294148e55b5d96ab73b2a727f173d464ba7129bd369daa4c6e393bc2b1b4b64dd4c5c97
-  data.tar.gz: 6affe5765f2bbdff84c34ecbfa2d0b924d9e0d5f30394893f42febebcbd1744802b32b81c09ffbadc4fe30c3d8ab255eaa69b5995a18459b029973a4ffaed392
+  metadata.gz: 2022d72abcaad4a9aa4099e69356da269355a5d43b7ad878aeb613fbe4cb26b56f2611f27e4fd65f8bcb4543b5a65e28b4668f83acc35de07bd553c6c99ae341
+  data.tar.gz: 8bbf159f95fa83d3f1ca4a55e849398a6156ed0630d2dfe831bfb17b5b15f970a26cacbec83c242f3e9f4d1831d8869d1761a160a7724e1a2cec56a2e763d46d

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 Rack compatible HTTP router for Ruby
 
+## v2.1.0.beta1 - 2023-06-29
+
+### Added
+
+- [Tim Riley] Accept `not_allowed_proc:` argument when initializing `Hanami::Router`. This allows
+  customisation of the `not_allowed` behavior like for `not_found` (#259)
+
 ## v2.0.2 - 2022-12-25
 
 ### Added

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2021 Luca Guidi
+Copyright © 2014 Hanami Team
 
 MIT License
 

data/README.md

@@ -365,4 +365,4 @@ __Hanami::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2022 Hanami Team – Released under MIT License
+Copyright © 2014 Hanami Team – Released under MIT License

data/lib/hanami/middleware/app.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "rack/builder"
-require_relative "./trie"
+require_relative "trie"
 
 module Hanami
   module Middleware

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

@@ -115,7 +115,7 @@ module Hanami
         # @api private
         # @since 1.3.0
         def classify(parser)
-          parser.to_s.split(/_/).map(&:capitalize).join
+          parser.to_s.split("_").map(&:capitalize).join
         end
 
         # @api private

data/lib/hanami/middleware/node.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hanami/router/segment"
+
 module Hanami
   module Middleware
     # Trie node to register scopes with custom Rack middleware
@@ -15,26 +17,46 @@ module Hanami
       # @since 2.0.0
       def initialize
         @app = nil
-        @children = {}
+        @variable = nil
+        @fixed = nil
       end
 
       # @api private
       # @since 2.0.0
       def freeze
-        @children.freeze
+        @variable.freeze
+        @fixed.freeze
         super
       end
 
       # @api private
       # @since 2.0.0
       def put(segment)
-        @children[segment] ||= self.class.new
+        if variable?(segment)
+          @variable ||= {}
+          @variable[segment_for(segment)] ||= self.class.new
+        else
+          @fixed ||= {}
+          @fixed[segment] ||= self.class.new
+        end
       end
 
       # @api private
       # @since 2.0.0
-      def get(segment)
-        @children.fetch(segment) { self if leaf? }
+      def get(segment) # rubocop:disable Metrics/PerceivedComplexity
+        found = @fixed&.fetch(segment, nil)
+        return found if found
+
+        @variable&.each do |matcher, node|
+          break if found
+
+          captured = matcher.match(segment)
+          found = node if captured
+        end
+
+        return found if found
+
+        self if leaf?
       end
 
       # @api private
@@ -52,7 +74,19 @@ module Hanami
       # @api private
       # @since 2.0.0
       def leaf?
-        @children.empty?
+        @fixed.nil? && @variable.nil?
+      end
+
+      # @api private
+      # @since 2.0.3
+      def variable?(segment)
+        Router::ROUTE_VARIABLE_MATCHER.match?(segment)
+      end
+
+      # @api private
+      # @since 2.0.3
+      def segment_for(segment)
+        Router::Segment.fabricate(segment)
       end
     end
   end

data/lib/hanami/middleware/trie.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./node"
+require_relative "node"
 
 module Hanami
   module Middleware
@@ -61,7 +61,7 @@ module Hanami
       # @api private
       # @since 2.0.0
       def for_each_segment(path, &blk)
-        _, *segments = path.split(/\//)
+        _, *segments = path.split("/")
         segments.each(&blk)
       end
     end

data/lib/hanami/router/url_helpers.rb

@@ -2,6 +2,7 @@
 
 require "hanami/router/errors"
 require "mustermann/error"
+require_relative "prefix"
 
 module Hanami
   class Router
@@ -11,8 +12,11 @@ module Hanami
       # @since 2.0.0
       # @api private
       def initialize(base_url)
-        @base_url = base_url
+        @base_url = URI(base_url)
         @named = {}
+        prefix = @base_url.path
+        prefix = DEFAULT_PREFIX if prefix.empty?
+        @prefix = Prefix.new(prefix)
       end
 
       # @since 2.0.0
@@ -34,7 +38,7 @@ module Hanami
       # @since 2.0.0
       # @api private
       def url(name, variables = {})
-        @base_url + path(name, variables)
+        @base_url + @prefix.join(path(name, variables)).to_s
       end
     end
   end

data/lib/hanami/router/version.rb

@@ -8,6 +8,6 @@ module Hanami
     #
     # @since 0.1.0
     # @api public
-    VERSION = "2.0.2"
+    VERSION = "2.1.0.beta1"
   end
 end

data/lib/hanami/router.rb

@@ -72,13 +72,14 @@ module Hanami
     #   Hanami::Router.new do
     #     get "/", to: ->(*) { [200, {}, ["OK"]] }
     #   end
-    def initialize(base_url: DEFAULT_BASE_URL, prefix: DEFAULT_PREFIX, resolver: DEFAULT_RESOLVER, not_found: NOT_FOUND, block_context: nil, inspector: nil, &blk) # rubocop:disable Layout/LineLength
+    def initialize(base_url: DEFAULT_BASE_URL, prefix: DEFAULT_PREFIX, resolver: DEFAULT_RESOLVER, not_allowed: NOT_ALLOWED, not_found: NOT_FOUND, block_context: nil, inspector: nil, &blk) # rubocop:disable Layout/LineLength
       # TODO: verify if Prefix can handle both name and path prefix
       @path_prefix = Prefix.new(prefix)
       @name_prefix = Prefix.new("")
       @url_helpers = UrlHelpers.new(base_url)
       @base_url = base_url
       @resolver = resolver
+      @not_allowed = not_allowed
       @not_found = not_found
       @block_context = block_context
       @fixed = {}
@@ -101,8 +102,7 @@ module Hanami
       endpoint, params = lookup(env)
 
       unless endpoint
-        return not_allowed(env) ||
-               not_found(env)
+        return not_allowed(env) || not_found(env)
       end
 
       endpoint.call(
@@ -147,7 +147,7 @@ module Hanami
     #   end
     #
     #   router.path(:root) # => "/"
-    #   router.url(:root)  # => "https://hanamirb.org"
+    #   router.url(:root)  # => #<URI::HTTPS https://hanamirb.org>
     def root(to: nil, &blk)
       get(ROOT_PATH, to: to, as: :root, &blk)
     end
@@ -191,7 +191,7 @@ module Hanami
     #   end
     #
     #   router.path(:welcome) # => "/"
-    #   router.url(:welcome)  # => "http://localhost/"
+    #   router.url(:welcome)  # => #<URI::HTTP http://localhost/>
     #
     # @example Constraints
     #   require "hanami/router"
@@ -466,7 +466,7 @@ module Hanami
     #
     # @param name [Symbol] the route name
     #
-    # @return [String]
+    # @return [URI::HTTP, URI::HTTPS]
     #
     # @raise [Hanami::Router::MissingRouteError] when the router fails to
     #   recognize a route, because of the given arguments.
@@ -483,9 +483,9 @@ module Hanami
     #     get "/:name", to: ->(*) { ... }, as: :framework
     #   end
     #
-    #   router.url(:login)                          # => "https://hanamirb.org/login"
-    #   router.url(:login, return_to: "/dashboard") # => "https://hanamirb.org/login?return_to=%2Fdashboard"
-    #   router.url(:framework, name: "router")      # => "https://hanamirb.org/router"
+    #   router.url(:login)                          # => #<URI::HTTPS https://hanamirb.org/login>
+    #   router.url(:login, return_to: "/dashboard") # => #<URI::HTTPS https://hanamirb.org/login?return_to=%2Fdashboard>
+    #   router.url(:framework, name: "router")      # => #<URI::HTTPS https://hanamirb.org/router>
     def url(name, variables = {})
       url_helpers.url(name, variables)
     end
@@ -652,15 +652,10 @@ module Hanami
     # @since 2.0.0
     # @api private
     def not_allowed(env)
-      http_methods = _not_allowed_fixed(env) || _not_allowed_variable(env)
-      return if http_methods.nil?
+      allowed_http_methods = _not_allowed_fixed(env) || _not_allowed_variable(env)
+      return if allowed_http_methods.nil?
 
-      [HTTP_STATUS_NOT_ALLOWED,
-       {
-         ::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH,
-         "Allow" => http_methods.join(", ")
-       },
-       [HTTP_BODY_NOT_ALLOWED]]
+      @not_allowed.call(env, allowed_http_methods)
     end
 
     # @since 2.0.0
@@ -776,6 +771,21 @@ module Hanami
     # @api private
     ROUTE_GLOBBED_MATCHER = /\*/
 
+    # Default response when the route method was not allowed
+    #
+    # @api private
+    # @since 2.1.0
+    NOT_ALLOWED = -> (_, allowed_http_methods) {
+      [
+        HTTP_STATUS_NOT_ALLOWED,
+        {
+          ::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH,
+          "Allow" => allowed_http_methods.join(", ")
+        },
+        [HTTP_BODY_NOT_ALLOWED]
+      ]
+    }
+
     # Default response when no route was matched
     #
     # @api private
@@ -790,7 +800,7 @@ module Hanami
       endpoint = fixed(env)
       return [endpoint, {}] if endpoint
 
-      variable(env) || globbed(env) || mounted(env)
+      variable(env) || mounted(env) || globbed(env)
     end
 
     # @since 2.0.0
@@ -900,6 +910,7 @@ module Hanami
         base_url: @base_url,
         prefix: @path_prefix.to_s,
         resolver: @resolver,
+        not_allowed: @not_allowed,
         not_found: @not_found,
         block_context: @block_context,
         inspector: @inspector

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -196,11 +196,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami