datacaster 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c42f42112214378de25b126640a7bb578532c1db0ac9fbb73914ef3c08db76e2
-  data.tar.gz: 0abba877a155d717b0aa2cb605c9214789c839b381492984cb277a1523c5a7a1
+  metadata.gz: d563422d81d874ec9f74b4e95a3d24a7a59cf2c3f50ad709a226346616364882
+  data.tar.gz: e33c3dffdbff37e5ce711f56c0196e8955379764c98c2429ec391fd33819797d
 SHA512:
-  metadata.gz: 4b07733981e971af666cf9a7688cd35f4a32b80eb2e4a53505620425027f5fdd963c7c63717f6888fe700df4ef6c5eb175a07aac7183cb0df29dd1e8b97fe446
-  data.tar.gz: a596b40d1ebff4e8abc455bdde09c01b0f1499a35cee44daca329885277448cbe6f66268d568a091fa78e83e0da7adf9d9cb09df0c5711d4bc3243d3b909a886
+  metadata.gz: d01eb486e4d11954f672e6958803b7ea4c60430c58850f2b4c8e8b16a500229c28a91ecadc45317775f7ff8098c4beddfb0373d415f72e5c917ccb1a93f589c8
+  data.tar.gz: c9bdb6f156a7de6eb81fa9cb87dcbf050fd47292d417afd4d085cb64a9e5460c4022b6471de723a1e112cd730a5b12e14c595e9ce248e30ff18fd84625a2cc8a

data/README.md

@@ -32,12 +32,12 @@ It is currently used in production in several projects (mainly as request parame
     - [`integer32(error_key = nil)`](#integer32error_key--nil)
     - [`non_empty_string(error_key = nil)`](#non_empty_stringerror_key--nil)
   - [Special types](#special-types)
-    - [`absent(error_key = nil)`](#absenterror_key--nil)
+    - [`absent(error_key = nil, on: nil)`](#absenterror_key--nil-on-nil)
     - [`any(error_key = nil)`](#anyerror_key--nil)
     - [`default(default_value, on: nil)`](#defaultdefault_value-on-nil)
     - [`merge_message_keys(*keys)`](#merge_message_keyskeys)
     - [`must_be(klass, error_key = nil)`](#must_beklass-error_key--nil)
-    - [`optional(base)`](#optionalbase)
+    - [`optional(base, on: nil)`](#optionalbase-on-nil)
     - [`pass`](#pass)
     - [`pass_if(base)`](#pass_ifbase)
     - [`pick(key)`](#pickkey)
@@ -502,9 +502,16 @@ Returns ValidResult if and only if provided value is a string and is not empty.
 
 ### Special types
 
-#### `absent(error_key = nil)`
+#### `absent(error_key = nil, on: nil)`
 
-Returns ValidResult if and only if provided value is `Datacaster.absent` (this is singleton instance). Relevant only for hash schemas (see below). Doesn't transform the value.
+Returns ValidResult if and only if provided value is absent. Relevant only for hash schemas (see below). Transforms the value to `Datacaster.absent`.
+
+The value is considered absent:
+
+* if the value is `Datacaster.absent` (`on` is disregarded in such case)
+* if `on` is set to a method name to which the value responds and yields truthy
+
+Set `on` to `:nil?`, `:empty?` or similar method names.
 
 I18n keys: `error_key`, `'.absent'`, `'datacaster.errors.absent'`.
 
@@ -636,18 +643,25 @@ Returns ValidResult if and only if the value `#is_a?(klass)`. Doesn't transform
 
 I18n keys: `error_key`,  `'.must_be'`, `'datacaster.errors.must_be'`. Adds `reference` i18n variable, setting it to `klass.name`. 
 
-#### `optional(base)`
+#### `optional(base, on: nil)`
+
+Returns ValidResult if and only if the value is either absent or passes `base` validation. In the value is absent, transforms it to the `Datacaster.absent`. Otherwise, returns `base` result.
+
+Value is considered absent:
+
+* if the value is `Datacaster.absent` (`on` is disregarded in such case)
+* if `on` is set to a method name to which the value responds and yields truthy
 
-Returns ValidResult if and only if the value is either `Datacaster.absent` or passes `base` validation. See below documentation on hash schemas for details on `Datacaster.absent`.
+Set `on` to `:nil?`, `:empty?` or similar method names.
 
 ```ruby
 item_with_optional_price =
-    Datacaster.schema do
-      hash_schema(
-        name: string,
-        price: optional(float)
-      )
-    end
+  Datacaster.schema do
+    hash_schema(
+      name: string,
+      price: optional(float)
+    )
+  end
 
 item_with_optional_price.(name: "Book", price: 1.23)
 # => Datacaster::ValidResult({:name=>"Book", :price=>1.23})
@@ -1025,7 +1039,7 @@ restricted_params.(username: "test", is_admin: nil)
 
 More practical case is to include `absent` validator in logical expressions, e.g. `something: absent | string`. If `something` is set to `nil`, this validation will fail, which could be the desired (and hardly achieved by any other validation framework) behavior.
 
-Also, see documentation for [`optional(base)`](#optionalbase) and [`optional_param(base)`](#optional_parambase). If some value becomes `Datacaster.absent` in its chain of validations-transformations, it is removed from the resultant hash (on the same stage where the lack of extra/unchecked keys in the hash is validated):
+Also, see documentation for [`optional(base)`](#optionalbase-on-nil) and [`optional_param(base)`](#optional_parambase). If some value becomes `Datacaster.absent` in its chain of validations-transformations, it is removed from the resultant hash (on the same stage where the lack of extra/unchecked keys in the hash is validated):
 
 ```ruby
 person =

data/lib/datacaster/predefined.rb

@@ -67,10 +67,20 @@ module Datacaster
 
     # 'Meta' types
 
-    def absent(error_key = nil)
+    def absent(error_key = nil, on: nil)
       error_keys = ['.absent', 'datacaster.errors.absent']
       error_keys.unshift(error_key) if error_key
-      check { |x| x == Datacaster.absent }.i18n_key(*error_keys)
+
+      cast do |x|
+        if x == Datacaster.absent ||
+          (!on.nil? && x.respond_to?(on) && x.public_send(on))
+          Datacaster.ValidResult(Datacaster.absent)
+        else
+          Datacaster.ErrorResult(
+            I18nValues::Key.new(error_keys, value: x)
+          )
+        end
+      end
     end
 
     def any(error_key = nil)
@@ -82,7 +92,7 @@ module Datacaster
     def default(value, on: nil)
       transform do |x|
         if x == Datacaster.absent ||
-          (on && x.respond_to?(on) && x.public_send(on))
+          (!on.nil? && x.respond_to?(on) && x.public_send(on))
           value
         else
           x
@@ -153,8 +163,16 @@ module Datacaster
       check { |x| x.is_a?(klass) }.i18n_key(*error_keys, reference: klass.name)
     end
 
-    def optional(base)
-      absent | base
+    def optional(base, on: nil)
+      return absent | base if on == nil
+      cast do |x|
+        if x == Datacaster.absent ||
+          (!on.nil? && x.respond_to?(on) && x.public_send(on))
+          Datacaster.ValidResult(Datacaster.absent)
+        else
+          base.(x)
+        end
+      end
     end
 
     # Strict types

data/lib/datacaster/version.rb

@@ -1,3 +1,3 @@
 module Datacaster
-  VERSION = "3.1.0"
+  VERSION = "3.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datacaster
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Eugene Zolotarev