hydra-validations 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cd9dc181595609320187b6967b7419c584e5592
-  data.tar.gz: e87ae57ed9847709bccd5979eee498381707cc13
+  metadata.gz: 5e3b8f594ffb78eea70a27d91d92ed195988ae54
+  data.tar.gz: 1d2abb83db312b502a3570bd428a90e13d355750
 SHA512:
-  metadata.gz: 45b9a25dd9f59461d336b8877e14371f67ef764ed0b879960f375f97e60236a646c29cef36660703598a2fe3ac46f6f7a7a0ea2ee1be020ea6552e94c914bfa7
-  data.tar.gz: 0212d9e7f159ddbacf0a291b4a80a91f95659aa95474c7cff67e337e57132fb37d2f39e2be660c4cfaaa0f856d51d62884c715196ca6b061522645e8c154aa23
+  metadata.gz: 77946326c106d26eef65cc9e41380a5a2eb01bab261f637dafb6400e84b710b31b2d3f04b22b7c8ba426a62043270708ebe78156bb467b904cf64b3175accdbd
+  data.tar.gz: 6084c27aaf6326df5adc5216b3466ecce67d67d0558cab7a0993c8fce488f8c263fe4ee5011cfd66d152b121c13593c95e803fc218e84fe844fab8784941608d

data/CONTRIBUTORS.md

@@ -2,3 +2,4 @@ Contributors to this project:
 
 * David Chandek-Stark
 * Jeremy Friesen
+* Rajesh Balekai

data/README.md

@@ -1,16 +1,18 @@
 hydra-validations
 =======================
 
-Custom validators for Hydra applications, based on ActiveModel::Validations.
-
 [![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)
 
+Custom validators based on ActiveModel::Validations, developed for Hydra applications.
+
 ## Dependencies
 
 * Ruby >= 1.9.3
 * ActiveModel 4.x
 
+ActiveFedora 7.x is a run-time dependency of the UniquenessValidator only, and is not provided by this gem.
+
 ## Installation
 
 Include in your Gemfile:
@@ -25,17 +27,109 @@ and
 bundle install
 ```
 
+## Why?
+
+- Metadata values are (often) arrays (XML or RDF).
+- ActiveModel validators don't distinguish between array values and scalar values.
+- We want validators that validate each member of an array value.
+
+### Example: PORO with ActiveModel::Validations
+
+```ruby
+class Validatable
+  include ActiveModel::Validations
+  attr_accessor :type
+  validates_inclusion_of :type, in: %w(text image audio video)
+end
+
+>> record = Validatable.new
+>> record.type = "text"
+>> record.valid?
+=> true
+
+>> record.type = ["text", "image"]
+>> record.valid?
+=> false # not what we want :(
+
+# now let's add Hydra::Validations ...
+
+class CorrectlyValidatable
+  include ActiveModel::Validations
+  include Hydra::Validations
+  attr_accessor :type
+  validates_inclusion_of :type, in: %w(text image audio video)
+end
+
+>> record = CorrectlyValidatable.new
+>> record.type = ["text", "image"]
+>> record.valid?
+=> true # Yay!
+
+>> record.type = ["text", "newspaper"]
+>> record.valid?
+=> false
+
+# tailors error message to specific invalid array value
+>> puts record.errors.full_messages
+Type value "newspaper" is not included in the list
+```
+
+### Example: ActiveTriples::Resource
+
+```ruby
+class MyResource < ActiveTriples::Resource
+  # ActiveTriples::Resource includes ActiveModel::Validations
+  property :type, predicate: RDF::DC.type
+  validates_inclusion_of :type, in: %w(text image audio video)
+end
+
+>> resource = MyResource.new
+>> resource.type = "text"
+>> resource.valid?
+=> false # Huh? Oh yeah, resource.type is actually an array ...
+>> resource.type
+=> ["text"]
+
+class YourResource < ActiveTriples::Resource
+  include Hydra::Validations
+  property :type, predicate: RDF::DC.type
+  validates_inclusion_of :type, in: %w(text image audio video)
+end
+
+>> resource = YourResource.new
+>> resource.type = "text"
+=> "text"
+>> resource.valid?
+=> true # Yay!
+
+>> resource.type << "newspapers"
+>> resource.type
+=> ["text", "newspapers"]
+>> resource.valid?
+=> false
+>> puts resource.errors.full_messages
+Type value "newspapers" is not included in the list
+```
+
 ## EnumerableBehavior Mixin
 
+`Hydra::Validations::EnumerableBehavior` is a mixin for an `ActiveModel::EachValidator` that validates each member of an enumerable value.  See the [FormatValidator](#formatvalidator) and [InclusionValidator](#inclusionvalidator) below for examples.
+
+EnumerableBehavior overrides `validate_each(record, attribute, value)` calling `super(record, attribute, member)` for each member of an enumerable value (i.e., responds to `:each`).  The module "fixes" any error messages to include the specific member that failed validation -- for example, `"is invalid"` becomes `"value \"foo1\" is invalid"`, so the full message `"Identifier is invalid"` becomes `"Identifer value \"foo1\" is invalid"`.
+
+**allow_nil, allow_blank, and allow_empty**
+
+With EnumerableBehavior, validation of non-enumerables is unchanged (`validate_each` simply returns `super`); however, the validator options `allow_nil` and `allow_blank` *apply only to the original value* (the enumerable) and not to its members. For example, the value `[""]` with the option `allow_blank: true` will *not* bypass validation. As a result, empty enumerables will fail validation unless `allow_blank` is true or the special enumerable option `allow_empty` is true (that option does not bypass validation for non-enumerables that respond to `:empty?`, e.g., empty strings).
+
 ## Validators
 
 See also the source code and spec tests.
 
 ### FormatValidator
 
-Extends the ActiveModel::Validations::FormatValidator, adding EnumerableBehavior.
+Extends `ActiveModel::Validations::FormatValidator`, adding EnumerableBehavior.
 
-See documentation for ActiveModel::Validations::FormatValidator for usage and options.
+See `ActiveModel::Validations::FormatValidator` for usage and options.
 
 ```ruby
 class FormatValidatable
@@ -47,27 +141,34 @@ class FormatValidatable
   # 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"]
+>> record = FormatValidatable.new
+=> #<FormatValidatable:0x007fe3cc0ece70>
+>> record.field = "foo"
+=> "foo"
+>> record.valid?
+=> true
+>> record.field = ["foo"]
+=> ["foo"]
+>> record.valid?
+=> true
+>> record.field = ["foo", "bar"]
+=> ["foo", "bar"]
+>> record.valid?
+=> true
+>> record.field = ["foo1", "bar2"]
+=> ["foo1", "bar2"]
+>> record.valid?
+=> false
+>> puts record.errors.full_messages
+Field value "foo1" is invalid
+Field value "bar2" is invalid
 ```
 
 ### InclusionValidator
 
-Extends ActiveModel::Validations::InclusionValidator, adding EnumerableBehavior.
+Extends `ActiveModel::Validations::InclusionValidator`, adding EnumerableBehavior.
 
-See documentation for ActiveModel::Validations::InclusionValidator for usage and options.
+See `ActiveModel::Validations::InclusionValidator` for usage and options.
 
 ```ruby
 class InclusionValidatable
@@ -79,20 +180,30 @@ class InclusionValidatable
   # validates_inclusion_of :field, 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"]
+>> record = InclusionValidatable.new
+=> #<InclusionValidatable:0x007fe3cbc40098>
+>> record.field = "foo"
+=> "foo"
+>> record.valid?
+=> true
+>> record.field = "foo1"
+=> "foo1"
+>> record.valid?
+=> false
+>> record.field = ["foo"]
+=> ["foo"]
+>> record.valid?
+=> true
+>> record.field = ["foo", "bar"]
+=> ["foo", "bar"]
+>> record.valid?
+=> true
+>> record.field = ["foo", "bar1", "baz"]
+=> ["foo", "bar1", "baz"]
+>> record.valid?
+=> false
+>> puts record.errors.full_messages
+Field value "bar1" is not included in the list
 ```
 
 ### UniquenessValidator
@@ -103,7 +214,7 @@ Intended for ActiveFedora 7.x.
 
 ```ruby
 class UniquenessValidatable < ActiveFedora::Base
-  include Hydra::Validations
+  include Hydra::Validations # ActiveFedora::Base includes ActiveModel::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.
@@ -118,9 +229,9 @@ end
 
 Validates the cardinality of the attribute value. 
 
-CardinalityValidator is a subclass of ActiveModel::Validations::LengthValidator which
+CardinalityValidator extends `ActiveModel::Validations::LengthValidator` and
 "tokenizes" values with `Array.wrap(value)`.  The "cardinality" of the value
-is the length the array. Hence,
+is therefore the length the array. Accordingly,
 
 - `nil` and empty enumerables have cardinality 0
 - scalar values (including empty string) have cardinality 1.
@@ -141,20 +252,20 @@ class CardinalityValidatable
   # validates_single_cardinality_of :field
 end
 
-> CardinalityValidatable.validators
- => [#<Hydra::Validations::CardinalityValidator:0x007fb91d1e9460 @attributes=[:field], @options={:is=>1}>] 
-> v = Validatable.new
- => #<Validatable:0x007fb91d1c9188> 
-> v.field = "foo"
- => "foo" 
-> v.valid?
- => true 
-> v.field = ["foo"]
- => ["foo"] 
-> v.valid?
- => true 
-> v.field = ["foo", "bar"]
- => ["foo", "bar"] 
-> v.valid?
- => false 
+>> record = CardinalityValidatable.new
+=> #<CardinalityValidatable:0x007fe3cbc632c8>
+>> record.field = "foo"
+=> "foo"
+>> record.valid?
+=> true
+>> record.field = ["foo"]
+=> ["foo"]
+>> record.valid?
+=> true
+>> record.field = ["foo", "bar"]
+=> ["foo", "bar"]
+>> record.valid?
+=> false
+>> puts record.errors.full_messages
+Field has the wrong cardinality (should have 1 value(s))
 ```

data/lib/hydra/validations/presence.rb

@@ -0,0 +1,16 @@
+require 'hydra/validations/enumerable_behavior'
+module Hydra
+  module Validations
+    class PresenceValidator < ActiveModel::Validations::PresenceValidator
+      def validate_each(record, attribute, values)
+        values = Array.wrap(values)
+        record.errors.add(attribute, :blank, options) if values.blank? || values.any?(&:blank?)
+      end
+    end
+    module HelperMethods
+      def validates_presence_of *attr_names
+        validates_with PresenceValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/hydra/validations/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module Validations
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/spec/validations/presence_validator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Hydra::Validations::PresenceValidator do
+  let(:validatable) do
+    Class.new do
+      def self.name
+        'Validatable'
+      end
+      include ActiveModel::Validations
+      include Hydra::Validations
+      attr_accessor :an_attribute
+      validates_presence_of :an_attribute, message: "Can't have blank values"
+    end
+  end
+
+  context 'validation scenarios' do
+    subject { validatable.new }
+    [
+      { values: [], valid?: false } ,
+      { values: [''], valid?: false } ,
+      { values: nil, valid?: false },
+      { values: '', valid?: false },
+      { values: ['work', ''], valid?: false },
+      { values: ['work', nil], valid?: false },
+      { values: ['work'], valid?: true },
+      { values: 'work', valid?: true }
+    ].each do |scenario|
+      it "will validate #{scenario.fetch(:values).inspect} as valid? == #{scenario.fetch(:valid?)}" do
+        subject.an_attribute = scenario.fetch(:values)
+        expect(subject.valid?).to eq(scenario.fetch(:valid?))
+      end
+    end
+
+    it 'should add error message' do
+      subject.an_attribute = nil
+      subject.valid?
+      expect(subject.errors[:an_attribute]).to eq(["Can't have blank values"])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-validations
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - dchandekstark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -88,6 +88,7 @@ files:
 - lib/hydra/validations/enumerable_behavior.rb
 - lib/hydra/validations/format.rb
 - lib/hydra/validations/inclusion.rb
+- lib/hydra/validations/presence.rb
 - lib/hydra/validations/uniqueness.rb
 - lib/hydra/validations/version.rb
 - spec/spec_helper.rb
@@ -96,6 +97,7 @@ files:
 - spec/validations/format_validator_spec.rb
 - spec/validations/helper_methods_spec.rb
 - spec/validations/inclusion_validator_spec.rb
+- spec/validations/presence_validator_spec.rb
 - spec/validations/uniqueness_validator_spec.rb
 homepage: https://github.com/duke-libraries/hydra-validations
 licenses:
@@ -129,4 +131,5 @@ test_files:
 - spec/validations/format_validator_spec.rb
 - spec/validations/helper_methods_spec.rb
 - spec/validations/inclusion_validator_spec.rb
+- spec/validations/presence_validator_spec.rb
 - spec/validations/uniqueness_validator_spec.rb