active_model_validators_ex 0.0.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854badf7303345d29a041e94264d9db10b3157c7
-  data.tar.gz: 067a7ec5466cb199761cb861a4ef431e6a2dc53f
+  metadata.gz: fb623b9155719e88023b83b4833516fa09a614a0
+  data.tar.gz: d0a82d484adf8b88c4c2e0f07d2d3670fb963b33
 SHA512:
-  metadata.gz: 9d9a52f18b2251efb6985fb8aa303f5ccb3b26c60893452029044513059cb8423707ea0f193edff321c693e51b6130943170109957027292165bdfdc552c2203
-  data.tar.gz: 4e15babcff28e0ff909fc4fb6f5ff07cc3d102fab4836fce07cb3941a6c61f6c36d235e2b9fddee69a325fbb6f7a415d243821e8ba804f6e50b8200a98c54556
+  metadata.gz: 0673775f33792232fd1ffc390dad636a0879f0b86821728784728b0cca87d5d8c4073e4ee66d16356a81d4ee708b7a9bd64d1096690e14e632f162fcabf32361
+  data.tar.gz: d0742f05524b44c5dffec0c6a951a102705a1965fa024458ced3374b6dd08241d1329eaa5cc65ebabfc670311568840463063944d507720f31fee9bfefa79491

data/README.md

@@ -29,8 +29,8 @@ validations:
 
   * ArrayInclusionValidator
 
-   Allow you to validate if values in an array is included in a specified range
-   (meaning the value itself has to be an Array). As an example:
+   Validates if attribute value is an Array, containing values defined under key
+   :in (this can be defined either with an Array or Range). As an example:
 
         class ExampleModel
           include Mongoid::Document
@@ -38,12 +38,16 @@ validations:
           field :array
 
           validates :array, array_inclusion: {
-              # the collection of valid values for array elements
-              in: [0, 1, 2], # it could also be written as a range: 0..2
+              # the collection of values to compare with each element in array
+              in: [0, 1, 2], # this could also be written as a range: 0..2
 
               # can be either true or false, indicates if nil is accepted
               # defaults to false
-              allow_nil: true
+              allow_nil: true,
+
+              # can be either true or false, indicates if it accepts empty arrays
+              # defaults to false
+              allow_empty: true
             }
         end
 
@@ -53,9 +57,39 @@ validations:
         # returns false
         ExampleModel.new(array: [1, 2, 5]).valid?
 
+        # returns true
+        ExampleModel.new(array: []).valid?
+
+  * ArrayFormatValidator
+
+        class ExampleModel
+          include Mongoid::Document
+
+          field :array
+
+          validates :array, array_format: {
+            # the regexp to compare each element in array
+            with: /(some|match|string)/
+
+            # can be either true or false, indicates if nil is accepted
+            # defaults to false
+            allow_nil: true,
+
+            # can be either true or false, indicates if it accepts empty arrays
+            # defaults to false
+            allow_empty: true
+          }
+        end
+
+        # returns true
+        ExampleModel.new(array: ['some', 'match', 'string']).valid?
+
+        # return false
+        ExampleModel.new(array: ['not', 'matching']).valid?
+
   * TimeFormatValidator
 
-   Allow you to check if given value is parsable to Time, example:
+   Validates if value is of type Time or a string parsable to Time, example:
 
         class ExampleModel < ActiveRecord::Base
           attr_accessible :time

data/active_model_validators_ex.gemspec

@@ -8,9 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = ActiveModelValidatorsEx::VERSION
   spec.authors       = ["junhanamaki"]
   spec.email         = ["jun.hanamaki@gmail.com"]
-  spec.summary       = %q{Some custom validators for ActiveModel}
-  spec.description   = %q{Extend ActiveModel with more validators for your
-                          models.}
+  spec.summary       = %q{Custom validators for ActiveModel}
+  spec.description   = %q{Add more validators for your ActiveModel models.}
   spec.homepage      = "https://github.com/junhanamaki/active_model_validators_ex"
   spec.license       = "MIT"
 
@@ -19,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.9'

data/lib/active_model_validators_ex.rb

@@ -1,4 +1,6 @@
 require 'active_model_validators_ex/version'
+require 'active_model_validators_ex/array_validator_base'
+require 'active_model_validators_ex/array_format_validator'
 require 'active_model_validators_ex/array_inclusion_validator'
 require 'active_model_validators_ex/time_format_validator'
 

data/lib/active_model_validators_ex/array_format_validator.rb

@@ -0,0 +1,19 @@
+require 'active_model_validators_ex/array_validator_base'
+
+class ArrayFormatValidator < ArrayValidatorBase
+  def initialize(options)
+    unless options.key?(:with) && options[:with].is_a?(Regexp)
+      raise 'key with must be present, and value must be a Regexp'
+    end
+
+    super(options)
+  end
+
+  def custom_validations(record, attribute, value)
+    unless value.all? { |val| !val.match(options[:with]).nil? }
+      record.errors[attribute] <<
+        "attribute #{attribute} must be an Array with values that matches " \
+        "#{options[:with]}"
+    end
+  end
+end

data/lib/active_model_validators_ex/array_inclusion_validator.rb

@@ -1,28 +1,21 @@
-class ArrayInclusionValidator < ActiveModel::EachValidator
+require 'active_model_validators_ex/array_validator_base'
+
+class ArrayInclusionValidator < ArrayValidatorBase
   def initialize(options)
     unless options.key?(:in) &&
            (options[:in].is_a?(Array) ||
             options[:in].is_a?(Range))
-      raise 'key :in can not be nil, and value must be either an Array or Range'
+      raise 'key in must be present, and value must be either a Range or Array'
     end
 
     super(options)
   end
 
-  def validate_each(record, attribute, value)
-    return if value.nil? and options[:allow_nil]
-
-    unless value.is_a? Array
-      record.errors[attribute] <<
-        "expecting either Array or nil for attribute #{attribute}"
-      return
-    end
-
+  def custom_validations(record, attribute, value)
     unless value.all? { |val| options[:in].include?(val) }
       record.errors[attribute] <<
         "attribute #{attribute} has be an array composed of values " \
-        " #{options[:in]}"
-      return
+        "#{options[:in]}"
     end
   end
 end

data/lib/active_model_validators_ex/array_validator_base.rb

@@ -0,0 +1,28 @@
+class ArrayValidatorBase < ActiveModel::EachValidator
+  def initialize(options)
+    options[:allow_nil]   ||= false
+    options[:allow_empty] ||= false
+
+    super(options)
+  end
+
+  def validate_each(record, attribute, value)
+    return if options[:allow_nil] && value.nil?
+
+    unless value.is_a? Array
+      record.errors[attribute] << "attribute #{attribute} must be an Array"
+      return
+    end
+
+    if !options[:allow_empty] and value.empty?
+      record.errors[attribute] << "attribute #{attribute} can't be empty"
+      return
+    end
+
+    custom_validations(record, attribute, value)
+  end
+
+  def custom_validations(record, attribute, value)
+    raise 'override this method to perform custom validations'
+  end
+end

data/lib/active_model_validators_ex/version.rb

@@ -1,3 +1,3 @@
 module ActiveModelValidatorsEx
-  VERSION = "0.0.3"
+  VERSION = "0.3.0"
 end

data/spec/active_model_validators_ex/array_format_validator_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe ArrayFormatValidator do
+  describe '.new' do
+    context 'when key with is not present in argument hash' do
+      let(:options) { { attributes: :something } }
+
+      it 'raises error' do
+        expect do
+          ArrayFormatValidator.new(options)
+        end.to raise_error
+      end
+    end
+
+    context 'when key with is a non Regexp value' do
+      let(:options) { { attributes: :something, with: 'not an regexp' } }
+
+      it 'raises error' do
+        expect do
+          ArrayFormatValidator.new(options)
+        end.to raise_error
+      end
+    end
+  end
+
+  describe '#validate_each' do
+    let(:record)    { MockRecord.new(attribute) }
+    let(:attribute) { :array }
+    let(:validator) { ArrayFormatValidator.new(options) }
+    before { validator.validate_each(record, attribute, value) }
+
+    context 'for instance initialized with regexp value in key :with' do
+      let(:regexp) { /(testing|one|two)/ }
+      let(:options) do
+        { attributes: attribute, with: regexp }
+      end
+
+      context 'when value is an Array with values that match regexp' do
+        let(:value) { ['testing', 'one', 'two'] }
+
+        it 'does not set error messages in record' do
+          expect(record.errors[attribute].count).to eq(0)
+        end
+      end
+
+      context 'when value is an array with values that do not match regexp' do
+        let(:value) { ['i do not match'] }
+
+        it 'sets error message in record' do
+          expect(record.errors[attribute].count).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/active_model_validators_ex/array_inclusion_validator_spec.rb

@@ -19,147 +19,10 @@ describe ArrayInclusionValidator do
     let(:validator) { ArrayInclusionValidator.new(options) }
     before { validator.validate_each(record, attribute, value) }
 
-    context 'for instance initialized with options hash ' \
-            'key :in with empty array as value' do
-      let(:options) { { attributes: attribute, in: [] } }
-
-      context 'when passed value is nil' do
-        let(:value) { nil }
-
-        it 'sets error message in record, under passed attribute key' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is a non nil, non array value' do
-        let(:value) { :symbol }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is an empty array' do
-        let(:value) { [] }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is an array with values' do
-        let(:value) { [1, 2, 3] }
-
-        it 'sets error message in record, under passed attribute key' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-    end
-
-    context 'for instance initialized with options hash ' \
-            'key :in with empty array as value, ' \
-            'allow_nil as false' do
-      let(:options) { { attributes: attribute, in: [], allow_nil: false } }
-
-      context 'when passed value is nil' do
-        let(:value) { nil }
-
-        it 'sets error message in record, under passed attribute key' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is a non nil, non array value' do
-        let(:value) { :symbol }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is an empty array' do
-        let(:value) { [] }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is an array with values' do
-        let(:value) { [1, 2, 3] }
-
-        it 'sets error message in record, under passed attribute key' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-    end
-
-    context 'for instance initialized with options hash ' \
-            'key :in with empty array as value, ' \
-            'allow_nil as true' do
-      let(:options) { { attributes: attribute, in: [], allow_nil: true } }
-
-      context 'when passed value is nil' do
-        let(:value) { nil }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is a non nil, non array value' do
-        let(:value) { :symbol }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is an empty array' do
-        let(:value) { [] }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is an array with values' do
-        let(:value) { [1, 2, 3] }
-
-        it 'sets error message in record, under passed attribute key' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-    end
-
-    context 'for instance initialized with options hash ' \
-            'key :in with array with values as value, ' \
-            'allow_nil as true' do
+    context 'for instance initialized with key in with an Array of values' do
       let(:in_array) { [1, 2, 3] }
-      let(:options)  { { attributes: attribute, in: in_array, allow_nil: true } }
-
-      context 'when passed value is nil' do
-        let(:value) { nil }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is a non nil, non array value' do
-        let(:value) { :symbol }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is an empty array' do
-        let(:value) { [] }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
+      let(:options) do
+        { attributes: attribute, in: in_array }
       end
 
       context 'when passed value is an array with values that are in options array' do
@@ -179,37 +42,13 @@ describe ArrayInclusionValidator do
       end
     end
 
-    context 'for instance initialized with options hash ' \
-            'key :in with range with values as value, ' \
-            'allow_nil as false' do
+    context 'for instance initialized with key in with a Range of values' do
       let(:in_range) { 1..3 }
-      let(:options)  { { attributes: attribute, in: in_range, allow_nil: false } }
-
-      context 'when passed value is nil' do
-        let(:value) { nil }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
+      let(:options) do
+        { attributes: attribute, in: in_range }
       end
 
-      context 'when passed value is a non nil, non array value' do
-        let(:value) { :symbol }
-
-        it 'sets error message in record' do
-          expect(record.errors[attribute].count).to eq(1)
-        end
-      end
-
-      context 'when passed value is an empty array' do
-        let(:value) { [] }
-
-        it 'does not set error messages in record' do
-          expect(record.errors[attribute].count).to eq(0)
-        end
-      end
-
-      context 'when passed value is an array with values that are in options range' do
+      context 'when passed value is an array with values that are in options array' do
         let(:value) { [1, 2, 3] }
 
         it 'does not set error messages in record' do
@@ -217,7 +56,7 @@ describe ArrayInclusionValidator do
         end
       end
 
-      context 'when passed value is an array with values not in options range' do
+      context 'when passed value is an array with values not in options array' do
         let(:value) { [4, 5, 6] }
 
         it 'sets error message in record' do

data/spec/active_model_validators_ex/array_validator_base_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe ArrayValidatorBase do
+  describe '.custom_validations' do
+    context 'if method is not overridden' do
+      it 'raises error' do
+        expect do
+          validator.custom_validations(nil, nil, nil)
+        end.to raise_error
+      end
+    end
+  end
+
+  describe '.validate_each' do
+    let(:record)    { MockRecord.new(attribute) }
+    let(:attribute) { :a }
+    let(:validator) { ArrayValidatorBase.new(options) }
+    before do
+      validator.validate_each(record, attribute, value) rescue nil
+    end
+
+    shared_examples_for :common_behavior do
+      context 'and value is a non nil, non array value' do
+        let(:value) { :symbol }
+
+        it 'sets error message in record' do
+          expect(record.errors[attribute].count).to eq(1)
+        end
+      end
+    end
+
+    shared_examples_for :allow_nil_true do
+      context 'and value is nil' do
+        let(:value) { nil }
+
+        it 'does not set error messages in record' do
+          expect(record.errors[attribute].count).to eq(0)
+        end
+      end
+    end
+
+    shared_examples_for :allow_nil_false do
+      context 'and value is nil' do
+        let(:value) { nil }
+
+        it 'sets error message in record' do
+          expect(record.errors[attribute].count).to eq(1)
+        end
+      end
+    end
+
+    shared_examples_for :allow_empty_true do
+      context 'and value is an empty Array' do
+        let(:value) { [] }
+
+        it 'does not set error messages in record' do
+          expect(record.errors[attribute].count).to eq(0)
+        end
+      end
+    end
+
+    shared_examples_for :allow_empty_false do
+      context 'and value is an empty Array' do
+        let(:value) { [] }
+
+        it 'set error messager in record' do
+          expect(record.errors[attribute].count).to eq(1)
+        end
+      end
+    end
+
+    context 'for instance initialized with no options (defaults test)' do
+      let(:options) { { attributes: attribute } }
+
+      it_behaves_like :common_behavior
+      it_behaves_like :allow_nil_false
+      it_behaves_like :allow_empty_false
+    end
+
+    context 'for instance initialized with allow_empty true' do
+      let(:options) { { attributes: attribute, allow_empty: true } }
+
+      it_behaves_like :common_behavior
+      it_behaves_like :allow_nil_false
+      it_behaves_like :allow_empty_true
+    end
+
+    context 'for instance initialized with allow_empty false' do
+      let(:options) { { attributes: attribute, allow_empty: false } }
+
+      it_behaves_like :common_behavior
+      it_behaves_like :allow_nil_false
+      it_behaves_like :allow_empty_false
+    end
+
+    context 'for instance initialized with allow_nil true' do
+      let(:options) { { attributes: attribute, allow_nil: true } }
+
+      it_behaves_like :common_behavior
+      it_behaves_like :allow_nil_true
+      it_behaves_like :allow_empty_false
+
+      context 'and allow_empty true' do
+        let(:options) do
+          { attributes: attribute, allow_nil: true, allow_empty: true }
+        end
+
+        it_behaves_like :common_behavior
+        it_behaves_like :allow_nil_true
+        it_behaves_like :allow_empty_true
+      end
+
+      context 'and allow_empty false' do
+        let(:options) do
+          { attributes: attribute, allow_nil: true, allow_empty: false }
+        end
+
+        it_behaves_like :common_behavior
+        it_behaves_like :allow_nil_true
+        it_behaves_like :allow_empty_false
+      end
+    end
+
+    context 'for instance initialized with allow_nil false' do
+      let(:options) { { attributes: attribute, allow_nil: false } }
+
+      it_behaves_like :common_behavior
+      it_behaves_like :allow_nil_false
+      it_behaves_like :allow_empty_false
+
+      context 'and allow_empty true' do
+        let(:options) do
+          { attributes: attribute, allow_nil: false, allow_empty: true }
+        end
+
+        it_behaves_like :common_behavior
+        it_behaves_like :allow_nil_false
+        it_behaves_like :allow_empty_true
+      end
+
+      context 'and allow_empty false' do
+        let(:options) do
+          { attributes: attribute, allow_nil: false, allow_empty: false }
+        end
+
+        it_behaves_like :common_behavior
+        it_behaves_like :allow_nil_false
+        it_behaves_like :allow_empty_false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_model_validators_ex
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.3.0
 platform: ruby
 authors:
 - junhanamaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-06 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,9 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-description: |-
-  Extend ActiveModel with more validators for your
-                            models.
+description: Add more validators for your ActiveModel models.
 email:
 - jun.hanamaki@gmail.com
 executables: []
@@ -114,10 +112,14 @@ files:
 - Rakefile
 - active_model_validators_ex.gemspec
 - lib/active_model_validators_ex.rb
+- lib/active_model_validators_ex/array_format_validator.rb
 - lib/active_model_validators_ex/array_inclusion_validator.rb
+- lib/active_model_validators_ex/array_validator_base.rb
 - lib/active_model_validators_ex/time_format_validator.rb
 - lib/active_model_validators_ex/version.rb
+- spec/active_model_validators_ex/array_format_validator_spec.rb
 - spec/active_model_validators_ex/array_inclusion_validator_spec.rb
+- spec/active_model_validators_ex/array_validator_base_spec.rb
 - spec/active_model_validators_ex/time_format_validator_spec.rb
 - spec/mock_objects/mock_record.rb
 - spec/spec_helper.rb
@@ -133,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -144,9 +146,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Some custom validators for ActiveModel
+summary: Custom validators for ActiveModel
 test_files:
+- spec/active_model_validators_ex/array_format_validator_spec.rb
 - spec/active_model_validators_ex/array_inclusion_validator_spec.rb
+- spec/active_model_validators_ex/array_validator_base_spec.rb
 - spec/active_model_validators_ex/time_format_validator_spec.rb
 - spec/mock_objects/mock_record.rb
 - spec/spec_helper.rb