activemodel-email_address_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab1d7fc08cf4665a14bb017c968b338df6561cad
+  data.tar.gz: 90f10888639066f3c41ae8f8a605766c3a2e8607
+SHA512:
+  metadata.gz: 280ca906a98d1ae8d3fa525811402be9cf40a2e061a109bac5dfc0e023c7017a4324e9d44f746f2d194eb2ecfdd5201f391aec3ff32ade335d5329a479d9ade3
+  data.tar.gz: e8c5f219aff734af345a3265537492a87f204354ddac415bf7d642c6de930b5c620abf97096ff500a569c766d784ca9a15b4e0cfe14f9f1131b1d556db78fb9e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,13 @@
+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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jakob Skjerning
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# 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)
+
+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.
+
+At this point I have pretty much one criteria:
+
+* Don't reject a valid email address realistically in use by a potential user. Err on the side of accepting too much.
+
+Quite frankly, I don't care about the RFC at this point, neither does the user. I care that my users can enter their email address and get on with using my product. I appreciate it if the application catches any misspellings of their email addresses, though - this is the opportune moment for them to correct it.
+
+## Requirements
+
+* Should not accept local email addresses: No user ever needed to sign up using `"postmaster@localhost"` or `"bob@1.2.3.4"` even though they are perfectly valid email addresses.
+* Must work with I18n like Rails' built-in validators do. If not configured otherwise, the default translation key must be `:invalid`.
+
+## Usage examples
+
+### Simplest case
+
+    validates :email, :email_address => true
+
+### Bring your own regex
+
+If you want to use a specific regular expression:
+
+    validates :email, :email_address => {:format => /.+@.+\..+/}
+
+### 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.
+
+    validates :email, :email_address => {:mx => true}
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activemodel-email_address_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel-email_address_validator
+
+## Resources
+
+* http://stackoverflow.com/questions/201323/using-a-regular-expression-to-validate-an-email-address
+* http://davidcel.is/blog/2012/09/06/stop-validating-email-addresses-with-regex/
+* http://blog.myitcv.org.uk/2013/03/14/validators-in-rails-using-email-as-an-example.html
+
+## Other libraries
+
+### Serverside
+
+* https://github.com/balexand/email_validator
+* https://github.com/codyrobbins/active-model-email-validator
+* https://github.com/franckverrot/activevalidators
+* https://github.com/hallelujah/valid_email
+* https://github.com/validates-email-format-of/validates_email_format_of
+
+### Clientside
+
+* https://github.com/mailcheck/mailcheck
+
+## Contributing
+
+1. Fork it ( https://github.com/substancelab/activemodel-email_address_validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Dir.glob("test/**/test_*.rb")
+  t.libs << "test"
+end
+
+task :default => :test
+
+desc "Launch an IRB console with the gem loaded"
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "activemodel-email_address_validator"
+  ARGV.clear
+  IRB.start
+end

data/activemodel-email_address_validator.gemspec

@@ -0,0 +1,25 @@
+# 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.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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/activemodel-email_address_validator.rb

@@ -0,0 +1,5 @@
+require "activemodel_email_address_validator/version"
+require "validator/email_address_validator"
+
+module ActiveModelEmailAddressValidator
+end

data/lib/activemodel_email_address_validator/email_address.rb

@@ -0,0 +1,39 @@
+module ActiveModelEmailAddressValidator
+  class EmailAddress
+    def initialize(address)
+      @address = address.to_s
+    end
+
+    def to_s
+      address
+    end
+
+    def valid?(regex = nil)
+      if regex
+        valid_using_regex?(regex)
+      else
+        valid_using_default?
+      end
+    end
+
+    private
+
+    attr_reader :address
+
+    def valid_using_regex?(regex)
+      address.to_s =~ regex
+    end
+
+    def valid_using_default?
+      return false if address =~ /\s+/
+      email_parts = address.split("@")
+
+      return false unless email_parts.size == 2
+
+      user, host = *email_parts
+      return false unless user =~ /^([^.]+\S)*[^. ]+$/
+      return false unless host =~ /^([^,. ]+\.)+[^,. ]+$/
+      true
+    end
+  end
+end

data/lib/activemodel_email_address_validator/version.rb

@@ -0,0 +1,3 @@
+module ActiveModelEmailAddressValidator
+  VERSION = "0.1.0"
+end

data/lib/validator/email_address_validator.rb

@@ -0,0 +1,16 @@
+require "active_model/validator"
+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)
+  end
+
+  private
+
+  def invalidate(record, attribute)
+    record.errors.add(attribute, :invalid)
+  end
+end

data/test/activemodel-email_address_validator/test_email_address.rb

@@ -0,0 +1,128 @@
+require "minitest_helper"
+
+class EmailAddressValidTest < MiniTest::Test
+  def test_accepts_common_email_address_format
+    accept("bob@example.com")
+  end
+
+  def test_rejects_email_address_without_at_sign
+    reject("bobexample.com")
+  end
+
+  def test_rejects_any_space
+    reject("John. Doe. somewhere@gmail.com")
+  end
+
+  def test_rejects_nil
+    reject(nil)
+  end
+
+  def test_rejects_blank_string
+    reject("")
+  end
+
+  def test_rejects_empty_string
+    reject("   ")
+  end
+
+  def test_accepts_hostname_with_dashes
+    accept("my@do-main.com")
+  end
+
+  def test_accepts_hostname_with_numbers
+    accept("my@d0main42.com")
+  end
+
+  def test_accepts_hostname_with_only_numbers
+    accept("iam@1337.com")
+  end
+
+  def test_accepts_hostname_with_multiple_parts
+    accept("my@secure.email.domain.name")
+  end
+
+  def test_accepts_local_part_with_dashes
+    accept("super-bob@example.com")
+  end
+
+  def test_accepts_local_part_with_period
+    accept("super.bob@example.com")
+  end
+
+  def test_accepts_local_part_with_plus
+    accept("super+bob@example.com")
+  end
+
+  def test_rejects_local_part_starting_with_dot
+    reject(".my@domain.com")
+  end
+
+  def test_rejects_local_part_with_spaces
+    reject("f oo @domain.com")
+  end
+
+  def test_rejects_local_part_ending_with_dot
+    reject("my.@domain.com")
+  end
+
+  def test_rejects_hostname_starting_with_dot
+    reject("my@.domain.com")
+  end
+
+  def test_rejects_hostname_starting_with_space
+    reject("my@ domain.com")
+  end
+
+  def test_rejects_hostname_ending_with_dot
+    reject("my@domain.com.")
+  end
+
+  def test_rejects_domain_part_without_dot
+    reject("my@domaindk")
+  end
+
+  def test_rejects_multiple_sequential_dots_in_local_part
+    reject("my..nice@domain.com")
+  end
+
+  def test_rejects_multiple_sequential_dots_in_hostname
+    reject("my@nice..domain.com")
+  end
+
+  def test_rejects_zero_at_signs
+    reject("mydomain.com")
+  end
+
+  def test_rejects_multiple_at_signs
+    reject("my@nice@domain.com")
+  end
+
+  def test_rejects_commas_in_hostname
+    reject("my@domain.com,")
+  end
+
+  def test_handles_long_failing_strings
+    reject("fernandeztorralbofrancisco@sabadellatlantico.")
+  end
+
+  private
+
+  def accept(email_address)
+    subject = ActiveModelEmailAddressValidator::EmailAddress.new(email_address)
+    assert subject.valid?, "Expected #{email_address} to be valid"
+  end
+
+  def reject(email_address)
+    subject = ActiveModelEmailAddressValidator::EmailAddress.new(email_address)
+    assert !subject.valid?, "Expected #{email_address} to be invalid"
+  end
+end
+
+class EmailAddressTest < MiniTest::Test
+  def test_to_s_uses_address
+    email_address = ActiveModelEmailAddressValidator::EmailAddress.new(
+      "bob@example.com"
+    )
+    assert_equal "bob@example.com", email_address.to_s
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,8 @@
+require "coveralls"
+Coveralls.wear!
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "activemodel-email_address_validator"
+
+require "minitest/autorun"
+require "minitest/spec"

data/test/test_active_model_integration.rb

@@ -0,0 +1,73 @@
+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
+  end
+
+  def test_accepts_nil_email_address
+    @subject = build_model_with_validations(
+      :email => {:email_address => true, :allow_nil => true}
+    )
+    accept(nil)
+  end
+
+  def test_accepts_valid_email_address
+    accept("bob@example.com")
+  end
+
+  def test_rejects_invalid_email_address
+    reject("bobexample.com")
+  end
+
+  def test_adds_errors_to_validated_attribute
+    subject = build_model_with_validations(
+      :work_email => {:email_address => true}
+    )
+    subject.work_email = "whatever"
+    subject.valid?
+    assert subject.errors[:email].empty?
+    assert !subject.errors[:work_email].empty?
+  end
+
+  def test_validates_with_custom_regular_expression
+    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?
+  end
+
+  private
+
+  def accept(email_address)
+    @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"
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-email_address_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakob Skjerning
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-26 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.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
+  name: minitest
+  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: 
+email:
+- jakob@mentalized.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activemodel-email_address_validator.gemspec
+- lib/activemodel-email_address_validator.rb
+- lib/activemodel_email_address_validator/email_address.rb
+- lib/activemodel_email_address_validator/version.rb
+- lib/validator/email_address_validator.rb
+- test/activemodel-email_address_validator/test_email_address.rb
+- test/minitest_helper.rb
+- test/test_active_model_integration.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ActiveModel-style email address format validator
+test_files:
+- test/activemodel-email_address_validator/test_email_address.rb
+- test/minitest_helper.rb
+- test/test_active_model_integration.rb