hydra-validations 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2420e8bab9e84e4208c4cad52baeb3b8b0e7f4b
-  data.tar.gz: 889cba23c9ce004052a4418fca5998f5243e8c1b
+  metadata.gz: 14a1051a97f663c054e73db5a4f50c90a45a447a
+  data.tar.gz: d7ffb762b468269fc1275604c50bacdabb05f83b
 SHA512:
-  metadata.gz: d076b873438ea19423e095d61aa24425cb160dd0c918346c6b1c480bf180919b42df10cd6865e9e13d7a741f5e2a5852980d1e3938e369dcae8a001a5823cc2e
-  data.tar.gz: 70ef6f6ec3a124046861bfc361a5d9486776d3efb9dbb788d3a969f081a6e94612aeb60c9c440601bc52eea8a78d224813c032882a6a18292fd046f1a2140e8a
+  metadata.gz: ceca377220db7fc7391c1d8bc2cc4729579b74c8fc9508cc11f60a98f3a79aff6d08c7480f4218e8e6f39811a1ba06f7b39fd83255ce8e72cd249865a7b69d05
+  data.tar.gz: 4c24af4ec23bfddbb3635486be91d310d2acd4c8225bdc17166b06be0f90ea1ef57e59105dcedba9f6106f53e60e53d0f1820d1db149d867a25bf187d7500f46

data/README.md

@@ -111,9 +111,9 @@ class UniquenessValidatable < ActiveFedora::Base
 end
 ```
 
-### SingleCardinalityValidatory
+### SingleCardinalityValidator
 
-Validates that the attribute value is a scaler or single-member enumerable.
+Validates that the attribute value is a scalar or single-member enumerable.
 
 ```ruby
 class Validatable

data/lib/hydra/validations.rb

@@ -10,6 +10,14 @@ module Hydra
       include HelperMethods
     end
 
+    module ClassMethods
+      protected
+      # Overwrites ActiveModel::Validations::ClassMethods, adding :allow_empty
+      def _validates_default_keys
+        [:if, :unless, :on, :allow_blank, :allow_nil , :strict, :allow_empty]
+      end
+    end
+
   end
 end
 

data/lib/hydra/validations/enumerable_behavior.rb

@@ -7,10 +7,18 @@ module Hydra
     # Behavior includes 'fixing' each error message to include the specific value
     # which was invalid.
     #
+    # `allow_empty` option can be used instead of `allow_blank` for greater
+    # clarity and precision with enumerable values. If a validator includes
+    # this mixin, then an empty enumerable value will always be invalid if
+    # `allow_empty` is false or nil.
+    #
     module EnumerableBehavior
 
       def validate_each(record, attribute, value)
-        if value.respond_to?(:each)
+        return super unless value.respond_to?(:each)
+        if value.respond_to?(:empty?) && value.empty?
+          record.errors.add(attribute, "can't be empty") unless options[:allow_empty]
+        else
           value.each do |v| 
             prev = record.errors[attribute].size rescue 0
             super(record, attribute, v)
@@ -19,8 +27,6 @@ module Hydra
               record.errors.add(attribute, fixed_message(v, messages.pop))
             end
           end
-        else
-          super
         end
       end
 

data/lib/hydra/validations/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Validations
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/spec/support/shared_examples_for_validators.rb

@@ -31,3 +31,79 @@ shared_examples "it validates the single cardinality of a scalar attribute" do
     expect(subject).to be_valid
   end
 end
+
+shared_examples "an enumerable validator" do
+
+  let(:record) { record_class.new }
+
+  before do
+    record_class.validates attribute, opts
+    allow(record).to receive(attribute) { value }
+  end
+
+  context "when the value is nil" do
+    let(:value) { nil }
+    context "and `allow_nil` is true" do
+      let(:opts) { options.merge(allow_nil: true) }
+      it "should be valid" do
+        expect(record).to be_valid
+      end
+    end
+    context "and `allow_nil` is not true" do
+      let(:opts) { options }
+      it "should validate the value" do
+        expect_any_instance_of(described_class).to receive(:validate_each).with(record, attribute, value)
+        record.valid?
+      end
+    end
+  end
+
+  context "when the value is a blank scalar" do
+    let(:value) { "" }
+    context "and `allow_blank` is true" do
+      let(:opts) { options.merge(allow_blank: true) }
+      it "should be valid" do
+        expect(record).to be_valid
+      end
+    end
+    context "and `allow_blank` is not true" do
+      let(:opts) { options }
+      it "should validate the value" do
+        expect_any_instance_of(described_class).to receive(:validate_each).with(record, attribute, value)
+        record.valid?
+      end
+    end
+  end
+
+  context "when the value is is a non-blank scalar" do
+    let(:value) { "foo" }
+    let(:opts) { options }
+    it "should validate the value" do
+      expect_any_instance_of(described_class).to receive(:validate_each).with(record, attribute, value)
+      record.valid?
+    end
+  end
+
+  context "when the value is an empty enumerable" do
+    let(:value) { [] }
+    context "and `allow_blank` is true" do
+      let(:opts) { options.merge(allow_blank: true) }
+      it "should be valid" do
+        expect(record).to be_valid
+      end
+    end
+    context "and `allow_empty` is true" do
+      let(:opts) { options.merge(allow_empty: true) }
+      it "should be valid" do
+        expect(record).to be_valid
+      end
+    end
+    context "and neither `allow_blank` nor `allow_empty` is true" do
+      let(:opts) { options }
+      it "should be invalid" do
+        expect(record).to be_invalid
+      end
+    end
+  end
+
+end

data/spec/validators/format_validator_spec.rb

@@ -1,25 +1,28 @@
 require 'spec_helper'
+require 'support/shared_examples_for_validators'
 
 shared_examples "it validates the format of each member of the attribute value" do
   context "all attribute value members are valid" do
-    before { subject.field = ["foo", "bar"] }
+    before { record.field = ["foo", "bar"] }
     it "should be valid" do
-      expect(subject).to be_valid
+      expect(record).to be_valid
     end
   end
+
   context "one of the attribute value members is invalid" do
-    before { subject.field = ["foo1", "bar"] }
+    before { record.field = ["foo1", "bar"] }
     it "should be invalid" do
-      expect(subject).to be_invalid
+      expect(record).to be_invalid
     end
     it "should 'fix' the error message to include the value" do
-      subject.valid?
-      expect(subject.errors[:field]).to eq ["value \"foo1\" is invalid"]
+      record.valid?
+      expect(record.errors[:field]).to eq ["value \"foo1\" is invalid"]
     end
   end
 end
 
 describe Hydra::Validations::FormatValidator do
+
   before(:all) do
     class Validatable
       include ActiveModel::Validations
@@ -27,21 +30,32 @@ describe Hydra::Validations::FormatValidator do
       attr_accessor :field
     end
   end
+
   before(:each) { Validatable.clear_validators! }
+
   after(:all) { Object.send(:remove_const, :Validatable) }
-  subject { Validatable.new }
-  describe ".validates" do
-    before do
-      Validatable.clear_validators!
-      Validatable.validates :field, format: { with: /\A[[:alpha:]]+\Z/ }
+
+  describe "class methods" do
+    describe ".validates" do
+      before { Validatable.validates :field, format: { with: /\A[[:alpha:]]+\Z/ } }
+      it_behaves_like "it validates the format of each member of the attribute value" do
+        let(:record) { Validatable.new }
+      end
     end
-    it_behaves_like "it validates the format of each member of the attribute value"
   end
-  describe ".validates_format_of" do
-    before do
-      Validatable.clear_validators!
-      Validatable.validates_format_of :field, with: /\A[[:alpha:]]+\Z/
+  describe "helper methods" do
+    describe ".validates_format_of" do
+      before { Validatable.validates_format_of :field, with: /\A[[:alpha:]]+\Z/ }
+      it_behaves_like "it validates the format of each member of the attribute value" do
+        let(:record) { Validatable.new }
+      end
     end
-    it_behaves_like "it validates the format of each member of the attribute value"
   end
+
+  it_behaves_like "an enumerable validator" do
+    let(:options) { { format: { with: /\A[[:alpha:]]+\Z/ } } }
+    let(:record_class) { Validatable }
+    let(:attribute) { :field }
+  end
+
 end

data/spec/validators/inclusion_validator_spec.rb

@@ -1,25 +1,30 @@
 require 'spec_helper'
+require 'support/shared_examples_for_validators'
 
 shared_examples "it validates the inclusion of each member of the attribute value" do
+
   context "all attribute value members are valid" do
-    before { subject.field = ["foo", "bar"] }
+    before { record.field = ["foo", "bar"] }
     it "should be valid" do
-      expect(subject).to be_valid
+      expect(record).to be_valid
     end
   end
+
   context "one of the attribute value members is invalid" do
-    before { subject.field = ["foo1", "bar"] }
+    before { record.field = ["foo1", "bar"] }
     it "should be invalid" do
-      expect(subject).to be_invalid
+      expect(record).to be_invalid
     end
     it "should 'fix' the error message to include the value" do
-      subject.valid?
-      expect(subject.errors[:field]).to eq ["value \"foo1\" is not included in the list"]
+      record.valid?
+      expect(record.errors[:field]).to eq ["value \"foo1\" is not included in the list"]
     end
   end
+
 end
 
 describe Hydra::Validations::InclusionValidator do
+
   before(:all) do
     class Validatable
       include ActiveModel::Validations
@@ -27,22 +32,31 @@ describe Hydra::Validations::InclusionValidator do
       attr_accessor :field
     end
   end
+
   before(:each) { Validatable.clear_validators! }
+
   after(:all) { Object.send(:remove_const, :Validatable) }
-  subject { Validatable.new }
+
   let(:valid_values) { ["foo", "bar", "baz"] }
+
   describe ".validates" do
-    before do
-      Validatable.clear_validators!
-      Validatable.validates :field, inclusion: { in: valid_values } 
+    before { Validatable.validates :field, inclusion: { in: valid_values } }
+    it_behaves_like "it validates the inclusion of each member of the attribute value" do
+      let(:record) { Validatable.new }
     end
-    it_behaves_like "it validates the inclusion of each member of the attribute value"
   end
+
   describe ".validates_inclusion_of" do
-    before do
-      Validatable.clear_validators!
-      Validatable.validates_inclusion_of :field, in: valid_values 
+    before { Validatable.validates_inclusion_of :field, in: valid_values }
+    it_behaves_like "it validates the inclusion of each member of the attribute value" do
+      let(:record) { Validatable.new }
     end
-    it_behaves_like "it validates the inclusion of each member of the attribute value"
   end
+
+  it_behaves_like "an enumerable validator" do
+    let(:options) { { inclusion: { in: valid_values } } }
+    let(:record_class) { Validatable }
+    let(:attribute) { :field }
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-validations
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - dchandekstark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel