hanami-router 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a2586983782aac1daa6b998207f6b1711ce0b30
-  data.tar.gz: 56be6fbaa73b846cd3d531da9747edbbf938cb6f
+  metadata.gz: 393f316c6e21157b2ac3d3d7a9544c9311e55c41
+  data.tar.gz: 887ed0b0c22b13bf105a621b2cfb9f8ce7542ea7
 SHA512:
-  metadata.gz: d4b100f203d78a140e62830b309f1bf6edca12cd825dfbfde86e6b89645baf7ed61898d06ec38bcf55b15eccb0fc38d3bc63ae9ffa151e6bb9a4dc3232d95650
-  data.tar.gz: 807b558c107acf679aef63e26b7b17bf4d7d726e6ae198beb954e9d380ba1ebc3578ea95ce9c589111591ca81f8a4ffcd3050301a4c0c0bcbcc506604d1a8a06
+  metadata.gz: 4fc20e2fe87c4fd3f2a7c088d26836dca184f7dfa4918930793442f7fabecd99de3eaec56c16d2e0fe85cca6f5b90b21607efaa297b27868dad5a0701e0de649
+  data.tar.gz: 722378463a90b9ea3ebcd5151a630a776655ce37d1025389b5dda41f4bd76e7345506a44188ad10c6ec8d2af8f35a741419665afc0704ce782d8596db3d0d5ac

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## v0.7.0 - 2016-07-22
+### Added
+- [Sean Collins] Introduced `Hanami::Router#root`. Example: `root to: 'home#index'`, equivalent to `get '/', to: 'home#index', as: :root`.
+- [Nicola Racco] Allow to mount Rack applications at a specific host. Example: `mount Blog, host: 'blog'`, which will be hit for `GET http://blog.example.com`
+- [Luca Guidi] Support `multi_json` gem as backend for JSON body parser. If `multi_json` is present in the gem bundle, it will be used, otherwise it will fallback to Ruby's `JSON`.
+- [Luca Guidi] Introduced `Hanami::Routing::RecognizedRoute#path` in order to allow a better introspection
+
+### Fixed
+- [Andrew De Ponte] Make routes inspection to work when non-Hanami apps are mounted
+- [Andrew De Ponte] Ensure to set the right `SCRIPT_NAME` in Rack env for mounted Hanami apps
+- [Luca Guidi] Fix `NoMethodError` when `Hanami::Router#recognize` is invoked with a Rack env or a route name or a path that can't be recognized
+
+### Changed
+– [Luca Guidi] Drop support for Ruby 2.0 and 2.1. Official support for JRuby 9.0.5.0+
+
 ## v0.6.2 - 2016-02-05
 ### Fixed
 - [Anton Davydov] Fix double leading slash for Capybara's `current_path`

data/README.md

@@ -68,7 +68,8 @@ For the standalone usage, it supports neat features:
 
 ```ruby
 Hanami::Router.new do
-  get '/', to: ->(env) { [200, {}, ['Hi!']] }
+  root                to: ->(env) { [200, {}, ['Hello']] }
+  get '/lambda',      to: ->(env) { [200, {}, ['World']] }
   get '/dashboard',   to: Dashboard::Index
   get '/rack-app',    to: RackApp.new
   get '/flowers',     to: 'flowers#index'
@@ -167,6 +168,15 @@ router.trace  '/hanami', to: endpoint
 
 
 
+### Root:
+
+```ruby
+router = Hanami::Router.new
+router.root to: ->(env) { [200, {}, ['Hello from Hanami!']] }
+```
+
+
+
 ### Redirect:
 
 ```ruby
@@ -608,6 +618,10 @@ If the json can't be parsed an exception is raised:
 Hanami::Routing::Parsing::BodyParsingError
 ```
 
+##### `multi_json`
+
+If you want to use a different JSON backend, include `multi_json` in your `Gemfile`.
+
 #### Custom Parsers
 
 ```ruby

data/hanami-router.gemspec

@@ -17,13 +17,14 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
 
+  spec.add_dependency 'rack',         '~> 1.6'
   spec.add_dependency 'http_router',  '~> 0.11'
