hanami-router 2.0.0.alpha5 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d72d9efd8d4b3b0df52796170481b05878e531b2aee3ea09894e6eeccb5562e6
-  data.tar.gz: 2078b5956054db900fe4d2f097b62901499ceb1622a57baae326fa921ef62f48
+  metadata.gz: 81061c98f91ba599e04ca8e16ac1ae9f8784e8398f3580b552cfa26885218b2e
+  data.tar.gz: cd776fa30375c022808441897e3849ec76ef5a6d5b452b36a444851c10a4f99c
 SHA512:
-  metadata.gz: 5409a722ae69fc035fcbe54138ecfe504d97d9dcd62f0c3ce04a93f2fa5ca40aa833813b491a3a13d1db972e8e352e9d7e89948dfa3f522d99beafae4908e961
-  data.tar.gz: 55505b92589cb74795bd01a6062d32effce16a56d0405b98e726d0ba9d3b54ca301fb464cf0826fdac7e45f1de23a15913a211359c2f908117b1e972684b90d7
+  metadata.gz: 3cdc82d97486a5d74893d8fdff7bd1f337dc5d64d6ff6407133519aef0b8a287b369231d973b62a4da5fdee7d07ecb766d3d0fd39a8e08aa3cd966a425fff238
+  data.tar.gz: ccc62d079fba4374b74dde5b008e3de0d4d5eaf630c9608179bca0ad0ff7ba6b0584713bb320977950f7901d0404b601598b2d6c97ffa218be428e8be47b2380

data/CHANGELOG.md

@@ -1,39 +1,81 @@
 # Hanami::Router
+
 Rack compatible HTTP router for Ruby
 
