schemacop 3.0.10 → 3.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8700be126ea3aced42828ce418ad665095584ba0e217eebb0cf2e42faf5b4aef
-  data.tar.gz: 9774973e128d64f02a06e84cfa19990b0a7b0890cf57d4fb94c0f5058337dd20
+  metadata.gz: 40958dccae4c661f133f181907cc729c0002ca02702a6675c1beb1c90fed425e
+  data.tar.gz: 4ef5dcf205bd5f5cc8203867e95d07ff5a56a8c4654f3eac89e90596cb9a2e39
 SHA512:
-  metadata.gz: 0cdd515a0d47c7d707b8418fa5f0c7e6e73375ccb28bd2552b8c5f960e0279c75fb3a89c99b4ff677069c7a75e3d2f2376645d720d0d65980688602af09e4d28
-  data.tar.gz: 27cb5b5b8c4c8e14601c907c443d4fd904457ad0762c31af26aabf7d75febbf49459555e19665a1e56674b05601b4a223ccc18cb12fcebf9fddd526c3ec37442
+  metadata.gz: 1af517385c88340f64067895363b6e79d2ce15e00415ef5d0110200706b2e264701e6a0eeac9332e2ea8d9c5967989e8e05a9e311291a1e942d1effc5cc15219
+  data.tar.gz: c773bd33014ae3a8ccb4f1cd22c2066b375de678fdde702d2d95dcbc78880bd6d19940bb06b8052b06f955bc740834b7761f5c389d21bec56250ee18a4680ce6

data/.releaser_config

@@ -1,4 +1,4 @@
 version_file: VERSION
 always_from_master: true
 gem_style: github
-ruby_command: ruby -S
+ruby_command: ruby -S

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 3.0.11 (2021-03-26)
+
+* Treat blank string as nil when using `cast_str` option
+
 ## 3.0.10 (2021-03-19)
 
 * If wrong type is given, report class of wrong type in error message

data/README_V3.md

@@ -317,7 +317,7 @@ integer can be done.
 * `cast_str`
   When set to `true`, this node also accepts strings that can be casted to an integer, e.g.
   the values `'-5'` or `'42'`. Please note that you can only validate numbers which
-  are in the `Integer` format.
+  are in the `Integer` format. Blank strings will be treated equally as `nil`.
 
 #### Examples
 
@@ -346,6 +346,19 @@ schema.validate!('102')           # => Schemacop::Exceptions::ValidationError: /
 schema.validate!('42.1')          # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
 schema.validate!('4r')            # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
 schema.validate!('(4 + 0i)')      # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
+schema.validate!(nil)             # => nil
+schema.validate!('')              # => nil
+```
+
+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:
+
+```ruby
+schema = Schemacop::Schema3.new(:integer, minimum: 0, maximum: 100, multiple_of: 2, cast_str: true, required: true)
+schema.validate!('42')  # => 42
+schema.validate!(nil)   # => Schemacop::Exceptions::ValidationError: /: Value must be given.
+schema.validate!('')    # => Schemacop::Exceptions::ValidationError: /: Value must be given.
 ```
 
 ### Number
@@ -386,7 +399,7 @@ With the various available options, validations on the value of the number can b
   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
   are in the `Integer` or `Float` format, i.e. values like `'1.5r'` or `'(4 + 0i)'` will
-  not work.
+  not work. Blank strings will be treated equally as `nil`.
 
 #### Examples
 
@@ -414,6 +427,19 @@ schema.validate!('51')        # => Schemacop::Exceptions::ValidationError: /: Ma
 schema.validate!('42.5')      # => 42.5
 schema.validate!('1.5r')      # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
 schema.validate!('(4 + 0i)')  # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
+schema.validate!(nil)         # => nil
+schema.validate!('')          # => nil
+```
+
+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:
+
+```ruby
+schema = Schemacop::Schema3.new(:number, cast_str: true, minimum: 0.0, maximum: (50r), multiple_of: BigDecimal('0.5'), require: true)
+schema.validate!('42.5')  # => 42.5
+schema.validate!(nil)     # => Schemacop::Exceptions::ValidationError: /: Value must be given.
+schema.validate!('')      # => Schemacop::Exceptions::ValidationError: /: Value must be given.
 ```
 
 ### Symbol
@@ -426,7 +452,7 @@ The symbol type is used to validate elements for the Ruby `Symbol` class.
 #### Options
 
 * `cast_str`
-  When set to `true`, this node also accepts strings that can be casted to a symbol.
+  When set to `true`, this node also accepts strings that can be casted to a symbol. Blank strings will be treated equally as `nil`.
 
 #### Examples
 
@@ -450,6 +476,19 @@ schema.validate!('foo')    # => :foo
 schema.validate!('123')    # => :"123"
 schema.validate!('false')  # => :false
 schema.validate!(':false') # => :":false"
+schema.validate!(nil)      # => nil
+schema.validate!('')       # => nil
+```
+
+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:
+
+```ruby
+schema = Schemacop::Schema3.new(:symbol, cast_str: true, required: true)
+schema.validate!('foo')   # => :foo
+schema.validate!(nil)     # => Schemacop::Exceptions::ValidationError: /: Value must be given.
+schema.validate!('')      # => Schemacop::Exceptions::ValidationError: /: Value must be given.
 ```
 
 ### Boolean
@@ -463,7 +502,7 @@ The boolean type is used to validate Ruby booleans, i.e. the `TrueClass` and `Fa
 
 * `cast_str`
   When set to `true`, this node also accepts strings that can be casted to a boolean, i.e.
-  the values `'true'` and `'false'`
+  the values `'true'` and `'false'`. Blank strings will be treated equally as `nil`.
 
 #### Examples
 
@@ -486,6 +525,19 @@ schema.validate!(false)   # => false
 schema.validate!(:false)  # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
 schema.validate!('false') # => false
 schema.validate!(1234)    # => Schemacop::Exceptions::ValidationError: /: Matches 0 definitions but should match exactly 1.
+schema.validate!(nil)     # => nil
+schema.validate!('')      # => nil
+```
+
+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:
+
+```ruby
+schema = Schemacop::Schema3.new(:boolean, cast_str: true, required: true)
+schema.validate!('false') # => false
+schema.validate!(nil)     # => Schemacop::Exceptions::ValidationError: /: Value must be given.
+schema.validate!('')      # => Schemacop::Exceptions::ValidationError: /: Value must be given.
 ```
 
 ### Array

data/VERSION

@@ -1 +1 @@
-3.0.10
+3.0.11

data/lib/schemacop/v3/node.rb

@@ -33,10 +33,11 @@ module Schemacop
         if options.delete(:cast_str)
           format = NodeRegistry.name(klass)
           one_of_options = {
-            required:    options.delete(:required),
-            name:        options.delete(:name),
-            as:          options.delete(:as),
-            description: options.delete(:description)
+            required:           options.delete(:required),
+            treat_blank_as_nil: true,
+            name:               options.delete(:name),
+            as:                 options.delete(:as),
+            description:        options.delete(:description)
           }
           node = create(:one_of, **one_of_options) do
             self.node node

data/lib/schemacop/v3/one_of_node.rb

@@ -5,8 +5,30 @@ module Schemacop
         :oneOf
       end
 
+      def self.allowed_options
+        super + %i[treat_blank_as_nil]
+      end
+
+      def cast(value)
+        item = match(value)
+
+        unless item
+          if options[:treat_blank_as_nil] && value.blank? && !value.is_a?(FalseClass)
+            return nil
+          else
+            return value
+          end
+        end
+
+        return item.cast(value)
+      end
+
       def _validate(data, result:)
-        super_data = super
+        if options[:treat_blank_as_nil] && data.blank? && !data.is_a?(FalseClass)
+          data = nil
+        end
+
+        super_data = super(data, result: result)
         return if super_data.nil?
 
         matches = matches(super_data)

data/schemacop.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: schemacop 3.0.10 ruby lib
+# stub: schemacop 3.0.11 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "schemacop".freeze
-  s.version = "3.0.10"
+  s.version = "3.0.11"
 
   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 = "2021-03-19"
+  s.date = "2021-03-26"
   s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.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/boolean_node_test.rb

@@ -152,6 +152,36 @@ module Schemacop
         assert_validation('1') do
           error '/', 'Matches 0 definitions but should match exactly 1.'
         end
+
+        # Nil can be validated, as it's not required
+        assert_validation(nil)
+
+        assert_validation('')
+
+        assert_cast('', nil)
+        assert_cast(nil, nil)
+      end
+
+      def test_cast_str_required
+        schema :boolean, cast_str: true, required: true
+
+        assert_cast('true', true)
+        assert_cast('false', false)
+
+        assert_cast(true, true)
+        assert_cast(false, false)
+
+        assert_validation('1') do
+          error '/', 'Matches 0 definitions but should match exactly 1.'
+        end
+
+        assert_validation(nil) do
+          error '/', 'Value must be given.'
+        end
+
+        assert_validation('') do
+          error '/', 'Value must be given.'
+        end
       end
     end
   end

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

@@ -965,6 +965,46 @@ module Schemacop
         assert_cast({ foo: 42, bar: 13 }, { bar: 42 }.with_indifferent_access)
         assert_cast({ bar: 13, foo: 42 }, { bar: 42 }.with_indifferent_access)
       end
+
+      def test_cast_str_required
+        schema :hash do
+          boo! :active, cast_str: true
+          int! :id, cast_str: true
+        end
+
+        assert_validation({ active: true, id: 1 })
+        assert_validation({ active: 'true', id: '1' })
+
+        assert_validation({}) do
+          error '/active', 'Value must be given.'
+          error '/id', 'Value must be given.'
+        end
+
+        assert_cast({ active: 'true', id: '1' }, { active: true, id: 1 }.with_indifferent_access)
+
+        assert_validation({ active: '', id: '' }) do
+          error '/active', 'Value must be given.'
+          error '/id', 'Value must be given.'
+        end
+      end
+
+      def test_cast_str_optional
+        schema :hash do
+          boo? :active, cast_str: true
+          int? :id, cast_str: true
+        end
+
+        assert_validation({ active: true, id: 1 })
+        assert_validation({ active: 'true', id: '1' })
+
+        assert_cast({ active: 'true', id: '1' }, { active: true, id: 1 }.with_indifferent_access)
+
+        assert_validation({})
+        assert_validation({ active: nil, id: nil })
+
+        assert_validation({ active: '', id: '' })
+        assert_cast({ active: '', id: '' }, { active: nil, id: nil }.with_indifferent_access)
+      end
     end
   end
 end

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

@@ -339,6 +339,28 @@ module Schemacop
         assert_cast('1', 1)
         assert_cast(1, 1)
 
+        assert_cast(nil, nil)
+        assert_cast('', nil)
+
+        assert_validation('true') do
+          error '/', 'Matches 0 definitions but should match exactly 1.'
+        end
+      end
+
+      def test_cast_str_required
+        schema :integer, cast_str: true, required: true
+
+        assert_cast('1', 1)
+        assert_cast(1, 1)
+
+        assert_validation(nil) do
+          error '/', 'Value must be given.'
+        end
+
+        assert_validation('') do
+          error '/', 'Value must be given.'
+        end
+
         assert_validation('true') do
           error '/', 'Matches 0 definitions but should match exactly 1.'
         end

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

@@ -93,6 +93,10 @@ module Schemacop
           error '/', 'Value must be given.'
         end
 
+        assert_validation('') do
+          error '/', 'Value must be given.'
+        end
+
         assert_validation('5')
         assert_validation('5.3') do
           error '/', 'Matches 0 definitions but should match exactly 1.'
@@ -156,6 +160,12 @@ module Schemacop
         assert_validation([nil]) do
           error '/[0]', 'Value must be given.'
         end
+        assert_validation(['']) do
+          error '/[0]', 'Value must be given.'
+        end
+        assert_validation([]) do
+          error '/', 'Array has 0 items but must have exactly 1.'
+        end
       end
 
       def test_not_support_block

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

@@ -308,6 +308,9 @@ module Schemacop
         assert_cast('1', 1)
         assert_cast(1, 1)
 
+        assert_validation(nil)
+        assert_validation('')
+
         assert_cast('1.0', 1.0)
         assert_cast(1.0, 1.0)
 

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

@@ -182,6 +182,18 @@ module Schemacop
           schema :one_of
         end
       end
+
+      def test_treat_blank_as_nil
+        schema :one_of, treat_blank_as_nil: true do
+          boo
+          str format: :boolean
+        end
+
+        assert_validation(nil)
+        assert_validation('')
+        assert_validation('true')
+        assert_validation(true)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schemacop
 version: !ruby/object:Gem::Version
-  version: 3.0.10
+  version: 3.0.11
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport