hanami-router 2.0.0.beta2 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81061c98f91ba599e04ca8e16ac1ae9f8784e8398f3580b552cfa26885218b2e
-  data.tar.gz: cd776fa30375c022808441897e3849ec76ef5a6d5b452b36a444851c10a4f99c
+  metadata.gz: 53dac1d070a5bbdfd29a6f6b53a508e0549211e114156d978fbe2850559fd529
+  data.tar.gz: 4c53a34b2208a43ffbdff6a940d98bf52bad7beb5c976ea635f38855c714ec73
 SHA512:
-  metadata.gz: 3cdc82d97486a5d74893d8fdff7bd1f337dc5d64d6ff6407133519aef0b8a287b369231d973b62a4da5fdee7d07ecb766d3d0fd39a8e08aa3cd966a425fff238
-  data.tar.gz: ccc62d079fba4374b74dde5b008e3de0d4d5eaf630c9608179bca0ad0ff7ba6b0584713bb320977950f7901d0404b601598b2d6c97ffa218be428e8be47b2380
+  metadata.gz: af90e79c8fe42aa2133616055388b9decc9d21fa9018c730fa4156fb5cdd056d386698eaf4a758e2719a8fa6d452be91a48b72f5fb66b340f09762ade7084467
+  data.tar.gz: cbc78fded67c18f1a18657e54d8f1de734bb90c06e20e72b97b282591dd22e9b4f00a3c71bfcf5ab99e817dd26d8e19aa6a0686b2d7e7104c892d9cb1a68295c

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 Rack compatible HTTP router for Ruby
 
+## v2.0.0.beta4 - 2022-10-24
+
+### Changed
+
+- [Peter Solnica] `Hanami::Middleware::BodyParser` can be initialized with one or more formats and additional custom mime types per format (`Hanami::Middleware::BodyParser.new(app, [:json, :xml])` or `Hanami::Middleware::BodyParser.new(app, [json: "application/json+scim"])`) (#230)
+
 ## v2.0.0.beta2 - 2022-08-16
 
 ### Fixed

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

@@ -9,15 +9,38 @@ module Hanami
       # @api private
       # @since 1.3.0
       module ClassInterface
+        # Instantiate a new body parser instance and load its parsers
+        #
+        # @example
+        #   Hanami::Middleware::BodyParser.new(->(env) { [200, {}, "app"] }, :json)
+        #
+        #   Hanami::Middleware::BodyParser.new(
+        #     ->(env) { [200, {}, "app"] }, [json: "application/json+scim"]
+        #   )
+        #
+        #   Hanami::Middleware::BodyParser.new(
+        #     ->(env) { [200, {}, "app"] }, [json: ["application/json+scim", "application/ld+json"]]
+        #   )
+        #
+        # @param app [#call]
+        # @param parser_specs [Symbol, Array<Hash>] parser name or name with mime-type(s)
+        #
+        # @api private
+        # @since 2.0.0
+        # @return BodyParser
+        def new(app, parser_specs)
+          super(app, build_parsers(parser_specs))
+        end
+
         # @api private
         # @since 1.3.0
-        def for(parser)
+        def build(parser, **config)
           parser =
             case parser
             when String, Symbol
-              require_parser(parser)
+              build(parser_class(parser), **config)
             when Class
-              parser.new
+              parser.new(**config)
             else
               parser
             end
@@ -27,32 +50,76 @@ module Hanami
           parser
         end
 
+        # @api private
+        # @since 2.0.0
+        def build_parsers(parser_specs, registry = {})
+          return DEFAULT_BODY_PARSERS if parser_specs.empty?
+
+          parsers = Array(parser_specs).flatten(0)
+
+          parsers.each_with_object(registry) do |spec, memo|
+            if spec.is_a?(Hash) && spec.size > 1
+              spec.each do |key, value|
+                build_parsers([key => [value]], memo)
+              end
+            else
+              name, *mime_types = Array(*spec).flatten(0)
+
+              parser = build(name, mime_types: mime_types.flatten)
+
+              parser.mime_types.each do |mime|
+                memo[mime] = parser
+              end
+            end
+          end
+        end
+
         private
 
         # @api private
         # @since 1.3.0
         PARSER_METHODS = %i[mime_types parse].freeze
 
+        # @api private
+        # @since 2.0.0
+        DEFAULT_BODY_PARSERS = {}.freeze
+
         # @api private
         # @since 1.3.0
         def ensure_parser(parser)
-          raise InvalidParserError.new(parser) unless PARSER_METHODS.all? { |method| parser.respond_to?(method) }
+          unless PARSER_METHODS.all? { |method| parser.respond_to?(method) }
+            raise InvalidParserError.new(parser)
+          end
         end
 
         # @api private
         # @since 1.3.0
-        def require_parser(parser)
-          require "hanami/middleware/body_parser/#{parser}_parser"
+        # rubocop:disable Lint/SuppressedException
+        def parser_class(parser_name)
+          parser = nil
+
+          begin
+            require "hanami/middleware/body_parser/#{parser_name}_parser"
+          rescue LoadError; end
+
+          begin
+            parser = load_parser!("#{classify(parser_name)}Parser")
+          rescue NameError; end
 
-          load_parser!("#{classify(parser)}Parser").new
-        rescue LoadError, NameError
-          raise UnknownParserError.new(parser)
+          parser
+        ensure
+          raise UnknownParserError, parser_name unless parser
         end
+        # rubocop:enable Lint/SuppressedException
 
+        # @api private
+        # @since 1.3.0
         def classify(parser)
           parser.to_s.split(/_/).map(&:capitalize).join
         end
 
+        # @api private
+        # @since 1.3.0
         def load_parser!(class_name)
           Hanami::Middleware::BodyParser.const_get(class_name, false)
         end

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

@@ -11,7 +11,7 @@ module Hanami
       class JsonParser < Parser
         # @since 1.3.0
         # @api private
-        def mime_types
+        def self.mime_types
           ["application/json", "application/vnd.api+json"]
         end
 

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

@@ -7,7 +7,9 @@ module Hanami
       #
       # @since 2.0.0
       class Parser
-        # Declare supported MIME types
+        DEFAULT_MIME_TYPES = [].freeze
+
+        # Return supported mime types
         #
         # @return [Array<String>] supported MIME types
         #
@@ -18,12 +20,15 @@ module Hanami
         #   require "hanami/middleware/body_parser"
         #
         #   class XMLParser < Hanami::Middleware::BodyParser::Parser
-        #     def mime_types
+        #     def self.mime_types
         #       ["application/xml", "text/xml"]
         #     end
         #   end
-        def mime_types
-          raise NotImplementedError
+        attr_reader :mime_types
+
+        # @api private
+        def initialize(mime_types: DEFAULT_MIME_TYPES)
+          @mime_types = self.class.mime_types + mime_types
         end
 
         # Parse raw HTTP request body

data/lib/hanami/middleware/body_parser.rb

@@ -37,7 +37,7 @@ module Hanami
 
       def initialize(app, parsers)
         @app = app
-        @parsers = build_parsers(parsers)
+        @parsers = parsers
       end
 
       def call(env)
@@ -56,19 +56,6 @@ module Hanami
 
       private
 
-      def build_parsers(parser_names)
-        parser_names = Array(parser_names)
-        return {} if parser_names.empty?
-
-        parser_names.each_with_object({}) do |name, parsers|
-          parser = self.class.for(name)
-
-          parser.mime_types.each do |mime|
-            parsers[mime] = parser
-          end
-        end
-      end
-
       # @api private
       def _symbolize(body)
         if body.is_a?(::Hash)

data/lib/hanami/router/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-router
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta4
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-16 00:00:00.000000000 Z
+date: 2022-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack