hanami-router 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6efe1bf0b84ce27d1aba7571f7d57faee9e63dd
-  data.tar.gz: 18ae4097f5a5584a5500e3421120fc62b9c6b4d8
+  metadata.gz: 4b0aa788bc3fdc570860f8dc2f41635320dd08ea
+  data.tar.gz: 77ecacea1b2c3741f6957f528cd327a3a4304a13
 SHA512:
-  metadata.gz: 357ad670d55be64cb067e53df95b5b2f30483869c6c9991978e842ed293508b095813a10129dcddc76ddfe3017384b1ebe28930351136c9420337f88aa2743aa
-  data.tar.gz: 7762a3896731fb24cb81651fe1d5e845f716a51a827ea33bcbb199b4fd9ad4029ad2549a176259d0e0c75b62c7b9fea864a8330f571f24997fe448a720698be8
+  metadata.gz: 716ec8875095f22614fac285b27e0548695abc8e8f233abcc01928a8d6a9a096f2634883c5dd8c7ffb0a6758e6573f179c92b0dfe8d4f1b9342281b25ecdea91
+  data.tar.gz: 864a3ba5e664f1a18397b6417e805c70449816e5bd0d9101a20e1a111471ac55474fb38da4b687d57c262579311b4fa948cc26a7cc1a8d22b1345004d17f2257

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## v1.0.0.beta3 - 2017-03-17
+
 ## v1.0.0.beta2 - 2017-03-02
 ### Fixed
 - [Valentyn Ostakh] Deep symbolize params from parsed body

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2016 Luca Guidi
+Copyright © 2014-2017 Luca Guidi
 
 MIT License
 

data/README.md

