missing_validators 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86d60392993a9b27e6d49a2ea7eb698c6ee98f1c
-  data.tar.gz: 5ff9de4d33d2e3a97c9c07743c7bc60b9d87f8dc
+  metadata.gz: 606dab4d74f885ca572168fef9a7315ef0c57c30
+  data.tar.gz: c45673eabbc315352ba49d35e59420673be12c25
 SHA512:
-  metadata.gz: 0349e0818d3a3281cbd2bd77803c6fc12409e85a890ba537ced0897e0d22e826f91c0a53d16f2c1256df86d394678ce358919ab4b249820f26c90930df103111
-  data.tar.gz: 91229866d28463716b4f65bc81a472c87efb487e2c32504cc3d0e7930930475f7bb802bf4fc28522fe7b5ffcc0f9ae9762ab32ea49db2ab36467722653edff80
+  metadata.gz: 3d48da718a2afb2e6b74c1a12f534b8a3d726873ec889f77c29c0ab30bcb2767295bdabd7f0166b870530949810934fa1eaca256b95d8e3890a35d35e380e2c9
+  data.tar.gz: 8b4880e80d5c3fa9e1ec7aad550d97d87ea6f5db2f494b4a0064cfc5b3bff01742c11114e1e338a7fb9ab13a39863b4f890fcdf5335946fbc9c17cda356817bb

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 2.2.0
   - 2.1.0
   - 2.0.0
   - 1.9.3

data/README.md

@@ -40,9 +40,11 @@ Or any ruby class:
 
 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'] }
+    validates :email, email: { domains: '.com' }
+    validates :email, email: { domains: 'example.org' }
+    validates :email, email: { domains: ['.com', '.edu', 'example.org'] }
+
+Please note that if a domain is specified as a sting starting with "." (for example, ".com") then the valid values should be in the subdomains of this domain (for example, "email@example.com" or "user@subdomain.example.com"). If a domain is specified without leading "." (for example, "example.org"), then the valid values should be in this domain only (for example, "user@example.org" or "email@example.org", but not "email@subdomain.example.org").
 
 RSpec matcher is also available for your convenience:
 
@@ -94,7 +96,7 @@ With an ActiveRecord model:
 
     class Flight < ActiveRecord::Base
       attr_accessor :origin, :destination
-      validates :origin, inequality: { to: :destination }
+      validates :origin, inequality: { to: ->(o) { o.destination } }
     end
 
 Or any ruby class:
@@ -102,13 +104,7 @@ 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) }
+      validates :origin, inequality: { to: ->(o) { o.destination } }
     end
 
 ### MacAddressValidator

data/Rakefile

@@ -1,8 +1,14 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'
+require 'cane/rake_task'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new('spec')
 
-task :default => :spec
+task default: :spec
+
+desc 'Run cane to check quality metrics'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.abc_max = 10
+  cane.no_style = true
+end

data/config/locales/en.yml

@@ -2,8 +2,8 @@ en:
   errors:
     messages:
       imei: "is not a valid IMEI"
-      inequality: "cannot be equal to %{attr}"
-      equality: "must be equal to %{attr}"
+      inequality: "cannot be equal to %{value}"
+      equality: "must be equal to %{value}"
       email: "is not a valid email address"
       url: "is not a valid URL"
       mac_address: "is not a valid MAC address"
@@ -12,12 +12,6 @@ en:
       color: "is not a valid hexadecimal color"
   missing_validators:
     matchers:
-      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,19 +1,21 @@
 require 'active_model'
-require 'rspec/matchers' if defined?(RSpec)
+require 'addressable/uri'
 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/inequality_validator'
 require 'missing_validators/validators/email_validator'
-require 'missing_validators/matchers/ensure_valid_email_format_of' if defined?(RSpec)
 require 'missing_validators/validators/url_validator'
-require 'missing_validators/matchers/ensure_valid_url_format_of' if defined?(RSpec)
 require 'missing_validators/validators/mac_address_validator'
-require 'missing_validators/matchers/ensure_valid_mac_address_format_of' if defined?(RSpec)
 require 'missing_validators/validators/longitude_validator'
 require 'missing_validators/validators/latitude_validator'
 require 'missing_validators/validators/color_validator'
 require 'missing_validators/validators/imei_validator'
-require 'missing_validators/matchers/ensure_valid_imei_format_of' if defined?(RSpec)
+
+if defined?(RSpec)
+  require 'rspec/matchers'
+  require 'missing_validators/matchers/ensure_valid_email_format_of'
+  require 'missing_validators/matchers/ensure_valid_url_format_of'
+  require 'missing_validators/matchers/ensure_valid_mac_address_format_of'
+  require 'missing_validators/matchers/ensure_valid_imei_format_of'
+end