-  spec.add_dependency 'hanami-utils', '~> 0.7'
+  spec.add_dependency 'hanami-utils', '~> 0.8'
 
   spec.add_development_dependency 'bundler',   '~> 1.5'
   spec.add_development_dependency 'minitest',  '~> 5'
-  spec.add_development_dependency 'rake',      '~> 10'
+  spec.add_development_dependency 'rake',      '~> 11'
   spec.add_development_dependency 'rack-test', '~> 0.6'
 end

data/lib/hanami/router.rb

@@ -91,6 +91,14 @@ module Hanami
       end
     end
 
+    # Defines root path
+    #
+    # @since 0.7.0
+    # @api private
+    #
+    # @see Hanami::Router#root
+    ROOT_PATH = '/'.freeze
+
     # Returns the given block as it is.
     #
     # When Hanami::Router is used as a standalone gem and the routes are defined
@@ -491,6 +499,36 @@ module Hanami
       @router.trace(path, options, &blk)
     end
 
+    # Defines a root route (a GET route for '/')
+    #
+    # @param options [Hash] the options to customize the route
+    # @option options [String,Proc,Class,Object#call] :to the endpoint
+    #
+    # @param blk [Proc] the anonymous proc to be used as endpoint for the route
+    #
+    # @return [Hanami::Routing::Route] this may vary according to the :route
+    #   option passed to the constructor
+    #
+    # @since 0.7.0
+    #
+    # @example Fixed matching string
+    #   require 'hanami/router'
+    #
+    #   router = Hanami::Router.new
+    #   router.root to: ->(env) { [200, {}, ['Hello from Hanami!']] }
+    #
+    # @example Included names as `root` (for path and url helpers)
+    #   require 'hanami/router'
+    #
+    #   router = Hanami::Router.new(scheme: 'https', host: 'hanamirb.org')
+    #   router.root to: ->(env) { [200, {}, ['Hello from Hanami!']] }
+    #
+    #   router.path(:root) # => "/"
+    #   router.url(:root)  # => "https://hanamirb.org/"
+    def root(options = {}, &blk)
+      @router.get(ROOT_PATH, options.merge(as: :root), &blk)
+    end
+
     # Defines a route that accepts a OPTIONS request for the given path.
     #
     # @param path [String] the relative URL to be matched

data/lib/hanami/router/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   class Router
     # @since 0.1.0
-    VERSION = '0.6.2'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

data/lib/hanami/routing/endpoint_resolver.rb

@@ -14,6 +14,10 @@ module Hanami
       # @api private
       NAMING_PATTERN = '%{controller}::%{action}'.freeze
 
+      # @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.
       #
@@ -48,7 +52,7 @@ module Hanami
       #   will be ignored.
       #   See the examples below.
       #
-      # @option options [String] :action_separator the sepatator between controller and
+      # @option options [String] :action_separator the separator between controller and
       #   action name. (defaults to `ACTION_SEPARATOR`)
       #
       # @return [Hanami::Routing::EndpointResolver] self
@@ -178,7 +182,7 @@ module Hanami
       protected
       def default
         @endpoint_class.new(
-          ->(env) { [404, {'X-Cascade' => 'pass'}, 'Not Found'] }
+          ->(env) { DEFAULT_RESPONSE }
         )
       end
 

data/lib/hanami/routing/http_router.rb

@@ -1,3 +1,4 @@
+require 'uri'
 require 'http_router'
 require 'hanami/utils/io'
 require 'hanami/routing/endpoint_resolver'
@@ -37,6 +38,24 @@ module Hanami
       # @api private
       SCRIPT_NAME = 'SCRIPT_NAME'.freeze
 
+      # Path info - rack environment variable
+      #
+      # @since 0.7.0
+      # @api private
+      PATH_INFO = 'PATH_INFO'.freeze
+
+      # Default PATH_INFO for Rack requests
+      #
+      # @since 0.7.0
+      # @api private
+      DEFAULT_PATH_INFO = '/'.freeze
+
+      # URL separator
+      #
+      # @since 0.7.0
+      # @api private
+      URL_SEPARATOR = '/'.freeze
+
       # @since 0.5.0
       # @api private
       attr_reader :namespace
@@ -48,6 +67,8 @@ module Hanami
       # @since 0.1.0
       # @api private
       def initialize(options = {}, &blk)
+        @compiled         = false
+        @uri_parser       = URI::Parser.new
         super(options, &nil)
 
         @namespace        = options[:namespace] if options[:namespace]
@@ -122,7 +143,7 @@ module Hanami
       # @since 0.1.1
       # @api private
       def mount(app, options)
-        add("#{ options.fetch(:at) }*").to(
+        add("#{ options.fetch(:at) }*", host: options[:host]).to(
           @resolver.resolve(to: app)
         )
       end
@@ -158,10 +179,15 @@ module Hanami
       end
 
       # @api private
-      # @since 0.5.0
-      def rewrite_path_info(env, request)
-        super
-        env[SCRIPT_NAME] = @prefix.join(env[SCRIPT_NAME])
+      def rewrite_partial_path_info(env, request)
+        if request.path.empty?
+          env[SCRIPT_NAME] += env[PATH_INFO]
+          env[PATH_INFO]    = DEFAULT_PATH_INFO
+        else
+          path_info_before  = env[PATH_INFO].dup
+          env[PATH_INFO]    = "/#{@uri_parser.escape(request.path.join(URL_SEPARATOR))}"
+          env[SCRIPT_NAME] += path_info_before[0, path_info_before.bytesize - env[PATH_INFO].bytesize]
+        end
       end
 
       private

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

@@ -1,4 +1,4 @@
-require 'json'
+require 'hanami/utils/json'
 
 module Hanami
   module Routing
@@ -18,8 +18,8 @@ module Hanami
         #
         # @since 0.2.0
         def parse(body)
-          JSON.parse(body)
-        rescue JSON::ParserError => e
+          Hanami::Utils::Json.load(body)
+        rescue Hanami::Utils::Json::ParserError => e
           raise BodyParsingError.new(e.message)
         end
       end

data/lib/hanami/routing/recognized_route.rb

@@ -12,6 +12,10 @@ module Hanami
       # @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
@@ -39,7 +43,9 @@ module Hanami
       # @since 0.5.0
       # @api private
       def initialize(response, env, router)
-        @env = env
+        @env      = env
+        @endpoint = nil
+        @params   = {}
 
         unless response.nil?
           @endpoint = response.route.dest
@@ -81,6 +87,16 @@ module Hanami
         @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]
@@ -99,6 +115,7 @@ module Hanami
       #
       #   puts router.recognize('/books/23').action # => "books#show"
       def action
+        return unless routable?
         namespace = NAMESPACE % @namespace
 
         if destination.match(namespace)
@@ -129,7 +146,7 @@ module Hanami
       #   puts router.recognize('/').routable?    # => true
       #   puts router.recognize('/foo').routable? # => false
       def routable?
-        !!@endpoint
+        !@endpoint.nil?
       end
 
       private
@@ -142,10 +159,12 @@ module Hanami
         @destination ||= begin
           case k = @endpoint.__getobj__
           when Class
-            k
+            k.name
+          when Proc
+            @endpoint.inspect
           else
-            k.class
-          end.name
+            k.class.name
+          end
         end
       end
     end

data/lib/hanami/routing/route.rb

@@ -16,6 +16,13 @@ module Hanami
     #   router = Hanami::Router.new
     #   router.get('/', to: endpoint) # => #<Hanami::Routing::Route:0x007f83083ba028 ...>
     class Route < HttpRouter::Route
+      # @since 0.7.0
+      # @api private
+      def initialize(*)
+        super
+        @name = nil
+      end
+
       # Asks the given resolver to return an endpoint that will be associated
       #   with the other options.
       #
@@ -45,12 +52,12 @@ module Hanami
       end
 
       # Introspect the given route to understand if there is a wrapped
-      # Hanami::Router
+      # router that has an inspector
       #
       # @since 0.2.0
       # @api private
       def nested_router
-        dest.routes if dest.respond_to?(:routes)
+        dest.routes if dest.respond_to?(:routes) && dest.routes.respond_to?(:inspector)
       end
 
       private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: http_router
   requirement: !ruby/object:Gem::Requirement
@@ -32,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,14 +88,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -142,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -150,9 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami
 test_files: []
-has_rdoc: