missing_validators 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e08933cb1d48eaa485ea7c22290d71be64477d0
-  data.tar.gz: 9456a6513e7249af10493f30d28d0a1947cfd5d3
+  metadata.gz: 86d60392993a9b27e6d49a2ea7eb698c6ee98f1c
+  data.tar.gz: 5ff9de4d33d2e3a97c9c07743c7bc60b9d87f8dc
 SHA512:
-  metadata.gz: d54385d82f777f5605fbfc6a49bb42a0c8ab95f490973816ad25f2ff818a8ca15e05a7a853c7c28da482895a6c5840885457b207da24e55110019c05ef41429d
-  data.tar.gz: e7e588451d9109835edfa1e2d15e57598ed37287a6fbb386577e1007bb61b97359ce3424916806670fd24cb02f78c364da39465f4c543ef48e4d8c0965f6fb4e
+  metadata.gz: 0349e0818d3a3281cbd2bd77803c6fc12409e85a890ba537ced0897e0d22e826f91c0a53d16f2c1256df86d394678ce358919ab4b249820f26c90930df103111
+  data.tar.gz: 91229866d28463716b4f65bc81a472c87efb487e2c32504cc3d0e7930930475f7bb802bf4fc28522fe7b5ffcc0f9ae9762ab32ea49db2ab36467722653edff80

data/README.md

