hydra-validations 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cae38f3407ca9c3bc9b8f23b3e48c058fdda29a7
-  data.tar.gz: 6f8425826a0e664be440b6508bf9f0deb7a7ecbf
+  metadata.gz: f00975706cfd4a91b57c5a09f1213dd3c70d7f94
+  data.tar.gz: 5cd13aed9137be4e5b7a1d5a2613e480714c769e
 SHA512:
-  metadata.gz: f1e72b4e763c1279f7a1bd16e8d9f2ef5ff730f85cccbbcbb52e210336f5ee748bb7acac8d7f6d8858f666bac9e99af4d039066d2bc912de804049a74c502625
-  data.tar.gz: 08ea622a521af583cc2122ad7f639cf9a45b3c09ae2549fe49ecf5f9e3af8648f30f72b00f2359472cb6325fe0aed22e04c7291bf6c9b1dd3b836c9cece959e7
+  metadata.gz: c1693bbdea424392a36c1ce404bfa101c4b0b50018bcc3bcf547aeb3c9080f846a70e3c3db369cd65c8ab9bcf9a9f4815db8c52c73b3ea75d02e70f651676a2d
+  data.tar.gz: fcf3f038f0dea92121caab4e694c8acb2bbc3a34f11ec8e4abe52d4df7a8eeb12ad05d7143b3d3a30f238f219441c32df6b41097a7630ef928f1f9fe68f23f53

data/README.md

@@ -28,28 +28,91 @@ bundle install
 
 ## Validators
 
-See also the source code andn spec tests.
+See also the source code and spec tests.
+
+### FormatValidator
+
+Extends the ActiveModel version to validate the format of *each member* of an enumerable attribute value.
+
+See documentation for ActiveModel::Validations::FormatValidator for usage and options.
+
+```ruby
+class FormatValidatable
+  include ActiveModel::Validations # required if not already included in class
+  include Hydra::Validations
+  attr_accessor :field
+  validates :field, format: { with: /\A[[:alpha:]]+\Z/ }
+  # ... or
+  # validates_format_of :field, with: /\A[[:alpha:]]+\Z/
+end
+
+> v = FormatValidatable.new
+ => #<FormatValidatable:0x007ffc55175300> 
+> v.field = ["foo", "bar"]
+ => ["foo", "bar"] 
+> v.valid?
+ => true 
+> v.field = ["foo1", "bar2"]
+ => ["foo1", "bar2"] 
+> v.valid?
+ => false 
+> v.errors[:field]
+ => ["value \"foo1\" is invalid", "value \"bar2\" is invalid"] 
+> v.errors.full_messages
+ => ["Field value \"foo1\" is invalid", "Field value \"bar2\" is invalid"]
+```
+
+### InclusionValidator
+
+Extends the ActiveModel version to validate inclusion of *each member* of an enumerable attribute value.
+
+See documentation for ActiveModel::Validations::InclusionValidator for usage and options.
+
+```ruby
+class InclusionValidatable
+  include ActiveModel::Validations # required if not already included in class
+  include Hydra::Validations
+  attr_accessor :field
+  validates :field, inclusion: { in: ["foo", "bar", "baz"] }
+end
+
+> v = InclusionValidatable.new
+ => #<InclusionValidatable:0x007ffc53079318> 
+> v.field = ["foo", "bar"]
+ => ["foo", "bar"] 
+> v.valid?
+ => true 
+> v.field = ["foo", "bar", "spam", "eggs"]
+ => ["foo", "bar", "spam", "eggs"] 
+> v.valid?
+ => false 
+> v.errors[:field]
+ => ["value \"spam\" is not included in the list", "value \"eggs\" is not included in the list"] 
+> v.errors.full_messages
+ => ["Field value \"spam\" is not included in the list", "Field value \"eggs\" is not included in the list"]
+```
 
 ### UniquenessValidator (ActiveFedora)
 
+Validates the uniqueness of an attribute based on a Solr index query.
+
 ```ruby
-class Validatable < ActiveFedora::Base
+class UniquenessValidatable < 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 :source, uniqueness: { solr_name: "source_ssim" }
+  # ... or using helper method
   validates_uniqueness_of :title, solr_name: "title_ssi"
-
-  # Using `validates' with options
-  validates :source, uniqueness: { solr_name: "subject_ssim" }
 end
 ```
 
-### SingleCardinalityValidatory (Can be used with POROs)
+### SingleCardinalityValidatory
+
+Validates that the attribute value is a scaler or single-member enumerable.
 
 ```ruby
 class Validatable

