missing_validators 0.1.1 → 0.2.0

data/README.md

@@ -1,6 +1,9 @@
 # MissingValidators
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/andrewgr/missing_validators.png)](https://travis-ci.org/andrewgr/missing_validators)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/andrewgr/missing_validators)
+
+MissingValidators is a collection of custom validators that are often required in Rails applications plus shoulda-style RSpec matchers to test the validation rules.
 
 ## Installation
 
@@ -18,10 +21,62 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### EmailValidator
+
+With an ActiveRecord model:
+
+    class User < ActiveRecord::Base
+      attr_accessor :email, :name
+      validates :email, email: true
+    end
+
+Or any ruby class:
+
+    class User
+      include ActiveModel::Validations
+      attr_accessor :email, :name
+      validates :email, email: true
+    end
+
+You can specify domains to which the email domain should belong in one of the folowing ways:
+
+    validates :email, email: { domains: 'com' }
+    validates :email, email: { domains: :com }
+    validates :email, email: { domains: [:com, 'edu'] }
+
+RSpec matcher is also available for your convenience:
+
+    describe User do
+      it { should ensure_valid_email_format_of(:email) }
+    end
+
+### InequalityValidator
+
+With an ActiveRecord model:
+
+    class Flight < ActiveRecord::Base
+      attr_accessor :origin, :destination
+      validates :origin, inequality: { to: :destination }
+    end
+
+Or any ruby class:
+
+    class Flight
+      include ActiveModel::Validations
+      attr_accessor :origin, :destination
+      validates :origin, inequality: { to: :destination }
+    end
+
+RSpec matcher is also available for your convenience:
+
+    describe Flight do
+      it { should ensure_inequality_of(:origin).to(:destination) }
+    end
 
 ## Contributing
 
+Your contribution is welcome.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)

data/lib/missing_validators/validators/email_validator.rb

@@ -1,6 +1,38 @@
+# Allows to check if the value of a specific attribute is a valid email address.
+#
+# @example Validate that the user email is a valid email address.
+#   class User << ActiveRecord::Base
+#     attr_accessor :email, :name
+#     validates :email, email: true
+#   end
 class EmailValidator < ActiveModel::EachValidator
+  # Checks if an attribute value is a valid email address.
+  #
+  # @param [Object] record object to validate
+  # @param [String] attribute name of the object attribute to validate
+  # @param [Object] attribute attribute value
   def validate_each(record, attribute, value)
-    unless value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+    domains = Array.wrap options[:domain]
+
+    allow_blank = options[:allow_blank] || false
+
+    value = "" if allow_blank && !value
+
+    if !allow_blank && !value
+      message = options[:message] || I18n.t('errors.messages.email')
+      record.errors[attribute] << message
+    end
+
+    valid_domain = true
+
+    valid_format = !!(value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i)
+    if domains.any?
+      valid_domain = domains.inject (false) do |acc, domain|
+        acc || value.end_with?(".#{domain}")
+      end
+    end
+
+    unless valid_format && valid_domain
       message = options[:message] || I18n.t('errors.messages.email')
       record.errors[attribute] << message
     end

data/lib/missing_validators/validators/inequality_validator.rb

@@ -1,4 +1,17 @@
+# Allows to check if the value of a specific attribute is not equal to
+# the value of another attribute of an object.
+#
+# @example Validate that flight origin is not the same as its destination.
+#   class Flight << ActiveRecord::Base
+#     attr_accessor :origin, :destination
+#     validates :origin, inequality: { to: :destination }
+#   end
 class InequalityValidator < ActiveModel::EachValidator
+  # Checks if an attribute value is unequal to another attrubute value.
+  #
+  # @param [Object] record object to validate
+  # @param [String] attribute name of the object attribute to validate
+  # @param [Object] attribute attribute value
   def validate_each(record, attribute, value)
     unequal_to_attr = options[:to]
 

data/lib/missing_validators/version.rb

@@ -1,3 +1,5 @@
+# Provides a collection of custom validators that are often required in Rails applications.
 module MissingValidators
-  VERSION = "0.1.1"
+  # Gem version.
+  VERSION = "0.2.0"
 end

data/missing_validators.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = MissingValidators::VERSION
 
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'shoulda-matchers'
 
   gem.add_dependency 'activemodel', '> 3.0.0'
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'missing_validators'
+require 'shoulda-matchers'
 
 I18n.load_path << File.expand_path("../../config/locales/en.yml", __FILE__)
 

data/spec/validators/email_validator_spec.rb

@@ -1,31 +1,71 @@
 require 'spec_helper'
 
 describe EmailValidator do
-  class User
-    include ActiveModel::Validations
-    attr_accessor :email, :name
-    validates :email, email: true
+  let(:klass) do
+    Class.new do
+      include ActiveModel::Validations
+      attr_accessor :email, :name
+      validates :email, email: true
+    end
   end
 
-  context do
-    subject(:user){ User.new }
+  subject(:model){ klass.new }
+
+  it { should ensure_valid_email_format_of(:email) }
+  it { should_not ensure_valid_email_format_of(:name) }
+
+  context "email has valid format" do
+    let(:klass) do
+      Class.new do
+        include ActiveModel::Validations
+        attr_accessor :email, :name
+        validates :email, email: true
+      end
+    end
+
+    it { should allow_value("super.user@example.com").for(:email) }
+    it { should_not allow_value("user_example.com").for(:email) }
+  end
 
-    it { should ensure_valid_email_format_of(:email) }
-    it { should_not ensure_valid_email_format_of(:name) }
+  context "email is in a specific domain" do
+    context "email domain specified as string" do
+      let(:klass) do
+        Class.new do
+          include ActiveModel::Validations
+          attr_accessor :email
+          validates :email, email: { domain: "edu" }
+        end
+      end
 
-    specify "is valid with a valid email address" do
-      user.email = "super.user@example.com"
-      expect(user).to be_valid
+      it { should allow_value("user@example.edu").for(:email) }
+      it { should_not allow_value("user@example.com").for(:email) }
     end
 
-    specify "is valid with a valid email address" do
-      user.email = "user@example.com"
-      expect(user).to be_valid
+    context "email domain specified as symbol" do
+      let(:klass) do
+        Class.new do
+          include ActiveModel::Validations
+          attr_accessor :email
+          validates :email, email: { domain: :edu }
+        end
+      end
+
+      it { should allow_value("user@example.edu").for(:email) }
+      it { should_not allow_value("user@example.com").for(:email) }
     end
 
-    specify "fields have different value" do
-      user.email = "user_example.com"
-      expect(user).to be_invalid
+    context "email set as an array of strings and symbols" do
+      let(:klass) do
+        Class.new do
+          include ActiveModel::Validations
+          attr_accessor :email
+          validates :email, email: { domain: ['com', :edu] }
+        end
+      end
+
+      it { should allow_value("user@example.com").for(:email) }
+      it { should allow_value("user@example.edu").for(:email) }
+      it { should_not allow_value("user@example.org").for(:email) }
     end
   end
 end

data/spec/validators/inequality_validator_spec.rb

@@ -1,44 +1,44 @@
 require 'spec_helper'
 
 describe InequalityValidator do
-  class Flight
-    include ActiveModel::Validations
-    attr_accessor :origin, :destination, :airline
-    validates :origin, inequality: { to: :destination }
+  let(:klass) do
+    Class.new do
+      include ActiveModel::Validations
+      attr_accessor :origin, :destination, :airline
+      validates :origin, inequality: { to: :destination }
+    end
   end
 
-  context do
-    subject(:flight){ Flight.new }
+  subject(:model){ klass.new }
 
-    it { should ensure_inequality_of(:origin).to(:destination) }
-    it { should_not ensure_inequality_of(:origin).to(:airline) }
+  it { should ensure_inequality_of(:origin).to(:destination) }
+  it { should_not ensure_inequality_of(:origin).to(:airline) }
 
-    specify "both fields have same values" do
-      flight.origin = flight.destination = "MOW"
-      expect(flight).to be_invalid
-    end
+  specify "both fields have same values" do
+    model.origin = model.destination = "MOW"
+    expect(model).to be_invalid
+  end
 
-    specify "fields have different value" do
-      flight.origin = "NYC"
-      flight.destination = "MOW"
-      expect(flight).to be_valid
-    end
+  specify "fields have different value" do
+    model.origin = "NYC"
+    model.destination = "MOW"
+    expect(model).to be_valid
+  end
 
-    specify "first field has value, the second is nil" do
-      flight.origin = "NYC"
-      flight.destination = nil
-      expect(flight).to be_valid
-    end
+  specify "first field has value, the second is nil" do
+    model.origin = "NYC"
+    model.destination = nil
+    expect(model).to be_valid
+  end
 
-    specify "first field is nil, the second has value" do
-      flight.origin = nil
-      flight.destination = "NYC"
-      expect(flight).to be_valid
-    end
+  specify "first field is nil, the second has value" do
+    model.origin = nil
+    model.destination = "NYC"
+    expect(model).to be_valid
+  end
 
-    specify "both fields are nil" do
-      flight.origin = flight.destination = nil
-      expect(flight).to be_invalid
-    end
+  specify "both fields are nil" do
+    model.origin = model.destination = nil
+    expect(model).to be_invalid
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: missing_validators
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153570960 !ruby/object:Gem::Requirement
+  requirement: &2153717420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153570960
+  version_requirements: *2153717420
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: &2153732080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153732080
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2153569660 !ruby/object:Gem::Requirement
+  requirement: &2153729920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -32,7 +43,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153569660
+  version_requirements: *2153729920
 description: Adds some handy validators.
 email:
 - andrew.gridnev@gmail.com
@@ -86,3 +97,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/validators/email_validator_spec.rb
 - spec/validators/inequality_validator_spec.rb
+has_rdoc: