hanami-router 2.0.0.alpha3 → 2.0.0

data/lib/hanami/router/recognized_route.rb

@@ -4,10 +4,13 @@ module Hanami
   class Router
     # Represents a result of router path recognition.
     #
-    # @since 0.5.0
-    #
     # @see Hanami::Router#recognize
+    #
+    # @since 0.5.0
+    # @api public
     class RecognizedRoute
+      # @since 0.5.0
+      # @api private
       def initialize(endpoint, env)
         @endpoint = endpoint
         @env = env
@@ -27,7 +30,7 @@ module Hanami
       # @see Hanami::Router::RecognizedRoute#routable?
       # @see Hanami::Router::NotRoutableEndpointError
       def call(env)
-        if routable? # rubocop:disable Style/GuardClause
+        if routable?
           @endpoint.call(env)
         else
           raise NotRoutableEndpointError.new(@env)
@@ -41,7 +44,7 @@ module Hanami
       # @since 0.5.0
       # @api public
       def verb
-        @env["REQUEST_METHOD"]
+        @env[::Rack::REQUEST_METHOD]
       end
 
       # Relative URL (path)
@@ -51,15 +54,25 @@ module Hanami
       # @since 0.7.0
       # @api public
       def path
-        @env["PATH_INFO"]
+        @env[::Rack::PATH_INFO]
       end
 
+      # Returns the route's path params.
+      #
+      # @return [Hash]
+      #
       # @since 0.7.0
       # @api public
       def params
-        @env["router.params"]
+        @env[Router::PARAMS]
       end
 
+      # Returns the route's endpoint object.
+      #
+      # Returns nil if the route is a {#redirect? redirect}.
+      #
+      # @return [Object, nil]
+      #
       # @since 0.7.0
       # @api public
       def endpoint
@@ -68,18 +81,30 @@ module Hanami
         @endpoint
       end
 
+      # Returns true if the route has an {#endpoint}.
+      #
+      # @return [Boolean]
+      #
       # @since 0.7.0
       # @api public
       def routable?
         !@endpoint.nil?
       end
 
+      # Returns true if the route is a redirect.
+      #
+      # @return [Boolean]
+      #
       # @since 0.7.0
       # @api public
       def redirect?
         @endpoint.is_a?(Redirect)
       end
 
+      # Returns the route's redirect path, if it is a redirect, or nil otherwise.
+      #
+      # @return [String, nil]
+      #
       # @since 0.7.0
       # @api public
       def redirection_path

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,160 @@
+# frozen_string_literal: true
+
+require "hanami/router/redirect"
+require "hanami/router/block"
+
+module Hanami
+  class Router
+    # A route from the router
+    #
+    # @since 2.0.0
+    # @api public
+    class Route
+      # @since 2.0.0
+      # @api private
+      ROUTE_CONSTRAINT_SEPARATOR = ", "
+      private_constant :ROUTE_CONSTRAINT_SEPARATOR
+
+      # Returns the route's HTTP method.
+      #
+      # @example
+      #   route.http_method # => "GET"
+      #
+      # @return [String]
+      #
+      # @since 2.0.0
+      # @api public
+      attr_reader :http_method
+
+      # Returns the route's path.
+      #
+      # @example
+      #   route.path # => "/a/b/c"
+      #
+      # @return [String]
+      #
+      # @since 2.0.0
+      # @api public
+      attr_reader :path
+
+      # Returns the route's Rack endpoint, as given to `to:` when the route was defined.
+      #
+      # @return [Object]
+      #
+      # @since 2.0.0
+      # @api public
+      attr_reader :to
+
+      # Returns the route's unique name, as given to `as:` when the route was defined.
+      #
+      # @return [Object]
+      #
+      # @since 2.0.0
+      # @api public
+      attr_reader :as
+
+      # Returns the route's contraints hash for its path variables.
+      #
+      # @return [Hash]
+      #
+      # @since 2.0.0
+      # @api public
+      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
+
+      # Returns true if the route is for the HEAD HTTP method.
+      #
+      # @return [Boolean]
+      #
+      # @see #http_method
+      #
+      # @since 2.0.0
+      # @api public
+      def head?
+        http_method == ::Rack::HEAD
+      end
+
+      # Returns true if the route has a name.
+      #
+      # @return [Boolean]
+      #
+      # @see #as
+      #
+      # @since 2.0.0
+      # @api public
+      def as?
+        !as.nil?
+      end
+
+      # Returns true if the route has any constraints.
+      #
+      # @return [Boolean]
+      #
+      # @see #constraints
+      #
+      # @since 2.0.0
+      # @api public
+      def constraints?
+        constraints.any?
+      end
+
+      # Returns a string containing a human-readable representation of the route's {#to} endpoint.
+      #
+      # @return [String]
+      #
+      # @since 2.0.0
+      # @api public
+      def inspect_to(value = to)
+        case value
+        when String
+          value
+        when Proc
+          "(proc)"
+        when Class
+          value.name || "(class)"
+        when Block
+          "(block)"
+        when Redirect
+          "#{value.destination} (HTTP #{to.code})"
+        else
+          inspect_to(value.class)
+        end
+      end
+
+      # Returns a string containing a human-readable representation of the route's {#constraints}.
+      #
+      # @return [String]
+      #
+      # @since 2.0.0
+      # @api public
+      def inspect_constraints
+        @constraints.map do |key, value|
+          "#{key}: #{value.inspect}"
+        end.join(ROUTE_CONSTRAINT_SEPARATOR)
+      end
+
+      # Returns a string containing a human-readable representation of the route's name.
+      #
+      # @return [String]
+      #
+      # @see #as
+      #
+      # @since 2.0.0
+      # @api public
+      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/url_helpers.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require "hanami/router/error"
+require "hanami/router/errors"
 require "mustermann/error"
 
 module Hanami
   class Router
-    # URL Helpers
+    # @since 2.0.0
+    # @api private
     class UrlHelpers
       # @since 2.0.0
       # @api private
@@ -21,17 +22,17 @@ module Hanami
       end
 
       # @since 2.0.0
-      # @api public
+      # @api private
       def path(name, variables = {})
         @named.fetch(name.to_sym) do
-          raise InvalidRouteException.new(name)
+          raise MissingRouteError.new(name)
         end.expand(:append, variables)
       rescue Mustermann::ExpandError => exception
-        raise InvalidRouteExpansionException.new(name, exception.message)
+        raise InvalidRouteExpansionError.new(name, exception.message)
       end
 
       # @since 2.0.0
-      # @api public
+      # @api private
       def url(name, variables = {})
         @base_url + path(name, variables)
       end

data/lib/hanami/router/version.rb

@@ -2,8 +2,11 @@
 
 module Hanami
   class Router
-    # @since 0.1.0
+    # Returns the hanami-router version.
+    #
+    # @return [String]
+    #
     # @api public
-    VERSION = "2.0.0.alpha3"
+    VERSION = "2.0.0"
   end
 end