media_types-serialization 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b21177c2ffb12e53fc1c077dc76e3228d79db6a26c9dbf8f84a0f8703e79d31f
-  data.tar.gz: 61355285dbc6025e54c7fb24ccb53e453a036135515baa5abac76e88344d2b99
+  metadata.gz: 737a38bc10cd0c3aff8fa9bc33c3c192098709eb331f7c35706840410ff3d280
+  data.tar.gz: d6311d9a1b27329e4164cb7bf3b8e839ce96419b05e9a9e42d033d7ba2942a50
 SHA512:
-  metadata.gz: c00d90c86d30ff29980942d443d93ba4368ec69c161e1d0da28cd9b7dff9b1616662e035ee42c702c8d49d2b31ec9dd2b98e2bfc9a419044d244e66430c6b71a
-  data.tar.gz: 6792550a393bb078940e3db00407881ca698e439f9b3387ea2e04a007c3f17efd00a57f344b2ec2f3dd698e57001185262a858dad53fed0cd10055717beabcb3
+  metadata.gz: c6fad7b09ecc516290fb5e0393ee5a790c128a75402cdb977c396b6dac01b30748b63f5631b001b7eaa9d9c1b8007e814200d9be7766afa757d1c93785bc34f8
+  data.tar.gz: ea95bb41414b2125ac3af7efe42ff9c5e521f36a7bae2930760dd52fdee3e58e1175e5aaa8f03d3eb27bf5022d089f0542f4bc51b418cee05ae3724ba3756779

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.3.4
+
+- Same as `1.3.3`
+
+## 1.3.3
+
+- 🐛 Fix override suffix not being picked up correctly
+- 🐛 Fix inability to override suffix for aliases
+- 🐛 Fix inability to override suffix for raw
+- 🐛 Fix default suffix for raw
+
 ## 1.3.2
 
 - 🐛 Fix override suffix not returning self or new

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    media_types-serialization (1.3.2)
+    media_types-serialization (1.3.4)
       actionpack (>= 4.0.0)
       activesupport (>= 4.0.0)
-      media_types (>= 2.0.0, < 3.0.0)
+      media_types (>= 2.1.0, < 3.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -56,26 +56,26 @@ GEM
     concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
     marcel (1.0.1)
-    media_types (2.0.1)
+    media_types (2.1.0)
     method_source (1.0.0)
     mini_mime (1.1.0)
     minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.11.7-x64-mingw32)
+    nio4r (2.5.8)
+    nokogiri (1.12.3-x64-mingw32)
       racc (~> 1.4)
-    nokogiri (1.11.7-x86_64-linux)
+    nokogiri (1.12.3-x86_64-linux)
       racc (~> 1.4)
-    oj (3.12.3)
+    oj (3.13.1)
     racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)

data/README.md

@@ -578,7 +578,7 @@ Custom attributes can be added using the `problem_output.attribute(name, value)`
 
 ## API
 
-### Serializer definition
+### Serializer class definition
 
 These methods become available during class definition if you inherit from `MediaTypes::Serialization::Base`.
 
@@ -597,6 +597,7 @@ Either validator or unvalidated must be used while defining a serializer.
 #### `output( view:, version:, versions: ) do |obj, version, context|`
 
 Defines a serialization block. Either version or versions can be set.
+`nil` is allowed for unversioned.
 View should be a symbol or unset.
 
 Obj is the object to be serialized, version is the negotiated version and context is the context passed in from the serialize function.
@@ -604,26 +605,30 @@ When using the controller integration, context is the current controller.
 
 The block should return an object to convert into JSON.
 
-#### `output_raw( view:, version:, versions: ) do |obj, version, context|`
+#### `output_raw( view:, version:, versions:, suffix: ) do |obj, version, context|`
 
 This has the same behavior as `output` but should return a string instead of an object.
 Output is not validated.
+By default, `input_raw` is expected to _not_ be JSON.
+Override `suffix` with `:json` if it _is_ JSON.
 
-#### `output_alias( media_type_identifier, view:, hide_variant: false )`
+#### `output_alias( media_type_identifier, view:, hide_variant: false, suffix: '~' )`
 
 Defines a legacy mapping. This will make the deserializer parse the media type `media_type_identifier` as if it was version `nil` of the specified view.
 If `view` is undefined it will use the output serializer without a view defined.
+By default, suffix is `:json` if `media_type_identifier` is a JSON type.
 
 Response will have a content type equal to `[media_type_identifier]; variant=[mapped_media_type_identifier]`.
 If `hide_variant:` is true, the content type emitted will only be `[media_type_identifier]`.
 
 > You cannot alias a _versioned_ media type, otherwise it would be easy to later break the definition by changing the version it aliases.
 
-#### `output_alias_optional( media_type_identifier, view:, hide_variant: false )`
+#### `output_alias_optional( media_type_identifier, view:, hide_variant: false, suffix: '~' )`
 
 Has the same behavior as `output_alias` but can be used by multiple serializers.
 The serializer that is loaded last in the controller 'wins' control over this media type identifier.
 If any of the serializers have an `output_alias` defined with the same media type identifier that one will win instead.
+By default, suffix is `:json` if `media_type_identifier` is a JSON type.
 
 Response will have a content type equal to `[media_type_identifier]; variant=[mapped_media_type_identifier]`. If `hide_variant:` is true, the content type emitted will only be `[media_type_identifier]`.
 
@@ -638,29 +643,34 @@ When using the controller integration, context is the current controller.
 The block should return the internal representation of the object.
 Best practise is to make sure not to change state in this function but to leave that up to the controller.
 
-#### `input_raw( view:, version:, versions: ) do |bytes, version, context|`
+#### `input_raw( view:, version:, versions:, suffix: nil ) do |bytes, version, context|`
 
-This has the same behavior as `input` but takes in raw data. Input is not validated.
+This has the same behavior as `input` but takes in raw data.
+Input is not validated.
+By default, `input_raw` is expected to _not_ be JSON.
+Override `suffix` with `:json` if it _is_ JSON.
 
-#### `input_alias( media_type_identifier, view: )`
+#### `input_alias( media_type_identifier, view:, suffix: '~' )`
 
 Defines a legacy mapping.
 This will make the serializer parse the media type `media_type_identifier` as if it was version `nil` of the specified view.
 If view is undefined it will use the input serializer without a view defined.
+By default, suffix is `:json` if `media_type_identifier` is a JSON type.
 
 > You cannot alias a _versioned_ media type, otherwise it would be easy to later break the definition by changing the version it aliases.
 
-#### `input_alias_optional( media_type_identifier, view: )`
+#### `input_alias_optional( media_type_identifier, view:, suffix: '~' )`
 
 Has the same behavior as `input_alias` but can be used by multiple serializers.
 The serializer that is loaded last in the controller 'wins' control over this media type identifier.
 If any of the serializers have an `input_alias` defined with the same media type identifier that one will win instead.
+By default, suffix is `:json` if `media_type_identifier` is a JSON type.
 
 #### `disable_wildcards`
 
 Disables registering wildcard media types.
 
-### Serializer definition
+### Serializer output definition
 
 The following methods are available within an `output ... do` block.
 
@@ -682,12 +692,16 @@ Returns the built up context so far.
 
 #### `index( array, serializer, version:, view: nil )`
 
+> Not the same as a validator `collection`.
+
 Adds an `_index` block to the current context. Uses the self links of the specified view to construct an index of urls to the child objects.
 
 Returns the built up context so far.
 
 #### `collection( array, serializer, version:, view: nil )`
 
+> Not the same as a validator `collection`.
+
 Adds an `_embedded` block to the current context. Uses the specified serializer to embed the child objects.
 Optionally a block can be used to modify the output from the child serializer.
 
@@ -711,9 +725,25 @@ Returns the built up context so far.
 
 Runs a block in a new context and returns the result
 
+> Most common use-case is emitting from an enumerable.
+>
+> ```ruby
+> results = [item, item, item].map do |current_item|
+>   object do
+>     attribute :foo, current_item.bar
+>   end
+> end
+>
+> attribute :items, results
+> ```
+
 #### `render_view( view, context:, **args)`
 
-Can be used to render a view. You can set local variables in the view by assigning a hash to the `assigns:` parameter.
+Can be used to render a view.
+You can set local variables in the view by assigning a hash to the `assigns:` parameter.
+Returns a `string`
+
+> When possible, prefer `output_raw` with `context.class.render(params)`
 
 ### Controller definition
 

data/lib/media_types/serialization.rb

@@ -345,7 +345,10 @@ module MediaTypes
 
     MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED = ::Object.new
 
-    def render_media(obj = MEDIA_TYPES_SERIALIZATION_OBJ_IS_UNDEFINED, serializers: nil, not_acceptable_serializer: nil, **options, &block)
+    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

data/lib/media_types/serialization/base.rb

@@ -44,35 +44,76 @@ module MediaTypes
             validator = serializer_validator.view(view).version(v)
             validator.override_suffix(:json) unless serializer_validated
 
-            serializer_output_registration.register_block(self, validator, v, block, false, wildcards: !self.serializer_disable_wildcards)
+            serializer_output_registration.register_block(
+              self,
+              validator,
+              v,
+              block,
+              false,
+              wildcards:
+              !serializer_disable_wildcards
+            )
           end
         end
 
-        def output_raw(view: nil, version: nil, versions: nil, &block)
+        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?
 
           versions.each do |v|
-            validator = serializer_validator.view(view).version(v).override_suffix('')
-
-            serializer_output_registration.register_block(self, validator, v, block, true, wildcards: !self.serializer_disable_wildcards)
+            validator = serializer_validator.view(view)
+                                            .version(v)
+                                            .override_suffix(suffix)
+
+            serializer_output_registration.register_block(
+              self,
+              validator,
+              v,
+              block,
+              true,
+              wildcards: !serializer_disable_wildcards
+            )
           end
         end
 
-        def output_alias(media_type_identifier, view: nil, hide_variant: false)
-          validator = serializer_validator.view(view)
+        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
 
-          serializer_output_registration.register_alias(self, media_type_identifier, victim_identifier, false, hide_variant, wildcards: !self.serializer_disable_wildcards)
-        end
-
-        def output_alias_optional(media_type_identifier, view: nil, hide_variant: false)
-          validator = serializer_validator.view(view)
+          serializer_output_registration.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
 
-          serializer_output_registration.register_alias(self, media_type_identifier, victim_identifier, true, hide_variant, wildcards: !self.serializer_disable_wildcards)
+          serializer_output_registration.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)
@@ -89,31 +130,53 @@ module MediaTypes
           end
         end
 
-        def input_raw(view: nil, version: nil, versions: nil, &block)
+        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?
 
           versions.each do |v|
-            validator = serializer_validator.view(view).version(v)
+            validator = serializer_validator.view(view).version(v).override_suffix(suffix)
 
             serializer_input_registration.register_block(self, validator, v, block, true)
           end
         end
 
-        def input_alias(media_type_identifier, view: nil)
-          validator = serializer_validator.view(view)
+        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
 
-          serializer_input_registration.register_alias(self, media_type_identifier, victim_identifier, false, true, wildcards: false)
-        end
-
-        def input_alias_optional(media_type_identifier, view: nil)
-          validator = serializer_validator.view(view)
+          serializer_input_registration.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
 
-          serializer_input_registration.register_alias(self, media_type_identifier, victim_identifier, true, true, wildcards: false)
+          serializer_input_registration.register_alias(
+            self,
+            media_type_identifier,
+            victim_identifier,
+            true,
+            true,
+            wildcards: false
+          )
         end
 
         def serialize(victim, media_type_identifier, context:, dsl: nil, raw: nil)
@@ -135,6 +198,8 @@ module MediaTypes
       end
 
       def self.inherited(subclass)
+        super
+
         subclass.extend(ClassMethods)
         subclass.instance_eval do
           class << self

data/lib/media_types/serialization/serialization_registration.rb

@@ -36,7 +36,7 @@ module MediaTypes
 
         unless registrations.key? target_identifier
           potential_match = registrations.keys.find do |k|
-            k.starts_with? target_identifier
+            k.start_with? target_identifier
           end
           raise VersionedAliasDefinitionError.new(target_identifier, inout, potential_match) unless potential_match.nil?
           raise UnbackedAliasDefinitionError.new(target_identifier, inout)
@@ -152,7 +152,7 @@ module MediaTypes
         self.raw = raw
         super(serializer, inout, validator, display_identifier)
       end
-      
+
       def merge(other)
         return nil unless other.is_a?(SerializationAliasRegistration)
 

data/lib/media_types/serialization/version.rb

@@ -1,5 +1,5 @@
 module MediaTypes
   module Serialization
-    VERSION = '1.3.2'.freeze
+    VERSION = '1.3.4'.freeze
   end
 end

data/media_types-serialization.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionpack', '>= 4.0.0'
   spec.add_dependency 'activesupport', '>= 4.0.0'
-  spec.add_dependency 'media_types', '>= 2.0.0', '< 3.0.0'
+  spec.add_dependency 'media_types', '>= 2.1.0', '< 3.0.0'
 
   spec.add_development_dependency 'awesome_print'
   spec.add_development_dependency 'bundler'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: media_types-serialization
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -45,7 +45,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -55,7 +55,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0