data/lib/hydra/validations/cardinality.rb

@@ -0,0 +1,20 @@
+module Hydra
+  module Validations
+    #
+    # Cardinality - a mixin adding cardinality validation methods.
+    #
+    module Cardinality
+
+      def validate_cardinality(cardinality, record, attribute, value)
+        return validate_single_cardinality(record, attribute, value) if cardinality == :single
+        raise ArgumentError, "Cardinality validation not supported: #{cardinality.inspect}"
+      end
+
+      def validate_single_cardinality(record, attribute, value)
+        # TODO i18n message
+        record.errors.add(attribute, "can't have more than one value") if value.respond_to?(:each) && value.size > 1
+      end
+
+    end
+  end
+end

data/lib/hydra/validations/enumerable_behavior.rb

@@ -0,0 +1,35 @@
+module Hydra
+  module Validations
+    #
+    # EnumerableBehavior - a mixin for subclasses of ActiveModel::EachValidator 
+    # adding validation for each member of an enumerable attribute value.
+    #
+    # Behavior includes 'fixing' each error message to include the specific value
+    # which was invalid.
+    #
+    module EnumerableBehavior
+
+      def validate_each(record, attribute, value)
+        if value.respond_to?(:each)
+          value.each do |v| 
+            prev = record.errors[attribute].size rescue 0
+            super(record, attribute, v)
+            messages = record.errors[attribute]
+            if messages && messages.size > prev
+              record.errors.add(attribute, fixed_message(v, messages.pop))
+            end
+          end
+        else
+          super
+        end
+      end
+
+      protected
+
+      def fixed_message(value, message)
+        "value \"#{value}\" #{message}"
+      end
+
+    end
+  end
+end

data/lib/hydra/validations/format.rb

@@ -0,0 +1,21 @@
+require 'hydra/validations/enumerable_behavior'
+
+module Hydra
+  module Validations
+    #
+    # FormatValidator - Add EnumerableBehavior to ActiveModel's FormatValidator
+    #
+    # See ActiveModel::Validations::FormatValidator for usage and options.
+    #
+    class FormatValidator < ActiveModel::Validations::FormatValidator
+      include EnumerableBehavior
+    end
+
+    module HelperMethods
+      def validates_format_of *attr_names
+        validates_with FormatValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end

data/lib/hydra/validations/inclusion.rb

@@ -0,0 +1,21 @@
+require 'hydra/validations/enumerable_behavior'
+
+module Hydra
+  module Validations
+    #
+    # InclusionValidation - Adds EnumerableBehavior to ActiveModel's InclusionValidator
+    #
+    # See ActiveModel::Validations::InclusionValidator for usage and options
+    #
+    class InclusionValidator < ActiveModel::Validations::InclusionValidator
+      include EnumerableBehavior
+    end
+
+    module HelperMethods
+      def validates_inclusion_of *attr_names
+        validates_with InclusionValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end

data/lib/hydra/validations/single_cardinality.rb

@@ -0,0 +1,32 @@
+require 'hydra/validations/cardinality'
+
+module Hydra
+  module Validations
+    #
+    # SingleCardinalityValidator - validates that an enumerator value has size 0 or 1
+    #
+    #    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).
+    #
+    class SingleCardinalityValidator < ActiveModel::EachValidator
+      
+      include Cardinality
+
+      def validate_each(record, attribute, value)
+        validate_cardinality(:single, record, attribute, value)
+      end
+
+    end
+
+    module HelperMethods
+      def validates_single_cardinality_of *attr_names
+        validates_with SingleCardinalityValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end
+

data/lib/hydra/validations/{uniqueness_validator.rb → uniqueness.rb}

@@ -1,5 +1,5 @@
 require 'hydra/validations'
-require 'hydra/validations/single_cardinality_validator'
+require 'hydra/validations/cardinality'
 
 module Hydra
   module Validations
@@ -16,29 +16,31 @@ module Hydra
     # - Accepts only one attribute (can have more than one UniquenessValidator on a model, however)
     # - :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