@@ -1,7 +1,7 @@
 # MissingValidators
 
 [![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)
+[![Code Climate](https://codeclimate.com/github/andrewgr/missing_validators/badges/gpa.svg)](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.
 
@@ -143,6 +143,100 @@ RSpec matcher is also available for your convenience:
       it { should ensure_valid_mac_address_format_of }
     end
 
+### ColorValidator
+
+Ensures that the color is a hexadecimal value starting with '#':
+
+With an ActiveRecord model:
+
+    class Widget < ActiveRecord::Base
+      attr_accessor :color
+      validates :color, color: true
+    end
+
+Or any ruby class:
+
+    class Widget
+      include ActiveModel::Validations
+      attr_accessor :color
+      validates :color, color: true
+    end
+
+RSpec matcher is not available yet.
+
+### ImeiValidator
+
+Ensures that IMEI is in one of the following formats:
+
+    '356843052637512'
+    '35-6843052-637512'
+    '35.6843052.637512'
+
+and its check digit is correct.
+
+With an ActiveRecord model:
+
+    class Phone < ActiveRecord::Base
+      attr_accessor :imei
+      validates :imei, imei: true
+    end
+
+Or any ruby class:
+
+    class Phone
+      include ActiveModel::Validations
+      attr_accessor :imei
+      validates :imei, imei: true
+    end
+
+RSpec matcher is also available for your convenience:
+
+    describe Phone do
+      it { should ensure_valid_imei_format_of }
+    end
+
+### LatitudeValidator
+
+Ensures that the value is between -90 and 90:
+
+With an ActiveRecord model:
+
+    class Coordinate < ActiveRecord::Base
+      attr_accessor :latitude
+      validates :latitude, latitude: true
+    end
+
+Or any ruby class:
+
+    class Coordinate
+      include ActiveModel::Validations
+      attr_accessor :latitude
+      validates :latitude, latitude: true
+    end
+
+RSpec matcher is not available yet.
+
+### LongitudeValidator
+
+Ensures that the value is between -180 and 180:
+
+With an ActiveRecord model:
+
+    class Coordinate < ActiveRecord::Base
+      attr_accessor :longitude
+      validates :longitude, longitude: true
+    end
+
+Or any ruby class:
+
+    class Coordinate
+      include ActiveModel::Validations
+      attr_accessor :longitude
+      validates :longitude, longitude: true
+    end
+
+RSpec matcher is not available yet.
+
 ## Contributing
 
 Your contribution is welcome.

data/config/locales/en.yml

@@ -3,6 +3,7 @@ en:
     messages:
       imei: "is not a valid IMEI"
       inequality: "cannot be equal to %{attr}"
+      equality: "must be equal to %{attr}"
       email: "is not a valid email address"
       url: "is not a valid URL"
       mac_address: "is not a valid MAC address"
@@ -14,6 +15,9 @@ en:
       ensure_inequality_of:
         failure_message_for_should: "#{model} should ensure inequality on attribute #{attr}"
         failure_message_for_should_not: "#{model} should not ensure inequality on attribute #{attr}"
+      ensure_equality_of:
+        failure_message_for_should: "#{model} should ensure equality on attribute #{attr}"
+        failure_message_for_should_not: "#{model} should not ensure equality on attribute #{attr}"
       ensure_valid_email_format_of:
         failure_message_for_should: "#{model} should ensure valid email format of attribute #{attr}"
         failure_message_for_should_not: "#{model} should not ensure valid email format of attribute #{attr}"

data/lib/missing_validators.rb

@@ -1,8 +1,11 @@
 require 'active_model'
 require 'rspec/matchers' if defined?(RSpec)
 require 'missing_validators/version'
+require 'missing_validators/validators/base_validator'
 require 'missing_validators/validators/inequality_validator'
 require 'missing_validators/matchers/ensure_inequality_of_matcher' if defined?(RSpec)
+require 'missing_validators/validators/equality_validator'
+require 'missing_validators/matchers/ensure_equality_of_matcher' if defined?(RSpec)
 require 'missing_validators/validators/email_validator'
 require 'missing_validators/matchers/ensure_valid_email_format_of' if defined?(RSpec)
 require 'missing_validators/validators/url_validator'

data/lib/missing_validators/matchers/ensure_equality_of_matcher.rb

@@ -0,0 +1,27 @@
+RSpec::Matchers.define :ensure_equality_of do |attribute|
+  chain :to do |to|
+    @to = to
+  end
+
+  match do |model|
+    raise Exception if @to.nil?
+
+    value = model.send(attribute)
+    model.send("#{@to}=", !!value)
+    model.valid?
+
+    if model.errors.has_key?(attribute)
+      model.errors[attribute].include?(I18n.t('errors.messages.equality', attr: @to))
+    end
+  end
+
+  failure_message do |model|
+    I18n.t 'missing_validators.matchers.ensure_equality_of.failure_message_for_should',
+      model: model.class, attr: attribute.inspect
+  end
+
+  failure_message_when_negated do |model|
+    I18n.t 'missing_validators.matchers.ensure_equality_of.failure_message_for_should_not',
+      model: model.class, attr: attribute.inspect
+  end
+end

data/lib/missing_validators/validators/base_validator.rb

@@ -0,0 +1,19 @@
+# Base class for most validators in the gem.
+#
+class BaseValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    allow_blank = options[:allow_blank] || false
+    return if allow_blank && value.blank?
+
+    unless self.class.valid?(value, options)
+      key = self.class.name.underscore.split('_').reverse.drop(1).reverse.join('_')
+      record.errors[attribute] << (options[:message] || I18n.t("errors.messages.#{key}"))
+    end
+  end
+
+  private
+
+  def self.valid?(color, options)
+    raise NotImplementedError
+  end
+end

data/lib/missing_validators/validators/color_validator.rb

@@ -5,29 +5,14 @@
 #     attr_accessor :color
 #     validates :color, color: true
 #   end
-class ColorValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is a valid hex color.
-  #
-  # @param [Object] record object to validate
-  # @param [String] attribute name of the object attribute to validate
-  # @param [Object] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless valid?(value, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.color'))
-    end
-  end
-
+class ColorValidator < BaseValidator
   def self.validate_format(color)
     !!(color =~ /^#(?:[0-9a-f]{3})(?:[0-9a-f]{3})?$/i)
   end
 
   private
 
-  def valid?(color, options)
-    self.class.validate_format(color)
+  def self.valid?(color, options)
+    validate_format(color)
   end
-
 end

data/lib/missing_validators/validators/email_validator.rb

@@ -5,21 +5,7 @@
 #     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] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless valid?(value, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.email'))
-    end
-  end
-
+class EmailValidator < BaseValidator
   def self.validate_format(email)
     !!(email =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i)
   end
@@ -31,9 +17,8 @@ class EmailValidator < ActiveModel::EachValidator
 
   private
 
-  def valid?(email, options)
-    self.class.validate_format(email) \
-      && self.class.validate_domain(email, [*(options[:domain])])
+  def self.valid?(email, options)
+    validate_format(email) \
+      && validate_domain(email, [*(options[:domain])])
   end
-
 end

data/lib/missing_validators/validators/equality_validator.rb

@@ -0,0 +1,24 @@
+# Allows to check if the value of a specific attribute is equal to
+# the value of another attribute of an object.
+#
+class EqualityValidator < 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] value attribute value
+  def validate_each(record, attribute, value)
+    equal_to = options[:to]
+
+    equal_to_value = if equal_to.respond_to?(:call)
+      options[:to].call(record)
+    else
+      record.send(equal_to.to_sym)
+    end
+
+    if equal_to.present? && value != equal_to_value
+      message = options[:message] || I18n.t('errors.messages.equality', attr: equal_to)
+      record.errors[attribute] << message
+    end
+  end
+end

data/lib/missing_validators/validators/imei_validator.rb

@@ -5,21 +5,7 @@
 #     attr_accessor :imei
 #     validates :imei, imei: true
 #   end
-class ImeiValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is a valid IMEI address.
-  #
-  # @param [Object] record object to validate
-  # @param [String] attribute name of the object attribute to validate
-  # @param [Object] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless valid?(value.to_s, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.imei'))
-    end
-  end
-
+class ImeiValidator < BaseValidator
   def self.validate_format(imei_number)
     !!(imei_number =~ /\A[\d\.\:\-\s]+\z/i) # 356843052637512 or 35-6843052-637512 or 35.6843052.637512
   end
@@ -43,8 +29,8 @@ class ImeiValidator < ActiveModel::EachValidator
 
   private
 
-  def valid?(imei, options)
-    self.class.validate_format(imei) \
-      && self.class.luhn_valid?(imei)
+  def self.valid?(imei, options)
+    validate_format(imei.to_s) \
+      && luhn_valid?(imei.to_s)
   end
 end

data/lib/missing_validators/validators/inequality_validator.rb

@@ -13,10 +13,16 @@ class InequalityValidator < ActiveModel::EachValidator
   # @param [String] attribute name of the object attribute to validate
   # @param [Object] value attribute value
   def validate_each(record, attribute, value)
-    unequal_to_attr = options[:to]
+    unequal_to = options[:to]
 
-    if unequal_to_attr.present? && value == record.send(unequal_to_attr.to_sym)
-      message = options[:message] || I18n.t('errors.messages.inequality', attr: unequal_to_attr)
+    unequal_to_value = if unequal_to.respond_to?(:call)
+      options[:to].call(record)
+    else
+      record.send(unequal_to.to_sym)
+    end
+
+    if unequal_to.present? && value == unequal_to_value
+      message = options[:message] || I18n.t('errors.messages.inequality', attr: unequal_to)
       record.errors[attribute] << message
     end
   end

data/lib/missing_validators/validators/latitude_validator.rb

@@ -5,25 +5,10 @@
 #     attr_accessor :lat
 #     validates :lat, latitude: true
 #   end
-class LatitudeValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is a valid MAC address.
-  #
-  # @param [Object] record object to validate
-  # @param [String] attribute name of the object attribute to validate
-  # @param [Object] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless self.class.valid?(value, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.latitude'))
-    end
-  end
-
+class LatitudeValidator < BaseValidator
   private
 
   def self.valid?(latitude, options)
     latitude.present? && latitude >= -90 && latitude <= 90
   end
-
 end

data/lib/missing_validators/validators/longitude_validator.rb

@@ -5,25 +5,10 @@
 #     attr_accessor :lon
 #     validates :lon, longitude: true
 #   end
-class LongitudeValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is a valid MAC address.
-  #
-  # @param [Object] record object to validate
-  # @param [String] attribute name of the object attribute to validate
-  # @param [Object] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless self.class.valid?(value, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.longitude'))
-    end
-  end
-
+class LongitudeValidator < BaseValidator
   private
 
   def self.valid?(longitude, options)
     longitude.present? && longitude >= -180 && longitude <= 180
   end
-
 end

data/lib/missing_validators/validators/mac_address_validator.rb

@@ -5,21 +5,7 @@
 #     attr_accessor :mac
 #     validates :mac, mac_address: true
 #   end
-class MacAddressValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is a valid MAC address.
-  #
-  # @param [Object] record object to validate
-  # @param [String] attribute name of the object attribute to validate
-  # @param [Object] value attribute value
-  def validate_each(record, attribute, value)
-    allow_blank = options[:allow_blank] || false
-    return if allow_blank && value.blank?
-
-    unless self.class.valid?(value, options)
-      record.errors[attribute] << (options[:message] || I18n.t('errors.messages.mac_address'))
-    end
-  end
-
+class MacAddressValidator < BaseValidator
   def self.validate_format(mac_address)
     !!(mac_address =~ /^([\h]{2}:){5}[\h]{2}?$/i) ||            # 08:00:2b:01:02:03
       !!(mac_address =~ /^([\h]{2}[-|\.|\s]){5}[\h]{2}?$/i) ||  # 08-00-2b-01-02-03 or 08.00.2b.01.02.03
@@ -34,5 +20,4 @@ class MacAddressValidator < ActiveModel::EachValidator
   def self.valid?(mac_address, options)
     validate_format(mac_address)
   end
-
 end

data/lib/missing_validators/validators/url_validator.rb

@@ -43,5 +43,4 @@ class UrlValidator < ActiveModel::EachValidator
       && self.class.validate_scheme(uri, [*(options[:scheme] || UrlValidator::DEFAULT_SCHEMES)]) \
       && (!!options[:root] ? self.class.validate_root(uri) : true)
   end
-
 end

data/lib/missing_validators/version.rb

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

data/missing_validators.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'shoulda-matchers'
+  gem.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
 require 'missing_validators'
 require 'shoulda/matchers/active_record'
 require 'shoulda-matchers'

data/spec/validators/equality_validator_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe EqualityValidator do
+
+  describe do
+    let(:klass) do
+      Class.new do
+        include ActiveModel::Validations
+        attr_accessor :attr
+        validates :attr, equality: { to: Proc.new { |o| 'valid value' } }
+      end
+    end
+
+    subject(:model){ klass.new }
+
+    specify "field is not the same as the result of the validating proc" do
+      model.attr = "invalid value"
+      expect(model).to be_invalid
+    end
+
+    specify "field is the same as the result of the validating proc" do
+      model.attr = "valid value"
+      expect(model).to be_valid
+    end
+  end
+
+  describe do
+    let(:klass) do
+      Class.new do
+        include ActiveModel::Validations
+        attr_accessor :origin, :destination, :airline
+        validates :origin, equality: { to: :destination }
+      end
+    end
+
+    subject(:model){ klass.new }
+
+    it { should ensure_equality_of(:origin).to(:destination) }
+    it { should_not ensure_equality_of(:origin).to(:airline) }
+
+    specify "both fields have same values" do
+      model.origin = model.destination = "MOW"
+      expect(model).to be_valid
+    end
+
+    specify "fields have different value" do
+      model.origin = "NYC"
+      model.destination = "MOW"
+      expect(model).to be_invalid
+    end
+
+    specify "first field has value, the second is nil" do
+      model.origin = "NYC"
+      model.destination = nil
+      expect(model).to be_invalid
+    end
+
+    specify "first field is nil, the second has value" do
+      model.origin = nil
+      model.destination = "NYC"
+      expect(model).to be_invalid
+    end
+
+    specify "both fields are nil" do
+      model.origin = model.destination = nil
+      expect(model).to be_valid
+    end
+  end
+end

data/spec/validators/inequality_validator_spec.rb

@@ -1,44 +1,68 @@
 require 'spec_helper'
 
 describe InequalityValidator do
-  let(:klass) do
-    Class.new do
-      include ActiveModel::Validations
-      attr_accessor :origin, :destination, :airline
-      validates :origin, inequality: { to: :destination }
+  describe do
+    let(:klass) do
+      Class.new do
+        include ActiveModel::Validations
+        attr_accessor :attr
+        validates :attr, inequality: { to: Proc.new { |o| "invalid value" } }
+      end
     end
-  end
 
-  subject(:model){ klass.new }
+    subject(:model){ klass.new }
 
-  it { should ensure_inequality_of(:origin).to(:destination) }
-  it { should_not ensure_inequality_of(:origin).to(:airline) }
+    specify "field is the same as the result of the validating proc" do
+      model.attr = "invalid value"
+      expect(model).to be_invalid
+    end
 
-  specify "both fields have same values" do
-    model.origin = model.destination = "MOW"
-    expect(model).to be_invalid
+    specify "field is not the same as the result of the validating proc" do
+      model.attr = "valid value"
+      expect(model).to be_valid
+    end
   end
 
-  specify "fields have different value" do
-    model.origin = "NYC"
-    model.destination = "MOW"
-    expect(model).to be_valid
-  end
+  describe do
+    let(:klass) do
+      Class.new do
+        include ActiveModel::Validations
+        attr_accessor :origin, :destination, :airline
+        validates :origin, inequality: { to: :destination }
+      end
+    end
 
-  specify "first field has value, the second is nil" do
-    model.origin = "NYC"
-    model.destination = nil
-    expect(model).to be_valid
-  end
+    subject(:model){ klass.new }
 
-  specify "first field is nil, the second has value" do
-    model.origin = nil
-    model.destination = "NYC"
-    expect(model).to be_valid
-  end
+    it { should ensure_inequality_of(:origin).to(:destination) }
+    it { should_not ensure_inequality_of(:origin).to(:airline) }
+
+    specify "both fields have same values" do
+      model.origin = model.destination = "MOW"
+      expect(model).to be_invalid
+    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
+      model.origin = "NYC"
+      model.destination = nil
+      expect(model).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
-    model.origin = model.destination = nil
-    expect(model).to be_invalid
+    specify "both fields are nil" do
+      model.origin = model.destination = nil
+      expect(model).to be_invalid
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: missing_validators
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrei Gridnev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Validates email addresses, URLs, IMEI, MAC addresses, latitude, longitude,
   hex colors and inequality of attributes.
 email:
@@ -83,13 +97,16 @@ files:
 - Rakefile
 - config/locales/en.yml
 - lib/missing_validators.rb
+- lib/missing_validators/matchers/ensure_equality_of_matcher.rb
 - lib/missing_validators/matchers/ensure_inequality_of_matcher.rb
 - lib/missing_validators/matchers/ensure_valid_email_format_of.rb
 - lib/missing_validators/matchers/ensure_valid_imei_format_of.rb
 - lib/missing_validators/matchers/ensure_valid_mac_address_format_of.rb
 - lib/missing_validators/matchers/ensure_valid_url_format_of.rb
+- lib/missing_validators/validators/base_validator.rb
 - lib/missing_validators/validators/color_validator.rb
 - lib/missing_validators/validators/email_validator.rb
+- lib/missing_validators/validators/equality_validator.rb
 - lib/missing_validators/validators/imei_validator.rb
 - lib/missing_validators/validators/inequality_validator.rb
 - lib/missing_validators/validators/latitude_validator.rb
@@ -101,6 +118,7 @@ files:
 - spec/spec_helper.rb
 - spec/validators/color_validator_spec.rb
 - spec/validators/email_validator_spec.rb
+- spec/validators/equality_validator_spec.rb
 - spec/validators/imei_spec.rb
 - spec/validators/inequality_validator_spec.rb
 - spec/validators/latitude_validator_spec.rb
@@ -135,6 +153,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/validators/color_validator_spec.rb
 - spec/validators/email_validator_spec.rb
+- spec/validators/equality_validator_spec.rb
 - spec/validators/imei_spec.rb
 - spec/validators/inequality_validator_spec.rb
 - spec/validators/latitude_validator_spec.rb