data/lib/missing_validators/matchers/ensure_valid_email_format_of.rb

@@ -1,20 +1,20 @@
 RSpec::Matchers.define :ensure_valid_email_format_of do |attribute|
+  root = 'missing_validators.matchers.ensure_valid_email_format_of'
+
   match do |model|
-    model.send("#{attribute}=", "invalid@email_address")
+    model.send("#{attribute}=", 'invalid@email_address')
     model.valid?
 
-    if model.errors.has_key?(attribute)
+    if model.errors.to_hash.key?(attribute)
       model.errors[attribute].include?(I18n.t('errors.messages.email'))
     end
   end
 
   failure_message do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_email_format_of.failure_message_for_should',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should", model: model.class)
   end
 
   failure_message_when_negated do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_email_format_of.failure_message_for_should_not',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should_not", model: model.class)
   end
 end

data/lib/missing_validators/matchers/ensure_valid_imei_format_of.rb

@@ -1,20 +1,20 @@
 RSpec::Matchers.define :ensure_valid_imei_format_of do |attribute|
+  root = 'missing_validators.matchers.ensure_valid_imei_format_of'
+
   match do |model|
-    model.send("#{attribute}=", "invalid.imei")
+    model.send("#{attribute}=", 'invalid.imei')
     model.valid?
 
-    if model.errors.has_key?(attribute)
+    if model.errors.to_hash.key?(attribute)
       model.errors[attribute].include?(I18n.t('errors.messages.imei'))
     end
   end
 
   failure_message do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_imei_format_of.failure_message_for_should',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should", model: model.class)
   end
 
   failure_message_when_negated do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_imei_format_of.failure_message_for_should_not',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should_not", model: model.class)
   end
 end

data/lib/missing_validators/matchers/ensure_valid_mac_address_format_of.rb

@@ -1,20 +1,20 @@
 RSpec::Matchers.define :ensure_valid_mac_address_format_of do |attribute|
+  root = 'missing_validators.matchers.ensure_valid_mac_address_format_of'
+
   match do |model|
-    model.send("#{attribute}=", "invalid.mac.address")
+    model.send("#{attribute}=", 'invalid.mac.address')
     model.valid?
 
-    if model.errors.has_key?(attribute)
+    if model.errors.to_hash.key?(attribute)
       model.errors[attribute].include?(I18n.t('errors.messages.mac_address'))
     end
   end
 
   failure_message do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_mac_address_format_of.failure_message_for_should',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should", model: model.class)
   end
 
   failure_message_when_negated do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_mac_address_format_of.failure_message_for_should_not',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should_not", model: model.class)
   end
 end

data/lib/missing_validators/matchers/ensure_valid_url_format_of.rb

@@ -1,20 +1,20 @@
 RSpec::Matchers.define :ensure_valid_url_format_of do |attribute|
+  root = 'missing_validators.matchers.ensure_valid_url_format_of'
+
   match do |model|
-    model.send("#{attribute}=", ".")
+    model.send("#{attribute}=", ' - ')
     model.valid?
 
-    if model.errors.has_key?(attribute)
+    if model.errors.to_hash.key?(attribute)
       model.errors[attribute].include?(I18n.t('errors.messages.url'))
     end
   end
 
   failure_message do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_url_format_of.failure_message_for_should',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should", model: model.class)
   end
 
   failure_message_when_negated do |model|
-    I18n.t 'missing_validators.matchers.ensure_valid_url_format_of.failure_message_for_should_not',
-      model: model.class
+    I18n.t("#{root}.failure_message_for_should_not", model: model.class)
   end
 end

data/lib/missing_validators/validators/base_validator.rb

@@ -1,19 +1,30 @@
 # Base class for most validators in the gem.
 #
 class BaseValidator < ActiveModel::EachValidator
+  # Checks if an attribute value is valid.
+  #
+  # @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
+    allow_blank = options.fetch(:allow_blank, false)
+
     return if allow_blank && value.blank?
+    return if valid?(value, options)
 
-    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}"))
+    record.errors[attribute] << options.fetch(:message) do
+      I18n.t(error_message_key)
     end
   end
 
   private
 
-  def self.valid?(color, options)
-    raise NotImplementedError
+  def valid?(_value, _options)
+    fail NotImplementedError
+  end
+
+  def error_message_key
+    key = self.class.name.underscore.gsub('_validator', '')
+    "errors.messages.#{key}"
   end
 end

data/lib/missing_validators/validators/color_validator.rb

@@ -1,4 +1,4 @@
-# Allows to check if the value of a specific attribute is a valid hex color.
+# Checks if the value of an attribute is a valid hex color.
 #
 # @example Validate that the product color is a valid hex color.
 #   class Product << ActiveRecord::Base
