hanami-router 2.0.0.alpha1 → 2.0.0.alpha2

data/lib/hanami/routing/endpoint.rb

@@ -1,213 +0,0 @@
-# frozen_string_literal: true
-
-require "delegate"
-require "hanami/utils/class"
-require "hanami/utils/string"
-
-module Hanami
-  module Routing
-    # Routes endpoint
-    #
-    # @since 2.0.0
-    # @api private
-    module Endpoint
-      # @since 2.0.0
-      # @api private
-      #
-      # FIXME: Shall this be the default of Utils::Class.load! ?
-      DEFAULT_NAMESPACE = Object
-
-      # Controller / action separator for Hanami
-      #
-      # @since 2.0.0
-      # @api private
-      #
-      # @example
-      #   require "hanami/router"
-      #
-      #   Hanami::Router.new do
-      #     get "/home", to: "home#index"
-      #   end
-      ACTION_SEPARATOR = "#"
-
-      # Replacement to load an action from the string name.
-      #
-      # Please note that the `"/"` value is required by `Hanami::Utils::String#classify`.
-      #
-      # Given the `"home#index"` string, with the `Web::Controllers` namespace,
-      # it will try to load `Web::Controllers::Home::Index` action.
-      #
-      # @since 2.0.0
-      # @api private
-      ACTION_SEPARATOR_REPLACEMENT = "/"
-
-      # Find an endpoint for the given name
-      #
-      # @param name [String,Class,Proc,Object] the endpoint expressed as name
-      #   (`String`), as a Rack class application (`Class`), as a Rack
-      #   compatible proc (`Proc`), or as any other Rack compatible object
-      #   (`Object`)
-      # @param namespace [Module] the Ruby module where to lookup the endpoint
-      # @param configuration [Hanami::Controller::Configuration] the action
-      #   configuration
-      #
-      # @raise [Hanami::Routing::NotCallableEndpointError] if the found object
-      #   doesn't implement Rack protocol (`#call`)
-      #
-      # @return [Object, Hanami::Routing::LazyEndpoint] a Rack compatible
-      #   endpoint
-      #
-      # @since 2.0.0
-      # @api private
-      def self.find(name, namespace, configuration = nil)
-        endpoint = case name
-                   when String
-                     find_string(name, namespace || DEFAULT_NAMESPACE, configuration)
-                   when Class
-                     name.respond_to?(:call) ? name : name.new
-                   else
-                     name
-                   end
-
-        raise NotCallableEndpointError.new(endpoint) unless endpoint.respond_to?(:call)
-
-        endpoint
-      end
-
-      # @since 1.0.1
-      # @api private
-      def redirect?
-        false
-      end
-
-      # @since 1.0.1
-      # @api private
-      def destination_path
-      end
-
-      # Find an endpoint from its name
-      #
-      # @param name [String] the endpoint name
-      # @param namespace [Module] the Ruby module where to lookup the endpoint
-      # @param configuration [Hanami::Controller::Configuration] the action
-      #   configuration
-      #
-      # @return [Object, Hanami::Routing::LazyEndpoint] a Rack compatible
-      #   endpoint
-      #
-      # @since 2.0.0
-      # @api private
-      #
-      # @example Basic Usage
-      #   Hanami::Routing::Endpoint.find("MyMiddleware")
-      #     # => #<MyMiddleware:0x007ff6df06f468>
-      #
-      # @example Hanami Action
-      #   Hanami::Routing::Endpoint.find("home#index", Web::Controllers)
-      #     # => #<Web::Controllers::Home::Index:0x007ff6df06f468>
-      def self.find_string(name, namespace, configuration)
-        n     = Utils::String.new(name.sub(ACTION_SEPARATOR, ACTION_SEPARATOR_REPLACEMENT)).classify.to_s
-        klass = Utils::Class.load!(n, namespace)
-
-        if hanami_action?(name, n)
-          klass.new(configuration: configuration)
-        else
-          klass.new
-        end
-      rescue NameError
-        Hanami::Routing::LazyEndpoint.new(n, namespace)
-      end
-
-      private_class_method :find_string
-
-      def self.hanami_action?(name, endpoint)
-        name != endpoint
-      end
-
-      private_class_method :hanami_action?
-    end
-
-    # Routing endpoint
-    # This is the object that responds to an HTTP request made against a certain
-    # path.
-    #
-    # The router will use this class for the same use cases of `ClassEndpoint`,
-    # but when the target class can't be found, instead of raise a `LoadError`
-    # we reference in a lazy endpoint.
-    #
-    # For each incoming HTTP request, it will look for the referenced class,
-    # then it will instantiate and invoke #call on the object.
-    #
-    # This behavior is required to solve a chicken-egg situation when we try
-    # to load the router first and then the application with all its endpoints.
-    #
-    # @since 0.1.0
-    #
-    # @api private
-    #
-    # @see Hanami::Routing::ClassEndpoint
-    class LazyEndpoint < SimpleDelegator
-      # Initialize the lazy endpoint
-      #
-      # @since 0.1.0
-      # @api private
-      def initialize(name, namespace)
-        @name      = name
-        @namespace = namespace
-      end
-
-      # Rack interface
-      #
-      # @raise [EndpointNotFound] when the endpoint can't be found.
-      #
-      # @since 0.1.0
-      # @api private
-      def call(env)
-        obj.call(env)
-      end
-
-      # @since 0.2.0
-      # @api private
-      def inspect
-        # TODO: review this implementation once the namespace feature will be
-        # cleaned up.
-        result = begin
-                   klass
-                 rescue
-                   nil
-                 end
-
-        if result.nil?
-          result = @name
-          result = "#{@namespace}::#{result}" if @namespace != Object
-        end
-
-        result
-      end
-
-      # @since 1.0.0
-      # @api private
-      def routable?
-        !__getobj__.nil?
-      rescue ArgumentError
-        false
-      end
-
-      private
-
-      # @since 0.1.0
-      # @api private
-      def obj
-        klass.new
-      end
-
-      # @since 0.2.0
-      # @api private
-      def klass
-        Utils::Class.load!(@name, @namespace)
-      rescue NameError => e
-        raise EndpointNotFound.new(e.message)
-      end
-    end
-  end
-end

