hash_validator 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a1492f217366ea561ca20646b123578e23a3d08
-  data.tar.gz: 9bfa7a9b44345a7bcca3837ee439b38db1f76bd7
+  metadata.gz: 1db341e997808db63ae406e44a49d51b1ca45287
+  data.tar.gz: b1d8af971d7c0fcdcdfb839bab7aec52092a4fc2
 SHA512:
-  metadata.gz: 5d4026acaac90a08173375923d6932b68d7151c2c1a6d3b7f5df82f2373111909d08b70f052a8bb4dd9010019480985ce90497296ef9630ada45b387f130bfe1
-  data.tar.gz: 3384677eaef109084a8d8089f21cb82c7a25d78ec5c4eb25554bcd26d8c451156328d64abcdfb5b330fad9849f4468632558fab69a2ab67b1a00a416d4d640cd
+  metadata.gz: 949b8a43860f1ec57f5fd3c23d0f18bb41dabf4615a215f636d6af7cbeb22cf69c78e20646bf6d4836ab38da28aaefe0e1fcd690e0df8867a3215a0b65b6e5a7
+  data.tar.gz: 61e7ca533f2b11c352218104382a8d2b04a1db4ac62f11cd4eefe8daab9c95b4bcf2b8eca5f559a54d7d8d7445ca40b8f632fd6625e4938beb0e8d29360c4fea

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/JamesBrooks/hash_validator.png)](https://travis-ci.org/JamesBrooks/hash_validator)
 [![Code Climate](https://codeclimate.com/github/JamesBrooks/hash_validator.png)](https://codeclimate.com/github/JamesBrooks/hash_validator)
 [![Gem Version](https://badge.fury.io/rb/hash_validator.png)](http://badge.fury.io/rb/hash_validator)
+[![Coverage Status](https://coveralls.io/repos/JamesBrooks/hash_validator/badge.png?branch=master)](https://coveralls.io/r/JamesBrooks/hash_validator)
 [![Dependency Status](https://gemnasium.com/JamesBrooks/hash_validator.png)](https://gemnasium.com/JamesBrooks/hash_validator)
 
 Ruby library to validate hashes (Hash) against user-defined requirements
@@ -67,6 +68,7 @@ Define a validation hash which will be used to validate. This has can be nested
 * `numeric`
 * `array`
 * `time`
+* `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.
 
 Example use-cases include Ruby APIs (I'm currently using it in a Rails API that I'm building for better error responses to developers).

data/hash_validator.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 2.13.0'
+  spec.add_development_dependency 'coveralls'
 end

data/lib/hash_validator/validators.rb

@@ -17,4 +17,5 @@ end
 # Load validators
 require 'hash_validator/validators/base'
 require 'hash_validator/validators/hash_validator'
+require 'hash_validator/validators/presence_validator'
 require 'hash_validator/validators/simple_type_validator'

data/lib/hash_validator/validators/hash_validator.rb

@@ -3,6 +3,10 @@ class HashValidator::Validator::HashValidator < HashValidator::Validator::Base
     'hash'
   end
 
+  def presence_error_message
+    "#{name} required"
+  end
+
   def should_validate?(rhs)
     rhs.is_a?(Hash)
   end
@@ -10,7 +14,7 @@ class HashValidator::Validator::HashValidator < HashValidator::Validator::Base
   def validate(key, value, validations, errors)
     # Validate hash
     unless value.is_a?(Hash)
-      errors[name] = 'should be hash'
+      errors[key] = presence_error_message
       return
     end
 
@@ -22,7 +26,7 @@ class HashValidator::Validator::HashValidator < HashValidator::Validator::Base
 
       # Key presence
       unless value[v_key]
-        errors[v_key] = "#{validator.name} required"
+        errors[v_key] = validator.presence_error_message
         next
       end
 

data/lib/hash_validator/validators/presence_validator.rb

@@ -0,0 +1,22 @@
+class HashValidator::Validator::PresenceValidator < HashValidator::Validator::Base
+  def name
+    'required'
+  end
+
+  def presence_error_message
+    'is required'
+  end
+
+  def should_validate?(rhs)
+    rhs == name
+  end
+
+  def validate(key, value, validations, errors)
+    unless value
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+
+HashValidator.append_validator(HashValidator::Validator::PresenceValidator.new)

data/lib/hash_validator/validators/simple_type_validator.rb

@@ -7,13 +7,17 @@ class HashValidator::Validator::SimpleTypeValidator < HashValidator::Validator::
     self.klass = klass
   end
 
+  def presence_error_message
+    "#{name} required"
+  end
+
   def should_validate?(rhs)
     rhs == self.name
   end
 
   def validate(key, value, validations, errors)
     unless value.is_a?(klass)
-      errors[key] = "should be #{name}"
+      errors[key] = presence_error_message
     end
   end
 end

data/lib/hash_validator/version.rb

@@ -1,3 +1,3 @@
 module HashValidator
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/spec/hash_validator_spec.rb

@@ -4,12 +4,30 @@ describe HashValidator do
   describe 'individual type validations' do
     it 'should validate hash' do
       validate({ v: {} }, { v: {} }).valid?.should be_true
+
       validate({ v: '' }, { v: {} }).valid?.should be_false
+      validate({ v: '' }, { v: {} }).errors.should eq({ v: 'hash required' })
+    end
+
+    it 'should validate presence' do
+      validate({ v: 'test' }, { v: 'required' }).valid?.should be_true
+      validate({ v: 1234   }, { v: 'required' }).valid?.should be_true
+
+      validate({ v: nil    }, { v: 'required' }).valid?.should be_false
+      validate({ v: nil    }, { v: 'required' }).errors.should eq({ v: 'is required' })
+
+      validate({ x: 'test' }, { v: 'required' }).valid?.should be_false
+      validate({ x: 'test' }, { v: 'required' }).errors.should eq({ v: 'is required' })
+
+      validate({ x: 1234   }, { v: 'required' }).valid?.should be_false
+      validate({ x: 1234   }, { v: 'required' }).errors.should eq({ v: 'is required' })
     end
 
     it 'should validate string' do
       validate({ v: 'test' }, { v: 'string' }).valid?.should be_true
+
       validate({ v: 123456 }, { v: 'string' }).valid?.should be_false
+      validate({ v: 123456 }, { v: 'string' }).errors.should eq({ v: 'string required' })
     end
 
     it 'should validate numeric' do
@@ -114,7 +132,7 @@ describe HashValidator do
       it 'should not validate a simple hash 2' do
         v = validate(invalid_simple_hash, validations)
         v.valid?.should be_false
-        v.errors.should eq({ bar: 'should be string' })
+        v.errors.should eq({ bar: 'string required' })
       end
 
       it 'should validate a complex hash' do
@@ -126,12 +144,12 @@ describe HashValidator do
       it 'should not validate a complex hash 2' do
         v = validate(invalid_complex_hash, validations)
         v.valid?.should be_false
-        v.errors.should eq({ bar: 'should be string' })
+        v.errors.should eq({ bar: 'string required' })
       end
     end
 
     describe 'nested validations' do
-      let(:validations) {{ foo: 'numeric', bar: 'string', user: { first_name: 'string', age: 'numeric', likes: 'array' } }}
+      let(:validations) {{ foo: 'numeric', bar: 'string', user: { first_name: 'string', age: 'required', likes: 'array' } }}
 
       it 'should validate a complex hash' do
         v = validate(complex_hash, validations)
@@ -142,7 +160,7 @@ describe HashValidator do
       it 'should not validate a complex hash 2' do
         v = validate(invalid_complex_hash, validations)
         v.valid?.should be_false
-        v.errors.should eq({ bar: 'should be string', user: { age: 'numeric required', likes: 'should be array' } })
+        v.errors.should eq({ bar: 'string required', user: { age: 'is required', likes: 'array required' } })
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'rubygems'
 require 'bundler/setup'
 require 'hash_validator'

data/spec/validators/base_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe HashValidator::Validator::Base do
+  let(:validator) { HashValidator::Validator::Base.new }
+
+  describe '#should_validate?' do
+    it 'throws an exception' do
+      expect { validator.should_validate?('name') }.to raise_error(StandardError, 'should_validate? should not be called directly on BaseValidator')
+    end
+  end
+
+  describe '#validate' do
+    it 'throws an exception' do
+      expect { validator.validate('key', 'value', {}, {}) }.to raise_error(StandardError, 'validate should not be called directly on BaseValidator')
+    end
+  end
+end

data/spec/validators/presence_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe HashValidator::Validator::Base do
+  let(:validator) { HashValidator::Validator::PresenceValidator.new }
+  let(:errors)    { Hash.new }
+
+  describe '#should_validate?' do
+    it 'should validate the name "required"' do
+      validator.should_validate?('required').should be_true
+    end
+
+    it 'should not validate other names' do
+      validator.should_validate?('string').should be_false
+      validator.should_validate?('array').should  be_false
+      validator.should_validate?(nil).should      be_false
+    end
+  end
+
+  describe '#validate' do
+    it 'should validate a string with true' do
+      validator.validate(:key, 'test', {}, errors)
+
+      errors.should be_empty
+    end
+
+    it 'should validate a number with true' do
+      validator.validate(:key, 123, {}, errors)
+
+      errors.should be_empty
+    end
+
+    it 'should validate a time with true' do
+      validator.validate(:key, Time.now, {}, errors)
+
+      errors.should be_empty
+    end
+
+    it 'should validate nil with false' do
+      validator.validate(:key, nil, {}, errors)
+
+      errors.should_not be_empty
+      errors.should eq({ key: 'is required' })
+    end
+  end
+end

data/spec/validators/simple_type_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe HashValidator::Validator::Base do
+  let(:my_class)  { Class.new }
+  let(:validator) { HashValidator::Validator::SimpleTypeValidator.new('my_class', my_class) }
+  let(:errors)    { Hash.new }
+
+  describe '#should_validate?' do
+    it 'should validate the name "my_class"' do
+      validator.should_validate?('my_class').should be_true
+    end
+
+    it 'should not validate other names' do
+      validator.should_validate?('string').should be_false
+      validator.should_validate?('array').should  be_false
+      validator.should_validate?(nil).should      be_false
+    end
+  end
+
+  describe '#validate' do
+    it 'should validate the my_class class with true' do
+      validator.validate(:key, my_class.new, {}, errors)
+
+      errors.should be_empty
+    end
+
+    it 'should validate other classes with errrors' do
+      validator.validate(:key, "foo bar", {}, errors)
+
+      errors.should_not be_empty
+      errors.should eq({ key: 'my_class required' })
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - James Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby library to validate hashes (Hash) against user-defined requirements
 email:
 - james@gooddogdesign.com
@@ -72,11 +86,15 @@ files:
 - lib/hash_validator/validators.rb
 - lib/hash_validator/validators/base.rb
 - lib/hash_validator/validators/hash_validator.rb
+- lib/hash_validator/validators/presence_validator.rb
 - lib/hash_validator/validators/simple_type_validator.rb
 - lib/hash_validator/version.rb
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
+- spec/validators/base_spec.rb
+- spec/validators/presence_spec.rb
+- spec/validators/simple_type_spec.rb
 homepage: https://github.com/JamesBrooks/hash_validator
 licenses:
 - MIT
@@ -105,3 +123,6 @@ test_files:
 - spec/hash_validator_spec.rb
 - spec/hash_validator_spec_helper.rb
 - spec/spec_helper.rb
+- spec/validators/base_spec.rb
+- spec/validators/presence_spec.rb
+- spec/validators/simple_type_spec.rb