typed_params 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b621fc5ea6362816239e4c5090b7fb9879d74fc7857b14a35f38f238f4152ac
-  data.tar.gz: ad6356fcd549587faa23baa5fd27a1d2dc515a49ef332aa2b10fb2eba025cbff
+  metadata.gz: c6db30cea880bd70a7a4c6ceeae65ebb28806ab5b62e0271ef9a660fbc88f394
+  data.tar.gz: 965eaf3101f70f84c6aae336ade54700580c0b3a850cb3c9813d61a3f1f7c23d
 SHA512:
-  metadata.gz: 83cc91b95282b83e264fcd085c2269eb090106ae8769231e2af36c4738fb950df57a4e08e4b6e922a157858e8850847df1952d8091882d4578edc453c22741cd
-  data.tar.gz: 8ebdf734c19540796192f1d87cf8088cf53e1d3abb4b25e9d51da7db20753fbce71ed1e997aae622493f763c3e739402ab45eb3a7545d6fc9d5237d17344538b
+  metadata.gz: 0d119eb25721f1f31a094e2d0c303af91ff9643a93d14c935c2a46c94efac99c614f72361c7e1ad8760ab7c0d1412486ce460dbd33e3e12293cc85e74a679362
+  data.tar.gz: b77c97d4355ea181408702e5a240f4ce99edbf232c1bb7c924d70a1344945ede034fded66c87b6ce055e1bd579f2be8758dc97f1d2e2023611e003566906121d

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.3.0
+
+- Add `:any` type to skip type validation for a given param.
+
+## 1.2.7
+
+- Fix issue where the JSONAPI formatter did not ignore `meta` when `data` is omitted.
+
 ## 1.2.6
 
 - Fix issue where an empty param of type `hash` or `array` would not raise when a required but `allow_nil` child param was missing.
@@ -14,7 +22,7 @@
 
 ## 1.2.3
 
-- Remove `alias` from child lookup criteria in JSONAPI serializer.
+- Remove `alias` from child lookup criteria in JSONAPI formatter.
 
 ## 1.2.2
 

data/README.md

@@ -68,6 +68,7 @@ Links:
   - [Non-scalar types](#non-scalar-types)
   - [Custom types](#custom-types)
   - [Formats](#formats)
+  - [Custom formats](#custom-formats)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -155,7 +156,7 @@ class UsersController < ApplicationController
     end
   }
   def create
-    user = User.new(user_params)
+    user = User.new(typed_params[:user])
 
     if user.save
       render_created user, location: v1_user_url(user)
@@ -944,6 +945,45 @@ class UsersController < ApplicationController
 end
 ```
 
+### Custom formats
+
+You may register custom formatters that can be utilized in your schemas.
+
+Each formatter consists of, at minimum, a `transform:` lambda, accepting a
+params hash as well as optional `controller:` and `schema:` keywords, and
+returning the formatted params.
+
+For more usage examples, see [the default formatters](https://github.com/keygen-sh/typed_params/tree/master/lib/typed_params/formatters).
+
+```rb
+TypedParams::Formatters.register(:strong_params,
+  transform: -> (params, controller:) {
+    wrapper   = controller.controller_name.singularize.to_sym
+    unwrapped = params[wrapper]
+
+    ActionController::Parameters.new(unwrapped).permit!
+  },
+)
+```
+
+```rb
+typed_params {
+  format :strong_params
+
+  param :user, type: :hash do
+    param :email, type: :string, format: { with: /@/ }
+    param :password, type: :string
+  end
+}
+def create
+  puts user_params
+  # => #<ActionController::Parameters
+  #       {"email"=>"json@smith.example","password"=>"7c84241a1102"}
+  #       permitted: true
+  #     >
+end
+```
+
 ## Is it any good?
 
 [Yes.](https://news.ycombinator.com/item?id=3067434)

data/lib/typed_params/formatters/jsonapi.rb

@@ -43,7 +43,7 @@ module TypedParams
 
           format_hash_data(data, schema: child)
         else
-          params
+          {}
         end
       end
 

data/lib/typed_params/schema.rb

@@ -281,7 +281,8 @@ module TypedParams
     def unless?            = !@unless.nil?
     def array?             = Types.array?(type)
     def hash?              = Types.hash?(type)
-    def scalar?            = Types.scalar?(type)
+    def scalar?            = type.scalar?
+    def any?               = type.any?
     def formatter?         = !!@formatter
 
     def inspect

data/lib/typed_params/types/any.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TypedParams
+  module Types
+    register(:any,
+      abstract: true,
+      match: -> _ {},
+    )
+  end
+end

data/lib/typed_params/types/type.rb

@@ -41,6 +41,7 @@ module TypedParams
       def accepts_block? = !!@accepts_block
       def coercable?     = !!@coerce
       def scalar?        = !!@scalar
+      def any?           = @type == :any
       def abstract?      = !!@abstract
       def subtype?       = !!@archetype
 

data/lib/typed_params/validator.rb

@@ -28,7 +28,7 @@ module TypedParams
 
         # Assert type
         raise InvalidParameterError.new("type mismatch (received #{type.humanize} expected #{schema.type.humanize})", path: param.path, source: schema.source) unless
-          type == schema.type || type.subtype? && type.archetype == schema.type
+          schema.any? || type == schema.type || type.subtype? && type.archetype == schema.type
 
         # Assertions for params without children
         if schema.children.nil?

data/lib/typed_params/version.rb

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

data/lib/typed_params.rb

@@ -26,6 +26,7 @@ require 'typed_params/transforms/noop'
 require 'typed_params/transforms/transform'
 require 'typed_params/transformer'
 require 'typed_params/types'
+require 'typed_params/types/any'
 require 'typed_params/types/array'
 require 'typed_params/types/boolean'
 require 'typed_params/types/date'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_params
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Zeke Gabrielse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-05 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,6 +79,7 @@ files:
 - lib/typed_params/transforms/noop.rb
 - lib/typed_params/transforms/transform.rb
 - lib/typed_params/types.rb
+- lib/typed_params/types/any.rb
 - lib/typed_params/types/array.rb
 - lib/typed_params/types/boolean.rb
 - lib/typed_params/types/date.rb