hanami-router 2.0.0.alpha3 → 2.0.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab23d35a0e2c1e71ec08a112f95f35a2c21eed5fb3ab45f231a2a7fc500cc31
-  data.tar.gz: 85c7e6ab36e321fb04235f088f3f479f542e98cf00e5ae7d642bb323bb42d969
+  metadata.gz: a855344a3dcd5d256259802c803eae8c7e41aeaeda1f108855d668458ec6c32d
+  data.tar.gz: 79f333141e1453d4bd4c4f4e09fd41e54bb2cab94d3889268a6a765ec9d52a16
 SHA512:
-  metadata.gz: 2ce90e7659b29b0571742eb972442ea27a4d51d1ea5500f9d25f943fe7e6a5e9b04598a1289a4c50f107289ea7162708a78e4825564b4ef056ee30a5765a63d6
-  data.tar.gz: b953c5d251e8cfb6f698bb6cea77df0dec2ff194bf51fe091d7fb4464ffad135c0760d328f9e50ae49f6cd48c45171b6ef4c55dc42f64c924cfd6d631cde5250
+  metadata.gz: 1dc165c33814c2869852526395de10368b14918b09af6d4dbac56e2610f6ae8dcd8e78eb1034e0b858a48e30d80470976af692e1a235cb58a54561c1dc7393b7
+  data.tar.gz: a73e23f4d0875143660610be0b8e349be143dcdbed62a258070d0b1973ee876c57b68ae8df90f1fc786bf9e689ec40a16ced52053dbd16f893efe4b62fa70e85

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 # Hanami::Router
 Rack compatible HTTP router for Ruby
 
+## v2.0.0.alpha4 - 2021-01-16
+### Added
+- [Luca Guidi] Official support for MRI 3.0
+- [Luca Guidi] Introduced `Hanami::Middleware::BodyParser::Parser` as superclass for body parsers
+- [Paweł Świątkowski] Added `not_found:` option to `Hanami::Router#initialize` to customize HTTP 404 status
+
 ## v2.0.0.alpha3 - 2020-05-20
 ### Fixed
 - [Luca Guidi] `Hanami::Router#initialize` do not yield block if not given

data/LICENSE.md

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

data/README.md

@@ -5,9 +5,8 @@ Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://h
 ## Status
 
 [![Gem Version](https://badge.fury.io/rb/hanami-router.svg)](https://badge.fury.io/rb/hanami-router)
-[![Build Status](https://ci.hanamirb.org/api/badges/hanami/router/status.svg)](https://ci.hanamirb.org/hanami/router)
-[![CircleCI](https://circleci.com/gh/hanami/router/tree/master.svg?style=svg)](https://circleci.com/gh/hanami/router/tree/master)
-[![Test Coverage](https://codecov.io/gh/hanami/router/branch/master/graph/badge.svg)](https://codecov.io/gh/hanami/router)
+[![CI](https://github.com/hanami/router/workflows/ci/badge.svg?branch=unstable)](https://github.com/hanami/router/actions?query=workflow%3Aci+branch%3Aunstable)
+[![Test Coverage](https://codecov.io/gh/hanami/router/branch/unstable/graph/badge.svg)](https://codecov.io/gh/hanami/router)
 [![Depfu](https://badges.depfu.com/badges/5f6b8e8fa3b0d082539f0b0f84d55960/overview.svg)](https://depfu.com/github/hanami/router?project=Bundler)
 [![Inline Docs](http://inch-ci.org/github/hanami/router.svg)](http://inch-ci.org/github/hanami/router)
 
@@ -22,7 +21,7 @@ Rack compatible, lightweight and fast HTTP Router for Ruby and [Hanami](http://h
 
 ## Rubies
 
-__Hanami::Router__ supports Ruby (MRI) 2.5+
+__Hanami::Router__ supports Ruby (MRI) 2.6+
 
 
 ## Installation
@@ -225,6 +224,13 @@ router = Hanami::Router.new
 router.call(Rack::MockRequest.env_for("/unknown")).status # => 404
 ```
 
+### Explicit Not Found:
+
+```ruby
+router = Hanami::Router.new(not_found: ->(_) { [499, {}, []]})
+router.call(Rack::MockRequest.env_for("/unknown")).status # => 499
+```
+
 ### Body Parsers
 
 Rack ignores request bodies unless they come from a form submission.
@@ -355,6 +361,6 @@ __Hanami::Router__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2020 Luca Guidi – Released under MIT License
+Copyright © 2014-2021 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-router`).

data/hanami-router.gemspec

@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "http://hanamirb.org"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-router.gemspec`.split($INPUT_RECORD_SEPARATOR)
+  spec.files         = `git ls-files -- lib/* CHANGELOG.md LICENSE.md README.md hanami-router.gemspec`.split($/)
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.add_dependency "rack",               "~> 2.0"
   spec.add_dependency "mustermann",         "~> 1.0"
@@ -28,4 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake",      "~> 13"
   spec.add_development_dependency "rack-test", "~> 1.0"
   spec.add_development_dependency "rspec",     "~> 3.8"
+
+  spec.add_development_dependency "rubocop", "0.91"
+  spec.add_development_dependency "rubocop-performance", "1.8.1"
 end

data/lib/hanami/middleware/body_parser.rb

@@ -2,13 +2,15 @@
 
 require "hanami/router/params"
 require "hanami/middleware/error"
-require_relative "body_parser/class_interface"
 
 module Hanami
   module Middleware
     # @since 1.3.0
     # @api private
     class BodyParser
+      require_relative "body_parser/class_interface"
+      require_relative "body_parser/parser"
+
       # @since 1.3.0
       # @api private
       CONTENT_TYPE = "CONTENT_TYPE"
@@ -72,7 +74,7 @@ module Hanami
         if body.is_a?(::Hash)
           Router::Params.deep_symbolize(body)
         else
-          { FALLBACK_KEY => body }
+          {FALLBACK_KEY => body}
         end
       end
 

data/lib/hanami/middleware/body_parser/class_interface.rb

@@ -11,7 +11,7 @@ module Hanami
       module ClassInterface
         # @api private
         # @since 1.3.0
-        def for(parser) # rubocop:disable Metrics/MethodLength
+        def for(parser)
           parser =
             case parser
             when String, Symbol

data/lib/hanami/middleware/body_parser/json_parser.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "errors"
+require_relative "parser"
 
 module Hanami
   module Middleware
     class BodyParser
       # @since 1.3.0
       # @api private
-      class JsonParser
+      class JsonParser < Parser
         # @since 1.3.0
         # @api private
         def mime_types

data/lib/hanami/middleware/body_parser/parser.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Middleware
+    class BodyParser
+      # Body parser abstract class
+      #
+      # @since 2.0.0
+      class Parser
+        # Declare supported MIME types
+        #
+        # @return [Array<String>] supported MIME types
+        #
+        # @abstract
+        # @since 2.0.0
+        #
+        # @example
+        #   require "hanami/middleware/body_parser"
+        #
+        #   class XMLParser < Hanami::Middleware::BodyParser::Parser
+        #     def mime_types
+        #       ["application/xml", "text/xml"]
+        #     end
+        #   end
+        def mime_types
+          raise NotImplementedError
+        end
+
+        # Parse raw HTTP request body
+        #
+        # @param body [String] HTTP request body
+        #
+        # @return [Hash] the result of the parsing
+        #
+        # @raise [Hanami::Middleware::BodyParser::BodyParsingError] the error
+        #   that must be raised if the parsing cannot be accomplished
+        #
+        # @abstract
+        # @since 2.0.0
+        #
+        # @example
+        #   require "hanami/middleware/body_parser"
+        #
+        #   class XMLParser < Hanami::Middleware::BodyParser::Parser
+        #     def parse(body)
+        #       # XML parsing
+        #       # ...
+        #     rescue => exception
+        #       raise Hanami::Middleware::BodyParser::BodyParsingError.new(exception.message)
+        #     end
+        #   end
+        def parse(body)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/hanami/router.rb

@@ -6,7 +6,7 @@ module Hanami
   # Rack compatible, lightweight and fast HTTP Router.
   #
   # @since 0.1.0
-  class Router # rubocop:disable Metrics/ClassLength
+  class Router
     require "hanami/router/version"
     require "hanami/router/error"
     require "hanami/router/segment"
@@ -48,6 +48,7 @@ module Hanami
     #   is deployed
     # @param resolver [#call(path, to)] a resolver for route entpoints
     # @param block_context [Hanami::Router::Block::Context)
+    # @param not_found [#call(env)] default handler when route is not matched
     # @param blk [Proc] the route definitions
     #
     # @since 0.1.0
@@ -60,12 +61,13 @@ module Hanami
     #   Hanami::Router.new do
     #     get "/", to: ->(*) { [200, {}, ["OK"]] }
     #   end
-    def initialize(base_url: DEFAULT_BASE_URL, prefix: DEFAULT_PREFIX, resolver: DEFAULT_RESOLVER, block_context: nil, &blk)
+    def initialize(base_url: DEFAULT_BASE_URL, prefix: DEFAULT_PREFIX, resolver: DEFAULT_RESOLVER, not_found: NOT_FOUND, block_context: nil, &blk) # rubocop:disable Layout/LineLength
       # TODO: verify if Prefix can handle both name and path prefix
       @path_prefix = Prefix.new(prefix)
       @name_prefix = Prefix.new("")
       @url_helpers = UrlHelpers.new(base_url)
       @resolver = resolver
+      @not_found = not_found
       @block_context = block_context
       @fixed = {}
       @variable = {}
@@ -86,7 +88,7 @@ module Hanami
 
       unless endpoint
         return not_allowed(env) ||
-               not_found
+               not_found(env)
       end
 
       endpoint.call(
@@ -631,13 +633,14 @@ module Hanami
     # @since 2.0.0
     # @api private
     def not_allowed(env)
-      (_not_allowed_fixed(env) || _not_allowed_variable(env)) and return [405, { "Content-Length" => "11" }, ["Not Allowed"]]
+      (_not_allowed_fixed(env) ||
+       _not_allowed_variable(env)) and return [405, {"Content-Length" => "11"}, ["Not Allowed"]]
     end
 
     # @since 2.0.0
     # @api private
-    def not_found
-      [404, { "Content-Length" => "9" }, ["Not Found"]]
+    def not_found(env)
+      @not_found.call(env)
     end
 
     protected
@@ -655,7 +658,7 @@ module Hanami
     #
     # @see Hanami::Router#recognize
     # @see http://www.rubydoc.info/github/rack/rack/Rack%2FMockRequest.env_for
-    def env_for(env, params = {}, options = {}) # rubocop:disable Metrics/MethodLength
+    def env_for(env, params = {}, options = {})
       require "rack/mock"
 
       case env
@@ -695,6 +698,12 @@ module Hanami
     # @api private
     PARAMS = "router.params"
 
+    # Default response when no route was matched
+    #
+    # @api private
+    # @since 2.0.0
+    NOT_FOUND = ->(*) { [404, {"Content-Length" => "9"}, ["Not Found"]] }.freeze
+
     # @since 2.0.0
     # @api private
     def lookup(env)
@@ -789,7 +798,7 @@ module Hanami
       end
 
       destination = prefixed_path(to)
-      Redirect.new(destination, ->(*) { [code, { "Location" => destination }, [body]] })
+      Redirect.new(destination, ->(*) { [code, {"Location" => destination}, [body]] })
     end
 
     # @since 2.0.0

data/lib/hanami/router/node.rb

@@ -36,8 +36,7 @@ module Hanami
       # @api private
       # @since 2.0.0
       #
-      # rubocop:disable Metrics/MethodLength
-      def get(segment)
+      def get(segment) # rubocop:disable Metrics/PerceivedComplexity
         return unless @variable || @fixed
 
         found = nil
@@ -55,7 +54,6 @@ module Hanami
 
         [found, captured&.named_captures]
       end
-      # rubocop:enable Metrics/MethodLength
 
       # @api private
       # @since 2.0.0

data/lib/hanami/router/params.rb

@@ -15,7 +15,7 @@ module Hanami
       #
       # @api private
       # @since 2.0.0
-      def self.deep_symbolize(params) # rubocop:disable Metrics/MethodLength
+      def self.deep_symbolize(params)
         params.each_with_object({}) do |(key, value), output|
           output[key.to_sym] =
             case value

data/lib/hanami/router/prefix.rb

@@ -25,7 +25,7 @@ module Hanami
       # @api private
       def relative_join(path, separator = DEFAULT_SEPARATOR)
         _join(path.to_s)
-          .gsub(DEFAULT_SEPARATOR_REGEXP, separator)[1..-1]
+          .gsub(DEFAULT_SEPARATOR_REGEXP, separator)[1..]
       end
 
       # @since 2.0.0
@@ -52,7 +52,7 @@ module Hanami
 
       # @since 2.0.0
       # @api private
-      DOUBLE_DEFAULT_SEPARATOR_REGEXP = /[\/]{2,}/.freeze
+      DOUBLE_DEFAULT_SEPARATOR_REGEXP = /\/{2,}/.freeze
 
       # @since 2.0.0
       # @api private

data/lib/hanami/router/recognized_route.rb

@@ -27,7 +27,7 @@ module Hanami
       # @see Hanami::Router::RecognizedRoute#routable?
       # @see Hanami::Router::NotRoutableEndpointError
       def call(env)
-        if routable? # rubocop:disable Style/GuardClause
+        if routable?
           @endpoint.call(env)
         else
           raise NotRoutableEndpointError.new(@env)

data/lib/hanami/router/version.rb

@@ -4,6 +4,6 @@ module Hanami
   class Router
     # @since 0.1.0
     # @api public
-    VERSION = "2.0.0.alpha3"
+    VERSION = "2.0.0.alpha4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha3
+  version: 2.0.0.alpha4
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -114,6 +114,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.91'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.91'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
 description: Rack compatible HTTP router for Ruby
 email:
 - me@lucaguidi.com
@@ -129,6 +157,7 @@ files:
 - lib/hanami/middleware/body_parser/class_interface.rb
 - lib/hanami/middleware/body_parser/errors.rb
 - lib/hanami/middleware/body_parser/json_parser.rb
+- lib/hanami/middleware/body_parser/parser.rb
 - lib/hanami/middleware/error.rb
 - lib/hanami/router.rb
 - lib/hanami/router/block.rb
@@ -146,7 +175,7 @@ homepage: http://hanamirb.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,15 +183,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.2.4
+signing_key:
 specification_version: 4
 summary: Rack compatible HTTP router for Ruby and Hanami
 test_files: []