hanami-router 1.3.2 → 2.0.0.alpha1

data/lib/hanami/routing/endpoint_resolver.rb

@@ -1,6 +1,8 @@
-require 'hanami/utils/string'
-require 'hanami/utils/class'
-require 'hanami/routing/endpoint'
+# frozen_string_literal: true
+
+require "hanami/utils/string"
+require "hanami/utils/class"
+require "hanami/routing/endpoint"
 
 module Hanami
   module Routing
@@ -12,11 +14,11 @@ module Hanami
     class EndpointResolver
       # @since 0.2.0
       # @api private
-      NAMING_PATTERN = '%{controller}::%{action}'.freeze
+      NAMING_PATTERN = "%<controller>s::%<action>s"
 
       # @since 0.7.0
       # @api private
-      DEFAULT_RESPONSE = [404, {'X-Cascade' => 'pass'}, 'Not Found'].freeze
+      DEFAULT_RESPONSE = [404, { "X-Cascade" => "pass" }, "Not Found"].freeze
 
       # Default separator for controller and action.
       # A different separator can be passed to #initialize with the `:separator` option.
@@ -32,7 +34,7 @@ module Hanami
       #   router = Hanami::Router.new do
       #     get '/', to: 'articles#show'
       #   end
-      ACTION_SEPARATOR = '#'.freeze
+      ACTION_SEPARATOR = "#"
 
       attr_reader :action_separator
 
@@ -183,10 +185,11 @@ module Hanami
       end
 
       protected
+
       # @api private
       def default
         @endpoint_class.new(
-          ->(env) { DEFAULT_RESPONSE }
+          ->(_env) { DEFAULT_RESPONSE }
         )
       end
 
@@ -208,6 +211,7 @@ module Hanami
       end
 
       private
+
       # @api private
       def resolve_callable(callable)
         if callable.respond_to?(:call)
@@ -219,19 +223,19 @@ module Hanami
 
       # @api private
       def resolve_matchable(matchable)
-        if matchable.respond_to?(:match)
-          constantize(
-            resolve_action(matchable) || classify(matchable)
-          )
-        end
+        return unless matchable.respond_to?(:match)
+
+        constantize(
+          resolve_action(matchable) || classify(matchable)
+        )
       end
 
       # @api private
       def resolve_action(string)
-        if string.match(action_separator)
-          controller, action = string.split(action_separator).map {|token| classify(token) }
-          @pattern % {controller: controller, action: action}
-        end
+        return unless string.match?(action_separator)
+
+        controller, action = string.split(action_separator).map { |token| classify(token) }
+        format(@pattern, controller: controller, action: action)
       end
     end
   end

