saphyr 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d491ec052216eb7db303fa4fb65b6a558ecbb2c39a24663a43ae85eb616da14
-  data.tar.gz: a07b8137c7e853c0e9625a18760139a220a1be4fdf5271365f81cd2459e288a5
+  metadata.gz: 699e716904911896a384f05b33ea53af443ca41e5981330126a4f0c08be75511
+  data.tar.gz: ff47bb4681ce194f3a92d10c4ce407f1a63904608a87de105e9c686bf8c4a64a
 SHA512:
-  metadata.gz: a816ea8a58c18ae02e599f077f40ce54081e84e8a12ea47e9e3734ce410e238c2562105bc4fd55cf9facfba94477d5856cf708877514eb369f5ffdd85413d7f1
-  data.tar.gz: bf4a796653f788a49f80bb2b1344d87a059e20a98c8fbd9ed8cd87d13062c228c153c62a8097204f252e69157611cd6d59b6b36b601fbd566b8a9bd0a8c24ff5
+  metadata.gz: a05d896442f9fdede8dd1452ebe61ff03a15ba1c5f58b859fdd9f0fbc34c9a0e153da6fdbeb91fa10a035d66c6b9b026c7c909b8cc1d97bb3e7d90562f9f1a73
+  data.tar.gz: 45d6db6210eee29afc46c0ff90eb695b99b833fe3d326bc391dc8a436d4c28b032ddacb1dd9264287883ceb34a37cbd5b9ba6492b0f31638f61acea16c1d40e6

data/CHANGELOG

@@ -1,3 +1,18 @@
+-----------------------------------------------------------------
+Version: 0.6.1 - 2025-06-29
+
+- Refactor email_field to use assert_string_regexp
+- Make get() variadic to fetch deep fields
+- Add get_safe()
+
+-----------------------------------------------------------------
+Version: 0.6.0 - 2025-06-21
+
+- Add standard field types
+  Email, URI, URL, Base64, ipv4, ipv6, ISO Country, ISO Language
+- Add assert_not_empty
+- Refactor expected_types()
+
 -----------------------------------------------------------------
 Version: 0.5.0 - 2025-05-21
 

data/lib/saphyr/fields/email_field.rb

@@ -14,14 +14,7 @@ module Saphyr
 
         def do_validate(ctx, name, value, errors)
           return unless assert_not_empty value, errors
-          unless value =~ ::URI::MailTo::EMAIL_REGEXP
-            errors << {
-              type: err('invalid'),
-              data: {
-                _val: value
-              }
-            }
-          end
+          assert_string_regexp ::URI::MailTo::EMAIL_REGEXP, value, errors
         end
     end
   end

data/lib/saphyr/validator.rb

@@ -119,11 +119,80 @@ module Saphyr
     end
 
     # Get a field from the data to validate.
-    # @param field [String | Symbol] The field name
+    #
+    # Use variadic arguments to access deep fields.
+    #
+    # Examples:
+    #
+    #     data = {
+    #       "id" => 3465,
+    #       "info" => {
+    #         "suffix" => ["gif", "jpg", "png"]
+    #         "size" => 34056
+    #       }
+    #     }
+    #
+    #     get("id")                    # => 3435
+    #     get("info", "suffix", 1)     # => "jpg"
+    #     get("info", "size")          # => 34056
+    #     get("name")                  # => raise an exception
+    #
     # @return The field value
-    def get(field)
-      data = @ctx.data_to_validate
-      data[field.to_s]
+    # @raise [Saphyr::Error] If field does not exists.
+    def get(*args)
+      status, value = get_safe(*args)
+      raise Saphyr::Error.new 'Requested field does not exists' if status == :err
+      value
+    end
+
+    # Get a field from the data to validate.
+    # (Same as +get()+ but never raise an exception).
+    #
+    # Use variadic arguments to access deep fields.
+    #
+    # Examples:
+    #
+    #     data = {
+    #       "id" => 3465,
+    #       "info" => {
+    #         "suffix" => ["gif", "jpg", "png"]
+    #         "size" => 34056
+    #       }
+    #     }
+    #
+    #     get("id")                    # => [:ok, 3435]
+    #     get("info", "suffix", 1)     # => [:ok, "jpg"]
+    #     get("info", "size")          # => [:ok, 34056]
+    #     get("name")                  # => [:err, :not_exists]
+    #     get("info", "suffix", 5)     # => [:err, :not_index]
+    #     get("info", 3)               # => [:err, :not_array]
+    #
+    # @return An array where first element is the status and second element is the result.
+    def get_safe(*args)
+      do_get_safe @data, args.reverse
+    end
+
+    private
+
+    def do_get_safe(data, args)
+      return [:ok, data] if args.size == 0
+      key = args.pop
+      if data.is_a? Hash
+        key = key.to_s if key.is_a? Symbol
+        if data.key? key
+          return do_get_safe data[key], args
+        else
+          return [:err, :not_exists]
+        end
+      elsif data.is_a? Array
+        if key.is_a? Integer
+          return do_get_safe data[key], args
+        else
+          return [:err, :not_index]
+        end
+      else
+        return [:err, :not_array]
+      end
     end
   end
 end

data/lib/saphyr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Saphyr
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saphyr
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - odelbos
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-20 00:00:00.000000000 Z
+date: 2025-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,8 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: The purpose of Saphyr is to provide a nice and simple DSL to easily and
-  quickly design a validation schema for JSON document.
+description: Simple DSL to design validation schemas for JSON document (or Hash /
+  Array structure)
 email:
 - od@phibox.com
 executables: []
@@ -111,5 +111,6 @@ requirements: []
 rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
-summary: The saphyr gem is used to validate JSON document.
+summary: Simple DSL to design validation schemas for JSON document (or Hash / Array
+  structure)
 test_files: []