hydra-validations 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 435663a78ed5e8ae4eed2d29cebbee6860792ed2
-  data.tar.gz: 85cf53d256c12174cda539c5193afff0a0e08a8a
+  metadata.gz: b9dfa48b0a0b2e0a48f98c2e74997eb01561f0e9
+  data.tar.gz: e079173cde687fd5330d95899159f3770ecbe033
 SHA512:
-  metadata.gz: cb3a7917caf907655fdfdcb3f1f304294c1cd4ea32abd73792b4301ac5b889b07a5c88e78c5519d8de86666c6d7419559fc6cbe3e82345cc81d16de833f9dd35
-  data.tar.gz: 906c190556c2aecb9ecd23c9dc123398551725f032b0616481d497d956b5382ce56c116da718b21d882641de370348e2d9085a0a3a0e68b57be913db79c5b5cb
+  metadata.gz: d3bf062ad4331cbbf804944742f837b4e6c8bb1fdf79281e9f2d5438b51f29a10bedad490df5e7ce3fb321cd63a92eca683ddb74310b1c7f1aaf0b86b10b4612
+  data.tar.gz: c436515ce8b56ac20c3c50331b800a8fef0d891a31398f3d02f5f833c02523f72f8e154af0e352504860cc71549efeccf390a20ad64cf800c4d20dc1ea79effa

data/.travis.yml

@@ -3,3 +3,6 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+# ActiveFedora raises RuntimeError w/o this setting
+env:
+  - environment="test"

data/README.md

@@ -1,15 +1,18 @@
 hydra-validations
 =======================
 
-Custom validators for Hydra applications based on ActiveModel::Validations.
+Custom validators for Hydra applications, based on ActiveModel::Validations.
 
