hanami-router 2.0.0.alpha4 → 2.0.0.alpha5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a855344a3dcd5d256259802c803eae8c7e41aeaeda1f108855d668458ec6c32d
-  data.tar.gz: 79f333141e1453d4bd4c4f4e09fd41e54bb2cab94d3889268a6a765ec9d52a16
+  metadata.gz: d72d9efd8d4b3b0df52796170481b05878e531b2aee3ea09894e6eeccb5562e6
+  data.tar.gz: 2078b5956054db900fe4d2f097b62901499ceb1622a57baae326fa921ef62f48
 SHA512:
-  metadata.gz: 1dc165c33814c2869852526395de10368b14918b09af6d4dbac56e2610f6ae8dcd8e78eb1034e0b858a48e30d80470976af692e1a235cb58a54561c1dc7393b7
-  data.tar.gz: a73e23f4d0875143660610be0b8e349be143dcdbed62a258070d0b1973ee876c57b68ae8df90f1fc786bf9e689ec40a16ced52053dbd16f893efe4b62fa70e85
+  metadata.gz: 5409a722ae69fc035fcbe54138ecfe504d97d9dcd62f0c3ce04a93f2fa5ca40aa833813b491a3a13d1db972e8e352e9d7e89948dfa3f522d99beafae4908e961
+  data.tar.gz: 55505b92589cb74795bd01a6062d32effce16a56d0405b98e726d0ba9d3b54ca301fb464cf0826fdac7e45f1de23a15913a211359c2f908117b1e972684b90d7

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## 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

data/lib/hanami/router.rb

@@ -15,6 +15,7 @@ module Hanami
     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 +24,12 @@ module Hanami
     # @since 2.0.0
     attr_reader :url_helpers
 
+    # Routes for inspection
+    #
+    # @api private
+    # @since 2.0.0
+    attr_reader :routes
+
     # Returns the given block as it is.
     #
     # @param blk [Proc] a set of route definitions
@@ -61,11 +68,12 @@ 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, &blk) # rubocop:disable Layout/LineLength
+    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
@@ -73,6 +81,8 @@ module Hanami
       @variable = {}
       @globbed = {}
       @mounted = {}
+      @blk = blk
+      @inspector = inspector
       instance_eval(&blk) if blk
     end
 
@@ -407,7 +417,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.
@@ -588,6 +602,21 @@ 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)
@@ -728,6 +757,12 @@ module Hanami
       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)
+        )
+      end
     end
 
     # @since 2.0.0
@@ -778,6 +813,12 @@ module Hanami
       /\*/.match?(path)
     end
 
+    # @since 2.0.0
+    # @api private
+    def inspect?
+      !@inspector.nil?
+    end
+
     # @since 2.0.0
     # @api private
     def prefixed_path(path)
@@ -790,6 +831,27 @@ module Hanami
       @name_prefix.relative_join(name, "_").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)
@@ -798,7 +860,7 @@ module Hanami
       end
 
       destination = prefixed_path(to)
-      Redirect.new(destination, ->(*) { [code, {"Location" => destination}, [body]] })
+      Redirect.new(destination, code, ->(*) { [code, {"Location" => destination}, [body]] })
     end
 
     # @since 2.0.0

data/lib/hanami/router/inspector.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Router
+    # Routes inspector
+    #
+    # @api private
+    # @since 2.0.0
+    class Inspector
+      # @api private
+      # @since 2.0.0
+      def initialize(routes: [])
+        @routes = routes
+      end
+
+      # @param route [Hash] serialized route
+      #
+      # @api private
+      # @since 2.0.0
+      def add_route(route)
+        @routes.push(route)
+      end
+
+      # @return [String] The inspected routes
+      #
+      # @api private
+      # @since 2.0.0
+      def call(*)
+        @routes.map(&:to_inspect).join(NEW_LINE)
+      end
+
+      # @api private
+      # @since 2.0.0
+      NEW_LINE = $/
+      private_constant :NEW_LINE
+    end
+  end
+end

data/lib/hanami/router/redirect.rb

@@ -13,8 +13,13 @@ module Hanami
 
       # @since 2.0.0
       # @api private
-      def initialize(destination, endpoint)
+      attr_reader :code
+
+      # @since 2.0.0
+      # @api private
+      def initialize(destination, code, endpoint)
         @destination = destination
+        @code = code
         @endpoint = endpoint
       end
 

data/lib/hanami/router/route.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "hanami/router/redirect"
+require "hanami/router/block"
+
+module Hanami
+  class Router
+    class Route
+      # @api private
+      # @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
+
+      # @api private
+      # @since 2.0.0
+      def initialize(http_method:, path:, to:, as: nil, constraints: {}, blk: nil) # rubocop:disable Metrics/ParameterLists
+        @http_method = http_method
+        @path = path
+        @to = to
+        @as = as
+        @constraints = constraints
+        @blk = blk
+        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
+      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"
+      end
+
+      # @api private
+      # @since 2.0.0
+      def constraints?
+        constraints.any?
+      end
+
+      # @api private
+      # @since 2.0.0
+      def inspect_to(to)
+        case to
+        when String
+          to
+        when Proc
+          "(proc)"
+        when Class
+          to.name || "(class)"
+        when Block
+          "(block)"
+        when Redirect
+          "#{to.destination} (HTTP #{to.code})"
+        else
+          inspect_to(to.class)
+        end
+      end
+
+      # @api private
+      # @since 2.0.0
+      def inspect_constraints(constraints)
+        constraints.map do |key, value|
+          "#{key}: #{value.inspect}"
+        end.join(ROUTE_CONSTRAINT_SEPARATOR)
+      end
+    end
+  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.alpha4"
+    VERSION = "2.0.0.alpha5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha4
+  version: 2.0.0.alpha5
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -162,11 +162,13 @@ files:
 - lib/hanami/router.rb
 - lib/hanami/router/block.rb
 - lib/hanami/router/error.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