hanami-router 1.3.2 → 2.0.0.alpha5

data/lib/hanami/routing/parsing/json_parser.rb

@@ -1,33 +0,0 @@
-require 'hanami/utils/json'
-
-module Hanami
-  module Routing
-    module Parsing
-      # @since 0.2.0
-      # @api private
-      class JsonParser < Parser
-        # @since 0.2.0
-        # @api private
-        def mime_types
-          ['application/json', 'application/vnd.api+json']
-        end
-
-        # Parse a json string
-        #
-        # @param body [String] a json string
-        #
-        # @return [Hash] the parsed json
-        #
-        # @raise [Hanami::Routing::Parsing::BodyParsingError] when the body can't be parsed.
-        #
-        # @since 0.2.0
-        # @api private
-        def parse(body)
-          Hanami::Utils::Json.parse(body)
-        rescue Hanami::Utils::Json::ParserError => e
-          raise BodyParsingError.new(e.message)
-        end
-      end
-    end
-  end
-end

data/lib/hanami/routing/parsing/parser.rb

@@ -1,61 +0,0 @@
-require 'hanami/utils/class'
-require 'hanami/utils/string'
-require 'hanami/routing/error'
-
-module Hanami
-  module Routing
-    module Parsing
-      # Body parsing error
-      # This is raised when parser fails to parse the body
-      #
-      # @since 0.5.0
-      class BodyParsingError < Hanami::Routing::Error
-      end
-
-      # @since 0.2.0
-      class UnknownParserError < Hanami::Routing::Error
-        # @since 0.2.0
-        # @api private
-        def initialize(parser)
-          super("Unknown Parser: `#{ parser }'")
-        end
-      end
-
-      # @since 0.2.0
-      class Parser
-        # @since 0.2.0
-        # @api private
-        def self.for(parser)
-          case parser
-          when String, Symbol
-            require_parser(parser)
-          else
-            parser
-          end
-        end
-
-        # @since 0.2.0
-        def mime_types
-          raise NotImplementedError
-        end
-
-        # @since 0.2.0
-        def parse(body)
-          Hash.new
-        end
-
-        private
-        # @since 0.2.0
-        # @api private
-        def self.require_parser(parser)
-          require "hanami/routing/parsing/#{ parser }_parser"
-
-          parser = Utils::String.classify(parser)
-          Utils::Class.load!("Hanami::Routing::Parsing::#{ parser }Parser").new
-        rescue LoadError, NameError
-          raise UnknownParserError.new(parser)
-        end
-      end
-    end
-  end
-end

data/lib/hanami/routing/recognized_route.rb

@@ -1,219 +0,0 @@
-require 'hanami/utils/string'
-
-module Hanami
-  module Routing
-    # Represents a result of router path recognition.
-    #
-    # @since 0.5.0
-    #
-    # @see Hanami::Router#recognize
-    class RecognizedRoute
-      # @since 0.5.0
-      # @api private
-      REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-
-      # @since 0.7.0
-      # @api private
-      PATH_INFO      = 'PATH_INFO'.freeze
-
-      # @since 0.5.0
-      # @api private
-      NAMESPACE             = '%s::'.freeze
-
-      # @since 0.5.0
-      # @api private
-      NAMESPACE_REPLACEMENT = ''.freeze
-
-      # @since 0.5.0
-      # @api private
-      ACTION_PATH_SEPARATOR = '/'.freeze
-
-      # @since 0.5.0
-      # @api public
-      attr_reader :params
-
-      # Creates a new instance
-      #
-      # @param response [HttpRouter::Response] raw response of recognition
-      # @param env [Hash] Rack env
-      # @param router [Hanami::Routing::HttpRouter] low level router
-      #
-      # @return [Hanami::Routing::RecognizedRoute]
-      #
-      # @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
-
-        @namespace        = router.namespace
-        @action_separator = router.action_separator
-      end
-
-      # Rack protocol compatibility
-      #
-      # @param env [Hash] Rack env
-      #
-      # @return [Array] serialized Rack response
-      #
-      # @raise [Hanami::Router::NotRoutableEndpointError] if not routable
-      #
-      # @since 0.5.0
-      # @api public
-      #
-      # @see Hanami::Routing::RecognizedRoute#routable?
-      # @see Hanami::Router::NotRoutableEndpointError
-      def call(env)
-        if routable?
-          @endpoint.call(env)
-        else
-          raise Hanami::Router::NotRoutableEndpointError.new(@env)
-        end
-      end
-
-      # HTTP verb (aka method)
-      #
-      # @return [String]
-      #
-      # @since 0.5.0
-      # @api public
-      def verb
-        @env[REQUEST_METHOD]
-      end
-
-      # Relative URL (path)
-      #
-      # @return [String]
-      #
-      # @since 0.7.0
-      # @api public
-      def path
-        @env[PATH_INFO]
-      end
-
-      # Action name
-      #
-      # @return [String]
-      #
-      # @since 0.5.0
-      # @api public
-      #
-      # @see Hanami::Router#recognize
-      #
-      # @example
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new do
-      #     get '/books/:id', to: 'books#show'
-      #   end
-      #
-      #   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])
-        else
-          destination
-        end
-      end
-
-      # Check if routable
-      #
-      # @return [TrueClass,FalseClass]
-      #
-      # @since 0.5.0
-      # @api public
-      #
-      # @see Hanami::Router#recognize
-      #
-      # @example
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new do
-      #     get '/', to: 'home#index'
-      #   end
-      #
-      #   puts router.recognize('/').routable?    # => true
-      #   puts router.recognize('/foo').routable? # => false
-      def routable?
-        @endpoint&.routable? || false
-      end
-
-      # Check if redirect
-      #
-      # @return [TrueClass,FalseClass]
-      #
-      # @since 1.0.1
-      # @api public
-      #
-      # @see Hanami::Router#recognize
-      #
-      # @example
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new do
-      #     get '/', to: 'home#index'
-      #     redirect '/home', to: '/'
-      #   end
-      #
-      #   puts router.recognize('/home').redirect? # => true
-      #   puts router.recognize('/').redirect?     # => false
-      def redirect?
-        @endpoint&.redirect? || false
-      end
-
-      # Returns the redirect destination path
-      #
-      # @return [String,NilClass] the destination path, if it's a redirect
-      #
-      # @since 1.0.1
-      # @api public
-      #
-      # @see Hanami::Router#recognize
-      # @see #redirect?
-      #
-      # @example
-      #   require 'hanami/router'
-      #
-      #   router = Hanami::Router.new do
-      #     get '/', to: 'home#index'
-      #     redirect '/home', to: '/'
-      #   end
-      #
-      #   puts router.recognize('/home').destination_path # => "/"
-      #   puts router.recognize('/').destination_path     # => nil
-      def redirection_path
-        @endpoint&.destination_path
-      end
-
-      private
-
-      # @since 0.5.0
-      # @api private
-      #
-      # @see Hanami::Routing::Endpoint
-      def destination
-        @destination ||= begin
-          case k = @endpoint.__getobj__
-          when Class
-            k.name
-          when Proc
-            @endpoint.inspect
-          else
-            k.class.name
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/routing/resource.rb

@@ -1,119 +0,0 @@
-require 'hanami/utils/class_attribute'
-require 'hanami/routing/resource/options'
-require 'hanami/routing/resource/action'
-
-module Hanami
-  module Routing
-    # Set of RESTful resource routes
-    # Implementation of Hanami::Router#resource
-    #
-    # @since 0.1.0
-    #
-    # @api private
-    #
-    # @see Hanami::Router#resource
-    class Resource
-      include Utils::ClassAttribute
-
-      # @api private
-      # @since 0.4.0
-      NESTED_ROUTES_SEPARATOR = '/'.freeze
-
-      # Set of default routes
-      #
-      # @api private
-      # @since 0.1.0
-      class_attribute :actions
-      self.actions = [:new, :create, :show, :edit, :update, :destroy]
-
-      # Action class
-      #
-      # @api private
-      # @since 0.1.0
-      class_attribute :action
-      self.action = Resource::Action
-
-      # Member action class
-      #
-      # @api private
-      # @since 0.1.0
-      class_attribute :member
-      self.member = Resource::MemberAction
-
-      # Collection action class
-      #
-      # @api private
-      # @since 0.1.0
-      class_attribute :collection
-      self.collection = Resource::CollectionAction
-
-      # @api private
-      # @since 0.4.0
-      attr_reader :parent
-
-      # @api private
-      # @since 0.1.0
-      def initialize(router, name, options = {}, parent = nil, &blk)
-        @router  = router
-        @name    = name
-        @parent  = parent
-        @options = Options.new(self.class.actions, options.merge(name: @name))
-        generate(&blk)
-      end
-
-      # Allow nested resources inside resource or resources
-      #
-      # @since 0.4.0
-      #
-      # @see Hanami::Router#resources
-      def resources(name, options = {}, &blk)
-        _resource(Resources, name, options, &blk)
-      end
-
-      # Allow nested resource inside resource or resources
-      #
-      # @since 0.4.0
-      #
-      # @see Hanami::Router#resource
-      def resource(name, options = {}, &blk)
-        _resource(Resource, name, options, &blk)
-      end
-
-      # Return separator
-      #
-      # @api private
-      # @since 0.4.0
-      def wildcard_param(route_param = nil)
-        NESTED_ROUTES_SEPARATOR
-      end
-
-      private
-
-      # @api private
-      # @since 0.4.0
-      def _resource(klass, name, options, &blk)
-        options = options.merge(separator: @options[:separator], namespace: @options[:namespace])
-        klass.new(@router, [@name, name].join(NESTED_ROUTES_SEPARATOR), options, self, &blk)
-      end
-
-      # @api private
-      def generate(&blk)
-        instance_eval(&blk) if block_given?
-
-        @options.actions.each do |action|
-          self.class.action.generate(@router, action, @options, self)
-        end
-      end
-
-      # @api private
-      def member(&blk)
-        self.class.member.new(@router, @options, self, &blk)
-      end
-
-      # @api private
-      def collection(&blk)
-        self.class.collection.new(@router, @options, self, &blk)
-      end
-    end
-  end
-end

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

@@ -1,402 +0,0 @@
-require 'hanami/utils/string'
-require 'hanami/utils/path_prefix'
-require 'hanami/utils/class_attribute'
-require 'hanami/routing/resource/nested'
-
-module Hanami
-  module Routing
-    class Resource
-      # Action for RESTful resource
-      #
-      # @since 0.1.0
-      #
-      # @api private
-      #
-      # @see Hanami::Router#resource
-      class Action
-        include Utils::ClassAttribute
-
-        # Nested routes separator
-        #
-        # @api private
-        # @since 0.4.0
-        NESTED_ROUTES_SEPARATOR = '/'.freeze
-
-        # Ruby namespace where lookup for default subclasses.
-        #
-        # @api private
-        # @since 0.1.0
-        class_attribute :namespace
-        self.namespace = Resource
-
-        # Accepted HTTP verb
-        #
-        # @api private
-        # @since 0.1.0
-        class_attribute :verb
-        self.verb = :get
-
-        # Separator for named routes
-        #
-        # @api private
-        # @since 0.2.0
-        class_attribute :named_route_separator
-        self.named_route_separator = '_'.freeze
-
-        # Generate an action for the given router
-        #
-        # @param router [Hanami::Router]
-        # @param action [Hanami::Routing::Resource::Action]
-        # @param options [Hash]
-        # @param resource [Hanami::Routing::Resource, Hanami::Routing::Resources]
-        #
-        # @api private
-        #
-        # @since 0.1.0
-        def self.generate(router, action, options = {}, resource = nil)
-          class_for(action).new(router, options, resource)
-        end
-
-        # Initialize an action
-        #
-        # @param router [Hanami::Router]
-        # @param options [Hash]
-        # @param resource [Hanami::Routing::Resource, Hanami::Routing::Resources]
-        # @param blk [Proc]
-        #
-        # @api private
-        #
-        # @since 0.1.0
-        def initialize(router, options = {}, resource = nil, &blk)
-          @router = router
-          @options = options
-          @resource = resource
-          generate(&blk)
-        end
-
-        # Generate an action for the given router
-        #
-        # @param blk [Proc]
-        #
-        # @api private
-        #
-        # @since 0.1.0
-        def generate(&blk)
-          @router.send verb, path, to: endpoint, as: as
-          instance_eval(&blk) if block_given?
-        end
-
-        # Resource name
-        #
-        # @return [String]
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @example
-        #   require 'hanami/router'
-        #
-        #   Hanami::Router.new do
-        #     resource 'identity'
-        #   end
-        #
-        #   # 'identity' is the name passed in the @options
-        def resource_name
-          @resource_name ||= @options[:name].to_s
-        end
-
-        # Namespace
-        #
-        # @api private
-        # @since 0.2.0
-        def namespace
-          @namespace ||= Utils::PathPrefix.new @options[:namespace]
-        end
-
-        private
-        # Load a subclass, according to the given action name
-        #
-        # @param action [String] the action name
-        #
-        # @example
-        #   Hanami::Routing::Resource::Action.send(:class_for, 'New') # =>
-        #     Hanami::Routing::Resource::New
-        #
-        # @api private
-        # @since 0.1.0
-        def self.class_for(action)
-          Utils::Class.load!(Utils::String.classify(action), namespace)
-        end
-
-        # Accepted HTTP verb
-        #
-        # @see Hanami::Routing::Resource::Action.verb
-        #
-        # @api private
-        # @since 0.1.0
-        def verb
-          self.class.verb
-        end
-
-        # The namespaced URL relative path
-        #
-        # @example
-        #   require 'hanami/router'
-        #
-        #   Hanami::Router.new do
-        #     resources 'flowers'
-        #
-        #     namespace 'animals' do
-        #       resources 'mammals'
-        #     end
-        #   end
-        #
-        #   # It will generate paths like '/flowers', '/flowers/:id' ..
-        #   # It will generate paths like '/animals/mammals', '/animals/mammals/:id' ..
-        #
-        # @api private
-        # @since 0.1.0
-        def path
-          rest_path
-        end
-
-        # The URL relative path
-        #
-        # @example
-        #   '/flowers'
-        #   '/flowers/new'
-        #   '/flowers/:id'
-        #
-        # @api private
-        # @since 0.1.0
-        def rest_path
-          namespace.join(_nested_rest_path || resource_name.to_s)
-        end
-
-        # The namespaced name of the action within the whole context of the router.
-        #
-        # @example
-        #   require 'hanami/router'
-        #
-        #   Hanami::Router.new do
-        #     resources 'flowers'
-        #
-        #     namespace 'animals' do
-        #       resources 'mammals'
-        #     end
-        #   end
-        #
-        #   # It will generate named routes like :flowers, :new_flowers ..
-        #   # It will generate named routes like :animals_mammals, :animals_new_mammals ..
-        #
-        # @api private
-        # @since 0.1.0
-        def as
-          namespace.relative_join(_singularized_as, self.class.named_route_separator).to_sym
-        end
-
-        # The name of the RESTful action.
-        #
-        # @example
-        #   'index'
-        #   'new'
-        #   'create'
-        #
-        # @api private
-        # @since 0.1.0
-        def action_name
-          Utils::String.transform(self.class.name, :demodulize, :downcase)
-        end
-
-        # A string that represents the endpoint to be loaded.
-        # It is composed by controller and action name.
-        #
-        # @see Hanami::Routing::Resource::Action#separator
-        #
-        # @example
-        #   'flowers#index'
-        #
-        # @api private
-        # @since 0.1.0
-        def endpoint
-          [ controller_name, action_name ].join separator
-        end
-
-        # Separator between controller and action name
-        #
-        # @see Hanami::Routing::EndpointResolver#separator
-        #
-        # @example
-        #   '#' # default
-        #
-        # @api private
-        # @since 0.1.0
-        def separator
-          @options[:separator]
-        end
-
-        # Resource controller name
-        #
-        # @example
-        #   Hanami::Router.new do
-        #     resources 'flowers', controller: 'rocks'
-        #   end
-        #
-        #   # It will mount path 'flowers/new' to Rocks::New instead of Flowers::New
-        #   # Same for other action names
-        #
-        # @api private
-        # @since 0.4.0
-        def controller_name
-          @options[:controller] || resource_name
-        end
-
-        private
-
-        # Singularize as (helper route)
-        #
-        # @api private
-        # @since 0.4.0
-        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)
-          end
-        end
-
-        # Create nested rest path
-        #
-        # @api private
-        # @since 0.4.0
-        def _nested_rest_path
-          Nested.new(resource_name, @resource).to_path
-        end
-      end
-
-      # Collection action
-      # It implements #collection within a #resource block.
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class CollectionAction < Action
-        # @since 0.1.0
-        # @api private
-        def generate(&blk)
-          instance_eval(&blk) if block_given?
-        end
-
-        protected
-        # @since 0.1.0
-        # @api private
-        def method_missing(m, *args)
-          verb        = m
-          action_name = Utils::PathPrefix.new(args.first).relative_join(nil)
-
-          @router.__send__ verb, path(action_name),
-            to: endpoint(action_name), as: as(action_name)
-        end
-
-        private
-        # @since 0.1.0
-        # @api private
-        def path(action_name)
-          rest_path.join(action_name)
-        end
-
-        # @since 0.1.0
-        # @api private
-        def endpoint(action_name)
-          [ 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
-        end
-      end
-
-      # Collection action
-      # It implements #member within a #resource block.
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class MemberAction < CollectionAction
-      end
-
-      # Implementation of common methods for concrete member actions
-      #
-      # @api private
-      # @since 0.1.0
-      module DefaultMemberAction
-        private
-        # @since 0.1.0
-        # @api private
-        def path
-          rest_path.join(action_name)
-        end
-
-        # @since 0.1.0
-        # @api private
-        def as
-          [ action_name, super ].join(self.class.named_route_separator).to_sym
-        end
-      end
-
-      # New action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class New < Action
-        include DefaultMemberAction
-      end
-
-      # Create action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class Create < Action
-        self.verb = :post
-      end
-
-      # Show action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class Show < Action
-      end
-
-      # Edit action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class Edit < Action
-        include DefaultMemberAction
-      end
-
-      # Update action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class Update < Action
-        self.verb = :patch
-      end
-
-      # Destroy action
-      #
-      # @api private
-      # @since 0.1.0
-      # @see Hanami::Router#resource
-      class Destroy < Action
-        self.verb = :delete
-      end
-    end
-  end
-end