hash_validator 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc15dcd023f389504598ac3895671ba65e79b8cc120af48db730c02552919ab
-  data.tar.gz: e968308c55c754b88d4a0fb969e75832576f06429f93e29e0b354cf4c1fbd632
+  metadata.gz: 204abb59a31b60ea1e62d18d370ff1140f6190e83aa35a989f771fcd4986d5d8
+  data.tar.gz: 8369e8089adfe5d612bca0596d95594816fc8923216a58a50302ad8cc11a1c51
 SHA512:
-  metadata.gz: 8251c3d9506f21e5f4fe6c5461ac45002b3bb48227619744734ccb7dd1a6c9ac7e8f443317f94845f93faf31b65695235d083f9a691b2dff7c6c26a9fef7cf79
-  data.tar.gz: 972582fdda827e6a086956d38ef908dfff7fbfbe6e0d0c50dd9170d61965c6ee009ef60178aa384288361dc0144f513a1093c12406c2881db108d5d1ec585949
+  metadata.gz: 0663b18d2799515a852b71ef70c69f8153d80c521afbb5fd88904ce8b6d3502fa903c4cb598251eed41e0a287fd69915de535ab49f71c11b04827073625b2e37
+  data.tar.gz: 23d774f32abb66ad78a6bf63e26dc7533935884792146f6d29cfff50adf7517a8fe5d8d3b20922c4f23c45767a87de42dba2ca9cc56b14477d1302ec5f63ba62

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.5.0
-  - 2.6.3
+  - 2.6.6
+  - 2.7.2

data/hash_validator.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'coveralls'
 end

data/lib/hash_validator/validators/array_validator.rb

@@ -0,0 +1,66 @@
+class HashValidator::Validator::ArrayValidator < HashValidator::Validator::Base
+  def initialize
+    super('__array__')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+  end
+
+  def should_validate?(rhs)
+    return false unless rhs.is_a?(Array)
+    return false unless rhs.size > 0
+    return false unless rhs[0] == :array
+
+    return true
+  end
+
+  def validate(key, value, specification, errors)
+    # the first item in specification is always ":array"
+    unless specification[0] == :array
+      errors[key] = "Wrong array specification. The #{:array} is expected as first item."
+      return
+    end
+
+    if specification.size > 2
+      errors[key] = "Wrong size of array specification. Allowed is one or two items."
+      return
+    end
+
+    unless value.is_a?(Array)
+      errors[key] = "#{Array} required"
+      return
+    end
+
+    # second item is optional
+    return if specification.size < 2
+
+    array_spec = specification[1]
+    return if array_spec.nil? # array specification is optional
+
+    if array_spec.is_a?(Numeric)
+      array_spec = { size: array_spec }
+    end
+
+    unless array_spec.is_a?(Hash)
+      errors[key] = "Second item of array specification must be #{Hash} or #{Numeric}."
+      return
+    end
+
+    return if array_spec.empty?
+
+    size_spec = array_spec[:size]
+    if size_spec.present?
+      unless value.size == size_spec
+        errors[key] = "The required size of array is #{size_spec} but is #{value.size}."
+        return
+      end
+    end
+
+    allowed_keys = [:size]
+    wrong_keys = array_spec.keys - allowed_keys
+
+    return if wrong_keys.size < 1
+
+    errors[key] = "Not supported specification for array: #{wrong_keys.sort.join(", ")}."
+    return
+  end
+end
+
+HashValidator.append_validator(HashValidator::Validator::ArrayValidator.new)

data/lib/hash_validator/validators/class_validator.rb

@@ -7,10 +7,6 @@ class HashValidator::Validator::ClassValidator < HashValidator::Validator::Base
     rhs.is_a?(Class)
   end
 
-  def presence_error_message
-    'value from list required'
-  end
-
   def validate(key, value, klass, errors)
     unless value.is_a?(klass)
       errors[key] = "#{klass} required"

data/lib/hash_validator/validators.rb

@@ -37,3 +37,4 @@ require 'hash_validator/validators/lambda_validator'
 require 'hash_validator/validators/optional_validator'
 require 'hash_validator/validators/many_validator'
 require 'hash_validator/validators/multiple_validator'
+require 'hash_validator/validators/array_validator'

data/lib/hash_validator/version.rb

@@ -1,3 +1,3 @@
 module HashValidator
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/validators/array_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe 'Array validator' do
+  let(:validator) { HashValidator::Validator::ArrayValidator.new }
+  let(:errors)    { Hash.new }
+
+  describe '#should_validate?' do
+    it 'should validate the array with first item ":array"' do
+      expect(validator.should_validate?([:array])).to eq true
+    end
+
+    it 'should validate the array with empty specification' do
+      expect(validator.should_validate?([:array, { }])).to eq true
+    end
+
+    it 'should validate the array with size specified to nil' do
+      expect(validator.should_validate?([:array, { size: nil }])).to eq true
+    end
+
+    it 'should validate the array with non-sense specification' do
+      expect(validator.should_validate?([:array, { blah_blah_blah: false }])).to eq true
+    end
+
+    it 'should not validate the empty array' do
+      expect(validator.should_validate?([])).to eq false
+    end
+
+    it 'should not validate the array with nil item' do
+      expect(validator.should_validate?([nil])).to eq false
+    end
+
+    it 'should not validate other names' do
+      expect(validator.should_validate?('string')).to eq false
+      expect(validator.should_validate?('array')).to eq false
+      expect(validator.should_validate?(nil)).to eq false
+    end
+  end
+
+  describe '#validate' do
+    it 'should validate an empty array with true' do
+      validator.validate(:key, [], [:array], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with nil spec' do
+      validator.validate(:key, [], [:array, nil], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with empty spec' do
+      validator.validate(:key, [], [:array, { }], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with size spec = nil' do
+      validator.validate(:key, [], [:array, { size: nil }], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with size spec = 0' do
+      validator.validate(:key, [], [:array, { size: 0 }], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with spec = 0' do
+      validator.validate(:key, [], [:array, 0], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an empty array with spec = 0.0' do
+      validator.validate(:key, [], [:array, 0.0], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an array of one item with spec = 1' do
+      validator.validate(:key, [nil], [:array, 1], errors)
+
+      expect(errors).to be_empty
+    end
+
+    it 'should validate an array of five items with {size: 5.0}' do
+      my_array = ["one", 2, nil, ["f", "o", "u", "r"], {five: 5}]
+      validator.validate(:key, my_array, [:array, {size: 5.0}], errors)
+
+      expect(errors).to be_empty
+    end
+
+    # >>> NOT >>>
+
+    it 'should not validate non array value' do
+      validator.validate(:key, "I'm not array", [:array], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Array required' })
+    end
+
+    it 'should not validate an empty array with size spec = 1' do
+      validator.validate(:key, [], [:array, { size: 1 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'The required size of array is 1 but is 0.' })
+    end
+
+    it 'should not validate an empty array with size spec = 1' do
+      validator.validate(:key, [], [:array, { size: 1 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'The required size of array is 1 but is 0.' })
+    end
+
+    it 'should not validate an empty array with spec = 1' do
+      validator.validate(:key, [], [:array, 1], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'The required size of array is 1 but is 0.' })
+    end
+
+    it 'should not validate an empty array with spec = "0" (string)' do
+      validator.validate(:key, [], [:array, "0"], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Second item of array specification must be Hash or Numeric.' })
+    end
+
+    it 'should not validate an empty array with spec = "1" (string)' do
+      validator.validate(:key, [], [:array, "1"], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Second item of array specification must be Hash or Numeric.' })
+    end
+
+    it 'should not validate an empty array with {min_size: 0} spec' do
+      validator.validate(:key, [], [:array, { min_size: 0 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Not supported specification for array: min_size.' })
+    end
+
+    it 'should not validate an empty array with {min_size: 0, max_size: 2} spec' do
+      validator.validate(:key, [], [:array, { min_size: 0, max_size: 2 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Not supported specification for array: max_size, min_size.' })
+    end
+
+    it 'should not validate an array of four items with {size: 3} spec' do
+      validator.validate(:key, [0, 1, 2, 3], [:array, { size: 3 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'The required size of array is 3 but is 4.' })
+    end
+
+    it 'should not validate an array of four items with {size: 5} spec' do
+      validator.validate(:key, [0, 1, 2, 3], [:array, { size: 5 }], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'The required size of array is 5 but is 4.' })
+    end
+
+    it 'should not validate an empty array with invalid specification' do
+      validator.validate(:key, [], [:blah], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Wrong array specification. The array is expected as first item.' })
+    end
+
+    it 'should not validate an empty array with to large specification' do
+      validator.validate(:key, [], [:array, 0, "overlaping item"], errors)
+
+      expect(errors).not_to be_empty
+      expect(errors).to eq({ key: 'Wrong size of array specification. Allowed is one or two items.' })
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - James Brooks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-18 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -88,6 +89,7 @@ files:
 - lib/hash_validator/validations/multiple.rb
 - lib/hash_validator/validations/optional.rb
 - lib/hash_validator/validators.rb
+- lib/hash_validator/validators/array_validator.rb
 - lib/hash_validator/validators/base.rb
 - lib/hash_validator/validators/boolean_validator.rb
 - lib/hash_validator/validators/class_validator.rb
@@ -106,6 +108,7 @@ files:
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
+- spec/validators/array_spec.rb
 - spec/validators/base_spec.rb
 - spec/validators/boolean_spec.rb
 - spec/validators/class_spec.rb
@@ -124,7 +127,7 @@ homepage: https://github.com/JamesBrooks/hash_validator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,14 +142,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Ruby library to validate hashes (Hash) against user-defined requirements
 test_files:
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
+- spec/validators/array_spec.rb
 - spec/validators/base_spec.rb
 - spec/validators/boolean_spec.rb
 - spec/validators/class_spec.rb