hash_validator 0.8.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3f14e426a06042aa90d83cd7addfc6453f759e4
-  data.tar.gz: 7fd7178c50fc0491bf276696b2c42b1cca24d3a7
+SHA256:
+  metadata.gz: 204abb59a31b60ea1e62d18d370ff1140f6190e83aa35a989f771fcd4986d5d8
+  data.tar.gz: 8369e8089adfe5d612bca0596d95594816fc8923216a58a50302ad8cc11a1c51
 SHA512:
-  metadata.gz: 44fc5928ebd086077dac64d7a53e91a3c14b144e9831b07389aa5b086ffdd63f6271659ae3fc3bc695e73d6d06767077147e48748ddcf32bb149b82aa1fdbe97
-  data.tar.gz: 2589013673495b01ac126c5a250528059e69c5f0610003d9db0ab5c852d3b837a51efd2eb18d22f3b81058a2b07acf292db0c199ad9da637a363ddc5ff171fc1
+  metadata.gz: 0663b18d2799515a852b71ef70c69f8153d80c521afbb5fd88904ce8b6d3502fa903c4cb598251eed41e0a287fd69915de535ab49f71c11b04827073625b2e37
+  data.tar.gz: 23d774f32abb66ad78a6bf63e26dc7533935884792146f6d29cfff50adf7517a8fe5d8d3b20922c4f23c45767a87de42dba2ca9cc56b14477d1302ec5f63ba62

data/.ruby-version

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

data/.travis.yml

@@ -1,7 +1,5 @@
 language: ruby
 rvm:
   - 2.0.0
-  - 2.1.0
-  - 2.2.0
-  - 2.3.0
-  - 2.4.0
+  - 2.6.6
+  - 2.7.2

data/README.md

@@ -1,10 +1,9 @@
 # Hash Validator
 
-[![Gem](https://img.shields.io/gem/v/hash_validator.svg)]()
+[![Gem](https://img.shields.io/gem/v/hash_validator.svg)](https://rubygems.org/gems/hash_validator)
 [![Travis](https://travis-ci.org/jamesbrooks/hash_validator.svg)](https://travis-ci.org/jamesbrooks/hash_validator)
 [![Coveralls](https://img.shields.io/coveralls/jamesbrooks/hash_validator.svg)](https://coveralls.io/r/jamesbrooks/hash_validator)
-[![Code Climate](https://img.shields.io/codeclimate/github/JamesBrooks/hash_validator.svg)](https://codeclimate.com/github/JamesBrooks/hash_validator)
-[![Gemnasium](https://img.shields.io/gemnasium/jamesbrooks/hash_validator.svg)](https://gemnasium.com/github.com/JamesBrooks/hash_validator)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dc6edc1b240860c5f5d9/maintainability)](https://codeclimate.com/github/JamesBrooks/hash_validator/maintainability)
 
 Ruby library to validate hashes (Hash) against user-defined requirements
 
@@ -28,7 +27,7 @@ Or install it yourself as:
 # Validations hash
 validations = {
   user: {
-    first_name: 'string',
+    first_name: String,
     last_name:  'string',
     age:        'numeric',
     likes:      'array'
@@ -80,6 +79,8 @@ Define a validation hash which will be used to validate. This has can be nested
 * `required`: just requires any value to be present for the designated key.
 * hashes are validates by nesting validations, or if just the presence of a hash is required `{}` can be used.
 
+On top of the pre-defined simple types, classes can be used directly (e.g. String) to validate the presence of a value of a desired class.
+
 Additional validations exist to validate beyond simple typing, such as:
 
 * An Enumerable instance: validates that the value is contained within the supplied enumerable.

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/base.rb

@@ -6,7 +6,7 @@ class HashValidator::Base
     self.errors      = {}
     self.hash        = hash
     self.validations = validations
-    
+
     validate
   end
 
@@ -18,12 +18,13 @@ class HashValidator::Base
     @strict = strict
     new(hash, validations)
   end
-  
+
   def self.strict?
     @strict
   end
-  
-  private
+
+
+private
   def validate
     HashValidator.validator_for(hash).validate(:base, self.hash, self.validations, self.errors)
     self.errors = errors[:base]

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

@@ -0,0 +1,17 @@
+class HashValidator::Validator::ClassValidator < HashValidator::Validator::Base
+  def initialize
+    super('_class')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+  end
+
+  def should_validate?(rhs)
+    rhs.is_a?(Class)
+  end
+
+  def validate(key, value, klass, errors)
+    unless value.is_a?(klass)
+      errors[key] = "#{klass} required"
+    end
+  end
+end
+
+HashValidator.append_validator(HashValidator::Validator::ClassValidator.new)

data/lib/hash_validator/validators.rb

@@ -25,6 +25,7 @@ end
 # Load validators
 require 'hash_validator/validators/base'
 require 'hash_validator/validators/simple_validator'
+require 'hash_validator/validators/class_validator'
 require 'hash_validator/validators/hash_validator'
 require 'hash_validator/validators/presence_validator'
 require 'hash_validator/validators/simple_type_validators'
@@ -36,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 = '0.8.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

data/spec/validators/class_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe 'Class validator' do
+  let(:errors) { Hash.new }
+
+  {
+    Array => {
+      valid:   [ [], [1], ['foo'], [1,['foo'],Time.now] ],
+      invalid: [ nil, '', 123, '123', Time.now, '[1]' ]
+    },
+    Complex => {
+      valid:   [ Complex(1), Complex(2, 3), Complex('2/3+3/4i'), 0.3.to_c ],
+      invalid: [ nil, '', 123, '123', Time.now, '[1]', [1], '2/3+3/4i', Rational(2, 3) ]
+    },
+    Float => {
+      valid:   [ 0.0, 1.1, 1.23, Float::INFINITY, Float::EPSILON ],
+      invalid: [ nil, '', 0, 123, '123', Time.now, '[1]', '2013-03-04' ]
+    },
+    Integer => {
+      valid:   [ 0, -1000000, 1000000 ],
+      invalid: [ nil, '', 1.1, '123', Time.now, '[1]', '2013-03-04' ]
+    },
+    Numeric => {
+      valid:   [ 0, 123, 123.45 ],
+      invalid: [ nil, '', '123', Time.now ]
+    },
+    Range => {
+      valid:   [ 0..10, 'a'..'z', 5..0 ],
+      invalid: [ nil, '', '123', Time.now ]
+    },
+    Rational => {
+      valid:   [ Rational(1), Rational(2, 3), 3.to_r ],
+      invalid: [ nil, '', 123, '123', Time.now, '[1]', [1], Complex(2, 3) ]
+    },
+    Regexp => {
+      valid:   [ /[a-z]+/, //, //i, Regexp.new('.*') ],
+      invalid: [ nil, '', 123, '123', Time.now, '.*' ]
+    },
+    String => {
+      valid:   [ '', 'Hello World', '12345' ],
+      invalid: [ nil, 12345, Time.now ]
+    },
+    Symbol => {
+      valid:   [ :foo, :'', 'bar'.to_sym ],
+      invalid: [ nil, '', 1.1, '123', Time.now, '[1]', '2013-03-04' ]
+    },
+    Time => {
+      valid:   [ Time.now ],
+      invalid: [ nil, '', 123, '123', "#{Time.now}" ]
+    }
+  }.each do |type, data|
+    describe type do
+      data[:valid].each do |value|
+        it "validates '#{value}' successful" do
+          validator = HashValidator.validate({ v: value }, { v: type })
+
+          expect(validator.valid?).to eq true
+          expect(validator.errors).to be_empty
+        end
+      end
+
+      data[:invalid].each do |value|
+        it "validates '#{value}' with failure" do
+          validator = HashValidator.validate({ v: value }, { v: type })
+
+          expect(validator.valid?).to eq false
+          expect(validator.errors).to eq({ v: "#{type} required" })
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.1.0
 platform: ruby
 authors:
 - James Brooks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-22 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,8 +89,10 @@ 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
 - lib/hash_validator/validators/email_validator.rb
 - lib/hash_validator/validators/enumerable_validator.rb
 - lib/hash_validator/validators/hash_validator.rb
@@ -105,8 +108,10 @@ 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
 - spec/validators/email_spec.rb
 - spec/validators/in_enumerable_spec.rb
 - spec/validators/lambda_spec.rb
@@ -122,7 +127,7 @@ homepage: https://github.com/JamesBrooks/hash_validator
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,17 +142,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-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
 - spec/validators/email_spec.rb
 - spec/validators/in_enumerable_spec.rb
 - spec/validators/lambda_spec.rb