data/lib/hanami/routing/prefix.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "delegate"
+require "hanami/utils/path_prefix"
+
+module Hanami
+  module Routing
+    # Prefix for routes.
+    # Implementation of Hanami::Router#prefix
+    #
+    # @since 2.0.0
+    # @api private
+    #
+    # @see Hanami::Router#prefix
+    class Prefix < SimpleDelegator
+      # @api private
+      # @since 2.0.0
+      def initialize(router, path, namespace, configuration, &blk)
+        @router        = router
+        @namespace     = namespace
+        @configuration = configuration
+        @path          = Utils::PathPrefix.new(path)
+        __setobj__(@router)
+        instance_eval(&blk)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def get(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def post(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def put(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def patch(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def delete(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def trace(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def options(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(namespace: @namespace, configuration: @configuration), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def resource(name, options = {})
+        super(name, options.merge(prefix: @path.relative_join(options[:prefix]), namespace: @namespace, configuration: @configuration))
+      end
+
+      # @api private
+      # @since 2.0.0
+      def resources(name, options = {})
+        super(name, options.merge(prefix: @path.relative_join(options[:prefix]), namespace: @namespace, configuration: @configuration))
+      end
+
+      # @api private
+      # @since 2.0.0
+      def redirect(path, options = {}, &endpoint)
+        super(@path.join(path), options.merge(to: @path.join(options[:to])), &endpoint)
+      end
+
+      # @api private
+      # @since 2.0.0
+      def mount(app, options)
+        super(app, options.merge(at: @path.join(options[:at])))
+      end
+
+      # Supports nested prefix
+      #
+      # @api private
+      # @since 2.0.0
+      def prefix(path, &blk)
+        self.class.new(self, path, @namespace, @configuration, &blk)
+      end
+    end
+  end
+end

data/lib/hanami/routing/recognized_route.rb

@@ -1,4 +1,6 @@
-require 'hanami/utils/string'
+# frozen_string_literal: true
+
+require "hanami/utils/string"
 
 module Hanami
   module Routing
@@ -10,23 +12,25 @@ module Hanami
     class RecognizedRoute
       # @since 0.5.0
       # @api private
-      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+      REQUEST_METHOD = "REQUEST_METHOD"
 
       # @since 0.7.0
       # @api private
-      PATH_INFO      = 'PATH_INFO'.freeze
+      PATH_INFO      = "PATH_INFO"
 
       # @since 0.5.0
       # @api private
-      NAMESPACE             = '%s::'.freeze
+      NAMESPACE             = "%s::"
 
       # @since 0.5.0
       # @api private
-      NAMESPACE_REPLACEMENT = ''.freeze
+      NAMESPACE_REPLACEMENT = ""
 
       # @since 0.5.0
       # @api private
-      ACTION_PATH_SEPARATOR = '/'.freeze
+      ACTION_PATH_SEPARATOR = "/"
+
+      ACTION_SEPARATOR = "#"
 
       # @since 0.5.0
       # @api public
@@ -42,18 +46,20 @@ module Hanami
       #
       # @since 0.5.0
       # @api private
-      def initialize(response, env, router)
-        @env      = env
-        @endpoint = nil
-        @params   = {}
-
-        unless response.nil?
-          @endpoint = response.route.dest
-          @params   = response.params
-        end
+      def initialize(route, env, namespace)
+        @env       = env
+        @endpoint  = nil
+        @params    = {}
+        @namespace = namespace
+
+        return if route.nil?
+
+        @endpoint = route.instance_variable_get(:@endpoint)
+
+        return unless routable?
 
-        @namespace        = router.namespace
-        @action_separator = router.action_separator
+        route.call(@env)
+        @params = @env["router.params"]
       end
 
       # Rack protocol compatibility
@@ -70,7 +76,7 @@ module Hanami
       # @see Hanami::Routing::RecognizedRoute#routable?
       # @see Hanami::Router::NotRoutableEndpointError
       def call(env)
-        if routable?
+        if routable? # rubocop:disable Style/GuardClause
           @endpoint.call(env)
         else
           raise Hanami::Router::NotRoutableEndpointError.new(@env)
@@ -116,12 +122,14 @@ module Hanami
       #   puts router.recognize('/books/23').action # => "books#show"
       def action
         return if !routable? || redirect?
+
         namespace = NAMESPACE % @namespace
 
         if destination.match(namespace)
           Hanami::Utils::String.transform(
             destination.sub(namespace, NAMESPACE_REPLACEMENT),
-            :underscore, [:rsub, ACTION_PATH_SEPARATOR, @action_separator])
+            :underscore, [:rsub, ACTION_PATH_SEPARATOR, ACTION_SEPARATOR]
+          )
         else
           destination
         end
@@ -146,7 +154,9 @@ module Hanami
       #   puts router.recognize('/').routable?    # => true
       #   puts router.recognize('/foo').routable? # => false
       def routable?
-        @endpoint&.routable? || false
+        return false if @endpoint.nil?
+
+        @endpoint.respond_to?(:routable?) ? @endpoint.routable? : true
       end
 
       # Check if redirect
@@ -169,7 +179,9 @@ module Hanami
       #   puts router.recognize('/home').redirect? # => true
       #   puts router.recognize('/').redirect?     # => false
       def redirect?
-        @endpoint&.redirect? || false
+        return false if @endpoint.nil?
+
+        @endpoint.respond_to?(:redirect?) ? @endpoint.redirect? : false
       end
 
       # Returns the redirect destination path
@@ -193,7 +205,9 @@ module Hanami
       #   puts router.recognize('/home').destination_path # => "/"
       #   puts router.recognize('/').destination_path     # => nil
       def redirection_path
-        @endpoint&.destination_path
+        return unless redirect?
+
+        @endpoint.destination_path if @endpoint.respond_to?(:destination_path)
       end
 
       private
@@ -204,13 +218,13 @@ module Hanami
       # @see Hanami::Routing::Endpoint
       def destination
         @destination ||= begin
-          case k = @endpoint.__getobj__
-          when Class
-            k.name
+          case @endpoint
           when Proc
             @endpoint.inspect
+          when Class
+            @endpoint.name
           else
-            k.class.name
+            @endpoint.class.name
           end
         end
       end

data/lib/hanami/routing/resource.rb

@@ -1,6 +1,8 @@
-require 'hanami/utils/class_attribute'
-require 'hanami/routing/resource/options'
-require 'hanami/routing/resource/action'
+# frozen_string_literal: true
+
+require "hanami/utils/class_attribute"
+require "hanami/routing/resource/options"
+require "hanami/routing/resource/action"
 
 module Hanami
   module Routing
@@ -17,14 +19,14 @@ module Hanami
 
       # @api private
       # @since 0.4.0
-      NESTED_ROUTES_SEPARATOR = '/'.freeze
+      NESTED_ROUTES_SEPARATOR = "/"
 
       # Set of default routes
       #
       # @api private
       # @since 0.1.0
       class_attribute :actions
-      self.actions = [:new, :create, :show, :edit, :update, :destroy]
+      self.actions = %i[new create show edit update destroy]
 
       # Action class
       #
@@ -83,7 +85,7 @@ module Hanami
       #
       # @api private
       # @since 0.4.0
-      def wildcard_param(route_param = nil)
+      def wildcard_param(_route_param = nil)
         NESTED_ROUTES_SEPARATOR
       end
 
@@ -92,7 +94,7 @@ module Hanami
       # @api private
       # @since 0.4.0
       def _resource(klass, name, options, &blk)
-        options = options.merge(separator: @options[:separator], namespace: @options[:namespace])
+        options = options.merge(separator: @options[:separator], prefix: @options[:prefix])
         klass.new(@router, [@name, name].join(NESTED_ROUTES_SEPARATOR), options, self, &blk)
       end
 

data/lib/hanami/routing/resource/action.rb

@@ -1,7 +1,9 @@
-require 'hanami/utils/string'
-require 'hanami/utils/path_prefix'
-require 'hanami/utils/class_attribute'
-require 'hanami/routing/resource/nested'
+# frozen_string_literal: true
+
+require "hanami/utils/string"
+require "hanami/utils/path_prefix"
+require "hanami/utils/class_attribute"
+require "hanami/routing/resource/nested"
 
 module Hanami
   module Routing
@@ -20,7 +22,7 @@ module Hanami
         #
         # @api private
         # @since 0.4.0
-        NESTED_ROUTES_SEPARATOR = '/'.freeze
+        NESTED_ROUTES_SEPARATOR = "/"
 
         # Ruby namespace where lookup for default subclasses.
         #
@@ -41,7 +43,7 @@ module Hanami
         # @api private
         # @since 0.2.0
         class_attribute :named_route_separator
-        self.named_route_separator = '_'.freeze
+        self.named_route_separator = "_"
 
         # Generate an action for the given router
         #
@@ -82,7 +84,7 @@ module Hanami
         #
         # @since 0.1.0
         def generate(&blk)
-          @router.send verb, path, to: endpoint, as: as
+          @router.send verb, path, to: endpoint, as: as, namespace: namespace, configuration: configuration
           instance_eval(&blk) if block_given?
         end
 
@@ -105,15 +107,30 @@ module Hanami
           @resource_name ||= @options[:name].to_s
         end
 
+        # Prefix
+        #
+        # @api private
+        # @since 2.0.0
+        def prefix
+          @prefix ||= Utils::PathPrefix.new(@options[:prefix])
+        end
+
         # Namespace
         #
         # @api private
-        # @since 0.2.0
+        # @since 2.0.0
         def namespace
-          @namespace ||= Utils::PathPrefix.new @options[:namespace]
+          @namespace ||= @options[:namespace]
+        end
+
+        # Configuration
+        #
+        # @api private
+        # @since 2.0.0
+        def configuration
+          @configuration ||= @options[:configuration]
         end
 
-        private
         # Load a subclass, according to the given action name
         #
         # @param action [String] the action name
@@ -128,6 +145,8 @@ module Hanami
           Utils::Class.load!(Utils::String.classify(action), namespace)
         end
 
+        private_class_method :class_for
+
         # Accepted HTTP verb
         #
         # @see Hanami::Routing::Resource::Action.verb
@@ -138,21 +157,21 @@ module Hanami
           self.class.verb
         end
 
-        # The namespaced URL relative path
+        # The prefixed relative URL
         #
         # @example
-        #   require 'hanami/router'
+        #   require "hanami/router"
         #
         #   Hanami::Router.new do
-        #     resources 'flowers'
+        #     resources "flowers"
         #
-        #     namespace 'animals' do
-        #       resources 'mammals'
+        #     prefix "animals" do
+        #       resources "mammals"
         #     end
         #   end
         #
-        #   # It will generate paths like '/flowers', '/flowers/:id' ..
-        #   # It will generate paths like '/animals/mammals', '/animals/mammals/:id' ..
+        #   # It will generate paths like "/flowers", "/flowers/:id" ..
+        #   # It will generate paths like "/animals/mammals", "/animals/mammals/:id" ..
         #
         # @api private
         # @since 0.1.0
@@ -170,19 +189,19 @@ module Hanami
         # @api private
         # @since 0.1.0
         def rest_path
-          namespace.join(_nested_rest_path || resource_name.to_s)
+          prefix.join(_nested_rest_path || resource_name.to_s)
         end
 
-        # The namespaced name of the action within the whole context of the router.
+        # The prefixed name of the action within the whole context of the router.
         #
         # @example
-        #   require 'hanami/router'
+        #   require "hanami/router"
         #
         #   Hanami::Router.new do
-        #     resources 'flowers'
+        #     resources "flowers"
         #
-        #     namespace 'animals' do
-        #       resources 'mammals'
+        #     prefix "animals" do
+        #       resources "mammals"
         #     end
         #   end
         #
@@ -192,7 +211,7 @@ module Hanami
         # @api private
         # @since 0.1.0
         def as
-          namespace.relative_join(_singularized_as, self.class.named_route_separator).to_sym
+          prefix.relative_join(_singularized_as, self.class.named_route_separator).to_sym
         end
 
         # The name of the RESTful action.
@@ -219,7 +238,7 @@ module Hanami
         # @api private
         # @since 0.1.0
         def endpoint
-          [ controller_name, action_name ].join separator
+          [controller_name, action_name].join separator
         end
 
         # Separator between controller and action name
@@ -260,7 +279,7 @@ module Hanami
         def _singularized_as
           name = @options[:as] ? @options[:as].to_s : resource_name
           name.split(NESTED_ROUTES_SEPARATOR).map do |n|
-            Hanami::Utils::String.singularize(n)
+            @router.inflector.singularize(n)
           end
         end
 
@@ -286,18 +305,23 @@ module Hanami
           instance_eval(&blk) if block_given?
         end
 
-        protected
         # @since 0.1.0
         # @api private
-        def method_missing(m, *args)
-          verb        = m
+        def method_missing(method_name, *args) # rubocop:disable Style/MethodMissingSuper
+          verb        = method_name
           action_name = Utils::PathPrefix.new(args.first).relative_join(nil)
 
           @router.__send__ verb, path(action_name),
-            to: endpoint(action_name), as: as(action_name)
+                           to: endpoint(action_name), as: as(action_name),
+                           namespace: namespace, configuration: configuration
+        end
+
+        def respond_to_missing?(method_name, include_all)
+          @router.respond_to?(method_name, include_all)
         end
 
         private
+
         # @since 0.1.0
         # @api private
         def path(action_name)
@@ -307,13 +331,13 @@ module Hanami
         # @since 0.1.0
         # @api private
         def endpoint(action_name)
-          [ controller_name, action_name ].join separator
+          [controller_name, action_name].join separator
         end
 
         # @since 0.1.0
         # @api private
         def as(action_name)
-          [ action_name, super() ].join(self.class.named_route_separator).to_sym
+          [action_name, super()].join(self.class.named_route_separator).to_sym
         end
       end
 
@@ -332,6 +356,7 @@ module Hanami
       # @since 0.1.0
       module DefaultMemberAction
         private
+
         # @since 0.1.0
         # @api private
         def path
@@ -341,7 +366,7 @@ module Hanami
         # @since 0.1.0
         # @api private
         def as
-          [ action_name, super ].join(self.class.named_route_separator).to_sym
+          [action_name, super].join(self.class.named_route_separator).to_sym
         end
       end