+## v2.0.0.beta2 - 2022-08-16
+
+### Fixed
+
+- [Luca Guidi] [Internal] Ensure `Hanami::Middleware::Error` class is available where it is needed [#225]
+
+## v2.0.0.beta1 - 2022-07-20
+
+### Added
+
+- [Marc Busqué] Introduced `Hanami::Router::Formatter::CSV` for CSV inspection of the routes
+
+### Fixed
+
+- [Marc Busqué] Routes inspection: Don't print empty line after the definition of a `get` route
+- [Marc Busqué] Routes inspection: Print `<controller>.<action>` instead of `(proc)`
+- [Marc Busqué] Routes inspection: Print `(block)` instead of `NilClass` when inspecting a route block
+
+## v2.0.0.alpha6 - 2022-02-10
+
+### Added
+
+- [Luca Guidi] Official support for MRI 3.1
+- [Luca Guidi] Parse non-GET request body and make it available in Rack env under the `router.params` key. For JSON requests, please use `Hanami:::Middleware::JsonParser`
+
+### Changed
+
+- [Luca Guidi] Drop support for Ruby: MRI 2.6, and 2.7.
+
 ## v2.0.0.alpha5 - 2021-05-04
+
 ### Added
+
 - [Luca Guidi] Introduced `Hanami::Router#to_inspect` which returns a string blob with all the routes formatted for human readability
 
 ## v2.0.0.alpha4 - 2021-01-16
+
 ### Added
+
 - [Luca Guidi] Official support for MRI 3.0
 - [Luca Guidi] Introduced `Hanami::Middleware::BodyParser::Parser` as superclass for body parsers
 - [Paweł Świątkowski] Added `not_found:` option to `Hanami::Router#initialize` to customize HTTP 404 status
 
 ## v2.0.0.alpha3 - 2020-05-20
+
 ### Fixed
+
 - [Luca Guidi] `Hanami::Router#initialize` do not yield block if not given
 - [Luca Guidi] Ensure to not accidentally cache response headers for HTTP 404 and 405
 - [Luca Guidi] Ensure scoped root to not be added as trailing slash
 
 ## v2.0.0.alpha2 - 2020-02-19
+
 ### Added
+
 - [Luca Guidi] Block syntax. Routes definition accept a block which returning value is the body of the Rack response.
 - [Luca Guidi] Added `resolver:` option to `Hanami::Router#initialize` to provide your own strategy to load endpoints.
 
 ### Changed
+
 - [Luca Guidi] Removed `Hanami::Router#resource` and `#resources`.
 - [Luca Guidi] Removed loading of routes endpoints.
 - [Luca Guidi] Removed `inflector:` from `Hanami::Router#initialize`
 - [Luca Guidi] Removed `scheme:`, `host:`, `port:` from `Hanami::Router#initialize`, use `base_url:` instead.
 
 ## v2.0.0.alpha1 - 2019-01-30
+
 ### Added
+
 - [Luca Guidi] Introduce `Hanami::Router#scope` to support single routing tier for Hanami
 - [Semyon Pupkov] Added `inflector:` option for `Hanami::Router#initialize` based on `dry-inflector`
 
 ### Changed
+
 - [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
 - [Luca Guidi] Renamed `Hanami::Router#namespace` => `#prefix`
 - [Gustavo Caso] Remove body cleanup for `HEAD` requests
@@ -45,25 +87,34 @@ Rack compatible HTTP router for Ruby
 - [Luca Guidi] `Hanami::Router#initialize` requires `configuration:` option if routes endpoints are `Hanami::Action` subclasses
 
 ## v1.3.2 - 2019-02-13
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.7
 - [Luca Guidi] Support `rack` 2.1
 
 ## v1.3.1 - 2019-01-18
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.6
 - [Luca Guidi] Support `bundler` 2.0+
 
 ## v1.3.0 - 2018-10-24
+
 ### Fixed
+
 - [Tim Riley] Skip attempting to parse unknown types in `Hanami::Middleware::BodyParser`
 
 ## v1.3.0.beta1 - 2018-08-08
+
 ### Added
+
 - [Luca Guidi] Official support for JRuby 9.2.0.0
 - [Gustavo Caso] Introduce `Hanami::Middleware::BodyParser` Rack middleware to parse payload of non-GET HTTP requests.
 
 ### Deprecated
+
 - [Alfonso Uceda] Deprecate `Hanami::Router.new(force_ssl: true)`. Use webserver (eg. Nginx), Rack middleware (eg. `rack-ssl`), or another strategy to force HTTPS connection.
 - [Gustavo Caso] Deprecate `Hanami::Router.new(body_parsers: [:json])`. Use `Hanami::Middleware::BodyParser` instead.
 
@@ -78,16 +129,21 @@ Rack compatible HTTP router for Ruby
 ## v1.2.0.beta1 - 2018-02-28
 
 ## v1.1.1 - 2018-02-27
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.5
 
 ### Fixed
+
 - [malin-as] Ensure `Hanami::Router` to properly respond to `unlink`
 
 ## v1.1.0 - 2017-10-25
 
 ## v1.1.0.rc1 - 2017-10-16
+
 ### Added
+
 - [Sergey Fedorov] Allow Rack applications to be mounted inside a namespace. (`namespace "api" { mount V1::App, at: "/v1" }`)
 
 ## v1.1.0.beta3 - 2017-10-04
@@ -97,10 +153,13 @@ Rack compatible HTTP router for Ruby
 ## v1.1.0.beta1 - 2017-08-11
 
 ## v1.0.1 - 2017-07-10
+
 ### Added
+
 - [Luca Guidi] Introduce new introspection methods (`#redirect?` and `#redirection_path`) for recognized routes (see `Hanami::Router#recognize`)
 
 ### Fixed
+
 - [Luca Guidi] Ensure `Hanami::Router#redirect` to be compatible with `#recognize`
 
 ## v1.0.0 - 2017-04-06
@@ -110,131 +169,176 @@ Rack compatible HTTP router for Ruby
 ## v1.0.0.beta3 - 2017-03-17
 
 ## v1.0.0.beta2 - 2017-03-02
+
 ### Fixed
+
 - [Valentyn Ostakh] Deep symbolize params from parsed body
 - [Luca Guidi] `Hanami::Router#recognize` must return a non-routeable object when the endpoint cannot be resolved
 
 ## v1.0.0.beta1 - 2017-02-14
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby: MRI 2.4
 - [Jakub Pavlík] Added `:as` option for RESTful resources (eg. `resources :psi, controller: 'dogs', as: 'dogs'`)
 
 ### Changed
+
 - [Pascal Betz] Make compatible with Rack 2.0 only
 
 ## v0.8.1 - 2016-11-18
+
 ### Fixed
+
 - [Luca Guidi] Ensure JSON body parser to not eval untrusted input
 
 ## v0.8.0 - 2016-11-15
+
 ### Added
+
 - [Kyle Chong] Referenced params from body parses in Rack env via `router.parsed_body`
 
 ### Fixed
+
 - [Luca Guidi & Lucas Hosseini] Ensure params from routes take precedence over params from body parsing
 - [Luca Guidi] Ensure inspector to respect path prefix of mouted apps
 
 ### Changed
+
 - [Luca Guidi] Official support for Ruby: MRI 2.3+ and JRuby 9.1.5.0+
 
 ## v0.7.0 - 2016-07-22
+
 ### Added
+
 - [Sean Collins] Introduced `Hanami::Router#root`. Example: `root to: 'home#index'`, equivalent to `get '/', to: 'home#index', as: :root`.
 - [Nicola Racco] Allow to mount Rack applications at a specific host. Example: `mount Blog, host: 'blog'`, which will be hit for `GET http://blog.example.com`
 - [Luca Guidi] Support `multi_json` gem as backend for JSON body parser. If `multi_json` is present in the gem bundle, it will be used, otherwise it will fallback to Ruby's `JSON`.
 - [Luca Guidi] Introduced `Hanami::Routing::RecognizedRoute#path` in order to allow a better introspection
 
 ### Fixed
+
 - [Andrew De Ponte] Make routes inspection to work when non-Hanami apps are mounted
 - [Andrew De Ponte] Ensure to set the right `SCRIPT_NAME` in Rack env for mounted Hanami apps
 - [Luca Guidi] Fix `NoMethodError` when `Hanami::Router#recognize` is invoked with a Rack env or a route name or a path that can't be recognized
 
 ### Changed
+
 – [Luca Guidi] Drop support for Ruby 2.0 and 2.1. Official support for JRuby 9.0.5.0+
 
 ## v0.6.2 - 2016-02-05
+
 ### Fixed
+
 - [Anton Davydov] Fix double leading slash for Capybara's `current_path`
 
 ## v0.6.1 - 2016-01-27
+
 ### Fixed
+
 - [Luca Guidi] Fix body parsers for non Hash requests
 
 ## v0.6.0 - 2016-01-22
+
 ### Changed
+
 - [Luca Guidi] Renamed the project
 
 ## v0.5.1 - 2016-01-19
+
 - [Anton Davydov] Print stacked lines for routes inspection
 
 ## v0.5.0 - 2016-01-12
+
 ### Added
+
 - [Luca Guidi] Added `Lotus::Router#recognize` as a testing facility. Example `router.recognize('/') # => associated route`
 - [Luca Guidi] Added `Lotus::Router.define` in order to wrap routes definitions in `config/routes.rb` when `Lotus::Router` is used outside of Lotus projects
 - [David Strauß] Make `Lotus::Routing::Parsing::JsonParser` compatible with `application/vnd.api+json` MIME Type
 - [Alfonso Uceda Pompa] Improved exception messages for `Lotus::Router#path` and `#url`
 
 ### Fixed
+
 - [Alfonso Uceda Pompa] Ensure `Lotus::Router#path` and `#url` to generate correct URL for mounted applications
 - [Vladislav Zarakovsky] Ensure Force SSL mode to respect Rack SPEC
 
 ### Changed
+
 - [Alfonso Uceda Pompa] A failure for body parsers raises a `Lotus::Routing::Parsing::BodyParsingError` exception
 - [Karim Tarek] Introduced `Lotus::Router::Error` and let all the framework exceptions to inherit from it.
 
 ## v0.4.3 - 2015-09-30
+
 ### Added
+
 - [Luca Guidi] Official support for JRuby 9k+
 
 ## v0.4.2 - 2015-07-10
+
 ### Fixed
+
 - [Alfonso Uceda Pompa] Ensure mounted applications to not repeat their prefix (eg `/admin/admin`)
 - [Thiago Felippe] Ensure router inspector properly prints routes with repeated entries (eg `/admin/dashboard/admin`)
 
 ## v0.4.1 - 2015-06-23
+
 ### Added
+
 - [Alfonso Uceda Pompa] Force SSL (eg `Lotus::Router.new(force_ssl: true`).
 - [Alfonso Uceda Pompa] Allow router to accept a `:prefix` option, in order to generate prefixed routes.
 
 ## v0.4.0 - 2015-05-15
+
 ### Added
+
 - [Alfonso Uceda Pompa] Nested RESTful resource(s)
 
 ### Changed
+
 - [Alfonso Uceda Pompa] RESTful resource(s) have a correct pluralization/singularization for variables and named routes (eg. `/books/:id` is now `:book` instead of `:books`)
 
 ## v0.3.0 - 2015-03-23
 
 ## v0.2.1 - 2015-01-30
+
 ### Added
+
 - [Alfonso Uceda Pompa] Lotus::Action compat: invoke `.call` if defined, otherwise fall back to `#call`.
 
 ## v0.2.0 - 2014-12-23
+
 ### Added
+
 - [Luca Guidi & Alfonso Uceda Pompa] Introduced routes inspector for CLI
 - [Luca Guidi & Janko Marohnić] Introduced body parser for JSON
 - [Luca Guidi] Introduced request body parsers: they parse body and turn into params.
 - [Fred Wu] Introduced Router#define
 
 ### Fixed
+
 - [Luca Guidi] Fix for member/collection actions in RESTful resource(s): allow to take actions with a leading slash.
 - [Janko Marohnić] Fix for nested namespaces and RESTful resource(s) under namespace. They were generating wrong route names.
 - [Luca Guidi] Made InvalidRouteException to inherit from StandardError so it can be catched from anonymous `rescue` clause
 - [Luca Guidi] Fix RESTful resource(s) to respect :only/:except options
 
 ### Changed
+
 - [Luca Guidi] Aligned naming conventions with Lotus::Controller: no more BooksController::Index. Use Books::Index instead.
 - [Luca Guidi] Removed `:prefix` option for routes. Use `#namespace` blocks instead.
 - [Janko Marohnić] Make 301 the default redirect status
 
 ## v0.1.1 - 2014-06-23
+
 ### Added
+
 - [Luca Guidi] Introduced Lotus::Router#mount
 - [Luca Guidi] Let specify a pattern for Lotus::Routing::EndpointResolver
 - [Luca Guidi] Make Lotus::Routing::Endpoint::EndpointNotFound to inherit from StandardError, instead of Exception. This make it compatible with Rack::ShowExceptions.
 
 ## v0.1.0 - 2014-01-23
+
 ### Added
+
 - [Luca Guidi] Official support for Ruby 2.1
 - [Luca Guidi] Added support for OPTIONS HTTP verb
 - [Luca Guidi] Added Lotus::Routing::EndpointNotFound when a lazy endpoint can't be found

data/README.md

@@ -2,11 +2,15 @@
 
 Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://hanamirb.org).
 
+## Version
+
+**This branch contains the code for `hanami-router` 2.x.**
+
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
-[![CI](https://github.com/hanami/router/workflows/ci/badge.svg?branch=unstable)](https://github.com/hanami/router/actions?query=workflow%3Aci+branch%3Aunstable)
-[![Test Coverage](https://codecov.io/gh/hanami/router/branch/unstable/graph/badge.svg)](https://codecov.io/gh/hanami/router)
+[![CI](https://github.com/hanami/router/workflows/ci/badge.svg?branch=main)](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)
 [![Inline Docs](http://inch-ci.org/github/hanami/router.svg)](http://inch-ci.org/github/hanami/router)
 
@@ -21,7 +25,7 @@ Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://h
 
 ## Rubies
 
-__Hanami::Router__ supports Ruby (MRI) 2.6+
+__Hanami::Router__ supports Ruby (MRI) 3.0+
 
 
 ## Installation
@@ -361,6 +365,4 @@ __Hanami::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2021 Luca Guidi – Released under MIT License
-
-This project was formerly known as Lotus (`lotus-router`).
+Copyright © 2014-2022 Hanami Team – Released under MIT License

data/hanami-router.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-router.gemspec`.split($/)
   spec.executables   = []
-  spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.required_ruby_version = ">= 3.0"
 
   spec.add_dependency "rack",               "~> 2.0"
   spec.add_dependency "mustermann",         "~> 1.0"
@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack-test", "~> 1.0"
   spec.add_development_dependency "rspec",     "~> 3.8"
 
-  spec.add_development_dependency "rubocop", "0.91"
-  spec.add_development_dependency "rubocop-performance", "1.8.1"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.0"
 end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "hanami/middleware/error"
+
 module Hanami
   module Middleware
     # @since 1.3.0

data/lib/hanami/middleware/body_parser.rb

@@ -17,7 +17,7 @@ module Hanami
 
       # @since 1.3.0
       # @api private
-      MEDIA_TYPE_MATCHER = /\s*[;,]\s*/.freeze
+      MEDIA_TYPE_MATCHER = /\s*[;,]\s*/
 
       # @since 1.3.0
       # @api private

data/lib/hanami/middleware/error.rb

@@ -5,7 +5,7 @@ module Hanami
   #
   # @since 1.3.0
   module Middleware
-    unless defined?(Error)
+    unless defined?(::Hanami::Middleware::Error)
       # Base error for Rack middleware
       #
       # @since 2.0.0

data/lib/hanami/router/block.rb

@@ -35,7 +35,7 @@ module Hanami
           if value
             @status = value
           else
-            @status ||= 200
+            @status ||= Router::HTTP_STATUS_OK
           end
         end
 
@@ -59,7 +59,7 @@ module Hanami
         #
         # @since 2.0.0
         def params
-          env["router.params"]
+          env[Router::PARAMS]
         end
 
         # @api private

data/lib/hanami/router/error.rb

@@ -60,7 +60,7 @@ module Hanami
     class NotRoutableEndpointError < Error
       # @since 0.5.0
       def initialize(env)
-        super %(Cannot find routable endpoint for: #{env['REQUEST_METHOD']} #{env['PATH_INFO']})
+        super %(Cannot find routable endpoint for: #{env[::Rack::REQUEST_METHOD]} #{env[::Rack::PATH_INFO]})
       end
     end
   end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Hanami
+  class Router
+    # Renders a CSV representation of the routes
+    #
+    # You can forward [CSV generation
+    # options](https://ruby-doc.org/stdlib-3.1.0/libdoc/csv/rdoc/CSV.html#class-CSV-label-Options+for+Generating]
+    # when calling it:
+    #
+    # ```
+    # require "hanami/router/inspector"
+    # require "hanami/router/formatter/csv"
+    #
+    # Hanami::Router::Inspector.new(
+    #   routes: Router.routes,
+    #   formatter: Hanami::Router::Formatter::CSV.new
+    # ).call(write_headers: false)
+    # ```
+    #
+    # @api private
+    # @since 2.0.0
+    module Formatter
+      class CSV
+        # @api private
+        # @since 2.0.0
+        DEFAULT_OPTIONS = {
+          write_headers: true
+        }.freeze
+
+        # @api private
+        # @since 2.0.0
+        HEADERS = %w[METHOD PATH TO AS CONSTRAINTS].freeze
+
+        # @api private
+        # @since 2.0.0
+        def call(routes, **csv_opts)
+          ::CSV.generate(**DEFAULT_OPTIONS.merge(csv_opts)) do |csv|
+            csv << HEADERS if csv.write_headers?
+            routes.reduce(csv) do |acc, route|
+              route.head? ? acc : acc << row(route)
+            end
+          end
+        end
+
+        private
+
+        def row(route)
+          [
+            route.http_method.to_s,
+            route.path,
+            route.inspect_to,
+            route.as? ? route.inspect_as : "",
+            route.constraints? ? route.inspect_constraints : ""
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Router
+    # Renders a human friendly representation of the routes
+    #
+    # @api private
+    # @since 2.0.0
+    module Formatter
+      class HumanFriendly
+        # @api private
+        # @since 2.0.0
+        NEW_LINE = $/
+        private_constant :NEW_LINE
+
+        # @api private
+        # @since 2.0.0
+        SMALL_STRING_JUSTIFY_AMOUNT = 8
+        private_constant :SMALL_STRING_JUSTIFY_AMOUNT
+
+        # @api private
+        # @since 2.0.0
+        MEDIUM_STRING_JUSTIFY_AMOUNT = 20
+        private_constant :MEDIUM_STRING_JUSTIFY_AMOUNT
+
+        # @api private
+        # @since 2.0.0
+        LARGE_STRING_JUSTIFY_AMOUNT = 30
+        private_constant :LARGE_STRING_JUSTIFY_AMOUNT
+
+        # @api private
+        # @since 2.0.0
+        EXTRA_LARGE_STRING_JUSTIFY_AMOUNT = 40
+        private_constant :EXTRA_LARGE_STRING_JUSTIFY_AMOUNT
+
+        # @api private
+        # @since 2.0.0
+        def call(routes)
+          routes.filter_map(&method(:format_route_unless_head)).join(NEW_LINE)
+        end
+
+        private
+
+        def format_route_unless_head(route)
+          !route.head? &&
+            [
+              route.http_method.to_s.ljust(SMALL_STRING_JUSTIFY_AMOUNT),
+              route.path.ljust(LARGE_STRING_JUSTIFY_AMOUNT),
+              route.inspect_to.ljust(LARGE_STRING_JUSTIFY_AMOUNT),
+              route.as? ? "as #{route.inspect_as}".ljust(MEDIUM_STRING_JUSTIFY_AMOUNT) : "",
+              route.constraints? ? "(#{route.inspect_constraints})".ljust(EXTRA_LARGE_STRING_JUSTIFY_AMOUNT) : ""
+            ].join
+        end
+      end
+    end
+  end
+end

data/lib/hanami/router/inspector.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 
+require "hanami/router/formatter/human_friendly"
+
 module Hanami
   class Router
     # Routes inspector
     #
-    # @api private
+    # Builds a representation of an array of routes according to a given
+    # formatter.
+    #
     # @since 2.0.0
     class Inspector
-      # @api private
+      # @param routes [Array<Hanami::Route>]
+      # @param formatter [#call] Takes the routes as an argument and returns
+      #   whatever representation it creates. Defaults to
+      #   {Hanami::Router::Formatter::HumanFriendly}.
       # @since 2.0.0
-      def initialize(routes: [])
+      def initialize(routes: [], formatter: Formatter::HumanFriendly.new)
         @routes = routes
+        @formatter = formatter
       end
 
       # @param route [Hash] serialized route
@@ -21,18 +29,12 @@ module Hanami
         @routes.push(route)
       end
 
-      # @return [String] The inspected routes
+      # @return [Any] Formatted routes
       #
-      # @api private
       # @since 2.0.0
-      def call(*)
-        @routes.map(&:to_inspect).join(NEW_LINE)
+      def call(...)
+        @formatter.call(@routes, ...)
       end
-
-      # @api private
-      # @since 2.0.0
-      NEW_LINE = $/
-      private_constant :NEW_LINE
     end
   end
 end

data/lib/hanami/router/node.rb

@@ -72,7 +72,7 @@ module Hanami
       # @api private
       # @since 2.0.0
       def variable?(segment)
-        /:/.match?(segment)
+        Router::ROUTE_VARIABLE_MATCHER.match?(segment)
       end
 
       # @api private

data/lib/hanami/router/prefix.rb

@@ -48,11 +48,11 @@ module Hanami
 
       # @since 2.0.0
       # @api private
-      DEFAULT_SEPARATOR_REGEXP = /\//.freeze
+      DEFAULT_SEPARATOR_REGEXP = /\//
 
       # @since 2.0.0
       # @api private
-      DOUBLE_DEFAULT_SEPARATOR_REGEXP = /\/{2,}/.freeze
+      DOUBLE_DEFAULT_SEPARATOR_REGEXP = /\/{2,}/
 
       # @since 2.0.0
       # @api private

data/lib/hanami/router/recognized_route.rb

@@ -41,7 +41,7 @@ module Hanami
       # @since 0.5.0
       # @api public
       def verb
-        @env["REQUEST_METHOD"]
+        @env[::Rack::REQUEST_METHOD]
       end
 
       # Relative URL (path)
@@ -51,13 +51,13 @@ module Hanami
       # @since 0.7.0
       # @api public
       def path
-        @env["PATH_INFO"]
+        @env[::Rack::PATH_INFO]
       end
 
       # @since 0.7.0
       # @api public
       def params
-        @env["router.params"]
+        @env[Router::PARAMS]
       end
 
       # @since 0.7.0

data/lib/hanami/router/route.rb

@@ -5,24 +5,27 @@ require "hanami/router/block"
 
 module Hanami
   class Router
+    # A route from the router
+    #
+    # @since 2.0.0
     class Route
       # @api private
+      # @since 2.0.0
+      ROUTE_CONSTRAINT_SEPARATOR = ", "
+      private_constant :ROUTE_CONSTRAINT_SEPARATOR
+
       # @since 2.0.0
       attr_reader :http_method
 
-      # @api private
       # @since 2.0.0
       attr_reader :path
 
-      # @api private
       # @since 2.0.0
       attr_reader :to
 
-      # @api private
       # @since 2.0.0
       attr_reader :as
 
-      # @api private
       # @since 2.0.0
       attr_reader :constraints
 
@@ -38,93 +41,50 @@ module Hanami
         freeze
       end
 
-      # @api private
       # @since 2.0.0
-      def to_inspect
-        return EMPTY_ROUTE if head?
-
-        result = http_method.to_s.ljust(SMALL_STRING_JUSTIFY_AMOUNT)
-        result += path.ljust(LARGE_STRING_JUSTIFY_AMOUNT)
-        result += inspect_to(to).ljust(LARGE_STRING_JUSTIFY_AMOUNT)
-        result += "as #{as.inspect}".ljust(MEDIUM_STRING_JUSTIFY_AMOUNT) if as
-
-        if constraints?
-          result += "(#{inspect_constraints(constraints)})".ljust(EXTRA_LARGE_STRING_JUSTIFY_AMOUNT)
-        end
-
-        result
+      def head?
+        http_method == ::Rack::HEAD
       end
 
-      private
-
-      # @api private
       # @since 2.0.0
-      EMPTY_ROUTE = ""
-      private_constant :EMPTY_ROUTE
-
-      # @api private
-      # @since 2.0.0
-      ROUTE_CONSTRAINT_SEPARATOR = ", "
-      private_constant :ROUTE_CONSTRAINT_SEPARATOR
-
-      # @api private
-      # @since 2.0.0
-      SMALL_STRING_JUSTIFY_AMOUNT = 8
-      private_constant :SMALL_STRING_JUSTIFY_AMOUNT
-
-      # @api private
-      # @since 2.0.0
-      MEDIUM_STRING_JUSTIFY_AMOUNT = 20
-      private_constant :MEDIUM_STRING_JUSTIFY_AMOUNT
-
-      # @api private
-      # @since 2.0.0
-      LARGE_STRING_JUSTIFY_AMOUNT = 30
-      private_constant :LARGE_STRING_JUSTIFY_AMOUNT
-
-      # @api private
-      # @since 2.0.0
-      EXTRA_LARGE_STRING_JUSTIFY_AMOUNT = 40
-      private_constant :EXTRA_LARGE_STRING_JUSTIFY_AMOUNT
-
-      # @api private
-      # @since 2.0.0
-      def head?
-        http_method == "HEAD"
+      def as?
+        !as.nil?
       end
 
-      # @api private
       # @since 2.0.0
       def constraints?
         constraints.any?
       end
 
-      # @api private
       # @since 2.0.0
-      def inspect_to(to)
-        case to
+      def inspect_to(value = to)
+        case value
         when String
-          to
+          value
         when Proc
           "(proc)"
         when Class
-          to.name || "(class)"
+          value.name || "(class)"
         when Block
           "(block)"
         when Redirect
-          "#{to.destination} (HTTP #{to.code})"
+          "#{value.destination} (HTTP #{to.code})"
         else
-          inspect_to(to.class)
+          inspect_to(value.class)
         end
       end
 
-      # @api private
       # @since 2.0.0
-      def inspect_constraints(constraints)
-        constraints.map do |key, value|
+      def inspect_constraints
+        @constraints.map do |key, value|
           "#{key}: #{value.inspect}"
         end.join(ROUTE_CONSTRAINT_SEPARATOR)
       end
+
+      # @since 2.0.0
+      def inspect_as
+        as ? as.inspect : Router::EMPTY_STRING
+      end
     end
   end
 end

data/lib/hanami/router/trie.rb

@@ -52,10 +52,15 @@ module Hanami
 
       private
 
+      # @api private
+      # @since 2.0.0
+      SEGMENT_SEPARATOR = /\//
+      private_constant :SEGMENT_SEPARATOR
+
       # @api private
       # @since 2.0.0
       def for_each_segment(path, &blk)
-        _, *segments = path.split(/\//)
+        _, *segments = path.split(SEGMENT_SEPARATOR)
         segments.each(&blk)
       end
     end

data/lib/hanami/router/version.rb

@@ -4,6 +4,6 @@ module Hanami
   class Router
     # @since 0.1.0
     # @api public
-    VERSION = "2.0.0.alpha5"
+    VERSION = "2.0.0.beta2"
   end
 end

data/lib/hanami/router.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "rack"
 require "rack/utils"
 
 module Hanami
@@ -24,11 +25,12 @@ module Hanami
     # @since 2.0.0
     attr_reader :url_helpers
 
-    # Routes for inspection
+    # Routes inspector
+    #
+    # @return [Hanami::Router::Inspector]
     #
-    # @api private
     # @since 2.0.0
-    attr_reader :routes
+    attr_reader :inspector
 
     # Returns the given block as it is.
     #
@@ -53,7 +55,7 @@ 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
@@ -145,7 +147,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.
@@ -196,8 +198,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.
@@ -215,7 +217,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.
@@ -233,7 +235,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.
@@ -251,7 +253,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.
@@ -269,7 +271,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.
@@ -287,7 +289,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.
@@ -305,7 +307,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.
@@ -323,7 +325,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.
@@ -341,7 +343,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.
@@ -451,7 +453,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.
@@ -481,7 +483,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
@@ -602,38 +604,23 @@ module Hanami
       )
     end
 
-    # Returns formatted routes
-    #
-    # @return [String] formatted routes
-    #
-    # @since 2.0.0
-    # @api private
-    def to_inspect
-      require "hanami/router/inspector"
-
-      inspector = Inspector.new
-      with(inspector: inspector)
-
-      inspector.call
-    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
@@ -645,13 +632,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
@@ -663,7 +650,9 @@ module Hanami
     # @api private
     def not_allowed(env)
       (_not_allowed_fixed(env) ||
-       _not_allowed_variable(env)) and return [405, {"Content-Length" => "11"}, ["Not Allowed"]]
+      _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
@@ -715,6 +704,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 }
@@ -723,15 +724,57 @@ 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 = ->(*) { [404, {"Content-Length" => "9"}, ["Not Found"]] }.freeze
+    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
@@ -746,21 +789,23 @@ 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
 
       add_named_route(path, as, constraints) if as
 
       if inspect?
         @inspector.add_route(
-          Route.new(http_method: http_method, path: path, to: to, as: as, constraints: constraints, blk: blk)
+          Route.new(
+            http_method: http_method, path: path, to: to || endpoint, as: as, constraints: constraints, blk: blk
+          )
         )
       end
     end
@@ -804,13 +849,13 @@ module Hanami
     # @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
@@ -828,7 +873,7 @@ 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.
@@ -855,12 +900,12 @@ module Hanami
     # @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, ->(*) { [code, {"Location" => destination}, [body]] })
+      Redirect.new(destination, code, ->(*) { [code, {HTTP_HEADER_LOCATION => destination}, [body]] })
     end
 
     # @since 2.0.0
@@ -868,7 +913,13 @@ module Hanami
     def _params(env, params)
       params ||= {}
       env[PARAMS] ||= {}
-      env[PARAMS].merge!(Rack::Utils.parse_nested_query(env["QUERY_STRING"]))
+
+      if (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
@@ -882,7 +933,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
@@ -896,7 +947,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.alpha5
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-04 00:00:00.000000000 Z
+date: 2022-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -118,30 +118,30 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.91'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.91'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1.0'
 description: Rack compatible HTTP router for Ruby
 email:
 - me@lucaguidi.com
@@ -162,6 +162,8 @@ files:
 - lib/hanami/router.rb
 - lib/hanami/router/block.rb
 - lib/hanami/router/error.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
@@ -176,7 +178,8 @@ files:
 homepage: http://hanamirb.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -185,14 +188,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.4
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami