datacaster 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cbcb054db89c228c0c38e19a2af1a3863a1835708dd9717a9f3d5c0b3f27286
-  data.tar.gz: 79aa8db52e0cb760b1fd6e8b49bf77b7853b7fae192f2a746d4a9205bc3c1b14
+  metadata.gz: 313d4857ebb527af62b00822c82ae25ca81d143fac6d46586704efda3337907d
+  data.tar.gz: cafec5e89d47418b72a3b9a9123699d2c4d8c479f8d7720739f4dd59b47e4d72
 SHA512:
-  metadata.gz: f5a325a3bd5534b69024488ea015d05e5c1e12970df5c07a2eeb26c34a0c8be48bbc2f2c98971f1ba4653231c7740d06cf38359c628ee030e4d8423cafebb278
-  data.tar.gz: aa0b7b42f0ecd22f9d4d9865e0c2c95602a990585550f5579c2b466f2a9bde4d6814adf0faeffe08d0e9e391d79c27519a1e5647a9fb0f9370276f72c8e461d2
+  metadata.gz: 7929550a2f1ca7c0b3002ccb32b27336a094737647d0aaaffcdc54001d1084ebfebc8c168b98096e59b7d990cccb1dc8e495cf4a4dcd9fbf0cb1168117f43ba1
+  data.tar.gz: 2a7fa2d4528c014fefd3c701c797566ea6eb9bcee08442bbe79f3fa881f9adb473e8424d909b05f0e0a2109ce79265bafb6b700b4873cb89778ab2ff601698c2

data/README.md

@@ -26,10 +26,13 @@ It is currently used in production in several projects (mainly as request parame
     - [`float(error_key = nil)`](#floaterror_key--nil)
     - [`hash_value(error_key = nil)`](#hash_valueerror_key--nil)
     - [`integer(error_key = nil)`](#integererror_key--nil)
+    - [`numeric(error_key = nil)`](#numericerror_key--nil)
     - [`string(error_key = nil)`](#stringerror_key--nil)
   - [Convenience types](#convenience-types)
     - [`hash_with_symbolized_keys(error_key = nil)`](#hash_with_symbolized_keyserror_key--nil)
     - [`integer32(error_key = nil)`](#integer32error_key--nil)
+    - [`maximum(max, error_key = nil, inclusive: true)`](#maximummax-error_key--nil-inclusive-true)
+    - [`minimum(min, error_key = nil, inclusive: true)`](#minimummin-error_key--nil-inclusive-true)
     - [`non_empty_string(error_key = nil)`](#non_empty_stringerror_key--nil)
     - [`pattern(regexp, error_key = nil)`](#patternregexp-error_key--nil)
     - [`uuid(error_key = nil)`](#uuiderror_key--nil)
@@ -500,6 +503,12 @@ Returns ValidResult if and only if provided value is an integer. Doesn't transfo
 
 I18n keys: `error_key`, `'.integer'`, `'datacaster.errors.integer'`.
 
+#### `numeric(error_key = nil)`
+
+Returns ValidResult if and only if provided value is a number (Ruby's `Numeric`). Doesn't transform the value.
+
+I18n keys: `error_key`, `'.numeric'`, `'datacaster.errors.numeric'`.
+
 #### `string(error_key = nil)`
 
 Returns ValidResult if and only if provided value is a string. Doesn't transform the value.
@@ -523,6 +532,26 @@ I18n keys:
 * not an integer – `error_key`, `'.integer'`, `'datacaster.errors.integer'`
 * too big – `error_key`, `'.integer32'`, `'datacaster.errors.integer32'`
 
+#### `maximum(max, error_key = nil, inclusive: true)`
+
+Returns ValidResult if and only if provided value is a number and is less than `max`. If `inclusive` set to true, provided value should be less than or equal to `max`. Doesn't transform the value.
+
+I18n keys:
+
+* not a number – `error_key`, `'.numeric'`, `'datacaster.errors.numeric'`
+* is less (when `inclusive` is `true`) – `error_key`, `'.maximum.lteq'`, `'datacaster.errors.maximum.lteq'`
+* is less (when `inclusive` is `false`) – `error_key`, `'.maximum.lt'`, `'datacaster.errors.maximum.lt'`
+
+#### `minimum(min, error_key = nil, inclusive: true)`
+
+Returns ValidResult if and only if provided value is a number and is greater than `min`. If `inclusive` set to true, provided value should be greater than or equal to `min`. Doesn't transform the value.
+
+I18n keys:
+
+* not a number – `error_key`, `'.numeric'`, `'datacaster.errors.numeric'`
+* is greater (when `inclusive` is `true`) – `error_key`, `'.minimum.gteq'`, `'datacaster.errors.minimum.gteq'`
+* is greater (when `inclusive` is `false`) – `error_key`, `'.minimum.gt'`, `'datacaster.errors.minimum.gt'`
+
 #### `non_empty_string(error_key = nil)`
 
 Returns ValidResult if and only if provided value is a string and is not empty. Doesn't transform the value.

data/config/locales/en.yml

@@ -15,7 +15,14 @@ en:
       integer: is not an integer
       integer32: is not a 32-bit integer
       iso8601: is not a string with ISO-8601 date and time
+      maximum:
+        lt: '%{value} should be less than %{max}'
+        lteq: '%{value} should be less than or equal to %{max}'
+      minimum:
+        gt: '%{value} should be greater than %{min}'
+        gteq: '%{value} should be greater than or equal to %{min}'
       must_be: "is not %{reference}"
+      numeric: is not a number
       pattern: has invalid format
       relate: "%{left} should be %{op} %{right}"
       responds_to: "does not respond to %{reference}"

data/lib/datacaster/predefined.rb

@@ -296,6 +296,12 @@ module Datacaster
 
     # Strict types
 
+    def numeric(error_key = nil)
+      error_keys = ['.numeric', 'datacaster.errors.numeric']
+      error_keys.unshift(error_key) if error_key
+      check { |x| x.is_a?(Numeric) }.i18n_key(*error_keys)
+    end
+
     def decimal(digits = 8, error_key = nil)
       error_keys = ['.decimal', 'datacaster.errors.decimal']
       error_keys.unshift(error_key) if error_key
@@ -355,6 +361,42 @@ module Datacaster
       integer(error_key) & check { |x| x.abs <= 2_147_483_647 }.i18n_key(*error_keys)
     end
 
+    def maximum(max, error_key = nil, inclusive: true)
+      subkey = 'lt'
+      subkey += 'eq' if inclusive
+
+      error_keys = [".maximum.#{subkey}", "datacaster.errors.maximum.#{subkey}"]
+
+      error_keys.unshift(error_key) if error_key
+
+      caster =
+        if inclusive
+          check { |x| x <= max }
+        else
+          check { |x| x < max }
+        end
+
+      numeric(error_key) & caster.i18n_key(*error_keys, max:)
+    end
+
+    def minimum(min, error_key = nil, inclusive: true)
+      subkey = 'gt'
+      subkey += 'eq' if inclusive
+
+      error_keys = [".minimum.#{subkey}", "datacaster.errors.minimum.#{subkey}"]
+
+      error_keys.unshift(error_key) if error_key
+
+      caster =
+        if inclusive
+          check { |x| x >= min }
+        else
+          check { |x| x > min }
+        end
+
+      numeric(error_key) & caster.i18n_key(*error_keys, min:)
+    end
+
     def string(error_key = nil)
       error_keys = ['.string', 'datacaster.errors.string']
       error_keys.unshift(error_key) if error_key

data/lib/datacaster/version.rb

@@ -1,3 +1,3 @@
 module Datacaster
-  VERSION = "4.1.0"
+  VERSION = "4.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacaster
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Eugene Zolotarev
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -106,7 +106,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-description: 
+description:
 email:
 - eugzol@gmail.com
 executables: []
@@ -178,7 +178,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/EugZol/datacaster
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -193,8 +193,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.20
+signing_key:
 specification_version: 4
 summary: Run-time type checker and transformer for Ruby
 test_files: []