activemodel-email_address_validator 0.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab1d7fc08cf4665a14bb017c968b338df6561cad
-  data.tar.gz: 90f10888639066f3c41ae8f8a605766c3a2e8607
+SHA256:
+  metadata.gz: b5580fb86ca5fc584177916ac313ca624193f64f06679f441521d5904250d4f2
+  data.tar.gz: ea37fa1181553939391da23a0a4894bc4b98186ca8b5f3b3dcb863c041013478
 SHA512:
-  metadata.gz: 280ca906a98d1ae8d3fa525811402be9cf40a2e061a109bac5dfc0e023c7017a4324e9d44f746f2d194eb2ecfdd5201f391aec3ff32ade335d5329a479d9ade3
-  data.tar.gz: e8c5f219aff734af345a3265537492a87f204354ddac415bf7d642c6de930b5c620abf97096ff500a569c766d784ca9a15b4e0cfe14f9f1131b1d556db78fb9e
+  metadata.gz: f21ef9f11bf4ed601b420dab39bbe62206c47873226e22ee9c3db0597105aa23ffe8064379cd81f34f9367fbcc742689e5303c417bcb6032eeb7d326e3ff9b35
+  data.tar.gz: 4d4e2b281fec06eb2c15a3e5fce997fb67f9c6bb70899bedd5a681c5cc2318a6a89ac68653a239b7735f7a4b18a78bf979f56abcfa1f496a49cc45bc96c37e6a

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Lint
+      run: bundle exec standardrb

data/CHANGELOG.md

@@ -0,0 +1,64 @@
+# Change Log
+
+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/).
+
+## Unreleased
+
+### Added
+
+-
+
+### Removed
+
+-
+
+
+## [2.1.0]
+
+### Added
+
+- Support for Ruby 3.0. We've also started testing against Ruby 3.1 to be
+  prepared.
+
+- Email addresses with trailing @'s are no longer accepted. Thanks
+  @prognostikos!
+
+## [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
+
+- Reject email addresses with tildes in the hostname
+
+## [1.0.0]
+
+### Added
+
+- Support for ActiveModel versions 5 and up
+- A changelog
+
+### Changed
+
+- Removed support for Ruby versions older than 2.2.2. ActiveSupport 5.0.0.1
+  requires Ruby version >= 2.2.2 so to support ActiveModel 5, which requires
+  ActiveSupport 5, we have to say goodbye to Ruby 2.1. If you need to use a
+  Ruby version prior to 2.2.2, version 0.1.0 of this gem should still work just fine.

data/Gemfile

@@ -3,4 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in activemodel-email_address_validator.gemspec
 gemspec
 
-gem "coveralls", :require => false
+gem "coveralls", require: false
+gem "standard", require: false

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)
+[![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/Rakefile

@@ -6,7 +6,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
 end
 
-task :default => :test
+task default: :test
 
 desc "Launch an IRB console with the gem loaded"
 task :console do

data/activemodel-email_address_validator.gemspec

@@ -1,25 +1,24 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "activemodel_email_address_validator/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "activemodel-email_address_validator"
-  spec.version       = ActiveModelEmailAddressValidator::VERSION
-  spec.authors       = ["Jakob Skjerning"]
-  spec.email         = ["jakob@mentalized.net"]
-  spec.summary       = "ActiveModel-style email address format validator"
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name = "activemodel-email_address_validator"
+  spec.version = ActiveModelEmailAddressValidator::VERSION
+  spec.authors = ["Jakob Skjerning"]
+  spec.email = ["jakob@mentalized.net"]
+  spec.summary = "ActiveModel-style email address format validator"
+  spec.homepage = ""
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activemodel", "~> 4.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/email_address.rb

@@ -25,14 +25,14 @@ module ActiveModelEmailAddressValidator
     end
 
     def valid_using_default?
-      return false if address =~ /\s+/
-      email_parts = address.split("@")
+      return false if /\s+/.match?(address)
+      email_parts = address.split("@", -1)
 
       return false unless email_parts.size == 2
 
       user, host = *email_parts
-      return false unless user =~ /^([^.]+\S)*[^. ]+$/
-      return false unless host =~ /^([^,. ]+\.)+[^,. ]+$/
+      return false unless /^([^.]+\S)*[^. ]+$/.match?(user)
+      return false unless /^([^,. ~]+\.)+[^,. ]+$/.match?(host)
       true
     end
   end

data/lib/activemodel_email_address_validator/version.rb

@@ -1,3 +1,3 @@
 module ActiveModelEmailAddressValidator
-  VERSION = "0.1.0"
+  VERSION = "2.1.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
@@ -97,10 +101,22 @@ class EmailAddressValidTest < MiniTest::Test
     reject("my@nice@domain.com")
   end
 
+  def test_rejects_leading_at_signs
+    reject("@my@domain.com")
+  end
+
+  def test_rejects_trailing_at_signs
+    reject("my@domain.com@")
+  end
+
   def test_rejects_commas_in_hostname
     reject("my@domain.com,")
   end
 
+  def test_rejects_tildes_in_hostname
+    reject("my@~domain.com")
+  end
+
   def test_handles_long_failing_strings
     reject("fernandeztorralbofrancisco@sabadellatlantico.")
   end

data/test/minitest_helper.rb

@@ -6,3 +6,21 @@ require "activemodel-email_address_validator"
 
 require "minitest/autorun"
 require "minitest/spec"
+
+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

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
@@ -26,22 +8,22 @@ class EmailAddressValidatorTest < MiniTest::Test
 
   def test_accepts_nil_email_address
     @subject = build_model_with_validations(
-      :email => {:email_address => true, :allow_nil => true}
+      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
     subject = build_model_with_validations(
-      :work_email => {:email_address => true}
+      work_email: {email_address: true}
     )
     subject.work_email = "whatever"
     subject.valid?
@@ -51,23 +33,52 @@ class EmailAddressValidatorTest < MiniTest::Test
 
   def test_validates_with_custom_regular_expression
     subject = build_model_with_validations(
-      :email => {:email_address => {:format => /.+@enterprise\..+/}}
+      email: {email_address: {format: /.+@enterprise\..+/}}
+    )
+    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 }
+        ]
+      }}
     )
-    subject.email = "whatever@enterprise.museum"
-    assert subject.valid?
-    subject.email = "totally@valid.com"
-    assert !subject.valid?
+    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,55 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-email_address_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jakob Skjerning
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        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
@@ -66,15 +72,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jakob@mentalized.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,7 +98,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,9 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: ActiveModel-style email address format validator
 test_files:

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0
-  - 2.1.7
-  - 2.2.0
-  - 2.2.1
-  - 2.2.2
-  - 2.2.3
-  - jruby-9.0.0.0
-
-notifications:
-  recipients:
-    - jakob@mentalized.net