activemodel-email_address_validator 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e27f8200f0c5dd161f5cf45fdd5478f01d94d79f
-  data.tar.gz: e50b9c48333da5ceb5d8978fab9dbf8318327761
+SHA256:
+  metadata.gz: 880e994c63a284ed895dfab2da408360b9cd70f8466176e99c1118d76e830f64
+  data.tar.gz: ef9a1389211791aff43ed9874421515e3417b7e2b00e85ce70ee478c8f8a837b
 SHA512:
-  metadata.gz: ed0ccfaaa18235cf55836b75bacfc43e5502e08bdf12f49575f11e205bd9f5aa9241135bed8fada104ec7f4fc8a036dea85c3af854fab939e27f3401d10a33fb
-  data.tar.gz: a0444e291646101a56a8a781932fd0db04d79358a52f657b5113874110ddd80e18e9da28765c36f0e874ea33a0d9d15de3208dbd8c24a464bd58d2e86b7fbe89
+  metadata.gz: 0dd406cdb1537d8d8099e71531e8797b9d4ebe3f619842ef65eaf9d43fd1a31062739bbca7ed7fa3f46f63ba2da30a8949f1e0f5795b7af3f26e2ea3cc8c030c
+  data.tar.gz: c8ebc7e19f10ac906503606c8308c7ade2018a08840465743819d38f86598320955323020fbd73d8b0304794c2cc11104195a9a19639c9740bae246295735c73

data/.travis.yml

@@ -1,7 +1,13 @@
 language: ruby
 rvm:
-  - 2.2.6
-  - 2.3.3
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0-preview1
+
+before_install:
+  - gem update --system
+  - gem install bundler
 
 notifications:
   recipients:

data/CHANGELOG.md

@@ -5,6 +5,23 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.0.0]
+
+### Added
+
+- Ability to specify custom rules to use when validating the email address
+  using the `:with` option.
+
+- Support for Ruby 2.5, 2.5 and 2.6. We've probably always had the support,
+  but now we're actually testing it.
+
+- Support for ActiveModel 6.
+
+### Removed
+
+- Support for Ruby 2.2 and 2.3 that are both EOL. We probably still support
+  and work on those versions, but we won't verify and test them any more.
+
 ## [1.0.1]
 
 ### Added

data/README.md

@@ -1,7 +1,7 @@
 # Email Address Validator
 ## ActiveModel-style email address format validator
 