data/lib/hanami/routing/endpoint_resolver.rb

@@ -1,242 +0,0 @@
-# frozen_string_literal: true
-
-require "hanami/utils/string"
-require "hanami/utils/class"
-require "hanami/routing/endpoint"
-
-module Hanami
-  module Routing
-    # Resolve duck-typed endpoints
-    #
-    # @since 0.1.0
-    #
-    # @api private
-    class EndpointResolver
-      # @since 0.2.0
-      # @api private
-      NAMING_PATTERN = "%<controller>s::%<action>s"
-
-      # @since 0.7.0
-      # @api private
-      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.
-      #
-      # @see #initialize
-      # @see #resolve
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new do
-      #     get '/', to: 'articles#show'
-      #   end
-      ACTION_SEPARATOR = "#"
-
-      attr_reader :action_separator
-
-      # Initialize an endpoint resolver
-      #
-      # @param options [Hash] the options used to customize lookup behavior
-      #
-      # @option options [Class] :endpoint the endpoint class that is returned
-      #   by `#resolve`. (defaults to `Hanami::Routing::Endpoint`)
-      #
-      # @option options [Class,Module] :namespace the Ruby namespace where to
-      #   lookup for controllers and actions. (defaults to `Object`)
-      #
-      # @option options [String] :pattern the string to interpolate in order
-      #   to return an action name. This string SHOULD contain
-      #   <tt>'%{controller}'</tt> and <tt>'%{action}'</tt>, all the other keys
-      #   will be ignored.
-      #   See the examples below.
-      #
-      # @option options [String] :action_separator the separator between controller and
-      #   action name. (defaults to `ACTION_SEPARATOR`)
-      #
-      # @return [Hanami::Routing::EndpointResolver] self
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @example Specify custom endpoint class
-      #   require 'hanami/router'
-      #
-      #   resolver = Hanami::Routing::EndpointResolver.new(endpoint: CustomEndpoint)
-      #   router   = Hanami::Router.new(resolver: resolver)
-      #
-      #   router.get('/', to: endpoint).dest # => #<CustomEndpoint:0x007f97f3359570 ...>
-      #
-      # @example Specify custom Ruby namespace
-      #   require 'hanami/router'
-      #
-      #   resolver = Hanami::Routing::EndpointResolver.new(namespace: MyApp)
-      #   router   = Hanami::Router.new(resolver: resolver)
-      #
-      #   router.get('/', to: 'articles#show')
-      #     # => Will look for: MyApp::Articles::Show
-      #
-      #
-      #
-      # @example Specify custom pattern
-      #   require 'hanami/router'
-      #
-      #   resolver = Hanami::Routing::EndpointResolver.new(pattern: '%{controller}Controller::%{action}')
-      #   router   = Hanami::Router.new(resolver: resolver)
-      #
-      #   router.get('/', to: 'articles#show')
-      #     # => Will look for: ArticlesController::Show
-      #
-      #
-      #
-      # @example Specify custom controller-action separator
-      #   require 'hanami/router'
-      #
-      #   resolver = Hanami::Routing::EndpointResolver.new(separator: '@')
-      #   router   = Hanami::Router.new(resolver: resolver)
-      #
-      #   router.get('/', to: 'articles@show')
-      #     # => Will look for: Articles::Show
-      def initialize(options = {})
-        @endpoint_class   = options[:endpoint]         || Endpoint
-        @namespace        = options[:namespace]        || Object
-        @action_separator = options[:action_separator] || ACTION_SEPARATOR
-        @pattern          = options[:pattern]          || NAMING_PATTERN
-      end
-
-      # Resolve the given set of HTTP verb, path, endpoint and options.
-      # If it fails to resolve, it will mount the default endpoint to the given
-      # path, which returns an 404 (Not Found).
-      #
-      # @param options [Hash] the options required to resolve the endpoint
-      #
-      # @option options [String,Proc,Class,Object#call] :to the endpoint
-      # @option options [String] :namespace an optional routing namespace
-      #
-      # @return [Endpoint] this may vary according to the :endpoint option
-      #   passed to #initialize
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @see #initialize
-      # @see #find
-      #
-      # @example Resolve to a Proc
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.get '/', to: ->(env) { [200, {}, ['Hi!']] }
-      #
-      # @example Resolve to a class
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.get '/', to: RackMiddleware
-      #
-      # @example Resolve to a Rack compatible object (respond to #call)
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.get '/', to: AnotherMiddleware.new
-      #
-      # @example Resolve to a Hanami::Action from a string (see Hanami::Controller framework)
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.get '/', to: 'articles#show'
-      #
-      # @example Resolve to a Hanami::Action (see Hanami::Controller framework)
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.get '/', to: Articles::Show
-      #
-      # @example Resolve a redirect with a namespace
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new
-      #   router.namespace 'users' do
-      #     get '/home',           to: ->(env) { ... }
-      #     redirect '/dashboard', to: '/home'
-      #   end
-      #
-      #   # GET /users/dashboard => 301 Location: "/users/home"
-      def resolve(options, &endpoint)
-        result = endpoint || find(options)
-        resolve_callable(result) || resolve_matchable(result) || default
-      end
-
-      # Finds a path from the given options.
-      #
-      # @param options [Hash] the path description
-      # @option options [String,Proc,Class,Object#call] :to the endpoint
-      # @option options [String] :namespace an optional namespace
-      #
-      # @since 0.1.0
-      # @api private
-      #
-      # @return [Object]
-      def find(options)
-        options[:to]
-      end
-
-      protected
-
-      # @api private
-      def default
-        @endpoint_class.new(
-          ->(_env) { DEFAULT_RESPONSE }
-        )
-      end
-
-      # @api private
-      def constantize(string)
-        klass = Utils::Class.load!(string, @namespace)
-        if klass.respond_to?(:call)
-          Endpoint.new(klass)
-        else
-          ClassEndpoint.new(klass)
-        end
-      rescue NameError
-        LazyEndpoint.new(string, @namespace)
-      end
-
-      # @api private
-      def classify(string)
-        Utils::String.transform(string, :underscore, :classify)
-      end
-
-      private
-
-      # @api private
-      def resolve_callable(callable)
-        if callable.respond_to?(:call)
-          @endpoint_class.new(callable)
-        elsif callable.is_a?(Class) && callable.instance_methods.include?(:call)
-          @endpoint_class.new(callable.new)
-        end
-      end
-
-      # @api private
-      def resolve_matchable(matchable)
-        return unless matchable.respond_to?(:match)
-
-        constantize(
-          resolve_action(matchable) || classify(matchable)
-        )
-      end
-
-      # @api private
-      def resolve_action(string)
-        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
-end