hash_validator 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba6e508f307239eeb92f9fbfcdb6bc9723e7cda6
-  data.tar.gz: 61651a497d2399d28e0b7119051f9edb51e4a1f9
+  metadata.gz: 6d8143f1edb6fe62100d9ae106dc46f46fcc423a
+  data.tar.gz: 550feb38aa3d4d0b799d64a8ecbe90ea3b09d750
 SHA512:
-  metadata.gz: 98b73f5f7efa1b4af4b6c1224826d8a0bd9f9dd63a21007c76bccf773e9a812988f3dc6deb168b1796ab0706164e295c39022f2672d7be320b87a65d887208ce
-  data.tar.gz: 913c5a8afd5491276ab5a10dd7b0718ec26b5849ac4688bf7f49c4cc0816928abb02e7fc77aecc9daaa78f9e20cb514406133533c1a397a0efa1720d231fca07
+  metadata.gz: e328a46e133e0e7ec35cdcc410ae2f829158598e437b663bf50518ff40fca45dc3bfad2f72705a9e72af4b39342ae2b251bf92d74daa74451fdc754751ed5f06
+  data.tar.gz: ef7ec9c9e27921e80ed3420ec92294ed3e1b1f01189243a8d000cbd16aa308265f5d25b5a587d32cb070b9c2fa7065768947ee983fdc22e74b10769158402635

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
   - jruby-19mode
-  - rbx-19mode

data/lib/hash_validator/validations/many.rb

@@ -0,0 +1,8 @@
+module HashValidator::Validations
+  class Many
+    attr_reader :validation
+    def initialize(validation)
+      @validation = validation
+    end
+  end
+end

data/lib/hash_validator/validations/optional.rb

@@ -0,0 +1,8 @@
+module HashValidator::Validations
+  class Optional
+    attr_reader :validation
+    def initialize(validation)
+      @validation = validation
+    end
+  end
+end

data/lib/hash_validator/validations.rb

@@ -0,0 +1,8 @@
+module HashValidator
+  module Validations
+  end
+end
+
+# Load validators
+require 'hash_validator/validations/optional'
+require 'hash_validator/validations/many'

data/lib/hash_validator/validators/many_validator.rb

@@ -0,0 +1,40 @@
+module HashValidator
+  module Validator
+    class ManyValidator < Base
+      def initialize
+        super('_many')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+      end
+
+      def should_validate?(validation)
+        validation.is_a?(Validations::Many)
+      end
+
+      def presence_error_message
+        "enumerable required"
+      end
+
+      def validate(key, value, validations, errors)
+        unless value.is_a?(Enumerable)
+          errors[key] = presence_error_message
+          return
+        end
+
+        element_errors = Array.new
+
+        value.each_with_index do |element, i|
+          ::HashValidator.validator_for(validations.validation).validate(i, element, validations.validation, element_errors)
+        end
+
+        element_errors.each_with_index do |e, i|
+          if e.respond_to?(:empty?) && e.empty?
+            element_errors[i] = nil
+          end
+        end
+
+        errors[key] = element_errors unless element_errors.all?(&:nil?)
+      end
+    end
+  end
+end
+
+HashValidator.append_validator(HashValidator::Validator::ManyValidator.new)

data/lib/hash_validator/validators/optional_validator.rb

@@ -0,0 +1,22 @@
+module HashValidator
+  module Validator
+    class OptionalValidator < Base
+      def initialize
+        super('_optional')  # The name of the validator, underscored as it won't usually be directly invoked (invoked through use of validator)
+      end
+
+      def should_validate?(validation)
+        validation.is_a?(Validations::Optional)
+      end
+
+      def validate(key, value, validations, errors)
+        if value
+          ::HashValidator.validator_for(validations.validation).validate(key, value, validations.validation, errors)
+          errors.delete(key) if errors[key].respond_to?(:empty?) && errors[key].empty?
+        end
+      end
+    end
+  end
+end
+
+HashValidator.append_validator(HashValidator::Validator::OptionalValidator.new)

data/lib/hash_validator/validators.rb

@@ -32,3 +32,5 @@ require 'hash_validator/validators/boolean_validator'
 require 'hash_validator/validators/email_validator'
 require 'hash_validator/validators/enumerable_validator'
 require 'hash_validator/validators/lambda_validator'
+require 'hash_validator/validators/optional_validator'
+require 'hash_validator/validators/many_validator'

data/lib/hash_validator/version.rb

@@ -1,3 +1,3 @@
 module HashValidator
-  VERSION = '0.2.7'
+  VERSION = '0.3.0'
 end

data/lib/hash_validator.rb

@@ -2,8 +2,17 @@ module HashValidator
   def self.validate(*args)
     Base.validate(*args)
   end
+
+  def self.optional(validation)
+    Validations::Optional.new(validation)
+  end
+
+  def self.many(validation)
+    Validations::Many.new(validation)
+  end
 end
 
 require 'hash_validator/base'
 require 'hash_validator/version'
 require 'hash_validator/validators'
+require 'hash_validator/validations'

data/spec/hash_validator_spec.rb

@@ -188,6 +188,38 @@ describe HashValidator do
           v.errors.should eq({ bar: 'string required', user: { age: 'is required', likes: 'array required' } })
         end
       end
+
+      describe 'optional validations' do
+        let(:validations) {{ foo: 'numeric', bar: HashValidator.optional('string') }}
+
+        it 'should validate a complex hash' do
+          v = validate(complex_hash, validations)
+          v.valid?.should be_true
+          v.errors.should be_empty
+        end
+
+        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: 'string required' })
+        end
+      end
+
+      describe 'many validations' do
+        let(:validations) {{ foo: 'numeric', bar: 'string', user: { first_name: 'string', likes: HashValidator.many('string') } }}
+
+        it 'should validate a complex hash' do
+          v = validate(complex_hash, validations)
+          v.valid?.should be_true
+          v.errors.should be_empty
+        end
+
+        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: 'string required', user: { likes: 'enumerable required' } })
+        end
+      end
     end
   end
 end

data/spec/validators/many_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe HashValidator::Validator::Base do
+  let(:validator)  { HashValidator::Validator::ManyValidator.new }
+  let(:errors)     { Hash.new }
+
+  def many(validation)
+    HashValidator::Validations::Many.new(validation)
+  end
+
+  describe '#should_validate?' do
+    it 'should validate an Many validation' do
+      validator.should_validate?(many('string')).should be_true
+    end
+
+    it 'should not validate other things' 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 accept an empty array' do
+      validator.validate(:key, [], many('string'), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should accept an array of matching elements' do
+      validator.validate(:key, ['a', 'b'], many('string'), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should not accept an array including a non-matching element' do
+      validator.validate(:key, ['a', 2], many('string'), errors)
+
+      errors.should eq({ key: [nil, 'string required'] })
+    end
+
+    it 'should accept an array of matching hashes' do
+      validator.validate(:key, [{v: 'a'}, {v: 'b'}], many({v: 'string'}), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should not accept an array including a non-matching element' do
+      validator.validate(:key, [{v: 'a'}, {v: 2}], many({v: 'string'}), errors)
+
+      errors.should eq({ key: [nil, {v: 'string required'}] })
+    end
+
+    it 'should not accept a non-enumerable' do
+      validator.validate(:key, 'a', many({v: 'string'}), errors)
+
+      errors.should eq({ key: 'enumerable required' })
+    end
+  end
+end

data/spec/validators/optional_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe HashValidator::Validator::Base do
+  let(:validator)  { HashValidator::Validator::OptionalValidator.new }
+  let(:errors)     { Hash.new }
+
+  def optional(validation)
+    HashValidator::Validations::Optional.new(validation)
+  end
+
+  describe '#should_validate?' do
+    it 'should validate an Optional validation' do
+      validator.should_validate?(optional('string')).should be_true
+    end
+
+    it 'should not validate other things' 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 accept a missing value' do
+      validator.validate(:key, nil, optional('string'), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should accept a present, matching value' do
+      validator.validate(:key, 'foo', optional('string'), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should reject a present, non-matching value' do
+      validator.validate(:key, 123, optional('string'), errors)
+
+      errors.should_not be_empty
+      errors.should eq({ key: 'string required' })
+    end
+
+    it 'should accept a present, matching hash' do
+      validator.validate(:key, {v: 'foo'}, optional({v: 'string'}), errors)
+
+      errors.should be_empty
+    end
+
+    it 'should reject a present, non-matching hash' do
+      validator.validate(:key, {}, optional({v: 'string'}), errors)
+
+      errors.should_not be_empty
+      errors.should eq({ key: {v: 'string required'} })
+    end
+  end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - James Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,6 +83,9 @@ files:
 - hash_validator.gemspec
 - lib/hash_validator.rb
 - lib/hash_validator/base.rb
+- lib/hash_validator/validations.rb
+- lib/hash_validator/validations/many.rb
+- lib/hash_validator/validations/optional.rb
 - lib/hash_validator/validators.rb
 - lib/hash_validator/validators/base.rb
 - lib/hash_validator/validators/boolean_validator.rb
@@ -90,6 +93,8 @@ files:
 - lib/hash_validator/validators/enumerable_validator.rb
 - lib/hash_validator/validators/hash_validator.rb
 - lib/hash_validator/validators/lambda_validator.rb
+- lib/hash_validator/validators/many_validator.rb
+- lib/hash_validator/validators/optional_validator.rb
 - lib/hash_validator/validators/presence_validator.rb
 - lib/hash_validator/validators/simple_type_validators.rb
 - lib/hash_validator/validators/simple_validator.rb
@@ -102,6 +107,8 @@ files:
 - spec/validators/email_spec.rb
 - spec/validators/in_enumerable_spec.rb
 - spec/validators/lambda_spec.rb
+- spec/validators/many_spec.rb
+- spec/validators/optional_spec.rb
 - spec/validators/presence_spec.rb
 - spec/validators/simple_spec.rb
 - spec/validators/simple_types_spec.rb
@@ -116,17 +123,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby library to validate hashes (Hash) against user-defined requirements
@@ -139,6 +146,8 @@ test_files:
 - spec/validators/email_spec.rb
 - spec/validators/in_enumerable_spec.rb
 - spec/validators/lambda_spec.rb
+- spec/validators/many_spec.rb
+- spec/validators/optional_spec.rb
 - spec/validators/presence_spec.rb
 - spec/validators/simple_spec.rb
 - spec/validators/simple_types_spec.rb