media_types-serialization 2.0.0 → 2.0.4

data/lib/media_types/serialization.rb

@@ -1,682 +1,689 @@
-require 'media_types/serialization/version'
-require 'media_types/serialization/serializers/common_css'
-require 'media_types/serialization/serializers/fallback_not_acceptable_serializer'
-require 'media_types/serialization/serializers/fallback_unsupported_media_type_serializer'
-require 'media_types/serialization/serializers/input_validation_error_serializer'
-require 'media_types/serialization/serializers/endpoint_description_serializer'
-require 'media_types/serialization/serializers/problem_serializer'
-require 'media_types/serialization/serializers/api_viewer'
-require 'media_types/problem'
-
-require 'abstract_controller'
-require 'action_controller/metal/mime_responds'
-require 'action_dispatch/http/mime_type'
-require 'active_support/concern'
-require 'active_support/core_ext/module/attribute_accessors'
-require 'active_support/core_ext/object/blank'
-
-require 'media_types/serialization/utils/accept_header'
-require 'media_types/serialization/base'
-require 'media_types/serialization/error'
-require 'media_types/serialization/serialization_dsl'
-
-require 'delegate'
-
-class SerializationSelectorDsl < SimpleDelegator
-  def initialize(controller, selected_serializer)
-    @serializer = selected_serializer
-    self.value = nil
-    self.matched = false
-    super controller
-  end
-
-  attr_accessor :value, :matched
-
-  def serializer(klazz, obj = nil, &block)
-    return if klazz != @serializer
-
-    self.matched = true
-    self.value = block.nil? ? obj : yield
-  end
-end
-
-module MediaTypes
-  module Serialization
-
-    HEADER_ACCEPT = 'HTTP_ACCEPT'.freeze
-    HEADER_ACCEPT_LANGUAGE = 'HTTP_ACCEPT_LANGUAGE'.freeze
-
-    mattr_accessor :json_encoder, :json_decoder
-    if defined?(::Oj)
-      self.json_encoder = ->(obj) {
-        Oj.dump(obj,
-          mode:       :compat,
-          indent:     '  ',
-          space:      ' ',
-          array_nl:   "\n",
-          object_nl:  "\n",
-          ascii_only: false,
-          allow_nan:  false,
-          symbol_keys: true,
-          allow_nil: false,
-          allow_invalid_unicode: false,
-          array_class: ::Array,
-          create_additions: false,
-          hash_class: ::Hash,
-          nilnil: false,
-          quirks_mode: false
-        )
-      }
-      self.json_decoder = ->(obj) {
-        Oj.load(obj,
-          mode:       :compat,
-          ascii_only: false,
-          allow_nan:  false,
-          symbol_keys: true,
-          allow_nil: false,
-          allow_invalid_unicode: false,
-          array_class: ::Array,
-          create_additions: false,
-          hash_class: ::Hash,
-          nilnil: false,
-          quirks_mode: false
-        )
-      }
-    else
-      require 'json'
-      self.json_encoder = JSON.method(:pretty_generate)
-      self.json_decoder = ->(txt) {
-        JSON.parse(txt, {
-          symbolize_names: true,
-          allow_nan: false,
-          create_additions: false,
-          object_class: ::Hash,
-          array_class: ::Array,
-        })
-      }
-    end
-
-    extend ActiveSupport::Concern
-
-    # rubocop:disable Metrics/BlockLength
-    class_methods do
-      def not_acceptable_serializer(serializer, **filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_not_acceptable_serializer = serializer
-        end
-      end
-
-      def unsupported_media_type_serializer(serializer, **filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_unsupported_media_type_serializer ||= []
-          @serialization_unsupported_media_type_serializer.append(serializer)
-        end
-      end
-
-      def clear_unsupported_media_type_serializer!(**filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_unsupported_media_type_serializer = []
-        end
-      end
-
-      def input_validation_failed_serializer(serializer, **filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_input_validation_failed_serializer ||= []
-          @serialization_input_validation_failed_serializer.append(serializer)
-        end
-      end
-
-      def clear_input_validation_failed_serializers!(**filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_input_validation_failed_serializer = []
-        end
-      end
-
-      ##
-      # Allow output serialization using the passed in +serializer+ for the given +view+
-      #
-      # @see #freeze_io!
-      #
-      # @param serializer the serializer to use for serialization.
-      # @param [(String | NilClass|)] view the view it should use the serializer for. Use nil for no view
-      # @param [(String | NilClass|)[]|NilClass] views the views it should use the serializer for. Use nil for no view
-      #
-      def allow_output_serializer(serializer, view: nil, views: nil, **filter_opts)
-        raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-        raise ArrayInViewParameterError, :allow_output_serializer if view.is_a? Array
-
-        views = [view] if views.nil?
-        raise ViewsNotAnArrayError unless views.is_a? Array
-
-        before_action do
-          @serialization_available_serializers ||= {}
-          @serialization_available_serializers[:output] ||= {}
-          actions = filter_opts[:only] || :all_actions
-          actions = [actions] unless actions.is_a?(Array)
-          actions.each do |action|
-            @serialization_available_serializers[:output][action.to_s] ||= []
-            views.each do |v|
-              @serialization_available_serializers[:output][action.to_s].push({serializer: serializer, view: v})
-            end
-          end
-        end
-
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_output_registrations ||= SerializationRegistration.new(:output)
-
-          mergeable_outputs = serializer.outputs_for(views: views)
-          raise AddedEmptyOutputSerializer, serializer.name if mergeable_outputs.registrations.empty?
-
-          @serialization_output_registrations = @serialization_output_registrations.merge(mergeable_outputs)
-        end
-      end
-
-      def allow_output_html(as: nil, view: nil, layout: nil, formats: [:html], variants: nil, **filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_output_registrations ||= SerializationRegistration.new(:output)
-
-          html_registration = SerializationRegistration.new(:output)
-          output_identifier = 'text/html'
-          output_identifier += "; variant=#{as}" unless as.nil?
-
-          validator = FakeValidator.new(as.nil? ? 'text/html' : as)
-
-          block = lambda { |victim, _, controller|
-            options = {}
-            options[:layout] = layout unless layout.nil?
-            options[:template] = view unless view.nil?
-            options[:formats] = formats unless formats.nil?
-            options[:variants] = variants unless variants.nil?
-            options[:locals] = victim if victim.is_a?(Hash)
-            options[:assigns] = { media: victim }
-
-            controller.render_to_string(**options)
-          }
-
-          html_registration.register_block(nil, validator, nil, block, true, wildcards: true)
-          html_registration.registrations[validator.identifier].display_identifier = output_identifier
-          html_registration.registrations["#{validator.identifier.split('/')[0]}/*"].display_identifier = output_identifier
-          html_registration.registrations['*/*'].display_identifier = output_identifier
-
-          @serialization_output_registrations = @serialization_output_registrations.merge(html_registration)
-        end
-      end
-
-      def allow_output_docs(description, **filter_opts)
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_output_registrations ||= SerializationRegistration.new(:output)
-
-          docs_registration = SerializationRegistration.new(:output)
-          validator = FakeValidator.new('text/vnd.delftsolutions.docs')
-
-          block = lambda { |_, _, _|
-            description
-          }
-
-          docs_registration.register_block(nil, validator, nil, block, true, wildcards: true)
-          docs_registration.registrations['text/vnd.delftsolutions.docs'].display_identifier = 'text/plain; charset=utf-8'
-          docs_registration.registrations['text/*'].display_identifier = 'text/plain; charset=utf-8'
-          docs_registration.registrations['*/*'].display_identifier = 'text/plain; charset=utf-8'
-
-          @serialization_output_registrations = @serialization_output_registrations.merge(docs_registration)
-        end
-      end
-
-      def allow_api_viewer(serializer: MediaTypes::Serialization::Serializers::ApiViewer, **filter_opts)
-        before_action do
-          @serialization_api_viewer_enabled ||= {}
-          actions = filter_opts[:only] || :all_actions
-          actions = [actions] unless actions.kind_of?(Array)
-          actions.each do |action|
-            @serialization_api_viewer_enabled[action.to_s] = true
-          end
-        end
-
-        before_action(**filter_opts) do
-          if request.query_parameters['api_viewer']
-            @serialization_override_accept = request.query_parameters['api_viewer'].sub ' ', '+'
-            @serialization_wrapping_renderer = serializer
-          end
-        end
-      end
-
-      ##
-      # Allow input serialization using the passed in +serializer+ for the given +view+
-      #
-      # @see #freeze_io!
-      #
-      # @param serializer the serializer to use for deserialization
-      # @param [(String | NilClass|)] view the view it should serializer for. Use nil for no view
-      # @param [(String | NilClass|)[]|NilClass] views the views it should serializer for. Use nil for no view
-      #
-      def allow_input_serializer(serializer, view: nil, views: nil, **filter_opts)
-        raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-        raise ArrayInViewParameterError, :allow_input_serializer if view.is_a? Array
-        views = [view] if views.nil?
-        raise ViewsNotAnArrayError unless views.is_a? Array
-
-        before_action do
-          @serialization_available_serializers ||= {}
-          @serialization_available_serializers[:input] ||= {}
-          actions = filter_opts[:only] || :all_actions
-          actions = [actions] unless actions.is_a?(Array)
-          actions.each do |action|
-            @serialization_available_serializers[:input][action.to_s] ||= []
-            views.each do |v|
-              @serialization_available_serializers[:input][action.to_s].push({serializer: serializer, view: v})
-            end
-          end
-        end
-
-        before_action(**filter_opts) do
-          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
-
-          @serialization_input_registrations ||= SerializationRegistration.new(:input)
-
-          mergeable_inputs = serializer.inputs_for(views: views)
-          raise AddedEmptyInputSerializer, serializer.name if mergeable_inputs.registrations.empty?
-
-          @serialization_input_registrations = @serialization_input_registrations.merge(mergeable_inputs)
-        end
-      end
-
-      def allow_all_output(**filter_opts)
-        before_action(**filter_opts) do
-          @serialization_output_registrations ||= SerializationRegistration.new(:output)
-          @serialization_output_allow_all ||= true
-        end
-      end
-
-      def allow_all_input(**filter_opts)
-        before_action(**filter_opts) do
-          @serialization_input_registrations ||= SerializationRegistration.new(:input)
-          @serialization_input_allow_all ||= true
-        end
-      end
-
-      ##
-      # Freezes additions to the serializes and notifies the controller what it will be able to respond to.
-      #
-      def freeze_io!(**filter_opts)
-        before_action :serializer_freeze_io_internal, **filter_opts
-
-        output_error MediaTypes::Serialization::NoInputReceivedError do |p, _error|
-          p.title 'Providing input is mandatory. Please set a Content-Type', lang: 'en'
-
-          p.status_code :bad_request
-        end
-      end
-
-      def output_error(klazz, serializers: [])
-        rescue_from klazz do |error|
-          problem = Problem.new(error)
-          instance_exec { yield problem, error, self } if block_given?
-
-          serializer = MediaTypes::Serialization::Serializers::ProblemSerializer
-          registrations = serializer.outputs_for(views: [:html, nil])
-
-          render_media(
-            problem,
-            serializers: [registrations] + serializers.map { |s| s.outputs_for(views: [nil])},
-            status: problem.response_status_code
-          )
-        end
-      end
-    end
-    # rubocop:enable Metrics/BlockLength
-
-    protected
-
-    def serialize(victim, media_type, serializer: Object.new, links: [], vary: ['Accept'])
-      context = SerializationDSL.new(serializer, links, vary, context: self)
-      context.instance_exec { @serialization_output_registrations.call(victim, media_type, context) }
-    end
-
-    MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED = ::Object.new
-
-    def render_media(obj = MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED, **options, &block)
-      serializers = options.delete(:serializers)
-      not_acceptable_serializer = options.delete(:not_acceptable_serializer)
-
-      if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED && options.keys.any? && !block
-        # options is too greedy :(
-        obj = options
-        options = {}
-      end
-
-      if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED && block.nil?
-        raise 'render_media was called without an object. Please provide one or supply a block to match the serializer.'
-      end
-
-      obj = nil if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED
-
-      raise SerializersNotFrozenError unless defined? @serialization_frozen
-
-      if defined? @serialization_not_acceptable_serializer
-        not_acceptable_serializer ||= @serialization_not_acceptable_serializer
-      end
-
-      @serialization_output_registrations ||= SerializationRegistration.new(:output)
-      registration = @serialization_output_registrations
-      unless serializers.nil?
-        registration = SerializationRegistration.new(:output)
-        serializers.each do |s|
-          registration = registration.merge(s)
-        end
-      end
-
-      identifier = resolve_media_type(request, registration)
-
-      if identifier.nil?
-        serialization_render_not_acceptable(registration, not_acceptable_serializer)
-        return
-      end
-
-      serializer = resolve_serializer(request, identifier, registration)
-
-      unless block.nil?
-        selector = SerializationSelectorDsl.new(self, serializer)
-        selector.instance_exec(&block)
-
-        raise UnmatchedSerializerError, serializer unless selector.matched
-
-        obj = selector.value
-      end
-
-      serialization_render_resolved(
-        obj: obj,
-        serializer: serializer,
-        identifier: identifier,
-        registrations: registration,
-        options: options
-      )
-    end
-
-    def deserialize(request)
-      raise SerializersNotFrozenError unless defined?(@serialization_frozen)
-
-      result = nil
-      begin
-        result = deserialize!(request)
-      rescue NoInputReceivedError
-        return nil
-      end
-      result
-    end
-
-    def deserialize!(request)
-      raise SerializersNotFrozenError unless defined?(@serialization_frozen)
-      raise NoInputReceivedError if request.content_type.blank?
-      raise InputNotAcceptableError unless @serialization_input_registrations.has? request.content_type
-
-      @serialization_input_registrations.call(@serialization_decoded_input, request.content_type, self)
-    end
-
-    def resolve_serializer(request, identifier = nil, registration = @serialization_output_registrations)
-      identifier = resolve_media_type(request, registration) if identifier.nil?
-      return nil if identifier.nil?
-
-      registration = registration.registrations[identifier]
-
-      raise 'Assertion failed, inconsistent answer from resolve_media_type' if registration.nil?
-
-      registration.serializer
-    end
-
-    private
-
-    def resolve_media_type(request, registration, allow_last: true)
-      if defined? @serialization_override_accept
-        if allow_last && @serialization_override_accept == 'last'
-          @serialization_override_accept = registration.registrations.keys.last
-        end
-
-        return @serialization_override_accept if registration.has? @serialization_override_accept
-        
-        # Always render problems in api viewer if we can't show chosen override
-        return 'application/problem+json' if registration.has? 'application/problem+json'
-
-        return nil
-      end
-
-      # Ruby negotiation
-      #
-      # This is similar to the respond_to logic. It sorts the accept values and tries to match against each option.
-      #
-      #
-
-      accept_header = Utils::AcceptHeader.new(request.get_header(HEADER_ACCEPT)) || ''
-      accept_header.each do |mime_type|
-        stripped = mime_type.to_s.split(';')[0]
-        next unless registration.has? stripped
-
-        return stripped
-      end
-
-      nil
-    end
-
-    def serialization_render_not_acceptable(registrations, override = nil)
-      serializer = override
-      serializer ||= MediaTypes::Serialization::Serializers::FallbackNotAcceptableSerializer
-      identifier = serializer.validator.identifier
-      obj = { request: request, registrations: registrations }
-      new_registrations = serializer.outputs_for(views: [nil])
-
-      serialization_render_resolved(
-        obj: obj,
-        serializer: serializer,
-        identifier: identifier,
-        registrations: new_registrations,
-        options: {}
-      )
-
-      response.status = :not_acceptable
-    end
-
-    def serializer_freeze_io_internal
-      raise UnableToRefreezeError if defined? @serialization_frozen
-
-      @serialization_frozen = true
-      @serialization_input_registrations ||= SerializationRegistration.new(:input)
-
-      raise NoOutputSerializersDefinedError unless defined? @serialization_output_registrations
-
-      # Input content-type negotiation and validation
-      all_allowed = false
-      all_allowed ||= @serialization_input_allow_all if defined?(@serialization_input_allow_all)
-
-      input_is_allowed = true
-      input_is_allowed = @serialization_input_registrations.has? request.content_type unless request.content_type.blank?
-
-      unless input_is_allowed || all_allowed
-        serializers = @serialization_unsupported_media_type_serializer || [
-          MediaTypes::Serialization::Serializers::ProblemSerializer,
-          MediaTypes::Serialization::Serializers::FallbackUnsupportedMediaTypeSerializer
-        ]
-        registrations = SerializationRegistration.new(:output)
-        serializers.each do |s|
-          registrations = registrations.merge(s.outputs_for(views: [nil, :html]))
-        end
-
-        input = {
-          registrations: @serialization_input_registrations
-        }
-
-        render_media nil, serializers: [registrations], status: :unsupported_media_type do
-          serializer MediaTypes::Serialization::Serializers::FallbackUnsupportedMediaTypeSerializer, input
-          serializer MediaTypes::Serialization::Serializers::ProblemSerializer do
-            error = UnsupportedMediaTypeError.new(input[:registrations].registrations.keys)
-            problem = Problem.new(error)
-            problem.title 'Unable to process your body Content-Type.', lang: 'en'
-
-            problem
-          end
-        end
-        return
-      end
-
-      if input_is_allowed && !request.content_type.blank?
-        begin
-          input_data = request.body.read
-          @serialization_decoded_input = @serialization_input_registrations.decode(
-            input_data,
-            request.content_type,
-            self
-          )
-        rescue InputValidationFailedError => e
-          serializers = @serialization_input_validation_failed_serializer || [
-            MediaTypes::Serialization::Serializers::ProblemSerializer,
-            MediaTypes::Serialization::Serializers::InputValidationErrorSerializer
-          ]
-          registrations = SerializationRegistration.new(:output)
-          serializers.each do |s|
-            registrations = registrations.merge(s.outputs_for(views: [nil, :html]))
-          end
-
-          input = {
-            identifier: request.content_type,
-            input: input_data,
-            error: e
-          }
-
-          render_media nil, serializers: [registrations], status: :bad_request do
-            serializer MediaTypes::Serialization::Serializers::InputValidationErrorSerializer, input
-            serializer MediaTypes::Serialization::Serializers::ProblemSerializer do
-              problem = Problem.new(e)
-              problem.title 'Input failed to validate.', lang: 'en'
-
-              problem
-            end
-          end
-          return
-        end
-      end
-
-      # Endpoint description media type
-
-      description_serializer = MediaTypes::Serialization::Serializers::EndpointDescriptionSerializer
-
-      # All endpoints have endpoint description.
-      # Placed in front of the list to make sure the api viewer doesn't pick it.
-      @serialization_output_registrations =
-        description_serializer
-        .outputs_for(views: [nil])
-        .merge(@serialization_output_registrations)
-
-      endpoint_matched_identifier = resolve_media_type(
-        request,
-        description_serializer.serializer_output_registrations[nil],
-        allow_last: false
-      )
-
-      if endpoint_matched_identifier
-        # We picked an endpoint description media type
-        #
-        @serialization_available_serializers ||= {}
-        @serialization_available_serializers[:output] ||= {}
-        @serialization_api_viewer_enabled ||= {}
-
-        input = {
-          api_viewer: @serialization_api_viewer_enabled,
-          actions: @serialization_available_serializers
-        }
-
-        serialization_render_resolved(
-          obj: input,
-          serializer: description_serializer,
-          identifier: endpoint_matched_identifier,
-          registrations: @serialization_output_registrations,
-          options: {}
-        )
-        return
-      end
-
-      # Output content negotiation
-      resolved_identifier = resolve_media_type(request, @serialization_output_registrations)
-
-      not_acceptable_serializer = nil
-
-      if defined? @serialization_not_acceptable_serializer
-        not_acceptable_serializer = @serialization_not_acceptable_serializer
-      end
-
-      not_acceptable_serializer ||= MediaTypes::Serialization::Serializers::FallbackNotAcceptableSerializer
-
-      can_satisfy_allow = !resolved_identifier.nil?
-      can_satisfy_allow ||= @serialization_output_allow_all if defined?(@serialization_output_allow_all)
-
-      unless can_satisfy_allow
-        serialization_render_not_acceptable(@serialization_output_registrations, not_acceptable_serializer)
-      end
-    end
-
-    def serialization_render_resolved(obj:, identifier:, serializer:, registrations:, options:)
-      links = []
-      vary = []
-      context = SerializationDSL.new(serializer, links, vary, context: self)
-      result = registrations.call(obj, identifier, self, dsl: context)
-
-      if links.any?
-        items = links.map do |l|
-          href_part = "<#{l[:href]}>"
-          tags = l.to_a.reject { |k, _| k == :href }.map { |k, v| "#{k}=#{v}" }
-          ([href_part] + tags).join('; ')
-        end
-        response.set_header('Link', items.join(', '))
-      end
-
-      if vary.any?
-        current_vary =
-          (response.headers['Vary'] || '')
-          .split(',')
-          .map(&:strip)
-          .reject(&:empty?)
-          .sort
-        merged_vary = (vary.sort + current_vary).uniq
-
-        response.set_header('Vary', merged_vary.join(', '))
-      end
-
-      if defined? @serialization_wrapping_renderer
-        input = {
-          identifier: identifier,
-          registrations: registrations,
-          output: result,
-          links: links,
-          etag: response.get_header('ETag'),
-          actions: @serialization_available_serializers
-        }
-        wrapped = @serialization_wrapping_renderer.serialize input, '*/*', context: self
-        render body: wrapped
-
-        response.content_type = 'text/html'
-        return
-      end
-
-      if context.serialization_custom_render.nil?
-        render body: result, **options
-
-        response.content_type = registrations.identifier_for(identifier)
-      else
-        context.serialization_custom_render.call(result)
-      end
-    end
-  end
-end
+require 'media_types/serialization/version'
+require 'media_types/serialization/serializers/common_css'
+require 'media_types/serialization/serializers/fallback_not_acceptable_serializer'
+require 'media_types/serialization/serializers/fallback_unsupported_media_type_serializer'
+require 'media_types/serialization/serializers/input_validation_error_serializer'
+require 'media_types/serialization/serializers/endpoint_description_serializer'
+require 'media_types/serialization/serializers/problem_serializer'
+require 'media_types/serialization/serializers/api_viewer'
+require 'media_types/problem'
+
+require 'abstract_controller'
+require 'action_controller/metal/mime_responds'
+require 'action_dispatch/http/mime_type'
+require 'active_support/concern'
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
+
+require 'media_types/serialization/utils/accept_header'
+require 'media_types/serialization/base'
+require 'media_types/serialization/error'
+require 'media_types/serialization/serialization_dsl'
+
+require 'delegate'
+
+class SerializationSelectorDsl < SimpleDelegator
+  def initialize(controller, selected_serializer)
+    @serializer = selected_serializer
+    self.value = nil
+    self.matched = false
+    super controller
+  end
+
+  attr_accessor :value, :matched
+
+  def serializer(klazz, obj = nil, &block)
+    return if klazz != @serializer
+
+    self.matched = true
+    self.value = block.nil? ? obj : yield
+  end
+end
+
+module MediaTypes
+  module Serialization
+
+    HEADER_ACCEPT = 'HTTP_ACCEPT'.freeze
+    HEADER_ACCEPT_LANGUAGE = 'HTTP_ACCEPT_LANGUAGE'.freeze
+
+    mattr_accessor :json_encoder, :json_decoder
+    if defined?(::Oj)
+      self.json_encoder = ->(obj) {
+        Oj.dump(obj,
+          mode:       :compat,
+          indent:     '  ',
+          space:      ' ',
+          array_nl:   "\n",
+          object_nl:  "\n",
+          ascii_only: false,
+          allow_nan:  false,
+          symbol_keys: true,
+          allow_nil: false,
+          allow_invalid_unicode: false,
+          array_class: ::Array,
+          create_additions: false,
+          hash_class: ::Hash,
+          nilnil: false,
+          quirks_mode: false
+        )
+      }
+      self.json_decoder = ->(obj) {
+        Oj.load(obj,
+          mode:       :compat,
+          ascii_only: false,
+          allow_nan:  false,
+          symbol_keys: true,
+          allow_nil: false,
+          allow_invalid_unicode: false,
+          array_class: ::Array,
+          create_additions: false,
+          hash_class: ::Hash,
+          nilnil: false,
+          quirks_mode: false
+        )
+      }
+    else
+      require 'json'
+      self.json_encoder = JSON.method(:pretty_generate)
+      self.json_decoder = ->(txt) {
+        JSON.parse(txt, {
+          symbolize_names: true,
+          allow_nan: false,
+          create_additions: false,
+          object_class: ::Hash,
+          array_class: ::Array,
+        })
+      }
+    end
+
+    extend ActiveSupport::Concern
+
+    # rubocop:disable Metrics/BlockLength
+    class_methods do
+      def not_acceptable_serializer(serializer, **filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_not_acceptable_serializer = serializer
+        end
+      end
+
+      def unsupported_media_type_serializer(serializer, **filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_unsupported_media_type_serializer ||= []
+          @serialization_unsupported_media_type_serializer.append(serializer)
+        end
+      end
+
+      def clear_unsupported_media_type_serializer!(**filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_unsupported_media_type_serializer = []
+        end
+      end
+
+      def input_validation_failed_serializer(serializer, **filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_input_validation_failed_serializer ||= []
+          @serialization_input_validation_failed_serializer.append(serializer)
+        end
+      end
+
+      def clear_input_validation_failed_serializers!(**filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_input_validation_failed_serializer = []
+        end
+      end
+
+      ##
+      # Allow output serialization using the passed in +serializer+ for the given +view+
+      #
+      # @see #freeze_io!
+      #
+      # @param serializer the serializer to use for serialization.
+      # @param [(String | NilClass|)] view the view it should use the serializer for. Use nil for no view
+      # @param [(String | NilClass|)[]|NilClass] views the views it should use the serializer for. Use nil for no view
+      #
+      def allow_output_serializer(serializer, view: nil, views: nil, **filter_opts)
+        raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+        raise ArrayInViewParameterError, :allow_output_serializer if view.is_a? Array
+
+        views = [view] if views.nil?
+        raise ViewsNotAnArrayError unless views.is_a? Array
+
+        before_action do
+          @serialization_available_serializers ||= {}
+          @serialization_available_serializers[:output] ||= {}
+          actions = filter_opts[:only] || :all_actions
+          actions = [actions] unless actions.is_a?(Array)
+          actions.each do |action|
+            @serialization_available_serializers[:output][action.to_s] ||= []
+            views.each do |v|
+              @serialization_available_serializers[:output][action.to_s].push({serializer: serializer, view: v})
+            end
+          end
+        end
+
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_output_registrations ||= SerializationRegistration.new(:output)
+
+          mergeable_outputs = serializer.outputs_for(views: views)
+          raise AddedEmptyOutputSerializer, serializer.name if mergeable_outputs.registrations.empty?
+
+          @serialization_output_registrations = @serialization_output_registrations.merge(mergeable_outputs)
+        end
+      end
+
+      def allow_output_html(as: nil, view: nil, layout: nil, formats: [:html], variants: nil, **filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_output_registrations ||= SerializationRegistration.new(:output)
+
+          html_registration = SerializationRegistration.new(:output)
+          output_identifier = 'text/html'
+          output_identifier += "; variant=#{as}" unless as.nil?
+
+          validator = FakeValidator.new(as.nil? ? 'text/html' : as)
+
+          block = lambda { |victim, _, controller|
+            options = {}
+            options[:layout] = layout unless layout.nil?
+            options[:template] = view unless view.nil?
+            options[:formats] = formats unless formats.nil?
+            options[:variants] = variants unless variants.nil?
+            options[:locals] = victim if victim.is_a?(::Hash)
+            options[:assigns] = { media: victim }
+
+            controller.render_to_string(**options)
+          }
+
+          html_registration.register_block(nil, validator, nil, block, true, wildcards: true)
+          html_registration.registrations[validator.identifier].display_identifier = output_identifier
+          html_registration.registrations["#{validator.identifier.split('/')[0]}/*"].display_identifier = output_identifier
+          html_registration.registrations['*/*'].display_identifier = output_identifier
+
+          @serialization_output_registrations = @serialization_output_registrations.merge(html_registration)
+        end
+      end
+
+      def allow_output_docs(description, **filter_opts)
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_output_registrations ||= SerializationRegistration.new(:output)
+
+          docs_registration = SerializationRegistration.new(:output)
+          validator = FakeValidator.new('text/vnd.delftsolutions.docs')
+
+          block = lambda { |_, _, _|
+            description
+          }
+
+          docs_registration.register_block(nil, validator, nil, block, true, wildcards: true)
+          docs_registration.registrations['text/vnd.delftsolutions.docs'].display_identifier = 'text/plain; charset=utf-8'
+          docs_registration.registrations['text/*'].display_identifier = 'text/plain; charset=utf-8'
+          docs_registration.registrations['*/*'].display_identifier = 'text/plain; charset=utf-8'
+
+          @serialization_output_registrations = @serialization_output_registrations.merge(docs_registration)
+        end
+      end
+
+      def allow_api_viewer(serializer: MediaTypes::Serialization::Serializers::ApiViewer, **filter_opts)
+        before_action do
+          @serialization_api_viewer_enabled ||= {}
+          actions = filter_opts[:only] || :all_actions
+          actions = [actions] unless actions.kind_of?(Array)
+          actions.each do |action|
+            @serialization_api_viewer_enabled[action.to_s] = true
+          end
+        end
+
+        before_action(**filter_opts) do
+          if request.query_parameters['api_viewer']
+            @serialization_override_accept = request.query_parameters['api_viewer'].sub ' ', '+'
+            @serialization_wrapping_renderer = serializer
+          end
+        end
+      end
+
+      ##
+      # Allow input serialization using the passed in +serializer+ for the given +view+
+      #
+      # @see #freeze_io!
+      #
+      # @param serializer the serializer to use for deserialization
+      # @param [(String | NilClass|)] view the view it should serializer for. Use nil for no view
+      # @param [(String | NilClass|)[]|NilClass] views the views it should serializer for. Use nil for no view
+      #
+      def allow_input_serializer(serializer, view: nil, views: nil, **filter_opts)
+        raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+        raise ArrayInViewParameterError, :allow_input_serializer if view.is_a? Array
+        views = [view] if views.nil?
+        raise ViewsNotAnArrayError unless views.is_a? Array
+
+        before_action do
+          @serialization_available_serializers ||= {}
+          @serialization_available_serializers[:input] ||= {}
+          actions = filter_opts[:only] || :all_actions
+          actions = [actions] unless actions.is_a?(Array)
+          actions.each do |action|
+            @serialization_available_serializers[:input][action.to_s] ||= []
+            views.each do |v|
+              @serialization_available_serializers[:input][action.to_s].push({serializer: serializer, view: v})
+            end
+          end
+        end
+
+        before_action(**filter_opts) do
+          raise SerializersAlreadyFrozenError if defined? @serialization_frozen
+
+          @serialization_input_registrations ||= SerializationRegistration.new(:input)
+
+          mergeable_inputs = serializer.inputs_for(views: views)
+          raise AddedEmptyInputSerializer, serializer.name if mergeable_inputs.registrations.empty?
+
+          @serialization_input_registrations = @serialization_input_registrations.merge(mergeable_inputs)
+        end
+      end
+
+      def allow_all_output(**filter_opts)
+        before_action(**filter_opts) do
+          @serialization_output_registrations ||= SerializationRegistration.new(:output)
+          @serialization_output_allow_all ||= true
+        end
+      end
+
+      def allow_all_input(**filter_opts)
+        before_action(**filter_opts) do
+          @serialization_input_registrations ||= SerializationRegistration.new(:input)
+          @serialization_input_allow_all ||= true
+        end
+      end
+
+      ##
+      # Freezes additions to the serializes and notifies the controller what it will be able to respond to.
+      #
+      def freeze_io!(**filter_opts)
+        before_action :serializer_freeze_io_internal, **filter_opts
+
+        output_error MediaTypes::Serialization::NoInputReceivedError do |p, _error|
+          p.title 'Providing input is mandatory. Please set a Content-Type', lang: 'en'
+
+          p.status_code :bad_request
+        end
+      end
+
+      def output_error(klazz, serializers: [])
+        rescue_from klazz do |error|
+          problem = Problem.new(error)
+          instance_exec { yield problem, error, self } if block_given?
+
+          serializer = MediaTypes::Serialization::Serializers::ProblemSerializer
+          registrations = serializer.outputs_for(views: [:html, nil])
+
+          render_media(
+            problem,
+            serializers: [registrations] + serializers.map { |s| s.outputs_for(views: [nil])},
+            status: problem.response_status_code
+          )
+        end
+      end
+    end
+    # rubocop:enable Metrics/BlockLength
+
+    protected
+
+    def serialize(victim, media_type, serializer: Object.new, links: [], vary: ['Accept'])
+      context = SerializationDSL.new(serializer, links, vary, context: self)
+      context.instance_exec { @serialization_output_registrations.call(victim, media_type, context) }
+    end
+
+    MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED = ::Object.new
+
+    def render_media(obj = MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED, **options, &block)
+      serializers = options.delete(:serializers)
+      not_acceptable_serializer = options.delete(:not_acceptable_serializer)
+
+      if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED && options.keys.any? && !block
+        # options is too greedy :(
+        obj = options
+        options = {}
+      end
+
+      if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED && block.nil?
+        raise 'render_media was called without an object. Please provide one or supply a block to match the serializer.'
+      end
+
+      obj = nil if obj == MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED
+
+      raise SerializersNotFrozenError unless defined? @serialization_frozen
+
+      if defined? @serialization_not_acceptable_serializer
+        not_acceptable_serializer ||= @serialization_not_acceptable_serializer
+      end
+
+      @serialization_output_registrations ||= SerializationRegistration.new(:output)
+      registration = @serialization_output_registrations
+      unless serializers.nil?
+        registration = SerializationRegistration.new(:output)
+        serializers.each do |s|
+          registration = registration.merge(s)
+        end
+      end
+
+      identifier = resolve_media_type(request, registration)
+
+      if identifier.nil?
+        serialization_render_not_acceptable(registration, not_acceptable_serializer)
+        return
+      end
+
+      serializer = resolve_serializer(request, identifier, registration)
+
+      unless block.nil?
+        selector = SerializationSelectorDsl.new(self, serializer)
+        selector.instance_exec(&block)
+
+        raise UnmatchedSerializerError, serializer unless selector.matched
+
+        obj = selector.value
+      end
+
+      serialization_render_resolved(
+        obj: obj,
+        serializer: serializer,
+        identifier: identifier,
+        registrations: registration,
+        options: options
+      )
+    end
+
+    def deserialize(request)
+      raise SerializersNotFrozenError unless defined?(@serialization_frozen)
+
+      result = nil
+      begin
+        result = deserialize!(request)
+      rescue NoInputReceivedError
+        return nil
+      end
+      result
+    end
+
+    def deserialize!(request)
+      raise SerializersNotFrozenError unless defined?(@serialization_frozen)
+      raise NoInputReceivedError if request.content_type.blank?
+      raise InputNotAcceptableError unless @serialization_input_registrations.has? request.content_type
+
+      @serialization_input_registrations.call(@serialization_decoded_input, request.content_type, self)
+    end
+
+    def resolve_serializer(request, identifier = nil, registration = @serialization_output_registrations)
+      identifier = resolve_media_type(request, registration) if identifier.nil?
+      return nil if identifier.nil?
+
+      registration = registration.registrations[identifier]
+
+      raise 'Assertion failed, inconsistent answer from resolve_media_type' if registration.nil?
+
+      registration.serializer
+    end
+
+    private
+
+    def resolve_media_type(request, registration, allow_last: true)
+      if defined? @serialization_override_accept
+        if allow_last && @serialization_override_accept == 'last'
+          @serialization_override_accept = registration.registrations.keys.last
+        end
+
+        return @serialization_override_accept if registration.has? @serialization_override_accept
+
+        # Always render problems in api viewer if we can't show chosen override
+        return 'application/problem+json' if registration.has? 'application/problem+json'
+
+        return nil
+      end
+
+      # Ruby negotiation
+      #
+      # This is similar to the respond_to logic. It sorts the accept values and tries to match against each option.
+      #
+      #
+
+      accept_header = Utils::AcceptHeader.new(request.get_header(HEADER_ACCEPT)) || ''
+      accept_header.each do |mime_type|
+        stripped = mime_type.to_s.split(';')[0]
+        next unless registration.has? stripped
+
+        return stripped
+      end
+
+      nil
+    end
+
+    def serialization_render_not_acceptable(registrations, override = nil)
+      serializer = override
+      serializer ||= MediaTypes::Serialization::Serializers::FallbackNotAcceptableSerializer
+      identifier = serializer.validator.identifier
+      obj = { request: request, registrations: registrations }
+      new_registrations = serializer.outputs_for(views: [nil])
+
+      serialization_render_resolved(
+        obj: obj,
+        serializer: serializer,
+        identifier: identifier,
+        registrations: new_registrations,
+        options: {}
+      )
+
+      response.status = :not_acceptable
+    end
+
+    def serializer_freeze_io_internal
+      raise UnableToRefreezeError if defined? @serialization_frozen
+
+      @serialization_frozen = true
+      @serialization_input_registrations ||= SerializationRegistration.new(:input)
+
+      raise NoOutputSerializersDefinedError unless defined? @serialization_output_registrations
+
+      # Input content-type negotiation and validation
+      all_allowed = false
+      all_allowed ||= @serialization_input_allow_all if defined?(@serialization_input_allow_all)
+
+      input_is_allowed = true
+      input_is_allowed = @serialization_input_registrations.has? request.content_type unless request.content_type.blank?
+
+      unless input_is_allowed || all_allowed
+        serializers = @serialization_unsupported_media_type_serializer || [
+          MediaTypes::Serialization::Serializers::ProblemSerializer,
+          MediaTypes::Serialization::Serializers::FallbackUnsupportedMediaTypeSerializer
+        ]
+        registrations = SerializationRegistration.new(:output)
+        serializers.each do |s|
+          registrations = registrations.merge(s.outputs_for(views: [nil, :html]))
+        end
+
+        input = {
+          registrations: @serialization_input_registrations
+        }
+
+        render_media nil, serializers: [registrations], status: :unsupported_media_type do
+          serializer MediaTypes::Serialization::Serializers::FallbackUnsupportedMediaTypeSerializer, input
+          serializer MediaTypes::Serialization::Serializers::ProblemSerializer do
+            error = UnsupportedMediaTypeError.new(input[:registrations].registrations.keys)
+            problem = Problem.new(error)
+            problem.title 'Unable to process your body Content-Type.', lang: 'en'
+
+            problem
+          end
+        end
+        return
+      end
+
+      if input_is_allowed && !request.content_type.blank?
+        begin
+          input_data = request.body.read
+          @serialization_decoded_input = @serialization_input_registrations.decode(
+            input_data,
+            request.content_type,
+            self
+          )
+        rescue InputValidationFailedError => e
+          serializers = if defined?(@serialization_input_validation_failed_serializer)
+            @serialization_input_validation_failed_serializer
+          else
+            [
+              MediaTypes::Serialization::Serializers::ProblemSerializer,
+              MediaTypes::Serialization::Serializers::InputValidationErrorSerializer
+            ]
+          end
+          registrations = SerializationRegistration.new(:output)
+          serializers.each do |s|
+            registrations = registrations.merge(s.outputs_for(views: [nil, :html]))
+          end
+
+          input = {
+            identifier: request.content_type,
+            input: input_data,
+            error: e
+          }
+
+          render_media nil, serializers: [registrations], status: :bad_request do
+            serializer MediaTypes::Serialization::Serializers::InputValidationErrorSerializer, input
+            serializer MediaTypes::Serialization::Serializers::ProblemSerializer do
+              problem = Problem.new(e)
+              problem.title 'Input failed to validate.', lang: 'en'
+
+              problem
+            end
+          end
+          return
+        end
+      end
+
+      # Endpoint description media type
+
+      description_serializer = MediaTypes::Serialization::Serializers::EndpointDescriptionSerializer
+
+      # All endpoints have endpoint description.
+      # Placed in front of the list to make sure the api viewer doesn't pick it.
+      @serialization_output_registrations =
+        description_serializer
+        .outputs_for(views: [nil])
+        .merge(@serialization_output_registrations)
+
+      endpoint_matched_identifier = resolve_media_type(
+        request,
+        description_serializer.serializer_output_registrations[nil],
+        allow_last: false
+      )
+
+      if endpoint_matched_identifier
+        # We picked an endpoint description media type
+        #
+        @serialization_available_serializers ||= {}
+        @serialization_available_serializers[:output] ||= {}
+        @serialization_api_viewer_enabled ||= {}
+
+        input = {
+          api_viewer: @serialization_api_viewer_enabled,
+          actions: @serialization_available_serializers
+        }
+
+        serialization_render_resolved(
+          obj: input,
+          serializer: description_serializer,
+          identifier: endpoint_matched_identifier,
+          registrations: @serialization_output_registrations,
+          options: {}
+        )
+        return
+      end
+
+      # Output content negotiation
+      resolved_identifier = resolve_media_type(request, @serialization_output_registrations)
+
+      not_acceptable_serializer = nil
+
+      if defined? @serialization_not_acceptable_serializer
+        not_acceptable_serializer = @serialization_not_acceptable_serializer
+      end
+
+      not_acceptable_serializer ||= MediaTypes::Serialization::Serializers::FallbackNotAcceptableSerializer
+
+      can_satisfy_allow = !resolved_identifier.nil?
+      can_satisfy_allow ||= @serialization_output_allow_all if defined?(@serialization_output_allow_all)
+
+      unless can_satisfy_allow
+        serialization_render_not_acceptable(@serialization_output_registrations, not_acceptable_serializer)
+      end
+    end
+
+    def serialization_render_resolved(obj:, identifier:, serializer:, registrations:, options:)
+      links = []
+      vary = []
+      context = SerializationDSL.new(serializer, links, vary, context: self)
+      result = registrations.call(obj, identifier, self, dsl: context)
+
+      if links.any?
+        items = links.map do |l|
+          href_part = "<#{l[:href]}>"
+          tags = l.to_a.reject { |k, _| k == :href }.map { |k, v| "#{k}=#{v}" }
+          ([href_part] + tags).join('; ')
+        end
+        response.set_header('Link', items.join(', '))
+      end
+
+      if vary.any?
+        current_vary =
+          (response.headers['Vary'] || '')
+          .split(',')
+          .map(&:strip)
+          .reject(&:empty?)
+          .sort
+        merged_vary = (vary.sort + current_vary).uniq
+
+        response.set_header('Vary', merged_vary.join(', '))
+      end
+
+      if defined? @serialization_wrapping_renderer
+        input = {
+          identifier: identifier,
+          registrations: registrations,
+          output: result,
+          links: links,
+          etag: response.get_header('ETag'),
+          actions: @serialization_available_serializers
+        }
+        wrapped = @serialization_wrapping_renderer.serialize input, '*/*', context: self
+        render body: wrapped
+
+        response.content_type = 'text/html'
+        return
+      end
+
+      if context.serialization_custom_render.nil?
+        status = options.delete(:status)
+        response.status = status if status
+
+        render body: result, **options
+
+        response.content_type = registrations.identifier_for(identifier)
+      else
+        context.serialization_custom_render.call(result)
+      end
+    end
+  end
+end