-### Dependencies
+[![Build Status](https://travis-ci.org/projecthydra-labs/hydra-validations.svg?branch=master)](https://travis-ci.org/projecthydra-labs/hydra-validations)
+[![Gem Version](https://badge.fury.io/rb/hydra-validations.svg)](http://badge.fury.io/rb/hydra-validations)
+
+## Dependencies
 
 * Ruby >= 1.9.3
 * ActiveModel 4.x
 * ActiveFedora 7.x
 
-### Installation
+## Installation
 
 Include in your Gemfile:
 
@@ -23,14 +26,34 @@ and
 bundle install
 ```
 
-### Example
+## Validators
+
+See also the source code andn spec tests.
+
+### UniquenessValidator (ActiveFedora)
+
+```ruby
+class Validatable < ActiveFedora::Base
+  include Hydra::Validations
+  has_metadata name: 'descMetadata', type: ActiveFedora::QualifiedDublinCoreDatastream
+  has_attributes :title, datastream: 'descMetadata', multiple: false
+  # Can use with multi-value attributes, but single cardinality is required.
+  # See SingleCardinalityValidator below.
+  has_attributes :source, datastream: 'descMetadata', multiple: true
+
+  # validates_uniqueness_of helper method
+  validates_uniqueness_of :title, solr_name: "title_ssi"
+
+  # Using `validates' with options
+  validates :source, uniqueness: { solr_name: "subject_ssim" }
+end
+```
 
-With a PORO, we have to include ActiveModel::Validations.  
-ActiveRecord::Base and ActiveFedora::Base already include ActiveModel::Validations.
+### SingleCardinalityValidatory (Can be used with POROs)
 
 ```ruby
 class Validatable
-  include ActiveModel::Validations 
+  include ActiveModel::Validations # required if not already included in class
   include Hydra::Validations
   attr_accessor :field
   validates :field, single_cardinality: true

data/lib/hydra/validations/single_cardinality_validator.rb

@@ -1,8 +1,11 @@
 #
 # SingleCardinalityValidator - validates that an enumerator value has size 0 or 1
 #
-#    validates :my_attr, single_cardinality: true
-#    validates_single_cardinality_of :my_attr
+#    validates :myattr, single_cardinality: true
+#    validates_single_cardinality_of :myattr
+#
+# Blank and nil values are considered valid (even without :allow_blank or :allow_nil
+# validator options).
 #
 module Hydra
   module Validations

data/lib/hydra/validations/uniqueness_validator.rb

@@ -1,3 +1,5 @@
+require 'hydra/validations'
+
 module Hydra
   module Validations
     #
@@ -11,28 +13,26 @@ module Hydra
     # Restrictions:
     #
     # - Accepts only one attribute (can have more than one UniquenessValidator on a model, however)
-    # - Attribute cannot be multi-valued (:multiple=>true option of `has_attributes')
     # - :solr_name option must be present
+    # - Can be used on enumerable values (attribute defined with :multiple=>true option), but 
+    #   validator subclasses SingleCardinalityValidator, so will not pass validation if enumerable
+    #   has more than one member.
     #
     # CAVEAT: The determination of uniqueness depends on a Solr query.
     # False negatives (record invalid) may result if, for example,
     # querying a Solr field of type "text".
     #
-    class UniquenessValidator < ActiveModel::EachValidator
-
-      def initialize(options = {})
-        super
-        attributes.each do |attr|
-          raise ArgumentError, "Cannot validate uniqueness on a multi-valued attribute: #{attribute}." if options[:class].multiple?(attr)
-        end
-      end
+    class UniquenessValidator < SingleCardinalityValidator
 
       def check_validity!
+        super
         raise ArgumentError, "UniquenessValidator accepts only a single attribute: #{attribues}" if attributes.length > 1 
         raise ArgumentError, "UniquenessValidator requires the :solr_name option be present." unless options[:solr_name].present?
       end
 
       def validate_each(record, attribute, value)
+        super
+        value = value.first if record.class.multiple?(attribute)
         conditions = {options[:solr_name] => value}
         conditions.merge!("-id" => record.id) if record.persisted?
         if record.class.exists? conditions

data/lib/hydra/validations/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Validations
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,3 @@
-require 'active_model'
 require 'hydra/validations'
 
 RSpec.configure do |config|

data/spec/support/shared_examples_for_validators.rb

@@ -0,0 +1,33 @@
+shared_examples "it validates the single cardinality of an enumerable attribute" do
+  it "should be valid when the attribute value is nil" do
+    subject.send("#{attribute}=", nil)
+    expect(subject).to be_valid
+  end
+  it "should be valid if the value is empty" do
+    subject.send("#{attribute}=", [])
+    expect(subject).to be_valid
+  end
+  it "should be valid if the value has one element" do
+    subject.send("#{attribute}=", ["foo"])
+    expect(subject).to be_valid
+  end
+  it "should be invalid if the value has more than one element" do
+    subject.send("#{attribute}=", ["foo", "bar"])
+    expect(subject).not_to be_valid      
+  end
+end
+
+shared_examples "it validates the single cardinality of a scalar attribute" do
+  it "should be valid when the attribute value is nil" do
+    subject.send("#{attribute}=", nil)
+    expect(subject).to be_valid
+  end
+  it "should be valid when the value is blank" do
+    subject.send("#{attribute}=", "")
+    expect(subject).to be_valid
+  end
+  it "should be valid when the value is present" do
+    subject.send("#{attribute}=", "foo")
+    expect(subject).to be_valid
+  end
+end

data/spec/validators/single_cardinality_validator_spec.rb

@@ -1,28 +1,9 @@
 require 'spec_helper'
+require 'support/shared_examples_for_validators'
 
-shared_examples "it validates the single cardinality of the field" do
-  it "should be valid when the field value is nil" do
-    subject.field = nil
-    expect(subject).to be_valid
-  end
-  it "should be valid when the field value is a scalar" do
-    subject.field = "foo"
-    expect(subject).to be_valid
-  end
-  context "when the field value is an enumerable" do
-    it "should be valid if the value is empty" do
-      subject.field = []
-      expect(subject).to be_valid
-    end
-    it "should be valid if the value has one element" do
-      subject.field = ["foo"]
-      expect(subject).to be_valid
-    end
-    it "should be invalid if the value has more than one element" do
-      subject.field = ["foo", "bar"]
-      expect(subject).not_to be_valid      
-    end
-  end
+shared_examples "it validates the single cardinality of the attribute" do
+  it_behaves_like "it validates the single cardinality of a scalar attribute"
+  it_behaves_like "it validates the single cardinality of an enumerable attribute"
 end
 
 describe Hydra::Validations::SingleCardinalityValidator do
@@ -38,11 +19,15 @@ describe Hydra::Validations::SingleCardinalityValidator do
   subject { Validatable.new }
   describe ".validates" do
     before { Validatable.validates :field, single_cardinality: true }
-    it_behaves_like "it validates the single cardinality of the field"
+    it_behaves_like "it validates the single cardinality of the attribute" do
+      let(:attribute) { :field }
+    end
   end
   describe ".validates_single_cardinality_of" do
     before { Validatable.validates_single_cardinality_of :field }
-    it_behaves_like "it validates the single cardinality of the field"
+    it_behaves_like "it validates the single cardinality of the attribute" do
+      let(:attribute) { :field }
+    end
   end
 end
 

data/spec/validators/uniqueness_validator_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'active_fedora'
+require 'support/shared_examples_for_validators'
 
 shared_examples "it validates the uniqueness of the attribute value" do
   context "when the value is not taken" do
@@ -23,8 +24,7 @@ describe Hydra::Validations::UniquenessValidator do
       include Hydra::Validations
       has_metadata name: 'descMetadata', type: ActiveFedora::QualifiedDublinCoreDatastream
       has_attributes :title, datastream: 'descMetadata', multiple: false
-      has_attributes :creator, datastream: 'descMetadata', multiple: false
-      has_attributes :subject, datastream: 'descMetadata', multiple: true
+      has_attributes :source, datastream: 'descMetadata', multiple: true
     end
   end
 
@@ -32,11 +32,8 @@ describe Hydra::Validations::UniquenessValidator do
 
   describe "exceptions" do
     before { Validatable.clear_validators! }
-    it "cannot be used on a multi-valued attribute" do
-      expect { Validatable.validates :subject, uniqueness: { solr_name: "subject_ssim" } }.to raise_error
-    end
     it "cannot be used on more than one attribute at a time" do
-      expect { Validatable.validates :title, :creator, uniqueness: { solr_name: "snafu_ssim" } }.to raise_error
+      expect { Validatable.validates :title, :source, uniqueness: { solr_name: "snafu_ssim" } }.to raise_error
     end
     it "cannot be used without the :solr_name option" do
       expect { Validatable.validates :title, uniqueness: true }.to raise_error
@@ -44,23 +41,54 @@ describe Hydra::Validations::UniquenessValidator do
   end
 
   describe "validation" do
-    subject { Validatable.new(pid: "foobar:1", title: "I am Unique!") }
-    let(:solr_name) { "title_ssi" }
-    before do
-      Validatable.clear_validators!
-      Validatable.validates_uniqueness_of :title, solr_name: solr_name
-    end
-    context "when the record is new" do
-      before { allow(subject).to receive(:persisted?) { false } }
-      it_behaves_like "it validates the uniqueness of the attribute value" do
-        let(:conditions) { {solr_name => subject.title} }
+    subject { Validatable.new(pid: "foobar:1", title: "I am Unique!", source: ["Outer Space"]) }
+    context "with a scalar attribute (:multiple=>false)" do
+      before(:all) do
+        Validatable.clear_validators!
+        Validatable.validates_uniqueness_of :title, solr_name: "title_ssi"
+      end
+      context "cardinality validation" do
+        before { allow(Validatable).to receive(:exists?) { false } }
+        it_behaves_like "it validates the single cardinality of a scalar attribute" do
+          let(:attribute) { :title }
+        end
+      end
+      context "when the record is new" do
+        before { allow(subject).to receive(:persisted?) { false } }
+        it_behaves_like "it validates the uniqueness of the attribute value" do
+          let(:conditions) { {"title_ssi" => subject.title} }
+        end
+      end
+      context "when the record is persisted" do
+        before { allow(subject).to receive(:persisted?) { true } }
+        it_behaves_like "it validates the uniqueness of the attribute value" do
+          let(:conditions) { {"title_ssi" => subject.title, "-id" => subject.pid} }
+        end
       end
     end
-    context "when the record is persisted" do
-      before { allow(subject).to receive(:persisted?) { true } }
-      it_behaves_like "it validates the uniqueness of the attribute value" do
-        let(:conditions) { {solr_name => subject.title, "-id" => subject.pid} }
+    context "with an enumerable attribute (:multiple=>true)" do
+      before(:all) do
+        Validatable.clear_validators!
+        Validatable.validates_uniqueness_of :source, solr_name: "source_ssim"
+      end
+      context "cardinality validation" do
+        before { allow(Validatable).to receive(:exists?) { false } }
+        it_behaves_like "it validates the single cardinality of an enumerable attribute" do
+          let(:attribute) { :source }
+        end
+      end
+      context "when the record is new" do
+        before { allow(subject).to receive(:persisted?) { false } }
+        it_behaves_like "it validates the uniqueness of the attribute value" do
+          let(:conditions) { {"source_ssim" => subject.source.first} }
+        end
       end
+      context "when the record is persisted" do
+        before { allow(subject).to receive(:persisted?) { true } }
+        it_behaves_like "it validates the uniqueness of the attribute value" do
+          let(:conditions) { {"source_ssim" => subject.source.first, "-id" => subject.pid} }
+        end
+      end      
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-validations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - dchandekstark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-16 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -102,6 +102,7 @@ files:
 - lib/hydra/validations/uniqueness_validator.rb
 - lib/hydra/validations/version.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_validators.rb
 - spec/validators/single_cardinality_validator_spec.rb
 - spec/validators/uniqueness_validator_spec.rb
 homepage: https://github.com/duke-libraries/hydra-validations
@@ -131,5 +132,6 @@ specification_version: 4
 summary: Validations for Hydra applications, based on ActiveModel::Validations
 test_files:
 - spec/spec_helper.rb
+- spec/support/shared_examples_for_validators.rb
 - spec/validators/single_cardinality_validator_spec.rb
 - spec/validators/uniqueness_validator_spec.rb