@@ -6,13 +6,11 @@
 #     validates :color, color: true
 #   end
 class ColorValidator < BaseValidator
-  def self.validate_format(color)
-    !!(color =~ /^#(?:[0-9a-f]{3})(?:[0-9a-f]{3})?$/i)
-  end
-
   private
 
-  def self.valid?(color, options)
-    validate_format(color)
+  HEX_COLOR_FORMAT = /^#(?:[0-9a-f]{3})(?:[0-9a-f]{3})?$/i
+
+  def valid?(color, _)
+    (color =~ HEX_COLOR_FORMAT).present?
   end
 end

data/lib/missing_validators/validators/email_validator.rb

@@ -1,4 +1,4 @@
-# Allows to check if the value of a specific attribute is a valid email address.
+# Checks if the value of an attribute is a valid email address.
 #
 # @example Validate that the user email is a valid email address.
 #   class User << ActiveRecord::Base
@@ -6,19 +6,29 @@
 #     validates :email, email: true
 #   end
 class EmailValidator < BaseValidator
-  def self.validate_format(email)
-    !!(email =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i)
+  private
+
+  EMAIL_FORMAT = /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
+
+  def valid?(email, options)
+    validate_format(email) && \
+      validate_domain(email, *options[:domain])
   end
 
-  def self.validate_domain(email, domains)
-    email_downcased = email.to_s.downcase
-    domains.empty? || domains.any? { |domain| email_downcased.end_with?(".#{domain.downcase}") }
+  def validate_format(email)
+    (email =~ EMAIL_FORMAT).present?
   end
 
-  private
+  def validate_domain(email, *domains)
+    return true if domains.blank?
+
+    email_downcased = email.to_s.downcase
+
+    domains.any? do |domain|
+      domain = domain.to_s.downcase
+      domain = "@#{domain}" unless domain.start_with?('.')
 
-  def self.valid?(email, options)
-    validate_format(email) \
-      && validate_domain(email, [*(options[:domain])])
+      email_downcased.end_with?(domain)
+    end
   end
 end

data/lib/missing_validators/validators/equality_validator.rb

@@ -1,24 +1,30 @@
-# Allows to check if the value of a specific attribute is equal to
-# the value of another attribute of an object.
+# Checks if the value of an attribute is equal to a value or proc result.
 #
 class EqualityValidator < ActiveModel::EachValidator
-  # Checks if an attribute value is unequal to another attrubute value.
+  # Checks if an attribute value is equal to a value or proc result.
   #
   # @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]
+    to = options[:to]
 
-    equal_to_value = if equal_to.respond_to?(:call)
-      options[:to].call(record)
-    else
-      record.send(equal_to.to_sym)
-    end
+    reference_value = to.respond_to?(:call) ? options[:to].call(record) : to
+
+    return if compare_value(value, reference_value)
 
-    if equal_to.present? && value != equal_to_value
-      message = options[:message] || I18n.t('errors.messages.equality', attr: equal_to)
-      record.errors[attribute] << message
+    record.errors[attribute] << options.fetch(:message) do
+      I18n.t(translation_key, value: reference_value)
     end
   end
+
+  private
+
+  def compare_value(value, reference_value)
+    value == reference_value
+  end
+
+  def translation_key
+    'errors.messages.equality'
+  end
 end

data/lib/missing_validators/validators/imei_validator.rb

@@ -1,18 +1,21 @@
-# Allows to check if the value of a specific attribute is a valid IMEI address.
+# Checks if the value of an attribute is a valid IMEI number.
 #
-# @example Validate that the device IMEI address is valid.
+# @example Validate that a device IMEI number is valid.
 #   class Device << ActiveRecord::Base
 #     attr_accessor :imei
 #     validates :imei, imei: true
 #   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
+  private
+
+  # 356843052637512 or 35-6843052-637512 or 35.6843052.637512
+  IMEI_FORMAT = /\A[\d\.\:\-\s]+\z/i
 
-  def self.luhn_valid?(input)
-    numbers = input.gsub(/\D/, '').reverse
+  def validate_format(imei_number)
+    (imei_number =~ IMEI_FORMAT).present?
+  end
 
+  def validate_luhn_checksum(numbers)
     sum, i = 0, 0
 
     numbers.each_char do |ch|
@@ -21,16 +24,14 @@ class ImeiValidator < BaseValidator
       n = 1 + (n - 10) if n >= 10
 
       sum += n
-      i   += 1
+      i += 1
     end
 
     (sum % 10).zero?
   end
 
-  private
-
-  def self.valid?(imei, options)
-    validate_format(imei.to_s) \
-      && luhn_valid?(imei.to_s)
+  def valid?(imei, _)
+    validate_format(imei.to_s) && \
+      validate_luhn_checksum(imei.to_s.gsub(/\D/, '').reverse)
   end
 end