-[![Build Status](https://travis-ci.org/substancelab/activemodel-email_address_validator.svg?branch=master)](https://travis-ci.org/substancelab/activemodel-email_address_validator) [![Code Climate](https://codeclimate.com/github/substancelab/activemodel-email_address_validator/badges/gpa.svg)](https://codeclimate.com/github/substancelab/activemodel-email_address_validator) [![Coverage Status](https://coveralls.io/repos/substancelab/activemodel-email_address_validator/badge.svg?branch=more-badges&service=github)](https://coveralls.io/github/substancelab/activemodel-email_address_validator?branch=more-badges) [![Dependency Status](https://gemnasium.com/substancelab/activemodel-email_address_validator.svg)](https://gemnasium.com/substancelab/activemodel-email_address_validator)
+[![Build Status](https://travis-ci.org/substancelab/activemodel-email_address_validator.svg?branch=master)](https://travis-ci.org/substancelab/activemodel-email_address_validator) [![Code Climate](https://codeclimate.com/github/substancelab/activemodel-email_address_validator/badges/gpa.svg)](https://codeclimate.com/github/substancelab/activemodel-email_address_validator) [![Coverage Status](https://coveralls.io/repos/substancelab/activemodel-email_address_validator/badge.svg?branch=more-badges&service=github)](https://coveralls.io/github/substancelab/activemodel-email_address_validator?branch=more-badges)
 
 Whenever I have wanted to validate an email address it has been because I wanted to be somewhat certain I can send an email to someone. Usually this happens as part of a signup procedure.
 
@@ -28,6 +28,14 @@ If you want to use a specific regular expression:
 
     validates :email, :email_address => {:format => /.+@.+\..+/}
 
+### Bring your own logic
+
+If a regular expression isn't enough for you, you can include your own rules for email addresses. For example, you could validate that all email adresses belong to the same company:
+
+    validates :email, :email_address => {
+      :with => proc { |address| address.end_with?("@substancelab.com") }
+    }
+
 ### Verify domain (still to be done - pull request, anybody?)
 
 This also checks that the domain actually has an MX record. Note this might take a while because of DNS lookups.
@@ -64,6 +72,7 @@ Or install it yourself as:
 * https://github.com/codyrobbins/active-model-email-validator
 * https://github.com/franckverrot/activevalidators
 * https://github.com/hallelujah/valid_email
+* https://github.com/micke/valid_email2
 * https://github.com/validates-email-format-of/validates_email_format_of
 
 ### Clientside

data/activemodel-email_address_validator.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activemodel", ">= 4.0", "< 6.0"
+  spec.add_dependency "activemodel", ">= 4.0", "< 7.0"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.7"
+  spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "minitest"
 end

data/lib/activemodel_email_address_validator/version.rb

@@ -1,3 +1,3 @@
 module ActiveModelEmailAddressValidator
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

data/lib/validator/email_address_validator.rb

@@ -3,13 +3,45 @@ require "activemodel_email_address_validator/email_address"
 
 class EmailAddressValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    address = ActiveModelEmailAddressValidator::EmailAddress.new(value)
-    regex = options[:format]
-    invalidate(record, attribute) unless address.valid?(regex)
+    rules = Array(options[:with] || [])
+    if rules.empty?
+      # We are using the old syntax, assume regular expressions
+      rules = [build_rule_from_format(options[:format])]
+    end
+
+    invalidate(record, attribute) unless all_rules_pass?(rules, value)
   end
 
   private
 
+  def all_rules_pass?(rules, address)
+    evaluators = rules.map { |rule| build_evaluator(rule) }
+    results = evaluators.map { |evaluator| evaluator.call(address) }
+    results.all?
+  end
+
+  # Returns an evaluator for the given rule. Evaluators are objects that respond
+  # to `#call` with an arity of 1; the raw attribute value in question.
+  #
+  # The return-value of `#call` should be `true` if the address passes the given
+  # rule, false otherwise.
+  def build_evaluator(rule)
+    case rule
+    when Regexp
+      proc { |a| a =~ rule }
+    else
+      rule
+    end
+  end
+
+  def build_rule_from_format(format)
+    proc { |attribute_value|
+      address =
+        ActiveModelEmailAddressValidator::EmailAddress.new(attribute_value)
+      address.valid?(format)
+    }
+  end
+
   def invalidate(record, attribute)
     record.errors.add(attribute, :invalid)
   end

data/test/activemodel-email_address_validator/test_email_address.rb

@@ -5,6 +5,10 @@ class EmailAddressValidTest < MiniTest::Test
     accept("bob@example.com")
   end
 
+  def test_accepts_non_us_ascii_in_local_part
+    accept("bøb@example.com")
+  end
+
   def test_rejects_email_address_without_at_sign
     reject("bobexample.com")
   end

data/test/minitest_helper.rb

@@ -6,3 +6,22 @@ require "activemodel-email_address_validator"
 
 require "minitest/autorun"
 require "minitest/spec"
+
+SIMPLEST_VALIDATION = {:email => {:email_address => true}}
+
+# rubocop:disable Metrics/MethodLength
+def build_model_with_validations(validations = SIMPLEST_VALIDATION)
+  klass = Class.new do
+    include ActiveModel::Validations
+    def self.model_name
+      ActiveModel::Name.new(self, nil, "ValidatorModel")
+    end
+
+    validations.each do |attribute, options|
+      attr_accessor attribute
+      validates attribute, options
+    end
+  end
+  klass.new
+end
+# rubocop:enable Metrics/MethodLength

data/test/test_active_model_integration.rb

@@ -1,24 +1,6 @@
 require "minitest_helper"
 require "active_model"
 
-# rubocop:disable Metrics/MethodLength
-SIMPLEST_VALIDATION = {:email => {:email_address => true}}
-def build_model_with_validations(validations = SIMPLEST_VALIDATION)
-  klass = Class.new do
-    include ActiveModel::Validations
-    def self.model_name
-      ActiveModel::Name.new(self, nil, "ValidatorModel")
-    end
-
-    validations.each do |attribute, options|
-      attr_accessor attribute
-      validates attribute, options
-    end
-  end
-  klass.new
-end
-# rubocop:enable Metrics/MethodLength
-
 class EmailAddressValidatorTest < MiniTest::Test
   def setup
     @subject = build_model_with_validations
@@ -28,15 +10,15 @@ class EmailAddressValidatorTest < MiniTest::Test
     @subject = build_model_with_validations(
       :email => {:email_address => true, :allow_nil => true}
     )
-    accept(nil)
+    accept(nil, @subject)
   end
 
   def test_accepts_valid_email_address
-    accept("bob@example.com")
+    accept("bob@example.com", @subject)
   end
 
   def test_rejects_invalid_email_address
-    reject("bobexample.com")
+    reject("bobexample.com", @subject)
   end
 
   def test_adds_errors_to_validated_attribute
@@ -53,21 +35,50 @@ class EmailAddressValidatorTest < MiniTest::Test
     subject = build_model_with_validations(
       :email => {:email_address => {:format => /.+@enterprise\..+/}}
     )
-    subject.email = "whatever@enterprise.museum"
-    assert subject.valid?
-    subject.email = "totally@valid.com"
-    assert !subject.valid?
+    accept("whatever@enterprise.museum", subject)
+    reject("totally@valid.com", subject)
+  end
+
+  def test_validates_with_custom_regular_as_a_rule
+    subject = build_model_with_validations(
+      :email => {:email_address => {:with => /.+@enterprise\..+/}}
+    )
+    accept("whatever@enterprise.museum", subject)
+    reject("totally@valid.com", subject)
+  end
+
+  def test_validates_with_proc
+    subject = build_model_with_validations(
+      :email => {:email_address => {
+        :with => proc { |address| address == "foo" }}
+      }
+    )
+    accept("foo", subject)
+    reject("foo@bar.com", subject)
+  end
+
+  def test_validates_with_multiple_procs
+    subject = build_model_with_validations(
+      :email => {:email_address => {
+        :with => [
+          proc { |address| address == "ada" },
+          proc { |address| address.reverse == address }
+        ]}
+      }
+    )
+    accept("ada", subject)
+    reject("bob", subject)
   end
 
   private
 
-  def accept(email_address)
-    @subject.email = email_address
-    assert @subject.valid?, "Expected #{email_address.inspect} to be valid"
+  def accept(email_address, subject)
+    subject.email = email_address
+    assert subject.valid?, "Expected #{email_address.inspect} to be valid"
   end
 
-  def reject(email_address)
-    @subject.email = email_address
-    assert !@subject.valid?, "Expected #{email_address.inspect} to be invalid"
+  def reject(email_address, subject)
+    subject.email = email_address
+    assert !subject.valid?, "Expected #{email_address.inspect} to be invalid"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-email_address_validator
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Jakob Skjerning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,33 +29,33 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
@@ -113,8 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: ActiveModel-style email address format validator