typed_params 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 014c42e82286c1ffc175d08aca51e631da96a5b2aee8e9bbf575fc0bea7e1d57
-  data.tar.gz: 3a0ea8bac6b1021143b768767763899a6f5328f16bb6011a87b2f1ed694b6325
+  metadata.gz: 160a6e63cc497232a6c33d2cdc06050682c44e71624bee8d70f72e25b3ef3374
+  data.tar.gz: f0e1c30200d4ac4fc555cd5418546ed3ceba69dc54b09a98a02e4b349dcfd014
 SHA512:
-  metadata.gz: c563758456e6359e37c75926124925141c59f535fc77070be23d46d3f86e0772f2cf2c52d2e57f165e2ba11f93717c6a0b15f90e61fcbe00baa19b3c1985f2a8
-  data.tar.gz: a277c1c13a5d0ac14ef293fbc9611bec82eba5df00686f9afaf8e324e89148aef7c49fa672bf025570a9482ec277e330edc1049a1e59051e41a559a31a4b6584
+  metadata.gz: 773babee3c280766879e615a654206f1665a3811ac98fe673dcab655ef6e42471335f9cc2605e999eed2aa06a3aa5e6a85ed74fcd4e138b39f97467fc28adef0
+  data.tar.gz: 0ab8544aa6011e99256af88dafe207b27509f78b7db906cc41f47192967fc5b24f7fe8d8b352729908083026804ec39f5aec314b27747c2ea222443e092e4276

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.2.2
+
+- Fix issue where `as:` keyword was not handled in JSONAPI relationship formatter.
+
+## 1.2.1
+
+- Update JSONAPI formatter to simplify logic for polymorphic relationships.
+
 ## 1.2.0
 
 - Add `aliases:` keyword to `#param` to allow the schema to be accessible by different names.

data/README.md

@@ -689,8 +689,10 @@ param :invalid, type: :string, validate: -> v {
 
 #### Polymorphic parameter
 
-***Currently, this option is only utilized by the JSONAPI formatter. Define
-a polymorphic parameter, used when formatting JSONAPI relationships.***
+_Note: currently, this option is only utilized by the JSONAPI formatter._
+
+Define a polymorphic parameter. Actual behavior will vary based on the
+formatter being used.
 
 ```ruby
 format :jsonapi
@@ -711,8 +713,8 @@ typed_params # => { owner_type: 'User', owner_id: 1 }
 
 In this example, a polymorphic `:owner` relationship is defined. When run
 through the JSONAPI formatter, instead of formatting the relationship
-into the `:owner_id` key, it also includes the `:owner_type` key
-for a polymorphic association.
+into solely the `:owner_id` key, it also includes the `:owner_type`
+key for a polymorphic association.
 
 ### Shared options
 

data/lib/typed_params/formatters/jsonapi.rb

@@ -58,9 +58,10 @@ module TypedParams
       end
 
       def self.format_hash_data(data, schema:)
-        rels  = data[:relationships]
-        attrs = data[:attributes]
-        res   = data.except(
+        relationships  = data[:relationships]
+        attributes     = data[:attributes]
+
+        res = data.except(
           :attributes,
           :links,
           :meta,
@@ -69,25 +70,28 @@ module TypedParams
         )
 
         # Move attributes over to top-level params
-        attrs&.each do |key, attr|
-          res[key] = attr
+        attributes&.each do |key, attribute|
+          res[key] = attribute
         end
 
         # Move relationships over. This will use x_id and x_ids when the
         # relationship data only contains :type and :id, otherwise it
         # will use the x_attributes key.
-        rels&.each do |key, rel|
-          child = schema.children.dig(:relationships, key)
-
-          case rel
+        relationships&.each do |key, relationship|
+          child = schema.children.fetch(:relationships).then do |rels|
+                    rels.children.fetch(key) {
+                      rels.children.values.find { _1.as == key || _1.alias == key }
+                    }
+                  end
+
+          case relationship
           # FIXME(ezekg) We need https://bugs.ruby-lang.org/issues/18961 to
           #              clean this up (i.e. remove the if guard).
           in data: [{ type:, id:, **nil }, *] => linkage if linkage.all? { _1 in type:, id:, **nil }
             res[:"#{key.to_s.singularize}_ids"] = linkage.map { _1[:id] }
           in data: []
             res[:"#{key.to_s.singularize}_ids"] = []
-          # FIXME(ezekg) Not sure how to make this cleaner, but this handles polymorphic relationships.
-          in data: { type:, id:, **nil } if key.to_s.underscore.classify != type.underscore.classify && child.polymorphic?
+          in data: { type:, id:, **nil } if child.polymorphic?
             res[:"#{key}_type"], res[:"#{key}_id"] = type.underscore.classify, id
           in data: { type:, id:, **nil }
             res[:"#{key}_id"] = id
@@ -96,7 +100,7 @@ module TypedParams
           else
             # NOTE(ezekg) Embedded relationships are non-standard as per the
             #             JSONAPI spec, but I don't really care. :)
-            res[:"#{key}_attributes"] = call(rel, schema: child)
+            res[:"#{key}_attributes"] = call(relationship, schema: child)
           end
         end
 

data/lib/typed_params/schema.rb

@@ -10,6 +10,7 @@ module TypedParams
                 :source,
                 :type,
                 :key,
+                :as,
                 :alias,
                 :if,
                 :unless
@@ -80,6 +81,7 @@ module TypedParams
       @strict            = strict
       @parent            = parent
       @key               = key
+      @as                = as
       @alias             = binding.local_variable_get(:alias)
       @optional          = optional
       @coerce            = coerce && @type.coercable?
@@ -272,7 +274,7 @@ module TypedParams
     def allow_nil?         = !!@allow_nil
     def allow_non_scalars? = !!@allow_non_scalars
     def nilify_blanks?     = !!@nilify_blanks
-    def endless?         = !!@endless
+    def endless?           = !!@endless
     def indexed?           = !endless?
     def if?                = !@if.nil?
     def unless?            = !@unless.nil?
@@ -285,9 +287,6 @@ module TypedParams
       "#<#{self.class.name} key=#{key.inspect} type=#{type.inspect} children=#{children.inspect}>"
     end
 
-    # @private
-    def dig(*keys) = children.dig(*keys)
-
     private
 
     attr_reader :controller,

data/lib/typed_params/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypedParams
-  VERSION = '1.2.0'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typed_params
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Zeke Gabrielse