typed_params 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 532f36036d10c99438c7764f96edee2a81609957e91549be1d39c09eeac3b986
-  data.tar.gz: 2780ca74ef0c99371dc87486134e37b25c8de93a4814f297d7d1955fab18ba32
+  metadata.gz: 014c42e82286c1ffc175d08aca51e631da96a5b2aee8e9bbf575fc0bea7e1d57
+  data.tar.gz: 3a0ea8bac6b1021143b768767763899a6f5328f16bb6011a87b2f1ed694b6325
 SHA512:
-  metadata.gz: 52d65870463fa00390b94bb2b469f3c12dda164518d4a32ed3151c5f09303ceb546ab4fcc76388eb0c42902a19a64ba249eb44119492ab771175c876821e0d7e
-  data.tar.gz: cd70318ed475aa00a8cbdafc89656957a93abe17c1108b0d39bca744102a1e91546d483168b8e5a9e8ac1ae9b58bb17870594d8611b8a05d46d46862f744d7ae
+  metadata.gz: c563758456e6359e37c75926124925141c59f535fc77070be23d46d3f86e0772f2cf2c52d2e57f165e2ba11f93717c6a0b15f90e61fcbe00baa19b3c1985f2a8
+  data.tar.gz: a277c1c13a5d0ac14ef293fbc9611bec82eba5df00686f9afaf8e324e89148aef7c49fa672bf025570a9482ec277e330edc1049a1e59051e41a559a31a4b6584

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.2.0
+
+- Add `aliases:` keyword to `#param` to allow the schema to be accessible by different names.
+- Add `polymorphic:` keyword to `#param` to define a polymorphic schema.
+
+## 1.1.1
+
+- Fix compatibility with Ruby 3.3.0 due to [#20091](https://bugs.ruby-lang.org/issues/20091).
+
+## 1.1.0
+
+- Add memoization to `#typed_params` and `#typed_query` methods.
+
 ## 1.0.3
 
 - Revert 0b0aaa6b66edd3e4c3336e51fa340592e7ef9e86.
@@ -18,4 +31,4 @@
 
 ## 0.2.0
 
-- Test release.
+- Test release.

data/README.md

@@ -110,6 +110,7 @@ _We're working on improving the docs._
 - Reuse schemas across controllers by defining named schemas.
 - Run validations on params, similar to active model validations.
 - Run transforms on params before they hit your controller.
+- Support formatters such as JSON:API.
 
 ## Usage
 
@@ -435,6 +436,7 @@ Parameters can have validations, transforms, and more.
 - [`:optional`](#optional-parameter)
 - [`:if` and `:unless`](#conditional-parameter)
 - [`:as`](#rename-parameter)
+- [`:alias`](#alias-parameter)
 - [`:noop`](#noop-parameter)
 - [`:coerce`](#coerce-parameter)
 - [`:allow_blank`](#allow-blank)
@@ -447,6 +449,7 @@ Parameters can have validations, transforms, and more.
 - [`:length`](#length-validation)
 - [`:transform`](#transform-parameter)
 - [`:validate`](#validate-parameter)
+- [`:polymorphic`](#polymorphic-parameter)
 
 #### Parameter key
 
@@ -519,6 +522,17 @@ typed_params # => { user_id: 1 }
 In this example, the parameter would be accepted as `:user`, but renamed
 to `:user_id` for use inside of the controller.
 
+#### Alias parameter
+
+Allow a parameter to be provided via an alias.
+
+```ruby
+param :owner_id, type: :integer, alias: :user_id
+```
+
+In this example, the parameter would be accepted as both `:owner_id` and
+`:user_id`, but accessible as `:owner_id` inside the controller.
+
 #### Noop parameter
 
 The parameter is accepted but immediately thrown out.
@@ -673,6 +687,33 @@ 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.***
+
+```ruby
+format :jsonapi
+
+param :data, type: :hash do
+  param :relationships, type: :hash do
+    param :owner, type: :hash, polymorphic: true do
+      param :data, type: :hash do
+        param :type, type: :string, inclusion: { in: %w[users user] }
+        param :id, type: :integer
+      end
+    end
+  end
+end
+
+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.
+
 ### Shared options
 
 You can define a set of options that will be applied to immediate
@@ -747,7 +788,7 @@ which may be a nested schema.
 
 ```ruby
 # array of hashes
-param :boundless_array, type: :array do
+param :endless_array, type: :array do
   items type: :hash do
     # ...
   end

data/lib/typed_params/formatters/formatter.rb

@@ -14,7 +14,7 @@ module TypedParams
 
       def decorator? = decorator.present?
 
-      delegate :arity, :call, to: :@transform
+      delegate :arity, :parameters, :call, to: :@transform
     end
   end
 end

data/lib/typed_params/formatters/jsonapi.rb

@@ -32,12 +32,16 @@ module TypedParams
     #   }
     #
     module JSONAPI
-      def self.call(params)
+      def self.call(params, schema:)
         case params
         in data: Array => data
-          format_array_data(data)
+          child = schema.children.fetch(:data)
+
+          format_array_data(data, schema: child)
         in data: Hash => data
-          format_hash_data(data)
+          child = schema.children.fetch(:data)
+
+          format_hash_data(data, schema: child)
         else
           params
         end
@@ -45,11 +49,15 @@ module TypedParams
 
       private
 
-      def self.format_array_data(data)
-        data.map { format_hash_data(_1) }
+      def self.format_array_data(data, schema:)
+        data.each_with_index.map do |value, i|
+          child = schema.children.fetch(i) { schema.endless? ? schema.children.first : nil }
+
+          format_hash_data(value, schema: child)
+        end
       end
 
-      def self.format_hash_data(data)
+      def self.format_hash_data(data, schema:)
         rels  = data[:relationships]
         attrs = data[:attributes]
         res   = data.except(
@@ -69,6 +77,8 @@ module TypedParams
         # 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
           # FIXME(ezekg) We need https://bugs.ruby-lang.org/issues/18961 to
           #              clean this up (i.e. remove the if guard).
@@ -77,7 +87,7 @@ module TypedParams
           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
+          in data: { type:, id:, **nil } if key.to_s.underscore.classify != type.underscore.classify && child.polymorphic?
             res[:"#{key}_type"], res[:"#{key}_id"] = type.underscore.classify, id
           in data: { type:, id:, **nil }
             res[:"#{key}_id"] = id
@@ -86,7 +96,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)
+            res[:"#{key}_attributes"] = call(rel, schema: child)
           end
         end
 

data/lib/typed_params/mapper.rb

@@ -47,7 +47,7 @@ module TypedParams
     #   │ 1 ││ 2 │     │ 5 │
     #   └───┘└───┘     └───┘
     #
-    def depth_first_map(param, &)
+    def depth_first_map(param, &block)
       return if param.nil?
 
       # Postorder DFS, so we'll visit the children first.
@@ -55,12 +55,12 @@ module TypedParams
         case param.schema.children
         in Array if param.array?
           if param.schema.indexed?
-            param.schema.children.each_with_index { |v, i| self.class.call(param[i], schema: v, controller:, &) }
+            param.schema.children.each_with_index { |v, i| self.class.call(param[i], schema: v, controller:, &block) }
           else
-            param.value.each { |v| self.class.call(v, schema: param.schema.children.first, controller:, &) }
+            param.value.each { |v| self.class.call(v, schema: param.schema.children.first, controller:, &block) }
           end
         in Hash if param.hash?
-          param.schema.children.each { |k, v| self.class.call(param[k], schema: v, controller:, &) }
+          param.schema.children.each { |k, v| self.class.call(param[k], schema: v, controller:, &block) }
         else
         end
       end

data/lib/typed_params/memoize.rb

@@ -34,7 +34,7 @@ module TypedParams
                               end
 
           klass.singleton_class.send(:alias_method, :"unmemoized_#{method_name}", method_name)
-          klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
             def self.#{method_name}(*args, **kwargs, &block)
               key = args.hash ^ kwargs.hash ^ block.hash
 
@@ -72,7 +72,7 @@ module TypedParams
                               end
 
           klass.alias_method :"unmemoized_#{method_name}", method_name
-          klass.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          klass.class_eval <<~RUBY, __FILE__, __LINE__ + 1
             def #{method_name}(*args, **kwargs, &block)
               key = args.hash ^ kwargs.hash ^ block.hash
 

data/lib/typed_params/parameter.rb

@@ -75,7 +75,16 @@ module TypedParams
       if formatter.present?
         v = case formatter.arity
             when 2
-              formatter.call(v, controller:)
+              case formatter.parameters
+              in [[:req, *], [:keyreq | :key, :controller], [:keyreq | :key, :schema]]
+                formatter.call(v, controller:, schema:)
+              in [[:req, *], [:keyreq | :key, :schema], [:keyreq | :key, :controller]]
+                formatter.call(v, schema:, controller:)
+              in [[:req, *], [:keyreq | :key, :controller]]
+                formatter.call(v, controller:)
+              in [[:req, *], [:keyreq | :key, :schema]]
+                formatter.call(v, schema:)
+              end
             when 1
               formatter.call(v)
             end

data/lib/typed_params/parameterizer.rb

@@ -38,7 +38,7 @@ module TypedParams
 
       value.each_with_index do |v, i|
         unless schema.children.nil?
-          child = schema.children.fetch(i) { schema.boundless? ? schema.children.first : nil }
+          child = schema.children.fetch(i) { schema.endless? ? schema.children.first : nil }
           if child.nil?
             raise UnpermittedParameterError.new('unpermitted parameter', path: Path.new(*param.path.keys, i), source: schema.source) if
               schema.strict?
@@ -63,7 +63,7 @@ module TypedParams
 
       value.each do |k, v|
         unless schema.children.nil?
-          child = schema.children.fetch(k) { nil }
+          child = schema.children.fetch(k) { schema.children.values.find { _1.alias == k } }
           if child.nil?
             raise UnpermittedParameterError.new('unpermitted parameter', path: Path.new(*param.path.keys, k), source: schema.source) if
               schema.strict?
@@ -71,7 +71,7 @@ module TypedParams
             next
           end
 
-          param[k] = Parameterizer.new(schema: child, parent: param).call(key: k, value: v)
+          param[child.key] = Parameterizer.new(schema: child, parent: param).call(key: child.key, value: v)
         else
           param[k] = Parameter.new(key: k, value: v, schema:, parent: param)
         end

data/lib/typed_params/schema.rb

@@ -10,6 +10,7 @@ module TypedParams
                 :source,
                 :type,
                 :key,
+                :alias,
                 :if,
                 :unless
 
@@ -22,6 +23,7 @@ module TypedParams
       key: nil,
       optional: false,
       coerce: false,
+      polymorphic: false,
       allow_blank: false,
       allow_nil: false,
       allow_non_scalars: false,
@@ -36,6 +38,7 @@ module TypedParams
       if: nil,
       unless: nil,
       as: nil,
+      alias: nil,
       casing: TypedParams.config.key_transform,
       &block
     )
@@ -77,8 +80,10 @@ module TypedParams
       @strict            = strict
       @parent            = parent
       @key               = key
+      @alias             = binding.local_variable_get(:alias)
       @optional          = optional
       @coerce            = coerce && @type.coercable?
+      @polymorphic       = polymorphic
       @allow_blank       = key == ROOT || allow_blank
       @allow_nil         = allow_nil
       @allow_non_scalars = allow_non_scalars
@@ -211,7 +216,7 @@ module TypedParams
 
     ##
     # params defines multiple like-parameters for a hash schema.
-    def params(*keys, **kwargs, &) = keys.each { param(_1, **kwargs, &) }
+    def params(*keys, **kwargs, &block) = keys.each { param(_1, **kwargs, &block) }
 
     ##
     # item defines an indexed parameter for an array schema.
@@ -220,7 +225,7 @@ module TypedParams
         Types.array?(children)
 
       raise ArgumentError, "index #{key} has already been defined" if
-        children[key].present? || boundless?
+        children[key].present? || endless?
 
       children << Schema.new(**options, **kwargs, key:, type:, strict:, source:, casing:, parent: self, &block)
     end
@@ -230,7 +235,7 @@ module TypedParams
     def items(**kwargs, &)
       item(0, **kwargs, &)
 
-      boundless!
+      endless!
     end
 
     def path
@@ -261,12 +266,14 @@ module TypedParams
     def optional?          = !!@optional
     def required?          = !optional?
     def coerce?            = !!@coerce
+    def polymorphic?       = !!@polymorphic
+    def aliased?           = !!@alias
     def allow_blank?       = !!@allow_blank
     def allow_nil?         = !!@allow_nil
     def allow_non_scalars? = !!@allow_non_scalars
     def nilify_blanks?     = !!@nilify_blanks
-    def boundless?         = !!@boundless
-    def indexed?           = !boundless?
+    def endless?         = !!@endless
+    def indexed?           = !endless?
     def if?                = !@if.nil?
     def unless?            = !@unless.nil?
     def array?             = Types.array?(type)
@@ -278,6 +285,9 @@ 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,
@@ -285,6 +295,6 @@ module TypedParams
                 :strict,
                 :casing
 
-    def boundless! = @boundless = true
+    def endless! = @endless = true
   end
 end

data/lib/typed_params/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_params
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails