hanami-router 2.0.0.alpha3 → 2.0.0

data/lib/hanami/router.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
 
+require "rack"
 require "rack/utils"
 
+# @see Hanami::Router
 module Hanami
   # Rack compatible, lightweight and fast HTTP Router.
   #
   # @since 0.1.0
-  class Router # rubocop:disable Metrics/ClassLength
+  class Router
     require "hanami/router/version"
-    require "hanami/router/error"
+    require "hanami/router/constants"
+    require "hanami/router/errors"
     require "hanami/router/segment"
     require "hanami/router/redirect"
     require "hanami/router/prefix"
     require "hanami/router/params"
     require "hanami/router/trie"
     require "hanami/router/block"
+    require "hanami/router/route"
     require "hanami/router/url_helpers"
 
     # URL helpers for other Hanami integrations
@@ -23,6 +27,13 @@ module Hanami
     # @since 2.0.0
     attr_reader :url_helpers
 
+    # Routes inspector
+    #
+    # @return [Hanami::Router::Inspector]
+    #
+    # @since 2.0.0
+    attr_reader :inspector
+
     # Returns the given block as it is.
     #
     # @param blk [Proc] a set of route definitions
@@ -46,8 +57,9 @@ module Hanami
     #   deployed
     # @param prefix [String] the relative URL prefix where the HTTP application
     #   is deployed
-    # @param resolver [#call(path, to)] a resolver for route entpoints
+    # @param resolver [#call(path, to)] a resolver for route endpoints
     # @param block_context [Hanami::Router::Block::Context)
+    # @param not_found [#call(env)] default handler when route is not matched
     # @param blk [Proc] the route definitions
     #
     # @since 0.1.0
@@ -60,17 +72,21 @@ module Hanami
     #   Hanami::Router.new do
     #     get "/", to: ->(*) { [200, {}, ["OK"]] }
     #   end
-    def initialize(base_url: DEFAULT_BASE_URL, prefix: DEFAULT_PREFIX, resolver: DEFAULT_RESOLVER, block_context: nil, &blk)
+    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
       # 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_found = not_found
       @block_context = block_context
       @fixed = {}
       @variable = {}
       @globbed = {}
       @mounted = {}
+      @blk = blk
+      @inspector = inspector
       instance_eval(&blk) if blk
     end
 
@@ -86,7 +102,7 @@ module Hanami
 
       unless endpoint
         return not_allowed(env) ||