+    #   validator also validates single cardinality, 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 < SingleCardinalityValidator
+    class UniquenessValidator < ActiveModel::EachValidator
+
+      include Cardinality
 
       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)
+        # TODO: i18n messages
+        validate_cardinality(:single, record, attribute, value)
+        # Validate uniqueness proper only if value is of single cardinality
+        return if record.errors.added?(attribute, "can't have more than one value") 
+        value = value.first if value.respond_to?(:each)
         conditions = {options[:solr_name] => value}
         conditions.merge!("-id" => record.id) if record.persisted?
-        if record.class.exists? conditions
-          record.errors.add attribute, "has already been taken" 
-        end
+        record.errors.add attribute, "has already been taken" if record.class.exists?(conditions)
       end
 
     end

data/lib/hydra/validations/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Validations
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/spec/spec_helper.rb

@@ -57,4 +57,6 @@ RSpec.configure do |config|
     # a real object. This is generally recommended.
     mocks.verify_partial_doubles = true
   end
+
+  I18n.enforce_available_locales = false
 end

data/spec/validators/format_validator_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+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"] }
+    it "should be valid" do
+      expect(subject).to be_valid
+    end
+  end
+  context "one of the attribute value members is invalid" do
+    before { subject.field = ["foo1", "bar"] }
+    it "should be invalid" do
+      expect(subject).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"]
+    end
+  end
+end
+
+describe Hydra::Validations::FormatValidator do
+  before(:all) do
+    class Validatable
+      include ActiveModel::Validations
+      include Hydra::Validations
+      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/ }
+    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/
+    end
+    it_behaves_like "it validates the format of each member of the attribute value"
+  end
+end

data/spec/validators/inclusion_validator_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+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"] }
+    it "should be valid" do
+      expect(subject).to be_valid
+    end
+  end
+  context "one of the attribute value members is invalid" do
+    before { subject.field = ["foo1", "bar"] }
+    it "should be invalid" do
+      expect(subject).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"]
+    end
+  end
+end
+
+describe Hydra::Validations::InclusionValidator do
+  before(:all) do
+    class Validatable
+      include ActiveModel::Validations
+      include Hydra::Validations
+      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 } 
+    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 
+    end
+    it_behaves_like "it validates the inclusion of each member of the attribute value"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-validations
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - dchandekstark
@@ -98,11 +98,17 @@ files:
 - Rakefile
 - hydra-validations.gemspec
 - lib/hydra/validations.rb
-- lib/hydra/validations/single_cardinality_validator.rb
-- lib/hydra/validations/uniqueness_validator.rb
+- lib/hydra/validations/cardinality.rb
+- lib/hydra/validations/enumerable_behavior.rb
+- lib/hydra/validations/format.rb
+- lib/hydra/validations/inclusion.rb
+- lib/hydra/validations/single_cardinality.rb
+- lib/hydra/validations/uniqueness.rb
 - lib/hydra/validations/version.rb
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_validators.rb
+- spec/validators/format_validator_spec.rb
+- spec/validators/inclusion_validator_spec.rb
 - spec/validators/single_cardinality_validator_spec.rb
 - spec/validators/uniqueness_validator_spec.rb
 homepage: https://github.com/duke-libraries/hydra-validations
@@ -133,5 +139,7 @@ summary: Validations for Hydra applications, based on ActiveModel::Validations
 test_files:
 - spec/spec_helper.rb
 - spec/support/shared_examples_for_validators.rb
+- spec/validators/format_validator_spec.rb
+- spec/validators/inclusion_validator_spec.rb
 - spec/validators/single_cardinality_validator_spec.rb
 - spec/validators/uniqueness_validator_spec.rb

data/lib/hydra/validations/single_cardinality_validator.rb

@@ -1,29 +0,0 @@
-#
-# SingleCardinalityValidator - validates that an enumerator value has size 0 or 1
-#
-#    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
-
-    class SingleCardinalityValidator < ActiveModel::EachValidator
-      def validate_each(record, attribute, value)
-        if value.respond_to?(:each)
-          record.errors.add(attribute, "can't have more than one value") if value.size > 1
-        end
-      end
-    end
-
-    module HelperMethods
-      def validates_single_cardinality_of *attr_names
-        validates_with SingleCardinalityValidator, _merge_attributes(attr_names)
-      end
-    end
-
-  end
-end
-