datacaster 3.2.7 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cecd5729ff179f70e6a7530603255f009814b7d4ef1d9dbe576a5f2b9e0bc222
-  data.tar.gz: 4e234450bc92faf277789eb21ccbd03ddb544253250978da41d85dd9d12f8e39
+  metadata.gz: 57a921f071865d8d6fae653de1e80edc19e1eaf5d2a37450ccd7b32a24f4386f
+  data.tar.gz: 5307a9a2f7619c331efd7620a2e1a2a7a3b11a82bec3e6ad760e8ec75a29ad84
 SHA512:
-  metadata.gz: 68e2588ec262fad2419fe3adf0a5d87aacfb28375ae47a277c4c8cb03e172913aec763375f1ffce90d2422269d219c1ff0f504921d5afc2be78c1efc8a3a2062
-  data.tar.gz: 335ef1ea64bbc63c78b0c6ef44d330967173187d6ac15bdc7b788bee9b38be77ebc63e892d97914f99fa7da1f25a604f10c96038c2f6ad4bb15b6319f5b2db0b
+  metadata.gz: 5b7f3713ebd7ce4568ae79d612e0ee2a8277d0c6baeb398e24975ff95c1167d151649565378240445765ac3499ff5db0c65380d5f215556449505e6e9f2b88a1
+  data.tar.gz: 5dc58c8d0f853ce3d906e6606af932e7531012666f77a813bf38684463a4606e4bdae3d1f0c63ae1159a1573f30b274b3fffcf9224efa82c34705b73b1671261

data/.github/workflows/rspec.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: ['3.1', '3.2', '3.3']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/README.md

@@ -31,6 +31,8 @@ It is currently used in production in several projects (mainly as request parame
     - [`hash_with_symbolized_keys(error_key = nil)`](#hash_with_symbolized_keyserror_key--nil)
     - [`integer32(error_key = nil)`](#integer32error_key--nil)
     - [`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)
   - [Special types](#special-types)
     - [`absent(error_key = nil, on: nil)`](#absenterror_key--nil-on-nil)
     - [`any(error_key = nil)`](#anyerror_key--nil)
@@ -525,9 +527,29 @@ I18n keys:
 
 Returns ValidResult if and only if provided value is a string and is not empty. Doesn't transform the value.
 
+I18n keys:
+
 * not a string – `error_key`, `'.string'`, `'datacaster.errors.string'`
 * is empty – `error_key`, `'.non_empty_string'`, `'datacaster.errors.non_empty_string'`
 
+#### `pattern(regexp, error_key = nil)`
+
+Returns ValidResult if and only if provided value is a string and satisfies regexp. Doesn't transform the value. Don't forget to provide start/end markers in the regexp if needed, e.g. `/\A\d+\z/` for digits-only string.
+
+I18n keys:
+
+* not a string – `error_key`, `'.string'`, `'datacaster.errors.string'`
+* doesn't satisfy the regexp – `error_key`, `'.pattern'`, `'datacaster.errors.pattern'`
+
+#### `uuid(error_key = nil)`
+
+Returns ValidResult if and only if provided value is a string and UUID. Doesn't transform the value.
+
+I18n keys:
+
+* not a string – `error_key`, `'.string'`, `'datacaster.errors.string'`
+* not UUID – `error_key`, `'.uuid'`, `'datacaster.errors.uuid'`
+
 ### Special types
 
 #### `absent(error_key = nil, on: nil)`
@@ -825,7 +847,11 @@ I18n keys:
 
 #### `transform_to_value(value)`
 
-Always returns ValidResult. The value is transformed to provided argument (disregarding the original value). See also [`default`](#defaultdefault_value-on-nil).
+Always returns ValidResult. The value is transformed to provided argument (disregarding the original value).
+
+Returned value is deeply freezed with [`Ractor::make_shareable`](https://docs.ruby-lang.org/en/master/Ractor.html#method-c-make_shareable) to prevent application bugs due to modification of unintentionally shared value. If that effect is undesired, use [`transform { value }`](#transform--value--) instead.
+
+See also [`default`](#defaultdefault_value-on-nil).
 
 ### "Web-form" types
 

data/config/locales/en.yml

@@ -16,6 +16,7 @@ en:
       integer32: is not a 32-bit integer
       iso8601: is not a string with ISO-8601 date and time
       must_be: "is not %{reference}"
+      pattern: has invalid format
       relate: "%{left} should be %{op} %{right}"
       responds_to: "does not respond to %{reference}"
       string: is not a string
@@ -25,3 +26,4 @@ en:
       non_empty_string: should be non-empty string
       switch: is invalid
       try: raised an error
+      uuid: is not UUID

data/datacaster.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Run-time type checker and transformer for Ruby}
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1')
 
   spec.metadata['source_code_uri'] = 'https://github.com/EugZol/datacaster'
   spec.homepage    = 'https://github.com/EugZol/datacaster'

data/lib/datacaster/absent.rb

@@ -19,5 +19,9 @@ module Datacaster
     def present?
       false
     end
+
+    def ==(other)
+      other.is_a?(self.class)
+    end
   end
 end

data/lib/datacaster/predefined.rb

@@ -276,7 +276,7 @@ module Datacaster
     end
 
     def transform_to_value(value)
-      transform { value }
+      transform { Datacaster::Utils.deep_freeze(value) }
     end
 
     def with(keys, caster)
@@ -319,6 +319,12 @@ module Datacaster
       check { |x| x.is_a?(Float) }.i18n_key(*error_keys)
     end
 
+    def pattern(regexp, error_key = nil)
+      error_keys = ['.pattern', 'datacaster.errors.pattern']
+      error_keys.unshift(error_key) if error_key
+      string(error_key) & check { |x| x.match?(regexp) }.i18n_key(*error_keys, reference: regexp.inspect)
+    end
+
     # 'hash' would be a bad method name, because it would override built in Object#hash
     def hash_value(error_key = nil)
       error_keys = ['.hash_value', 'datacaster.errors.hash_value']
@@ -360,6 +366,12 @@ module Datacaster
       string(error_key) & check { |x| !x.empty? }.i18n_key(*error_keys)
     end
 
+    def uuid(error_key = nil)
+      error_keys = ['.uuid', 'datacaster.errors.uuid']
+      error_keys.unshift(error_key) if error_key
+      string(error_key) & pattern(/\A\h{8}-\h{4}-\h{4}-\h{4}-\h{12}\z/).i18n_key(*error_keys)
+    end
+
     # Form request types
 
     def iso8601(error_key = nil)

data/lib/datacaster/utils.rb

@@ -2,6 +2,10 @@ module Datacaster
   module Utils
     extend self
 
+    def deep_freeze(value, copy: true)
+      Ractor.make_shareable(value, copy:)
+    end
+
     def merge_errors(left, right)
       add_error_to_base = ->(hash, error) {
         hash[:base] ||= []

data/lib/datacaster/version.rb

@@ -1,3 +1,3 @@
 module Datacaster
-  VERSION = "3.2.7"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datacaster
 version: !ruby/object:Gem::Version
-  version: 3.2.7
+  version: 3.3.0
 platform: ruby
 authors:
 - Eugene Zolotarev
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-07-05 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
@@ -186,15 +186,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.14
+signing_key:
 specification_version: 4
 summary: Run-time type checker and transformer for Ruby
 test_files: []