RubyGems - media_types-serialization - Versions diffs - 2.0.4 → 2.1.0 - Mend

media_types-serialization 2.0.4 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

checksums.yaml +4 -4
data/.github/workflows/ci.yml +32 -32
data/.github/workflows/publish-bookworm.yml +34 -34
data/.github/workflows/publish-sid.yml +34 -34
data/.gitignore +22 -22
data/.idea/.rakeTasks +7 -7
data/.idea/dictionaries/Derk_Jan.xml +6 -6
data/.idea/encodings.xml +3 -3
data/.idea/inspectionProfiles/Project_Default.xml +5 -5
data/.idea/media_types-serialization.iml +76 -76
data/.idea/misc.xml +6 -6
data/.idea/modules.xml +7 -7
data/.idea/runConfigurations/test.xml +19 -19
data/.idea/vcs.xml +5 -5
data/CHANGELOG.md +207 -200
data/CODE_OF_CONDUCT.md +74 -74
data/Gemfile +4 -4
data/Gemfile.lock +176 -169
data/LICENSE.txt +21 -21
data/README.md +1058 -1048
data/Rakefile +10 -10
data/bin/console +14 -14
data/bin/setup +8 -8
data/lib/media_types/problem.rb +67 -67
data/lib/media_types/serialization/base.rb +269 -269
data/lib/media_types/serialization/error.rb +193 -193
data/lib/media_types/serialization/fake_validator.rb +53 -53
data/lib/media_types/serialization/serialization_dsl.rb +139 -135
data/lib/media_types/serialization/serialization_registration.rb +245 -245
data/lib/media_types/serialization/serializers/api_viewer.rb +383 -383
data/lib/media_types/serialization/serializers/common_css.rb +212 -212
data/lib/media_types/serialization/serializers/endpoint_description_serializer.rb +80 -80
data/lib/media_types/serialization/serializers/fallback_not_acceptable_serializer.rb +85 -85
data/lib/media_types/serialization/serializers/fallback_unsupported_media_type_serializer.rb +58 -58
data/lib/media_types/serialization/serializers/input_validation_error_serializer.rb +95 -93
data/lib/media_types/serialization/serializers/problem_serializer.rb +111 -111
data/lib/media_types/serialization/utils/accept_header.rb +77 -77
data/lib/media_types/serialization/utils/accept_language_header.rb +82 -82
data/lib/media_types/serialization/version.rb +7 -7
data/lib/media_types/serialization.rb +689 -689
data/media_types-serialization.gemspec +48 -48
metadata +3 -3

data/lib/media_types/serialization/base.rb CHANGED Viewed

