validate_as_email 1.0.1 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28ec894f592a434dcab3f7a29822fc68184248ca
+  data.tar.gz: 652bca29a770d9b1e52236f103cfb7ca3ebf32c9
+SHA512:
+  metadata.gz: 03243e0cbdf5f6d4782943f66dab6fd65d00db62f839cad14c2f4a3f04e76795351115ce7dc3ccded97bfa5b70fb9fb956ae6b94ef448d7077351608b9a2ad87
+  data.tar.gz: 1713e9ae94e98dc9f9516e76e53243339cef1ee618c517288ae0cb098ea246e485dd91583ae608cbd8c161e87e03f81b6530cb87466c185332d7c29dba2cded2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Evently
+
+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

@@ -1,7 +1,7 @@
-# ValidateAsEmail
+# Validate as Email [![Circle CI](https://circleci.com/gh/jcf/validate_as_email.svg?style=svg)](https://circleci.com/gh/jcf/validate_as_email)
 
 Validation of email addresses via the excellent Mail gem that is
-available in all Rails 3 applications.
+available in all Rails 3 and 4 applications.
 
 ## Installation
 
@@ -19,11 +19,65 @@ Or install it yourself as:
 
 ## Usage
 
-This gem required Ruby 1.9, and is tested against MRI, JRuby, and
-Rubinius using Travis CI.
+This gem is tested against MRI, JRuby, and Rubinius using Travis CI.
 
-You will need to be using Rails 3 to make use of this validator, as it
-is built on top of ActiveModel, which was introduced in Rails 3.
+You will need to be using Rails 3 or greater to make use of this
+validator, as it is built on top of ActiveModel, which was introduced in
+Rails 3.
+
+### Usage with ActiveModel
+
+``` ruby
+class Person
+  include ActiveModel::Validations
+  validates_as_email :email
+  attr_accessor :email
+end
+
+# OR
+
+class Person
+  include ActiveModel::Validations
+  validates :email, email: true
+  attr_accessor :email
+end
+```
+
+### Usage with ActiveRecord
+
+``` ruby
+class Person < ActiveRecord::Base
+  validates_as_email :email
+  attr_accessor :email
+end
+
+# OR
+
+class Person < ActiveRecord::Base
+  validates :email, email: true
+  attr_accessor :email
+end
+```
+
+### Built-in RSpec Matcher
+
+The custom matcher will be loaded automatically if RSpec is loaded
+first. Otherwise, you'll need to require the RSpec matcher manually
+using `require 'validate_as_email/rspec'`.
+
+``` ruby
+require 'validate_as_email/rspec'
+
+class Person < ActiveRecord::Base
+  validates_as_email :email
+  attr_accessor :email
+end
+
+describe Person do
+  it { should have_a_valid_email_address_for(:email) }
+  it { should_not have_a_valid_email_address_for(:email) }
+end
+```
 
 ## Contributing
 

data/lib/active_model/validations/email_validator.rb

@@ -4,19 +4,26 @@ require 'mail'
 module ActiveModel
   module Validations
     class EmailValidator < EachValidator
-      attr_reader :record, :attribute, :value, :email, :tree
+      attr_reader :record, :attribute, :value, :email
 
       def validate_each(record, attribute, value)
         @record, @attribute, @value = record, attribute, value
 
         @email = Mail::Address.new(value)
-        @tree  = email.__send__(:tree)
 
         add_error unless valid?
       rescue Mail::Field::ParseError
         add_error
       end
 
+      def domain_parts
+        @domain_parts ||= if email.domain
+                            email.domain.split('.')
+                          else
+                            []
+                          end
+      end
+
       private
 
       def valid?
@@ -28,7 +35,7 @@ module ActiveModel
       end
 
       def domain_has_more_than_one_atom?
-        tree.domain.dot_atom_text.elements.length > 1
+        domain_parts.length > 1
       end
 
       def add_error

data/lib/validate_as_email/rspec.rb

@@ -0,0 +1,48 @@
+require 'rspec/rails/extensions/active_record/base'
+# Adds a custom matcher to RSpec to make it easier to make sure your email
+# column is valid.
+#
+#   class Person
+#     include ActiveModel::Validations
+#
+#     validates_as_email :email
+#
+#     def initialize(attributes = {})
+#       @attributes = attributes
+#     end
+#
+#     def email
+#       @attributes[:email]
+#     end
+#
+#     def email=(address)
+#       @attributes[:email] = address
+#     end
+#   end
+#
+#   describe Person
+#     it { should have_a_valid_email_address_for(:email) }
+#   end
+RSpec::Matchers.define(:have_a_valid_email_address_for) do |column_name|
+  match do |klass|
+    %w(
+      matz@example.com
+      a@b.tld
+      1@8.8.8.8
+    ).each do |valid|
+      klass.send("#{column_name}=", valid)
+      klass.should have(0).errors_on(column_name)
+    end
+
+    %w(
+      word
+      a@
+      @b
+      example.com
+      8.8.8.8
+    ).each do |invalid|
+      klass.send("#{column_name}=", invalid)
+      klass.should have(1).error_on(column_name)
+    end
+  end
+end

data/lib/validate_as_email/version.rb

@@ -1,3 +1,3 @@
 module ValidateAsEmail
-  VERSION = '1.0.1'
+  VERSION = '3.0.0'
 end

data/lib/validate_as_email.rb

@@ -2,5 +2,6 @@ require 'validate_as_email/version'
 require 'active_model'
 require 'active_model/validations/email_validator'
 
-module ValidateAsEmail
+if defined?(RSpec::Matchers)
+  require 'validate_as_email/rspec'
 end

data/spec/active_model/validations/email_validator_spec.rb

@@ -1,75 +1,57 @@
 require 'spec_helper'
 
 describe ActiveModel::Validations::EmailValidator do
-  let(:person) { Person.new(email: 'invalid') }
-
-  let(:options) { {attributes: [:email]} }
-
-  def build_validator(options = {})
-    ActiveModel::Validations::EmailValidator.new(
-      options.merge(attributes: [:email])
-    )
-  end
-
-  subject(:validator) { build_validator }
-
   describe '#validate' do
-    context 'with a valid email address' do
-      before do
-        person.email = 'james@logi.cl'
-      end
-
-      it 'does not add errors' do
-        validator.validate(person)
-        person.errors.to_a.should == []
-      end
-    end
-
-    context 'with nil allowed' do
-      subject(:validator) do
-        build_validator(allow_nil: true)
-      end
-
-      before do
-        person.email = nil
-      end
-
-      it 'skips adding errors is email is nil' do
-        validator.validate(person)
-        person.errors.to_a.should == []
-      end
-    end
-
-    context 'with blank is allowed' do
-      subject(:validator) do
-        build_validator(allow_blank: true)
-      end
-
-      before do
-        person.email = '  '
-      end
-
-      it 'skips adding errors is email is nil' do
-        validator.validate(person)
-        person.errors.to_a.should == []
-      end
-    end
-
-    context 'with no message provided' do
-      it 'adds a symbol to errors for I18n lookup' do
-        validator.validate(person)
-        person.errors.to_a.should == ['Email is invalid']
-      end
-    end
-
-    context 'with a specific error message provided' do
-      subject(:validator) do
-        build_validator(message: 'is kinda odd looking')
-      end
-
-      it 'uses the message you specify' do
-        validator.validate(person)
-        person.errors.to_a.should == ['Email is kinda odd looking']
+    [
+      {
+        desc: 'with a valid email address',
+        validator: {},
+        people: [
+          {email: 'a@b.c'},
+          {email: 'a+x@b.c'},
+          {email: 'a@192.168.0.1'},
+          {email: '1@1.com'}
+        ],
+        errors: []
+      },
+      {
+        desc: 'with nil allowed',
+        validator: {allow_nil: true},
+        people: [ {email: nil} ],
+        errors: []
+      },
+      {
+        desc: 'with blank allowed',
+        validator: {allow_blank: true},
+        people: [ {email: ' '}, {email: "\t\n"} ],
+        errors: []
+      },
+      {
+        desc: 'with no message provided',
+        validator: {},
+        people: [ {email: 'invalid'}, {email: '  '} ],
+        errors: ['Email is invalid']
+      },
+      {
+        desc: 'with a custom error message',
+        validator: {message: 'is kinda odd looking'},
+        people: [ {email: 'invalid'}, {email: '  '} ],
+        errors: ['Email is kinda odd looking']
+      }
+    ].each do |data|
+      data[:people].each do |person_attributes|
+        context data do
+          let(:person) { Person.new(person_attributes) }
+
+          let(:validator) do
+            ActiveModel::Validations::EmailValidator.new(
+              data[:validator].merge(attributes: [:email])
+            )
+          end
+
+          before { validator.validate(person) }
+          it { expect(person.errors.to_a).to eq(data[:errors]) }
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$: << 'lib'
+
+begin
+  require 'simplecov'
+rescue LoadError
+end
+
+require 'validate_as_email'
+require 'rspec/rails/extensions/active_record/base'
+
+Dir.glob(File.expand_path('../support/**/*.rb', __FILE__)) { |file| require file }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/spec/support/model.rb

@@ -0,0 +1,25 @@
+class Model
+  include ActiveModel::Validations
+
+  attr_accessor :attributes
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+
+  def email
+    @attributes[:email]
+  end
+
+  def email=(email)
+    @attributes[:email] = email
+  end
+end
+
+class Person < Model
+  validates :email, email: true
+end

metadata

@@ -1,132 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: validate_as_email
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - James Conroy-Finn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: cucumber
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-description: The ultimate Rails 3 email validator
+        version: '0'
+description: The ultimate email validator
 email:
 - james@logi.cl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
 - lib/active_model/validations/email_validator.rb
-- lib/validate_as_email/version.rb
 - lib/validate_as_email.rb
-- README.md
+- lib/validate_as_email/rspec.rb
+- lib/validate_as_email/version.rb
 - spec/active_model/validations/email_validator_spec.rb
-homepage: https://github.com/evently/mail_validator
+- spec/spec_helper.rb
+- spec/support/model.rb
+homepage: https://github.com/jcf/validate_as_email
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
-summary: The ultimate Rails 3 email validator. Powered by the Mail gem.
+specification_version: 4
+summary: The ultimate email validator. Powered by the Mail gem.
 test_files:
 - spec/active_model/validations/email_validator_spec.rb
-has_rdoc: 
+- spec/spec_helper.rb
+- spec/support/model.rb