hash_validator 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef7bafe9d1c4d43bec0450101f7849224c43ccbe
-  data.tar.gz: bf2cf47a021f8a01d84a1cbb7344e73be0cf0026
+  metadata.gz: 14c3d859ad35ec3b2ac6b4750bd10a5f6d0d1784
+  data.tar.gz: 024a49a7d98e43fe7476fd4f7e87b4dbef88393f
 SHA512:
-  metadata.gz: 2b5ac97feaac7377ae57fc21cf1bc1910a532f0e1e413d1a2d40c10efc1ac45431544a207fd2585533216d310da8cdfe2cdbc0b5ca727435cd271c4b20d318db
-  data.tar.gz: 8978b24518ef2cfdf99d86ea2dd1b3380cc04c3f60c1931f119854648c51a37f1ca1ba6735c19cc80b4ced4e29a975453a1178b4631830be10e94c9a75240463
+  metadata.gz: 5bf1fe8300640b5d0f5e3a0a01429526d25f012a031add4594702439ee5e89c7c01f942f7f55b5a6cf86ddd57a61b9d0f84280c7106a2c4336b2b0826f17a318
+  data.tar.gz: 28d376b771b6e4e38f0c69b1bfb3430053aa7b0f01fe37c2fb7f104d8797c9b7a4b76de98f9f8ee41d1b6a1eba4d43558c4958aab06bb4f1c3c044e921137364

data/README.md

@@ -67,6 +67,7 @@ Define a validation hash which will be used to validate. This has can be nested
 * `array`
 * `boolean`
 * `complex`
+* `enumerable`
 * `float`
 * `integer`
 * `numeric`
@@ -81,7 +82,8 @@ Define a validation hash which will be used to validate. This has can be nested
 
 Additional validations exist to validate beyond simple typing, such as:
 
-* `email`: email address validation (string + email address)
+* An Enumerable instance: validates that the value is contained within the supplied enumerable.
+* `email`: email address validation (string + email address).
 
 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/lib/hash_validator/validators.rb

@@ -30,3 +30,4 @@ require 'hash_validator/validators/presence_validator'
 require 'hash_validator/validators/simple_type_validators'
 require 'hash_validator/validators/boolean_validator'
 require 'hash_validator/validators/email_validator'
+require 'hash_validator/validators/enumerable_validator'

data/lib/hash_validator/validators/enumerable_validator.rb

@@ -0,0 +1,21 @@
+class HashValidator::Validator::EnumerableValidator < HashValidator::Validator::Base
+  def initialize
+    super('_enumerable')  # 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?(Enumerable)
+  end
+
+  def presence_error_message
+    'value from list required'
+  end
+
+  def validate(key, value, validations, errors)
+    unless validations.include?(value)
+      errors[key] = presence_error_message
+    end
+  end
+end
+
+HashValidator.append_validator(HashValidator::Validator::EnumerableValidator.new)

data/lib/hash_validator/validators/simple_type_validators.rb

@@ -1,6 +1,7 @@
 [
   Array,
   Complex,
+  Enumerable,
   Float,
   Integer,
   Numeric,

data/lib/hash_validator/version.rb

@@ -1,3 +1,3 @@
 module HashValidator
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/spec/validators/in_enumerable_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe 'Enumerable validator' do
+  describe 'Accepting Enumerables in validations' do
+    it 'should accept an empty array' do
+      validate({}, { foo: [] })
+    end
+
+    it 'should accept an array' do
+      validate({}, { foo: [ 'apple', 'banana', 'carrot' ] })
+    end
+
+    it 'should accept a hash' do
+      validate({}, { foo: { apple: 'apple', banana: 'banana', carrot: 'cattot' } })
+    end
+  end
+
+  describe '#validate' do
+    describe 'Simple Array' do
+      let(:validations) {{ fruit: [ 'apple', 'banana', 'carrot' ] }}
+
+      it 'should validate true if the value is present' do
+        validate({ fruit: 'apple' }, validations).valid?.should be_true
+      end
+
+      it 'should validate false if the value is not present' do
+        validate({ fruit: 'pear' }, validations).valid?.should be_false
+      end
+
+      it 'should validate false if the key is not present' do
+        validate({ something: 'apple' }, validations).valid?.should be_false
+      end
+
+      it 'should provide an appropriate error message is the value is not present' do
+        validate({ fruit: 'pear' }, validations).errors.should eq({ fruit: 'value from list required' })
+      end
+    end
+
+    describe 'Range' do
+      let(:validations) {{ number: 1..10 }}
+
+      it 'should validate true if the value is present' do
+        validate({ number: 5 }, validations).valid?.should be_true
+      end
+      it 'should validate false if the value is not present' do
+        validate({ number: 15 }, validations).valid?.should be_false
+      end
+    end
+
+    describe 'Infinite Range' do
+      let(:validations) {{ number: 1..Float::INFINITY }}
+
+      it 'should validate true if the value is present' do
+        validate({ number: 5 }, validations).valid?.should be_true
+      end
+      it 'should validate false if the value is not present' do
+        validate({ number: -5 }, validations).valid?.should be_false
+      end
+    end
+  end
+end

data/spec/validators/simple_types_spec.rb

@@ -13,6 +13,10 @@ describe 'Simple validator types' do
       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) ]
     },
+    enumerable: {
+      valid:   [ [], [ 1, 2, 3 ], 1..Float::INFINITY ],
+      invalid: [ nil, '', 123, '123', Time.now, Float::INFINITY ]
+    },
     float: {
       valid:   [ 0.0, 1.1, 1.23, Float::INFINITY, Float::EPSILON ],
       invalid: [ nil, '', 0, 123, '123', Time.now, '[1]', '2013-03-04' ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_validator
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - James Brooks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-22 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - lib/hash_validator/validators/base.rb
 - lib/hash_validator/validators/boolean_validator.rb
 - lib/hash_validator/validators/email_validator.rb
+- lib/hash_validator/validators/enumerable_validator.rb
 - lib/hash_validator/validators/hash_validator.rb
 - lib/hash_validator/validators/presence_validator.rb
 - lib/hash_validator/validators/simple_type_validators.rb
@@ -98,6 +99,7 @@ files:
 - spec/validators/base_spec.rb
 - spec/validators/boolean_spec.rb
 - spec/validators/email_spec.rb
+- spec/validators/in_enumerable_spec.rb
 - spec/validators/presence_spec.rb
 - spec/validators/simple_spec.rb
 - spec/validators/simple_types_spec.rb
@@ -133,6 +135,7 @@ test_files:
 - spec/validators/base_spec.rb
 - spec/validators/boolean_spec.rb
 - spec/validators/email_spec.rb
+- spec/validators/in_enumerable_spec.rb
 - spec/validators/presence_spec.rb
 - spec/validators/simple_spec.rb
 - spec/validators/simple_types_spec.rb