@@ -1,269 +1,269 @@
-# frozen_string_literal: true
-require 'media_types/serialization/error'
-require 'media_types/serialization/fake_validator'
-require 'media_types/serialization/serialization_registration'
-require 'media_types/serialization/serialization_dsl'
-module MediaTypes
-  module Serialization
-    class Base
-      module ClassMethods
-        def unvalidated(prefix)
-          self.serializer_validated = false
-          self.serializer_validator = FakeValidator.new(prefix)
-          self.serializer_input_registrations = {}
-          self.serializer_output_registrations = {}
-        end
-        def validator(validator = nil)
-          raise NoValidatorSetError if !defined? serializer_validator && validator.nil?
-          return serializer_validator if validator.nil?
-          self.serializer_validated = true
-          self.serializer_validator = validator
-          self.serializer_input_registrations = {}
-          self.serializer_output_registrations = {}
-        end
-        def disable_wildcards
-          self.serializer_disable_wildcards = true
-        end
-        def enable_wildcards
-          self.serializer_disable_wildcards = false
-        end
-        def output(view: nil, version: nil, versions: nil, &block)
-          versions = [version] if versions.nil?
-          raise VersionsNotAnArrayError unless versions.is_a? Array
-          raise ValidatorNotSpecifiedError, :output if serializer_validator.nil?
-          unless serializer_output_registrations.has_key? view
-            serializer_output_registrations[view] = SerializationRegistration.new(:output)
-          end
-          versions.each do |v|
-            validator = serializer_validator.view(view).version(v)
-            validator.override_suffix(:json) unless serializer_validated
-            serializer_output_registrations[view].register_block(
-              self,
-              validator,
-              v,
-              block,
-              false,
-              wildcards:
-              !serializer_disable_wildcards
-            )
-          end
-        end
-        def output_raw(view: nil, version: nil, versions: nil, suffix: nil, &block)
-          versions = [version] if versions.nil?
-          raise VersionsNotAnArrayError unless versions.is_a? Array
-          raise ValidatorNotSpecifiedError, :output if serializer_validator.nil?
-          unless serializer_output_registrations.has_key? view
-            serializer_output_registrations[view] = SerializationRegistration.new(:output)
-          end
-          versions.each do |v|
-            validator = serializer_validator.view(view)
-                                            .version(v)
-                                            .override_suffix(suffix)
-            serializer_output_registrations[view].register_block(
-              self,
-              validator,
-              v,
-              block,
-              true,
-              wildcards: !serializer_disable_wildcards
-            )
-          end
-        end
-        def output_alias(
-          media_type_identifier,
-          view: nil,
-          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil,
-          hide_variant: false
-        )
-          validator = serializer_validator.view(view).override_suffix(suffix)
-          victim_identifier = validator.identifier
-          unless serializer_output_registrations.has_key? view
-            serializer_output_registrations[view] = SerializationRegistration.new(:output)
-          end
-          serializer_output_registrations[view].register_alias(
-            self,
-            media_type_identifier,
-            victim_identifier,
-            false,
-            hide_variant,
-            wildcards: !serializer_disable_wildcards
-          )
-        end
-        def output_alias_optional(
-          media_type_identifier,
-          view: nil,
-          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil,
-          hide_variant: false
-        )
-          validator = serializer_validator.view(view).override_suffix(suffix)
-          victim_identifier = validator.identifier
-          unless serializer_output_registrations.has_key? view
-            serializer_output_registrations[view] = SerializationRegistration.new(:output)
-          end
-          serializer_output_registrations[view].register_alias(
-            self,
-            media_type_identifier,
-            victim_identifier,
-            true,
-            hide_variant,
-            wildcards: !serializer_disable_wildcards
-          )
-        end
-        def input(view: nil, version: nil, versions: nil, &block)
-          versions = [version] if versions.nil?
-          raise VersionsNotAnArrayError unless versions.is_a? Array
-          raise ValidatorNotSpecifiedError, :input if serializer_validator.nil?
-          unless serializer_input_registrations.has_key? view
-            serializer_input_registrations[view] = SerializationRegistration.new(:input)
-          end
-          versions.each do |v|
-            validator = serializer_validator.view(view).version(v)
-            validator.override_suffix(:json) unless serializer_validated
-            serializer_input_registrations[view].register_block(self, validator, v, block, false)
-          end
-        end
-        def input_raw(view: nil, version: nil, versions: nil, suffix: nil, &block)
-          versions = [version] if versions.nil?
-          raise VersionsNotAnArrayError unless versions.is_a? Array
-          raise ValidatorNotSpecifiedError, :input if serializer_validator.nil?
-          unless serializer_input_registrations.has_key? view
-            serializer_input_registrations[view] = SerializationRegistration.new(:input)
-          end
-          versions.each do |v|
-            validator = serializer_validator.view(view).version(v).override_suffix(suffix)
-            serializer_input_registrations[view].register_block(self, validator, v, block, true)
-          end
-        end
-        def input_alias(
-          media_type_identifier,
-          view: nil,
-          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil
-        )
-          validator = serializer_validator.view(view).override_suffix(suffix)
-          victim_identifier = validator.identifier
-          unless serializer_input_registrations.has_key? view
-            serializer_input_registrations[view] = SerializationRegistration.new(:input)
-          end
-          serializer_input_registrations[view].register_alias(
-            self,
-            media_type_identifier,
-            victim_identifier,
-            false,
-            true,
-            wildcards: false
-          )
-        end
-        def input_alias_optional(
-          media_type_identifier,
-          view: nil,
-          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil
-        )
-          validator = serializer_validator.view(view).override_suffix(suffix)
-          victim_identifier = validator.identifier
-          unless serializer_input_registrations.has_key? view
-            serializer_input_registrations[view] = SerializationRegistration.new(:input)
-          end
-          serializer_input_registrations[view].register_alias(
-            self,
-            media_type_identifier,
-            victim_identifier,
-            true,
-            true,
-            wildcards: false
-          )
-        end
-        def serialize(victim, media_type_identifier, context:, dsl: nil, raw: nil)
-          dsl ||= SerializationDSL.new(self, context: context)
-          merged_output_registrations = SerializationRegistration.new(:output)
-          serializer_output_registrations.keys.each do |k|
-            merged_output_registrations = merged_output_registrations.merge(serializer_output_registrations[k])
-          end
-          merged_output_registrations.call(victim, media_type_identifier.to_s, context, dsl: dsl, raw: raw)
-        end
-        def deserialize(victim, media_type_identifier, context:)
-          merged_input_registrations = SerializationRegistration.new(:input)
-          serializer_input_registrations.keys.each do |k|
-            merged_input_registrations = merged_input_registrations.merge(serializer_input_registrations[k])
-          end
-          merged_input_registrations.call(victim, media_type_identifier, context)
-        end
-        def outputs_for(views:)
-          merged_output_registrations = SerializationRegistration.new(:output)
-          views.each do |k|
-            merged_output_registrations = merged_output_registrations.merge(serializer_output_registrations[k]) if serializer_output_registrations.has_key?(k)
-          end
-          merged_output_registrations
-        end
-        def inputs_for(views:)
-          merged_input_registrations = SerializationRegistration.new(:input)
-          views.each do |k|
-            merged_input_registrations = merged_input_registrations.merge(serializer_input_registrations[k]) if serializer_input_registrations.has_key?(k)
-          end
-          merged_input_registrations
-        end
-      end
-      def self.inherited(subclass)
-        super
-        subclass.extend(ClassMethods)
-        subclass.instance_eval do
-          class << self
-            attr_accessor :serializer_validated
-            attr_accessor :serializer_validator
-            attr_accessor :serializer_input_registrations
-            attr_accessor :serializer_output_registrations
-            attr_accessor :serializer_disable_wildcards
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'media_types/serialization/error'
+require 'media_types/serialization/fake_validator'
+require 'media_types/serialization/serialization_registration'
+require 'media_types/serialization/serialization_dsl'
+module MediaTypes
+  module Serialization
+    class Base
+      module ClassMethods
+        def unvalidated(prefix)
+          self.serializer_validated = false
+          self.serializer_validator = FakeValidator.new(prefix)
+          self.serializer_input_registrations = {}
+          self.serializer_output_registrations = {}
+        end
+        def validator(validator = nil)
+          raise NoValidatorSetError if !defined? serializer_validator && validator.nil?
+          return serializer_validator if validator.nil?
+          self.serializer_validated = true
+          self.serializer_validator = validator
+          self.serializer_input_registrations = {}
+          self.serializer_output_registrations = {}
+        end
+        def disable_wildcards
+          self.serializer_disable_wildcards = true
+        end
+        def enable_wildcards
+          self.serializer_disable_wildcards = false
+        end
+        def output(view: nil, version: nil, versions: nil, &block)
+          versions = [version] if versions.nil?
+          raise VersionsNotAnArrayError unless versions.is_a? Array
+          raise ValidatorNotSpecifiedError, :output if serializer_validator.nil?
+          unless serializer_output_registrations.has_key? view
+            serializer_output_registrations[view] = SerializationRegistration.new(:output)
+          end
+          versions.each do |v|
+            validator = serializer_validator.view(view).version(v)
+            validator.override_suffix(:json) unless serializer_validated
+            serializer_output_registrations[view].register_block(
+              self,
+              validator,
+              v,
+              block,
+              false,
+              wildcards:
+              !serializer_disable_wildcards
+            )
+          end
+        end
+        def output_raw(view: nil, version: nil, versions: nil, suffix: nil, &block)
+          versions = [version] if versions.nil?
+          raise VersionsNotAnArrayError unless versions.is_a? Array
+          raise ValidatorNotSpecifiedError, :output if serializer_validator.nil?
+          unless serializer_output_registrations.has_key? view
+            serializer_output_registrations[view] = SerializationRegistration.new(:output)
+          end
+          versions.each do |v|
+            validator = serializer_validator.view(view)
+                                            .version(v)
+                                            .override_suffix(suffix)
+            serializer_output_registrations[view].register_block(
+              self,
+              validator,
+              v,
+              block,
+              true,
+              wildcards: !serializer_disable_wildcards
+            )
+          end
+        end
+        def output_alias(
+          media_type_identifier,
+          view: nil,
+          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil,
+          hide_variant: false
+        )
+          validator = serializer_validator.view(view).override_suffix(suffix)
+          victim_identifier = validator.identifier
+          unless serializer_output_registrations.has_key? view
+            serializer_output_registrations[view] = SerializationRegistration.new(:output)
+          end
+          serializer_output_registrations[view].register_alias(
+            self,
+            media_type_identifier,
+            victim_identifier,
+            false,
+            hide_variant,
+            wildcards: !serializer_disable_wildcards
+          )
+        end
+        def output_alias_optional(
+          media_type_identifier,
+          view: nil,
+          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil,
+          hide_variant: false
+        )
+          validator = serializer_validator.view(view).override_suffix(suffix)
+          victim_identifier = validator.identifier
+          unless serializer_output_registrations.has_key? view
+            serializer_output_registrations[view] = SerializationRegistration.new(:output)
+          end
+          serializer_output_registrations[view].register_alias(
+            self,
+            media_type_identifier,
+            victim_identifier,
+            true,
+            hide_variant,
+            wildcards: !serializer_disable_wildcards
+          )
+        end
+        def input(view: nil, version: nil, versions: nil, &block)
+          versions = [version] if versions.nil?
+          raise VersionsNotAnArrayError unless versions.is_a? Array
+          raise ValidatorNotSpecifiedError, :input if serializer_validator.nil?
+          unless serializer_input_registrations.has_key? view
+            serializer_input_registrations[view] = SerializationRegistration.new(:input)
+          end
+          versions.each do |v|
+            validator = serializer_validator.view(view).version(v)
+            validator.override_suffix(:json) unless serializer_validated
+            serializer_input_registrations[view].register_block(self, validator, v, block, false)
+          end
+        end
+        def input_raw(view: nil, version: nil, versions: nil, suffix: nil, &block)
+          versions = [version] if versions.nil?
+          raise VersionsNotAnArrayError unless versions.is_a? Array
+          raise ValidatorNotSpecifiedError, :input if serializer_validator.nil?
+          unless serializer_input_registrations.has_key? view
+            serializer_input_registrations[view] = SerializationRegistration.new(:input)
+          end
+          versions.each do |v|
+            validator = serializer_validator.view(view).version(v).override_suffix(suffix)
+            serializer_input_registrations[view].register_block(self, validator, v, block, true)
+          end
+        end
+        def input_alias(
+          media_type_identifier,
+          view: nil,
+          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil
+        )
+          validator = serializer_validator.view(view).override_suffix(suffix)
+          victim_identifier = validator.identifier
+          unless serializer_input_registrations.has_key? view
+            serializer_input_registrations[view] = SerializationRegistration.new(:input)
+          end
+          serializer_input_registrations[view].register_alias(
+            self,
+            media_type_identifier,
+            victim_identifier,
+            false,
+            true,
+            wildcards: false
+          )
+        end
+        def input_alias_optional(
+          media_type_identifier,
+          view: nil,
+          suffix: media_type_identifier == 'application/json' || media_type_identifier.end_with?('+json') ? :json : nil
+        )
+          validator = serializer_validator.view(view).override_suffix(suffix)
+          victim_identifier = validator.identifier
+          unless serializer_input_registrations.has_key? view
+            serializer_input_registrations[view] = SerializationRegistration.new(:input)
+          end
+          serializer_input_registrations[view].register_alias(
+            self,
+            media_type_identifier,
+            victim_identifier,
+            true,
+            true,
+            wildcards: false
+          )
+        end
+        def serialize(victim, media_type_identifier, context:, dsl: nil, raw: nil)
+          dsl ||= SerializationDSL.new(self, context: context)
+          merged_output_registrations = SerializationRegistration.new(:output)
+          serializer_output_registrations.keys.each do |k|
+            merged_output_registrations = merged_output_registrations.merge(serializer_output_registrations[k])
+          end
+          merged_output_registrations.call(victim, media_type_identifier.to_s, context, dsl: dsl, raw: raw)
+        end
+        def deserialize(victim, media_type_identifier, context:)
+          merged_input_registrations = SerializationRegistration.new(:input)
+          serializer_input_registrations.keys.each do |k|
+            merged_input_registrations = merged_input_registrations.merge(serializer_input_registrations[k])
+          end
+          merged_input_registrations.call(victim, media_type_identifier, context)
+        end
+        def outputs_for(views:)
+          merged_output_registrations = SerializationRegistration.new(:output)
+          views.each do |k|
+            merged_output_registrations = merged_output_registrations.merge(serializer_output_registrations[k]) if serializer_output_registrations.has_key?(k)
+          end
+          merged_output_registrations
+        end
+        def inputs_for(views:)
+          merged_input_registrations = SerializationRegistration.new(:input)
+          views.each do |k|
+            merged_input_registrations = merged_input_registrations.merge(serializer_input_registrations[k]) if serializer_input_registrations.has_key?(k)
+          end
+          merged_input_registrations
+        end
+      end
+      def self.inherited(subclass)
+        super
+        subclass.extend(ClassMethods)
+        subclass.instance_eval do
+          class << self
+            attr_accessor :serializer_validated
+            attr_accessor :serializer_validator
+            attr_accessor :serializer_input_registrations
+            attr_accessor :serializer_output_registrations
+            attr_accessor :serializer_disable_wildcards
+          end
+        end
+      end
+    end
+  end
+end