schemacop 3.0.34 → 3.0.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818a611a08d135cb5fb9c691a101472133c2313e5536675b62af795b01a56fbb
-  data.tar.gz: bea474ef2808294b83597bab07b076103b5ddddbe0d4aa2164bbed779f2cc130
+  metadata.gz: 80f588e0e3422fa0fea90f6725f48cb7eab64b7b2d6158e93e05496bc51f7565
+  data.tar.gz: 18b0514093843e7b1065e3b2c102263cbb4afa708cf8fa13f7c404cbec037abe
 SHA512:
-  metadata.gz: f815986a0a382961c35445d710217a7af8bf9937fe6e137852e4c54c95bc9550b6796aa610f29e2b06aacd277e99eb2e19039bde2d8e1b6c0c5d27578db6b2a0
-  data.tar.gz: 0db3deb0605ae6a1315e91a58ca1beebfd74aabe7be9488df320736d1077c54ba993c4705b4a8f4b63c8adda3daf57c5a3e6b46639127daf9435a8e1b45544a1
+  metadata.gz: f54e94a656fa9df82c4adde9f81d60a5f93b673018a8f9d50a80c755aa2b67ec362eeace426a1b4fcd9cbd4a0af8100b845b876afc37a2de5dac82a8b14acd6f
+  data.tar.gz: 8e362b61caf5ba6f885cef3014e53677e3d76775f31945fc70b0a7400cf465d5c28a0a6c053288e38a4642f8dd13b60cd35047dfe58a5fb8c88eecafc65c9499

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## 3.0.35 (2025-07-31)
+
+* Add option `max_precision` to `number` nodes for Schemacop V3 schemas to validate
+  the maximum number of decimal places for `Float` and `BigDecimal` values
+
 ## 3.0.34 (2025-05-27)
 
 * Adapt string format `number` to cast to `Integer` instead of to a `Float` if

data/README_V3.md

@@ -445,6 +445,10 @@ With the various available options, validations on the value of the number can b
 * `multiple_of`
   The received number has to be a multiple of the given number for the validation to
   pass.
+* `max_precision`
+  Defines the maximum number of digits after the decimal point for `Float` and 
+  `BigDecimal` values. Must be a non-negative integer. When `nil` (default), no
+  precision validation is performed. Trailing zeros are ignored in the validation.
 * `cast_str`
   When set to `true`, this node also accepts strings that can be casted to a number, e.g.
   the values `'0.1'` or `'3.1415'`. Please note that you can only validate numbers which
@@ -483,6 +487,21 @@ schema.validate!(nil)         # => nil
 schema.validate!('')          # => nil
 ```
 
+With `max_precision`:
+
+```ruby
+# Validates that the input is a number with maximum 2 decimal places
+schema = Schemacop::Schema3.new(:number, max_precision: 2)
+schema.validate!(42)                   # => 42
+schema.validate!(42.5)                 # => 42.5
+schema.validate!(42.52)                # => 42.52
+schema.validate!(42.523)               # => Schemacop::Exceptions::ValidationError: /: Value must have a maximum precision of 2 digits after the decimal point.
+schema.validate!(BigDecimal('3.14'))   # => 0.314e1
+schema.validate!(BigDecimal('3.141'))  # => Schemacop::Exceptions::ValidationError: /: Value must have a maximum precision of 2 digits after the decimal point.
+schema.validate!(BigDecimal('3.140'))  # => 0.314e1 (trailing zeros are ignored)
+schema.validate!(1r)                   # => (1/1) (rational numbers are not affected)
+```
+
 Please note, that `nil` and blank strings are treated equally when using the `cast_str` option,
 and validating a blank string will return `nil`.
 If you need a value, use the `required` option:

data/VERSION

@@ -1 +1 @@
-3.0.34
+3.0.35

data/lib/schemacop/v3/numeric_node.rb

@@ -8,6 +8,7 @@ module Schemacop
         multiple_of
         exclusive_minimum
         exclusive_maximum
+        max_precision
       ].freeze
 
       def self.allowed_options
@@ -58,12 +59,39 @@ module Schemacop
         if options[:multiple_of] && !compare_float((super_data % options[:multiple_of]), 0.0)
           result.error "Value must be a multiple of #{options[:multiple_of]}."
         end
+
+        # Validate max precision #
+        if options[:max_precision] && (super_data.is_a?(Float) || super_data.is_a?(BigDecimal))
+          # Convert to string and check decimal places
+          str = super_data.to_s
+          # For BigDecimal, remove the trailing '0' from the scientific notation if present
+          str = str.sub(/\.0e[+-]?\d+\z/, '.0') if super_data.is_a?(BigDecimal)
+
+          if (match = str.match(/\.(\d+)$/))
+            # Remove trailing zeros for more accurate precision check
+            decimal_part = match[1].sub(/0+\z/, '')
+            decimal_places = decimal_part.empty? ? 0 : decimal_part.length
+            if decimal_places > options[:max_precision]
+              result.error "Value must have a maximum precision of #{options[:max_precision]} digits after the decimal point."
+            end
+          end
+        end
       end
 
       def validate_self
         # Check that the options have the correct type
         ATTRIBUTES.each do |attribute|
           next if options[attribute].nil?
+
+          # Special handling for max_precision - must be an integer
+          if attribute == :max_precision
+            unless options[attribute].is_a?(Integer) && options[attribute] >= 0
+              fail 'Option "max_precision" must be a non-negative integer.'
+            end
+
+            next
+          end
+
           next unless allowed_types.keys.none? { |c| options[attribute].send(type_assertion_method, c) }
 
           collection = allowed_types.values.map { |t| "\"#{t}\"" }.uniq.sort.join(' or ')

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 3.0.34 ruby lib
+# stub: schemacop 3.0.35 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.34".freeze
+  s.version = "3.0.35".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2025-05-27"
+  s.date = "2025-07-31"
   s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "README_V2.md".freeze, "README_V3.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "lib/schemacop.rb".freeze, "lib/schemacop/base_schema.rb".freeze, "lib/schemacop/exceptions.rb".freeze, "lib/schemacop/railtie.rb".freeze, "lib/schemacop/schema.rb".freeze, "lib/schemacop/schema2.rb".freeze, "lib/schemacop/schema3.rb".freeze, "lib/schemacop/scoped_env.rb".freeze, "lib/schemacop/v2.rb".freeze, "lib/schemacop/v2/caster.rb".freeze, "lib/schemacop/v2/collector.rb".freeze, "lib/schemacop/v2/dupper.rb".freeze, "lib/schemacop/v2/field_node.rb".freeze, "lib/schemacop/v2/node.rb".freeze, "lib/schemacop/v2/node_resolver.rb".freeze, "lib/schemacop/v2/node_supporting_field.rb".freeze, "lib/schemacop/v2/node_supporting_type.rb".freeze, "lib/schemacop/v2/node_with_block.rb".freeze, "lib/schemacop/v2/validator/array_validator.rb".freeze, "lib/schemacop/v2/validator/boolean_validator.rb".freeze, "lib/schemacop/v2/validator/float_validator.rb".freeze, "lib/schemacop/v2/validator/hash_validator.rb".freeze, "lib/schemacop/v2/validator/integer_validator.rb".freeze, "lib/schemacop/v2/validator/nil_validator.rb".freeze, "lib/schemacop/v2/validator/number_validator.rb".freeze, "lib/schemacop/v2/validator/object_validator.rb".freeze, "lib/schemacop/v2/validator/string_validator.rb".freeze, "lib/schemacop/v2/validator/symbol_validator.rb".freeze, "lib/schemacop/v3.rb".freeze, "lib/schemacop/v3/all_of_node.rb".freeze, "lib/schemacop/v3/any_of_node.rb".freeze, "lib/schemacop/v3/array_node.rb".freeze, "lib/schemacop/v3/boolean_node.rb".freeze, "lib/schemacop/v3/combination_node.rb".freeze, "lib/schemacop/v3/context.rb".freeze, "lib/schemacop/v3/dsl_scope.rb".freeze, "lib/schemacop/v3/global_context.rb".freeze, "lib/schemacop/v3/hash_node.rb".freeze, "lib/schemacop/v3/integer_node.rb".freeze, "lib/schemacop/v3/is_not_node.rb".freeze, "lib/schemacop/v3/node.rb".freeze, "lib/schemacop/v3/node_registry.rb".freeze, "lib/schemacop/v3/number_node.rb".freeze, "lib/schemacop/v3/numeric_node.rb".freeze, "lib/schemacop/v3/object_node.rb".freeze, "lib/schemacop/v3/one_of_node.rb".freeze, "lib/schemacop/v3/reference_node.rb".freeze, "lib/schemacop/v3/result.rb".freeze, "lib/schemacop/v3/string_node.rb".freeze, "lib/schemacop/v3/symbol_node.rb".freeze, "schemacop.gemspec".freeze, "test/lib/test_helper.rb".freeze, "test/schemas/nested/group.rb".freeze, "test/schemas/user.rb".freeze, "test/unit/schemacop/v2/casting_test.rb".freeze, "test/unit/schemacop/v2/collector_test.rb".freeze, "test/unit/schemacop/v2/custom_check_test.rb".freeze, "test/unit/schemacop/v2/custom_if_test.rb".freeze, "test/unit/schemacop/v2/defaults_test.rb".freeze, "test/unit/schemacop/v2/empty_test.rb".freeze, "test/unit/schemacop/v2/nil_dis_allow_test.rb".freeze, "test/unit/schemacop/v2/node_resolver_test.rb".freeze, "test/unit/schemacop/v2/short_forms_test.rb".freeze, "test/unit/schemacop/v2/types_test.rb".freeze, "test/unit/schemacop/v2/validator_array_test.rb".freeze, "test/unit/schemacop/v2/validator_boolean_test.rb".freeze, "test/unit/schemacop/v2/validator_float_test.rb".freeze, "test/unit/schemacop/v2/validator_hash_test.rb".freeze, "test/unit/schemacop/v2/validator_integer_test.rb".freeze, "test/unit/schemacop/v2/validator_nil_test.rb".freeze, "test/unit/schemacop/v2/validator_number_test.rb".freeze, "test/unit/schemacop/v2/validator_object_test.rb".freeze, "test/unit/schemacop/v2/validator_string_test.rb".freeze, "test/unit/schemacop/v2/validator_symbol_test.rb".freeze, "test/unit/schemacop/v3/all_of_node_test.rb".freeze, "test/unit/schemacop/v3/any_of_node_test.rb".freeze, "test/unit/schemacop/v3/array_node_test.rb".freeze, "test/unit/schemacop/v3/boolean_node_test.rb".freeze, "test/unit/schemacop/v3/global_context_test.rb".freeze, "test/unit/schemacop/v3/hash_node_test.rb".freeze, "test/unit/schemacop/v3/integer_node_test.rb".freeze, "test/unit/schemacop/v3/is_not_node_test.rb".freeze, "test/unit/schemacop/v3/node_test.rb".freeze, "test/unit/schemacop/v3/number_node_test.rb".freeze, "test/unit/schemacop/v3/object_node_test.rb".freeze, "test/unit/schemacop/v3/one_of_node_test.rb".freeze, "test/unit/schemacop/v3/reference_node_test.rb".freeze, "test/unit/schemacop/v3/string_node_test.rb".freeze, "test/unit/schemacop/v3/symbol_node_test.rb".freeze]
   s.homepage = "https://github.com/sitrox/schemacop".freeze
   s.licenses = ["MIT".freeze]

data/test/unit/schemacop/v3/number_node_test.rb

@@ -193,6 +193,75 @@ module Schemacop
         end
       end
 
+      def test_max_precision
+        schema :number, max_precision: 2
+
+        assert_json(
+          type:         :number,
+          maxPrecision: 2
+        )
+
+        # Valid cases
+        assert_validation(42)          # Integer
+        assert_validation(3.14)        # 2 decimal places
+        assert_validation(3.1)         # 1 decimal place
+        assert_validation(3.0)         # 0 decimal places
+        assert_validation(0.12)        # 2 decimal places
+        assert_validation(1r)          # Rational should not be affected
+
+        # BigDecimal valid cases
+        assert_validation(BigDecimal('3.14'))     # 2 decimal places
+        assert_validation(BigDecimal('3.1'))      # 1 decimal place
+        assert_validation(BigDecimal('3.0'))      # 0 decimal places (with trailing zero)
+        assert_validation(BigDecimal('3'))        # 0 decimal places
+        assert_validation(BigDecimal('3.00'))     # trailing zeros should be ignored
+
+        # Invalid cases - Float
+        assert_validation(3.141) do
+          error '/', 'Value must have a maximum precision of 2 digits after the decimal point.'
+        end
+
+        assert_validation(0.123) do
+          error '/', 'Value must have a maximum precision of 2 digits after the decimal point.'
+        end
+
+        assert_validation(123.456789) do
+          error '/', 'Value must have a maximum precision of 2 digits after the decimal point.'
+        end
+
+        # Invalid cases - BigDecimal
+        assert_validation(BigDecimal('3.141')) do
+          error '/', 'Value must have a maximum precision of 2 digits after the decimal point.'
+        end
+
+        assert_validation(BigDecimal('0.123')) do
+          error '/', 'Value must have a maximum precision of 2 digits after the decimal point.'
+        end
+
+        # Test with max_precision: 0
+        schema :number, max_precision: 0
+
+        assert_json(
+          type:         :number,
+          maxPrecision: 0
+        )
+
+        assert_validation(42)
+        assert_validation(3.0)
+        assert_validation(0)
+        assert_validation(BigDecimal('3'))
+        assert_validation(BigDecimal('3.0'))
+        assert_validation(BigDecimal('3.00'))
+
+        assert_validation(3.1) do
+          error '/', 'Value must have a maximum precision of 0 digits after the decimal point.'
+        end
+
+        assert_validation(BigDecimal('3.1')) do
+          error '/', 'Value must have a maximum precision of 0 digits after the decimal point.'
+        end
+      end
+
       # Helper function that checks for all the options if the option is
       # an allowed class or something else, in which case it needs to raise
       def validate_self_should_error(value_to_check)
@@ -239,6 +308,21 @@ module Schemacop
           schema :number, multiple_of: 0
         end
 
+        assert_raises_with_message Exceptions::InvalidSchemaError,
+                                   'Option "max_precision" must be a non-negative integer.' do
+          schema :number, max_precision: -1
+        end
+
+        assert_raises_with_message Exceptions::InvalidSchemaError,
+                                   'Option "max_precision" must be a non-negative integer.' do
+          schema :number, max_precision: 2.5
+        end
+
+        assert_raises_with_message Exceptions::InvalidSchemaError,
+                                   'Option "max_precision" must be a non-negative integer.' do
+          schema :number, max_precision: '2'
+        end
+
         validate_self_should_error(1 + 0i) # Complex
         validate_self_should_error(Object.new)
         validate_self_should_error(true)
@@ -310,6 +394,33 @@ module Schemacop
                     })
       end
 
+      def test_combined_validations_with_max_precision
+        schema :number, minimum: 0, maximum: 100, max_precision: 1
+
+        assert_json(
+          type:         :number,
+          minimum:      0,
+          maximum:      100,
+          maxPrecision: 1
+        )
+
+        assert_validation(50.5)
+        assert_validation(0.1)
+        assert_validation(100.0)
+
+        assert_validation(50.55) do
+          error '/', 'Value must have a maximum precision of 1 digits after the decimal point.'
+        end
+
+        assert_validation(-0.1) do
+          error '/', 'Value must have a minimum of 0.'
+        end
+
+        assert_validation(100.1) do
+          error '/', 'Value must have a maximum of 100.'
+        end
+      end
+
       def test_cast_str
         schema :number, cast_str: true, minimum: 0.0, maximum: 50r, multiple_of: BigDecimal('0.5')
 

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 3.0.34
+  version: 3.0.35
 platform: ruby
 authors:
 - Sitrox
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-27 00:00:00.000000000 Z
+date: 2025-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,6 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.4
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -148,6 +151,7 @@ homepage: https://github.com/sitrox/schemacop
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,7 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: Schemacop validates ruby structures consisting of nested hashes and arrays
   against simple schema definitions.