-               not_found
+               not_found(env)
       end
 
       endpoint.call(
@@ -133,7 +149,7 @@ module Hanami
     #   router.path(:root) # => "/"
     #   router.url(:root)  # => "https://hanamirb.org"
     def root(to: nil, &blk)
-      get("/", to: to, as: :root, &blk)
+      get(ROOT_PATH, to: to, as: :root, &blk)
     end
 
     # Defines a route that accepts GET requests for the given path.
@@ -184,8 +200,8 @@ module Hanami
     #     get "/users/:id", to: ->(*) { [200, {}, ["OK"]] }, id: /\d+/
     #   end
     def get(path, to: nil, as: nil, **constraints, &blk)
-      add_route("GET", path, to, as, constraints, &blk)
-      add_route("HEAD", path, to, as, constraints, &blk)
+      add_route(::Rack::GET, path, to, as, constraints, &blk)
+      add_route(::Rack::HEAD, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts POST requests for the given path.
@@ -203,7 +219,7 @@ module Hanami
     # @see #path
     # @see #url
     def post(path, to: nil, as: nil, **constraints, &blk)
-      add_route("POST", path, to, as, constraints, &blk)
+      add_route(::Rack::POST, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts PATCH requests for the given path.
@@ -221,7 +237,7 @@ module Hanami
     # @see #path
     # @see #url
     def patch(path, to: nil, as: nil, **constraints, &blk)
-      add_route("PATCH", path, to, as, constraints, &blk)
+      add_route(::Rack::PATCH, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts PUT requests for the given path.
@@ -239,7 +255,7 @@ module Hanami
     # @see #path
     # @see #url
     def put(path, to: nil, as: nil, **constraints, &blk)
-      add_route("PUT", path, to, as, constraints, &blk)
+      add_route(::Rack::PUT, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts DELETE requests for the given path.
@@ -257,7 +273,7 @@ module Hanami
     # @see #path
     # @see #url
     def delete(path, to: nil, as: nil, **constraints, &blk)
-      add_route("DELETE", path, to, as, constraints, &blk)
+      add_route(::Rack::DELETE, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts TRACE requests for the given path.
@@ -275,7 +291,7 @@ module Hanami
     # @see #path
     # @see #url
     def trace(path, to: nil, as: nil, **constraints, &blk)
-      add_route("TRACE", path, to, as, constraints, &blk)
+      add_route(::Rack::TRACE, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts OPTIONS requests for the given path.
@@ -293,7 +309,7 @@ module Hanami
     # @see #path
     # @see #url
     def options(path, to: nil, as: nil, **constraints, &blk)
-      add_route("OPTIONS", path, to, as, constraints, &blk)
+      add_route(::Rack::OPTIONS, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts LINK requests for the given path.
@@ -311,7 +327,7 @@ module Hanami
     # @see #path
     # @see #url
     def link(path, to: nil, as: nil, **constraints, &blk)
-      add_route("LINK", path, to, as, constraints, &blk)
+      add_route(::Rack::LINK, path, to, as, constraints, &blk)
     end
 
     # Defines a route that accepts UNLINK requests for the given path.
@@ -329,7 +345,7 @@ module Hanami
     # @see #path
     # @see #url
     def unlink(path, to: nil, as: nil, **constraints, &blk)
-      add_route("UNLINK", path, to, as, constraints, &blk)
+      add_route(::Rack::UNLINK, path, to, as, constraints, &blk)
     end
 
     # Defines a route that redirects the incoming request to another path.
@@ -339,6 +355,8 @@ module Hanami
     # @param as [Symbol] a unique name for the route
     # @param code [Integer] a HTTP status code to use for the redirect
     #
+    # @raise [Hanami::Router::UnknownHTTPStatusCodeError] when an unknown redirect code is given
+    #
     # @since 0.1.0
     #
     # @see #get
@@ -405,7 +423,11 @@ module Hanami
     def mount(app, at:, **constraints)
       path = prefixed_path(at)
       prefix = Segment.fabricate(path, **constraints)
+
       @mounted[prefix] = @resolver.call(path, app)
+      if inspect?
+        @inspector.add_route(Route.new(http_method: "*", path: at, to: app, constraints: constraints))
+      end
     end
 
     # Generate an relative URL for a specified named route.
@@ -416,7 +438,7 @@ module Hanami
     #
     # @return [String]
     #
-    # @raise [Hanami::Routing::InvalidRouteException] when the router fails to
+    # @raise [Hanami::Router::MissingRouteError] when the router fails to
     #   recognize a route, because of the given arguments.
     #
     # @since 0.1.0
@@ -435,7 +457,7 @@ module Hanami
     #   router.path(:login, return_to: "/dashboard") # => "/login?return_to=%2Fdashboard"
     #   router.path(:framework, name: "router")      # => "/router"
     def path(name, variables = {})
-      @url_helpers.path(name, variables)
+      url_helpers.path(name, variables)
     end
 
     # Generate an absolute URL for a specified named route.
@@ -446,7 +468,7 @@ module Hanami
     #
     # @return [String]
     #
-    # @raise [Hanami::Routing::InvalidRouteException] when the router fails to
+    # @raise [Hanami::Router::MissingRouteError] when the router fails to
     #   recognize a route, because of the given arguments.
     #
     # @since 0.1.0
@@ -465,7 +487,7 @@ module Hanami
     #   router.url(:login, return_to: "/dashboard") # => "https://hanamirb.org/login?return_to=%2Fdashboard"
     #   router.url(:framework, name: "router")      # => "https://hanamirb.org/router"
     def url(name, variables = {})
-      @url_helpers.url(name, variables)
+      url_helpers.url(name, variables)
     end
 
     # Recognize the given env, path, or name and return a route for testing
@@ -578,31 +600,30 @@ module Hanami
     #   route.params    # => {:id=>"1"}
     def recognize(env, params = {}, options = {})
       require "hanami/router/recognized_route"
+
       env = env_for(env, params, options)
       endpoint, params = lookup(env)
 
-      RecognizedRoute.new(
-        endpoint, _params(env, params)
-      )
+      RecognizedRoute.new(endpoint, _params(env, params))
     end
 
     # @since 2.0.0
     # @api private
     def fixed(env)
-      @fixed.dig(env["REQUEST_METHOD"], env["PATH_INFO"])
+      @fixed.dig(env[::Rack::REQUEST_METHOD], env[::Rack::PATH_INFO])
     end
 
     # @since 2.0.0
     # @api private
     def variable(env)
-      @variable[env["REQUEST_METHOD"]]&.find(env["PATH_INFO"])
+      @variable[env[::Rack::REQUEST_METHOD]]&.find(env[::Rack::PATH_INFO])
     end
 
     # @since 2.0.0
     # @api private
     def globbed(env)
-      @globbed[env["REQUEST_METHOD"]]&.each do |path, to|
-        if (match = path.match(env["PATH_INFO"]))
+      @globbed[env[::Rack::REQUEST_METHOD]]&.each do |path, to|
+        if (match = path.match(env[::Rack::PATH_INFO]))
           return [to, match.named_captures]
         end
       end
@@ -614,13 +635,13 @@ module Hanami
     # @api private
     def mounted(env)
       @mounted.each do |prefix, app|
-        next unless (match = prefix.peek_match(env["PATH_INFO"]))
+        next unless (match = prefix.peek_match(env[::Rack::PATH_INFO]))
 
-        # TODO: ensure compatibility with existing env["SCRIPT_NAME"]
+        # TODO: ensure compatibility with existing env[::Rack::SCRIPT_NAME]
         # TODO: cleanup this code
-        env["SCRIPT_NAME"] = env["SCRIPT_NAME"].to_s + prefix.to_s
-        env["PATH_INFO"] = env["PATH_INFO"].sub(prefix.to_s, "")
-        env["PATH_INFO"] = "/" if env["PATH_INFO"] == ""
+        env[::Rack::SCRIPT_NAME] = env[::Rack::SCRIPT_NAME].to_s + prefix.to_s
+        env[::Rack::PATH_INFO] = env[::Rack::PATH_INFO].sub(prefix.to_s, EMPTY_STRING)
+        env[::Rack::PATH_INFO] = DEFAULT_PREFIX if env[::Rack::PATH_INFO] == EMPTY_STRING
 
         return [app, match.named_captures]
       end
@@ -631,13 +652,16 @@ module Hanami
     # @since 2.0.0
     # @api private
     def not_allowed(env)
-      (_not_allowed_fixed(env) || _not_allowed_variable(env)) and return [405, { "Content-Length" => "11" }, ["Not Allowed"]]
+      (_not_allowed_fixed(env) ||
+      _not_allowed_variable(env)) and return [HTTP_STATUS_NOT_ALLOWED,
+                                              {::Rack::CONTENT_LENGTH => HTTP_BODY_NOT_ALLOWED_LENGTH},
+                                              [HTTP_BODY_NOT_ALLOWED]]
     end
 
     # @since 2.0.0
     # @api private
-    def not_found
-      [404, { "Content-Length" => "9" }, ["Not Found"]]
+    def not_found(env)
+      @not_found.call(env)
     end
 
     protected
@@ -655,7 +679,7 @@ module Hanami
     #
     # @see Hanami::Router#recognize
     # @see http://www.rubydoc.info/github/rack/rack/Rack%2FMockRequest.env_for
-    def env_for(env, params = {}, options = {}) # rubocop:disable Metrics/MethodLength
+    def env_for(env, params = {}, options = {})
       require "rack/mock"
 
       case env
@@ -665,7 +689,7 @@ module Hanami
         begin
           url = path(env, params)
           return env_for(url, params, options) # rubocop:disable Style/RedundantReturn
-        rescue Hanami::Router::InvalidRouteException
+        rescue Hanami::Router::MissingRouteError
           {} # Empty Rack env
         end
       else
@@ -683,6 +707,18 @@ module Hanami
     # @api private
     DEFAULT_PREFIX = "/"
 
+    # @since 2.0.0
+    # @api private
+    PREFIXED_NAME_SEPARATOR = "_"
+
+    # @since 2.0.0
+    # @api private
+    ROOT_PATH = "/"
+
+    # @since 2.0.0
+    # @api private
+    EMPTY_STRING = ""
+
     # @since 2.0.0
     # @api private
     DEFAULT_RESOLVER = ->(_, to) { to }
@@ -691,10 +727,58 @@ module Hanami
     # @api private
     DEFAULT_REDIRECT_CODE = 301
 
+    # @since 2.0.0
+    # @api private
+    HTTP_STATUS_OK = 200
+
+    # @since 2.0.0
+    # @api private
+    HTTP_STATUS_NOT_FOUND = 404
+
+    # @since 2.0.0
+    # @api private
+    HTTP_BODY_NOT_FOUND = ::Rack::Utils::HTTP_STATUS_CODES.fetch(HTTP_STATUS_NOT_FOUND)
+
+    # @since 2.0.0
+    # @api private
+    HTTP_BODY_NOT_FOUND_LENGTH = HTTP_BODY_NOT_FOUND.bytesize.to_s
+
+    # @since 2.0.0
+    # @api private
+    HTTP_STATUS_NOT_ALLOWED = 405
+
+    # @since 2.0.0
+    # @api private
+    HTTP_BODY_NOT_ALLOWED = ::Rack::Utils::HTTP_STATUS_CODES.fetch(HTTP_STATUS_NOT_ALLOWED)
+
+    # @since 2.0.0
+    # @api private
+    HTTP_BODY_NOT_ALLOWED_LENGTH = HTTP_BODY_NOT_ALLOWED.bytesize.to_s
+
+    # @since 2.0.0
+    # @api private
+    HTTP_HEADER_LOCATION = "Location"
+
     # @since 2.0.0
     # @api private
     PARAMS = "router.params"
 
+    # @since 2.0.0
+    # @api private
+    ROUTE_VARIABLE_MATCHER = /:/
+
+    # @since 2.0.0
+    # @api private
+    ROUTE_GLOBBED_MATCHER = /\*/
+
+    # Default response when no route was matched
+    #
+    # @api private
+    # @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)
@@ -708,17 +792,28 @@ module Hanami
     # @api private
     def add_route(http_method, path, to, as, constraints, &blk)
       path = prefixed_path(path)
-      to = resolve_endpoint(path, to, blk)
+      endpoint = resolve_endpoint(path, to, blk)
 
       if globbed?(path)
-        add_globbed_route(http_method, path, to, constraints)
+        add_globbed_route(http_method, path, endpoint, constraints)
       elsif variable?(path)
-        add_variable_route(http_method, path, to, constraints)
+        add_variable_route(http_method, path, endpoint, constraints)
       else
-        add_fixed_route(http_method, path, to)
+        add_fixed_route(http_method, path, endpoint)
+      end
+
+      if as
+        as = prefixed_name(as)
+        add_named_route(path, as, constraints)
       end
 
-      add_named_route(path, as, constraints) if as
+      if inspect?
+        @inspector.add_route(
+          Route.new(
+            http_method: http_method, path: path, to: to || endpoint, as: as, constraints: constraints, blk: blk
+          )
+        )
+      end
     end
 
     # @since 2.0.0
@@ -754,19 +849,25 @@ module Hanami
     # @since 2.0.0
     # @api private
     def add_named_route(path, as, constraints)
-      @url_helpers.add(prefixed_name(as), Segment.fabricate(path, **constraints))
+      @url_helpers.add(as, Segment.fabricate(path, **constraints))
     end
 
     # @since 2.0.0
     # @api private
     def variable?(path)
-      /:/.match?(path)
+      ROUTE_VARIABLE_MATCHER.match?(path)
     end
 
     # @since 2.0.0
     # @api private
     def globbed?(path)
-      /\*/.match?(path)
+      ROUTE_GLOBBED_MATCHER.match?(path)
+    end
+
+    # @since 2.0.0
+    # @api private
+    def inspect?
+      !@inspector.nil?
     end
 
     # @since 2.0.0
@@ -778,18 +879,39 @@ module Hanami
     # @since 2.0.0
     # @api private
     def prefixed_name(name)
-      @name_prefix.relative_join(name, "_").to_sym
+      @name_prefix.relative_join(name, PREFIXED_NAME_SEPARATOR).to_sym
+    end
+
+    # Returns a new instance of Hanami::Router with the modified options.
+    #
+    # @return [Hanami::Route] a new instance of Hanami::Router
+    #
+    # @see Hanami::Router#initialize
+    #
+    # @since 2.0.0
+    # @api private
+    def with(**new_options, &blk)
+      options = {
+        base_url: @base_url,
+        prefix: @path_prefix.to_s,
+        resolver: @resolver,
+        not_found: @not_found,
+        block_context: @block_context,
+        inspector: @inspector
+      }
+
+      self.class.new(**options.merge(new_options), &(blk || @blk))
     end
 
     # @since 2.0.0
     # @api private
     def _redirect(to, code)
-      body = Rack::Utils::HTTP_STATUS_CODES.fetch(code) do
+      body = ::Rack::Utils::HTTP_STATUS_CODES.fetch(code) do
         raise UnknownHTTPStatusCodeError.new(code)
       end
 
       destination = prefixed_path(to)
-      Redirect.new(destination, ->(*) { [code, { "Location" => destination }, [body]] })
+      Redirect.new(destination, code, ->(*) { [code, {HTTP_HEADER_LOCATION => destination}, [body]] })
     end
 
     # @since 2.0.0
@@ -797,7 +919,13 @@ module Hanami
     def _params(env, params)
       params ||= {}
       env[PARAMS] ||= {}
-      env[PARAMS].merge!(Rack::Utils.parse_nested_query(env["QUERY_STRING"]))
+
+      if !env.key?(ROUTER_PARSED_BODY) && (input = env[::Rack::RACK_INPUT]) and input.rewind
+        env[PARAMS].merge!(::Rack::Utils.parse_nested_query(input.read))
+        input.rewind
+      end
+
+      env[PARAMS].merge!(::Rack::Utils.parse_nested_query(env[::Rack::QUERY_STRING]))
       env[PARAMS].merge!(params)
       env[PARAMS] = Params.deep_symbolize(env[PARAMS])
       env
@@ -811,7 +939,7 @@ module Hanami
       @fixed.each_value do |routes|
         break if found
 
-        found = routes.key?(env["PATH_INFO"])
+        found = routes.key?(env[::Rack::PATH_INFO])
       end
 
       found
@@ -825,7 +953,7 @@ module Hanami
       @variable.each_value do |routes|
         break if found
 
-        found = routes.find(env["PATH_INFO"])
+        found = routes.find(env[::Rack::PATH_INFO])
       end
 
       found

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha3
+  version: 2.0.0
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -114,6 +114,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Rack compatible HTTP router for Ruby
 email:
 - me@lucaguidi.com
@@ -125,19 +153,28 @@ files:
 - LICENSE.md
 - README.md
 - hanami-router.gemspec
+- lib/hanami/middleware/app.rb
 - lib/hanami/middleware/body_parser.rb
 - lib/hanami/middleware/body_parser/class_interface.rb
 - lib/hanami/middleware/body_parser/errors.rb
 - lib/hanami/middleware/body_parser/json_parser.rb
+- lib/hanami/middleware/body_parser/parser.rb
 - lib/hanami/middleware/error.rb
+- lib/hanami/middleware/node.rb
+- lib/hanami/middleware/trie.rb
 - lib/hanami/router.rb
 - lib/hanami/router/block.rb
-- lib/hanami/router/error.rb
+- lib/hanami/router/constants.rb
+- lib/hanami/router/errors.rb
+- lib/hanami/router/formatter/csv.rb
+- lib/hanami/router/formatter/human_friendly.rb
+- lib/hanami/router/inspector.rb
 - lib/hanami/router/node.rb
 - lib/hanami/router/params.rb
 - lib/hanami/router/prefix.rb
 - lib/hanami/router/recognized_route.rb
 - lib/hanami/router/redirect.rb
+- lib/hanami/router/route.rb
 - lib/hanami/router/segment.rb
 - lib/hanami/router/trie.rb
 - lib/hanami/router/url_helpers.rb
@@ -145,8 +182,9 @@ files:
 homepage: http://hanamirb.org
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,15 +192,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami
 test_files: []