saphyr 0.4.2.beta → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d172fb9555ca86f1b02e7aebfd3fb9ff0de38c016e3ff70c04a362d6a919d479
-  data.tar.gz: 838664f628c9ffa0fb948ce2812bf973664c4485b9322baf5fbe7f1f4894b2e4
+  metadata.gz: 6b1c26f4af7159d647c18c278b0a57abf7583a8876b401f15f396fb538850f07
+  data.tar.gz: 29f8fe0a5e93e4d08c6eee677e13a29687f939493d9591e717050986df297089
 SHA512:
-  metadata.gz: e2fb9ef59ea455da2490aee2a58f0a1af564ac71aa7ea246cf2e94bf1d7e5c934541aaffcd68b715d8622f257482b934ce74c947e6d8bc4911c28c83085075da
-  data.tar.gz: f5112099c3cd3a1d5d034717a3f72b7abad3af7133d5a1081c289371d4e390b9fe88dc99ed07b329b703829780e5535dff0a2234d4a49030ea4a3fde91bce48d
+  metadata.gz: 6419db7b64a4a99c50ed40fae4ba2fd8ad098bc92aa3696b5d4a2e43264c6f2dbad98c11841c95944ebf58be4b62f2e3b328b8d17f6f235d8e65cd55019394ea
+  data.tar.gz: d4c40c6b13270e89551558112ce962cc0c0c8a0ae3ae46529c57a552ab25243b3c19f96e513dc87db509eb22a12b52e10a6438fa7c66d94125f3f602557f2f88

data/CHANGELOG

@@ -1,13 +1,16 @@
-No changelog update during all the beta development phase.
+-----------------------------------------------------------------
+Version: 0.5.0 - 2025-05-21
+
+- Refactor the way we validate field type
+  Adding EXPECTED_TYPES to field_base to automate the check
+- Add :default option to field
 
 -----------------------------------------------------------------
 Version: 0.4.2.beta - 2025-05-06
------------------------------------------------------------------
 
 - Fix CVE-2024-47220 upgrade webrick to ~> 1.8.2
 
 -----------------------------------------------------------------
 Version: 0.1.0.beta - 2023-08-30
------------------------------------------------------------------
 
 - Initial release

data/lib/saphyr/engine.rb

@@ -171,20 +171,25 @@ module Saphyr
           end
 
           unless data.key? name
-            next unless @ctx.schema.strict?
-            if field.required?
-              @ctx.errors << {
-                path: field_path,
-                errors: [
-                  {
-                    type: 'strict_mode:missing_in_data',
-                    data: {
-                      field: name,
+            if field.default?
+              data[name] = field.opts[:default]
+            else
+              next unless @ctx.schema.strict?
+              if field.required?
+                @ctx.errors << {
+                  path: field_path,
+                  errors: [
+                    {
+                      type: 'strict_mode:missing_in_data',
+                      data: {
+                        field: name,
+                      }
                     }
-                  }
-                ],
-              }
+                  ],
+                }
+              end
             end
+
             next
           end
 

data/lib/saphyr/fields/array_field.rb

@@ -3,7 +3,7 @@ module Saphyr
 
     class ArrayField < FieldBase
       PREFIX = 'array'
-
+      EXPECTED_TYPES = Array
       AUTHORIZED_OPTIONS = [:len, :min, :max, :of_type, :of_schema, :opts]
 
       REQUIRED_ONE_OF_OPTIONS = [:of_type, :of_schema]
@@ -34,7 +34,6 @@ module Saphyr
       private 
 
         def do_validate(ctx, name, value, errors)
-          return unless assert_class Array, value, errors
           assert_size_len @opts[:len], value, errors
           assert_size_min @opts[:min], value, errors
           assert_size_max @opts[:max], value, errors

data/lib/saphyr/fields/boolean_field.rb

@@ -6,13 +6,12 @@ module Saphyr
     # Allowed options are: +:eq+.
     class BooleanField < FieldBase
       PREFIX = 'boolean'
-
+      EXPECTED_TYPES = [TrueClass, FalseClass]
       AUTHORIZED_OPTIONS = [:eq]
 
       private
 
         def do_validate(ctx, name, value, errors)
-          return unless assert_class [TrueClass, FalseClass], value, errors
           assert_eq @opts[:eq], value, errors
         end
     end

data/lib/saphyr/fields/field_base.rb

@@ -17,13 +17,18 @@ module Saphyr
 
       # Every field type has the +:required+ and +:nullable+ options.
       # @api private
-      DEFAULT_OPT_VALUES = {required: true, nullable: false}.freeze
+      DEFAULT_OPT_VALUES = {required: true, nullable: false, default: :_none_}.freeze
       # @api private
       DEFAULT_OPTS = DEFAULT_OPT_VALUES.keys.freeze
 
       # NOTE: 
       # Override following constants to manage options
 
+      # List of expected classes for the field. It can be an array of class names, or
+      # a single class name. EX: [TrueClass, FalseClass] or Integer.
+      # @note Overriding this class constant is mandatory.
+      EXPECTED_TYPES = nil
+
       # List of authorized options.
       # @note Override this class constant if you want to use this feature.
       AUTHORIZED_OPTIONS = []
@@ -55,8 +60,10 @@ module Saphyr
       # @note Override this class constant if you want to use this feature.
       NOT_SUP_OR_EQUALS_OPTIONS = []
 
-
       def initialize(opts={})
+        if self.class::EXPECTED_TYPES.nil?
+          raise Saphyr::Error.new "The 'EXPECTED_TYPES' constant must be defined"
+        end
         if opts.key? :required
           unless assert_boolean opts[:required]
             raise Saphyr::Error.new "Option ':required' must be a Boolean"
@@ -67,10 +74,15 @@ module Saphyr
             raise Saphyr::Error.new "Option ':nullable' must be a Boolean"
           end
         end
+        if opts.key? :default
+          unless assert_class self.class::EXPECTED_TYPES, opts[:default], []
+            raise Saphyr::Error.new "Option ':default' bad type. Expecting: '#{self.class::EXPECTED_TYPES.to_s}', got: '#{opts[:default].class.name}'"
+          end
+        end
 
         unless authorized_options.size == 0
           opts.keys.each do |opt|
-            next if  opt == :required or opt == :nullable
+            next if opt == :required or opt == :nullable or opt == :default
             unless authorized_options.include? opt
               raise Saphyr::Error.new "Unauthorized option: #{opt}"
             end
@@ -212,6 +224,10 @@ module Saphyr
         @opts[:nullable]
       end
 
+      def default?
+        @opts[:default] != :_none_
+      end
+
       # -----
 
       # Check if the field value is valid.
@@ -221,6 +237,7 @@ module Saphyr
       def validate(ctx, name, value)
         # NOTE: Nullable is handle by the engine.
         errors = []
+        return errors unless assert_class self.class::EXPECTED_TYPES, value, errors
         do_validate ctx, name, value, errors
         errors
       end

data/lib/saphyr/fields/float_field.rb

@@ -6,7 +6,7 @@ module Saphyr
     # Allowed options are: +:eq, :gt, :gte, :lt, :lte, :in+.
     class FloatField < FieldBase
       PREFIX = 'float'
-
+      EXPECTED_TYPES = Float
       AUTHORIZED_OPTIONS = [:eq, :gt, :gte, :lt, :lte, :in]
 
       EXCLUSIVE_OPTIONS = [
@@ -36,7 +36,6 @@ module Saphyr
       private
 
         def do_validate(ctx, name, value, errors)
-          return unless assert_class Float, value, errors
           assert_eq @opts[:eq], value, errors
           assert_numeric_gt @opts[:gt], value, errors
           assert_numeric_gte @opts[:gte], value, errors

data/lib/saphyr/fields/integer_field.rb

@@ -6,7 +6,7 @@ module Saphyr
     # Allowed options are: +:eq, :gt, :gte, :lt, :lte, :in+.
     class IntegerField < FieldBase
       PREFIX = 'integer'
-
+      EXPECTED_TYPES = Integer
       AUTHORIZED_OPTIONS = [:eq, :gt, :gte, :lt, :lte, :in]
 
       EXCLUSIVE_OPTIONS = [
@@ -36,7 +36,6 @@ module Saphyr
       private
 
         def do_validate(ctx, name, value, errors)
-          return unless assert_class Integer, value, errors
           assert_eq @opts[:eq], value, errors
           assert_numeric_gt @opts[:gt], value, errors
           assert_numeric_gte @opts[:gte], value, errors

data/lib/saphyr/fields/schema_field.rb

@@ -3,9 +3,8 @@ module Saphyr
 
     class SchemaField < FieldBase
       PREFIX = 'schema'
-
+      EXPECTED_TYPES = Hash
       AUTHORIZED_OPTIONS = [:name]
-
       REQUIRED_OPTIONS = [:name]
 
       private

data/lib/saphyr/fields/string_field.rb

@@ -6,7 +6,7 @@ module Saphyr
     # Allowed options are: +:eq, :len, :min, :max, :in, :regexp+.
     class StringField < FieldBase
       PREFIX = 'string'
-
+      EXPECTED_TYPES = String
       AUTHORIZED_OPTIONS = [:eq, :len, :min, :max, :in, :regexp]
 
       EXCLUSIVE_OPTIONS = [
@@ -28,7 +28,6 @@ module Saphyr
       private
 
         def do_validate(ctx, name, value, errors)
-          return unless assert_class String, value, errors
           assert_eq @opts[:eq], value, errors
           assert_size_len @opts[:len], value, errors
           assert_size_min @opts[:min], value, errors

data/lib/saphyr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Saphyr
-  VERSION = "0.4.2.beta"
+  VERSION = '0.5.0'
 end

data/rdoc/02_Field_Types.md

@@ -4,7 +4,7 @@ By default the `Saphyr` library is including many field types.
 
 ## Common options
 
-All field type have the common `:required`, `:nullable`.
+All field type have the common `:required`, `:nullable` and `:nullable` options.
 
 ## String
 
@@ -15,10 +15,10 @@ Here is an example with all possible options for `:string` type:
 ```ruby
 class MyValidator < Saphyr::Validator
   field :name,      :string
-  field :name,      :string,  eq: 'v1.1'
-  field :name,      :string,  min: 5, max: 50
-  field :name,      :string,  max: 50
-  field :name,      :string,  len: 15
+  field :name,      :string,  eq: 'v1.1'               # Field name can be a
+  field "name",     :string,  min: 5, max: 50          # Symbol or a String
+  field "name",     :string,  max: 50
+  field "name",     :string,  len: 15
   field :name,      :string,  len: 15, regexp: /^[a-f0-9]+$/
   field :name,      :string,  regexp: /^[A-Z0-9]{15}$/
   field :name,      :string,  in: ['jpg', 'png', 'gif']
@@ -42,15 +42,15 @@ Here is an example with all possible options for `:integer` type:
 
 ```ruby
 class MyValidator < Saphyr::Validator
-  field :count,  :integer
-  field :count,  :integer,  eq: 'v1.1'
-  field :count,  :integer,  gt: 0
-  field :count,  :integer,  lt: 50
-  field :count,  :integer,  gte: 5, lte: 50
-  field :count,  :integer,  in: ['jpg', 'png', 'gif']
+  field :name,  :integer
+  field :name,  :integer,  eq: 'v1.1'
+  field :name,  :integer,  gt: 0
+  field :name,  :integer,  lt: 50
+  field :name,  :integer,  gte: 5, lte: 50
+  field :name,  :integer,  in: ['jpg', 'png', 'gif']
 
   field :count,  :integer,  required: false, gte: 10
-  field :count,  :integer,  nullable: true, lte: 1024
+  field :round,  :integer,  nullable: true, lte: 1024
 end
 ```
 
@@ -65,15 +65,15 @@ Here is an example with all possible options for `:float` type:
 
 ```ruby
 class MyValidator < Saphyr::Validator
-  field :price,  :float
-  field :price,  :float,  eq: 15.1
-  field :price,  :float,  gt: 0
-  field :price,  :float,  lt: 50
-  field :price,  :float,  gte: 5, lte: 50
-  field :price,  :float,  in: ['jpg', 'png', 'gif']
-
-  field :price,  :float,  required: false, gte: 10
-  field :price,  :float,  nullable: true, lte: 1024
+  field :name,  :float
+  field :name,  :float,  eq: 15.1
+  field :name,  :float,  gt: 0
+  field :name,  :float,  lt: 50
+  field :name,  :float,  gte: 5, lte: 50
+  field :name,  :float,  in: ['jpg', 'png', 'gif']
+
+  field :price,     :float,  required: false, gte: 10
+  field :discount,  :float,  nullable: true, lte: 1024
 end
 ```
 
@@ -88,12 +88,12 @@ Here is an example with all possible options for `:boolean` type:
 
 ```ruby
 class MyValidator < Saphyr::Validator
-  field :active,  :boolean
-  field :active,  :boolean,  eq: true
-  field :active,  :boolean,  eq: false
+  field :name,  :boolean
+  field :name,  :boolean,  eq: true
+  field :name,  :boolean,  eq: false
 
-  field :active,  :boolean,  required: false
-  field :active,  :boolean,  nullable: true
+  field :active,     :boolean,  required: false
+  field :processed,  :boolean,  nullable: true
 end
 ```
 

data/rdoc/04_Define_Custom_Field_Type.md

@@ -0,0 +1,47 @@
+# How To Define a Field Type
+
+It's possible to define your own custom type.
+
+You can take inspiration from `lib/saphyr/fields/*_field.rb`.
+
+Here is an example:
+
+## Define custom B62 field
+
+```ruby
+class B62Field < Saphyr::Fields::FieldBase
+  PREFIX = 'b62'
+  EXPECTED_TYPES = String
+  AUTHORIZED_OPTIONS = [:len, :min, :max]
+
+  EXCLUSIVE_OPTIONS = [
+    [ :len, [:min, :max] ],      # It mean if you use 'len' then you
+  ]                              # you can't use 'min' or 'max' and vice versa
+
+  private
+
+    def do_validate(ctx, name, value, errors)
+      assert_size_len @opts[:len], value, errors
+      assert_size_min @opts[:min], value, errors
+      assert_size_max @opts[:max], value, errors
+      assert_string_regexp /^[a-zA-Z0-9]+$/, value, errors, ERR_BAD_FORMAT
+    end
+end
+```
+
+## Register the custom type
+
+```ruby
+Saphyr.register do
+  field_type :b62, B62Field
+end
+```
+
+## Use the custom type in a validator
+
+```ruby
+class ItemValidator < Saphyr::Validator
+  field :id,     :integer,  gte: 1
+  field :uuid,   :b62,      min: 10, max: 100
+end
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saphyr
 version: !ruby/object:Gem::Version
-  version: 0.4.2.beta
+  version: 0.5.0
 platform: ruby
 authors:
 - odelbos
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,6 +50,7 @@ extra_rdoc_files:
 - rdoc/01_Define_Schema.md
 - rdoc/02_Field_Types.md
 - rdoc/03_Strict_Mode.md
+- rdoc/04_Define_Custom_Field_Type.md
 files:
 - CHANGELOG
 - LICENSE
@@ -77,6 +78,7 @@ files:
 - rdoc/01_Define_Schema.md
 - rdoc/02_Field_Types.md
 - rdoc/03_Strict_Mode.md
+- rdoc/04_Define_Custom_Field_Type.md
 homepage: https://github.com/odelbos/saphyr
 licenses:
 - MIT