@@ -703,6 +703,6 @@ Thanks to Joshua Hull ([@joshbuddy](https://github.com/joshbuddy)) for his
 
 ## Copyright
 
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Copyright © 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-router`).

data/lib/hanami/router.rb

@@ -5,6 +5,9 @@ require 'hanami/routing/resource'
 require 'hanami/routing/resources'
 require 'hanami/routing/error'
 
+# Hanami
+#
+# @since 0.1.0
 module Hanami
   # Rack compatible, lightweight and fast HTTP Router.
   #
@@ -83,9 +86,15 @@ module Hanami
     # @see Hanami::Routing::RecognizedRoute#call
     # @see Hanami::Routing::RecognizedRoute#routable?
     class NotRoutableEndpointError < Hanami::Routing::Error
+      # @since 0.5.0
+      # @api private
       REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
+      # @since 0.5.0
+      # @api private
       PATH_INFO      = 'PATH_INFO'.freeze
 
+      # @since 0.5.0
       def initialize(env)
         super %(Cannot find routable endpoint for #{ env[REQUEST_METHOD] } "#{ env[PATH_INFO] }")
       end

data/lib/hanami/router/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   class Router
     # @since 0.1.0
-    VERSION = '1.0.0.beta2'.freeze
+    VERSION = '1.0.0.beta3'.freeze
   end
 end

data/lib/hanami/routing/endpoint.rb

@@ -32,6 +32,7 @@ module Hanami
     #   end
     class Endpoint < SimpleDelegator
       # @since 0.2.0
+      # @api private
       def inspect
         case __getobj__
         when Proc
@@ -84,6 +85,7 @@ module Hanami
       # Rack interface
       #
       # @since 0.1.0
+      # @api private
       def call(env)
         __getobj__.new.call(env)
       end
@@ -112,6 +114,7 @@ module Hanami
       # Initialize the lazy endpoint
       #
       # @since 0.1.0
+      # @api private
       def initialize(name, namespace)
         @name, @namespace = name, namespace
       end
@@ -121,11 +124,13 @@ module Hanami
       # @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.

data/lib/hanami/routing/endpoint_resolver.rb

@@ -58,6 +58,7 @@ module Hanami
       # @return [Hanami::Routing::EndpointResolver] self
       #
       # @since 0.1.0
+      # @api private
       #
       # @example Specify custom endpoint class
       #   require 'hanami/router'
@@ -117,6 +118,7 @@ module Hanami
       #   passed to #initialize
       #
       # @since 0.1.0
+      # @api private
       #
       # @see #initialize
       # @see #find
@@ -173,6 +175,7 @@ module Hanami
       # @option options [String] :namespace an optional namespace
       #
       # @since 0.1.0
+      # @api private
       #
       # @return [Object]
       def find(options)
@@ -180,12 +183,14 @@ module Hanami
       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)
@@ -197,11 +202,13 @@ module Hanami
         LazyEndpoint.new(string, @namespace)
       end
 
+      # @api private
       def classify(string)
         Utils::String.new(string).underscore.classify
       end
 
       private
+      # @api private
       def resolve_callable(callable)
         if callable.respond_to?(:call)
           @endpoint_class.new(callable)
@@ -210,6 +217,7 @@ module Hanami
         end
       end
 
+      # @api private
       def resolve_matchable(matchable)
         if matchable.respond_to?(:match)
           constantize(
@@ -218,6 +226,7 @@ module Hanami
         end
       end
 
+      # @api private
       def resolve_action(string)
         if string.match(action_separator)
           controller, action = string.split(action_separator).map {|token| classify(token) }

data/lib/hanami/routing/http_router.rb

@@ -192,6 +192,7 @@ module Hanami
 
       private
 
+      # @api private
       def _rescue_url_recognition
         yield
       rescue ::HttpRouter::InvalidRouteException,
@@ -199,10 +200,12 @@ module Hanami
         raise Routing::InvalidRouteException.new("#{ e.message } - please check given arguments")
       end
 
+      # @api private
       def add_with_request_method(path, method, opts = {}, &app)
         super.generate(@resolver, opts, &app)
       end
 
+      # @api private
       def _custom_path(uri_string)
         uri = URI.parse(uri_string)
         uri.path = @prefix.join(uri.path)

data/lib/hanami/routing/http_router_monkey_patch.rb

@@ -3,8 +3,11 @@
 # This monkey patches http_router to make it Rack 2.0 compatible.
 # Details see: https://github.com/hanami/router/issues/136
 #
+# @api private
 class HttpRouter
+  # @api private
   class Node
+    # @api private
     class Path < Node
       def to_code
         path_ivar = inject_root_ivar(self)

data/lib/hanami/routing/parsers.rb

@@ -3,25 +3,47 @@ require 'hanami/utils/hash'
 
 module Hanami
   module Routing
+    # @since 0.2.0
+    # @api private
     class Parsers
+      # @since 0.2.0
+      # @api private
       CONTENT_TYPE       = 'CONTENT_TYPE'.freeze
+
+      # @since 0.2.0
+      # @api private
       MEDIA_TYPE_MATCHER = /\s*[;,]\s*/.freeze
 
+      # @since 0.2.0
+      # @api private
       RACK_INPUT    = 'rack.input'.freeze
+
+      # @since 0.2.0
+      # @api private
       ROUTER_PARAMS = 'router.params'.freeze
+
+      # @api private
       ROUTER_PARSED_BODY = 'router.parsed_body'.freeze
+
+      # @api private
       FALLBACK_KEY  = '_'.freeze
 
+      # @since 0.2.0
+      # @api private
       def initialize(parsers)
         @parsers = prepare(parsers)
         _redefine_call
       end
 
+      # @since 0.2.0
+      # @api private
       def call(env)
         env
       end
 
       private
+      # @since 0.2.0
+      # @api private
       def prepare(args)
         result  = Hash.new
         args    = Array(args)
@@ -39,6 +61,8 @@ module Hanami
         result
       end
 
+      # @since 0.2.0
+      # @api private
       def _redefine_call
         return if @parsers.empty?
 
@@ -56,6 +80,7 @@ module Hanami
         end
       end
 
+      # @api private
       def _symbolize(body)
         if body.is_a?(Hash)
           Utils::Hash.new(body).deep_dup.deep_symbolize!.to_h
@@ -64,18 +89,21 @@ module Hanami
         end
       end
 
+      # @api private
       def _parse(env, body)
         @parsers[
           media_type(env)
         ].parse(body)
       end
 
+      # @api private
       def media_type(env)
         if ct = content_type(env)
           ct.split(MEDIA_TYPE_MATCHER, 2).first.downcase
         end
       end
 
+      # @api private
       def content_type(env)
         content_type = env[CONTENT_TYPE]
         content_type.nil? || content_type.empty? ? nil : content_type

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

@@ -3,7 +3,11 @@ 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
@@ -17,6 +21,7 @@ module Hanami
         # @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

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

@@ -14,6 +14,8 @@ module Hanami
 
       # @since 0.2.0
       class UnknownParserError < Hanami::Routing::Error
+        # @since 0.2.0
+        # @api private
         def initialize(parser)
           super("Unknown Parser: `#{ parser }'")
         end
@@ -22,6 +24,7 @@ module Hanami
       # @since 0.2.0
       class Parser
         # @since 0.2.0
+        # @api private
         def self.for(parser)
           case parser
           when String, Symbol

data/lib/hanami/routing/resource.rb

@@ -96,6 +96,7 @@ module Hanami
         klass.new(@router, [@name, name].join(NESTED_ROUTES_SEPARATOR), options, self, &blk)
       end
 
+      # @api private
       def generate(&blk)
         instance_eval(&blk) if block_given?
 
@@ -104,10 +105,12 @@ module Hanami
         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

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

@@ -280,11 +280,15 @@ module Hanami
       # @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)
@@ -294,14 +298,20 @@ module Hanami
         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
@@ -322,10 +332,14 @@ module Hanami
       # @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

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

@@ -28,6 +28,8 @@ module Hanami
 
         private
 
+        # @api private
+        # @since 0.4.0
         def _calculate(param_wildcard, resource = nil)
           return if resource.nil?
           @path << resource.wildcard_param(param_wildcard.pop)

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

@@ -62,6 +62,8 @@ module Hanami
       # @see Hanami::Router#resources
       class MemberAction < Resource::MemberAction
         private
+        # @since 0.1.0
+        # @api private
         def path(action_name)
           rest_path.join(Action.identifier, action_name)
         end
@@ -73,6 +75,8 @@ module Hanami
       # @since 0.1.0
       module DefaultMemberAction
         private
+        # @since 0.1.0
+        # @api private
         def path
           rest_path.join(Action.identifier)
         end
@@ -123,6 +127,8 @@ module Hanami
         include DefaultMemberAction
 
         private
+        # @since 0.1.0
+        # @api private
         def path
           super.join(action_name)
         end

data/lib/hanami/routing/route.rb

@@ -7,6 +7,7 @@ module Hanami
     # @api private
     #
     # @since 0.1.0
+    # @api private
     #
     # @see http://rdoc.info/gems/http_router/HttpRouter/Route
     #
@@ -61,6 +62,7 @@ module Hanami
       end
 
       private
+      # @api private
       def to=(dest = nil, &blk)
         self.to dest, &blk
       end

data/lib/hanami/routing/routes_inspector.rb

@@ -60,6 +60,7 @@ module Hanami
       # @return [String] routes pretty print
       #
       # @since 0.2.0
+      # @api private
       #
       # @see Hanami::Routing::RoutesInspector::FORMATTER
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack