hash_validator 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3f14e426a06042aa90d83cd7addfc6453f759e4
-  data.tar.gz: 7fd7178c50fc0491bf276696b2c42b1cca24d3a7
+SHA256:
+  metadata.gz: ddc15dcd023f389504598ac3895671ba65e79b8cc120af48db730c02552919ab
+  data.tar.gz: e968308c55c754b88d4a0fb969e75832576f06429f93e29e0b354cf4c1fbd632
 SHA512:
-  metadata.gz: 44fc5928ebd086077dac64d7a53e91a3c14b144e9831b07389aa5b086ffdd63f6271659ae3fc3bc695e73d6d06767077147e48748ddcf32bb149b82aa1fdbe97
-  data.tar.gz: 2589013673495b01ac126c5a250528059e69c5f0610003d9db0ab5c852d3b837a51efd2eb18d22f3b81058a2b07acf292db0c199ad9da637a363ddc5ff171fc1
+  metadata.gz: 8251c3d9506f21e5f4fe6c5461ac45002b3bb48227619744734ccb7dd1a6c9ac7e8f443317f94845f93faf31b65695235d083f9a691b2dff7c6c26a9fef7cf79
+  data.tar.gz: 972582fdda827e6a086956d38ef908dfff7fbfbe6e0d0c50dd9170d61965c6ee009ef60178aa384288361dc0144f513a1093c12406c2881db108d5d1ec585949

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.5.0
+  - 2.6.3

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/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.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'

data/lib/hash_validator/validators/class_validator.rb

@@ -0,0 +1,21 @@
+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 presence_error_message
+    'value from list required'
+  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/version.rb

@@ -1,3 +1,3 @@
 module HashValidator
-  VERSION = '0.8.0'
+  VERSION = '1.0.0'
 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.0.0
 platform: ruby
 authors:
 - James Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2019-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,6 +90,7 @@ files:
 - lib/hash_validator/validators.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
@@ -107,6 +108,7 @@ files:
 - spec/spec_helper.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
@@ -137,8 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby library to validate hashes (Hash) against user-defined requirements
@@ -148,6 +149,7 @@ test_files:
 - spec/spec_helper.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