validates_email_format_of 1.5.3 → 1.6.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Nzc3NWIyMDUwNDM0NWRiMTViYmE2MjU4MWNiNjQwM2I1MjBiYTZiYw==
+  data.tar.gz: !binary |-
+    MjJiOTNiNzBiNjcyZTlkY2I3NTZjMmRlZjcwZTZiYTNiNDg4ZmE2Yg==
+SHA512:
+  metadata.gz: !binary |-
+    NDk4ZmFjYzgzN2Y1N2FiOTE1ZjUwZGU0YjQzOTY4YzE3ZTY5NTYyZDVlNDIw
+    YTRmN2JjYzQ3N2M3ZDZhOTc4OTU3YjFjMWMyNjY4Mzg5YjkyNmM3ZjFlZWYw
+    ZDlhNzQ2MTIwNGYyODJiMDA0OWQxODM0ZmM0OGEwMzliMmFlYTI=
+  data.tar.gz: !binary |-
+    N2Q1OTQyMjQ4ZWFkMWMzODU2MmMxMTc0MmZmYzhhMzY2ZTU3ZjhkMWQzZDY2
+    Y2VmYjZmMzRkY2I4NzEzYjAwN2Y4YmZmMjIzM2U0MDkwNjMzNDBkZWRkMzFj
+    NjU4NTMzODU3OTkyMzRiMTM5OWVhNzc5ZWUxZGUyZWJkYjAyMTA=

data/.gitignore

@@ -0,0 +1,8 @@
+pkg
+test/debug.log
+rdoc
+Gemfile.lock
+*.gem
+*.sqlite3
+*.swp
+.ruby-version

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,18 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby
+  - ree
+gemfile:
+  - Gemfile
+  - gemfiles/active_model_2_1
+  - gemfiles/active_model_3_0
+  - gemfiles/active_model_3_1
+  - gemfiles/active_model_3_2
+  - gemfiles/active_model_4_0
+  - gemfiles/active_model_4_1
+install: bundle install
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.rdoc

@@ -8,75 +8,76 @@ Installing as a gem:
 
   gem install validates_email_format_of
 
-Installing as a Ruby on Rails 2 plugin:
-
-  ./script/plugin install http://github.com/alexdunae/validates_email_format_of.git
-
-Or in your Rails 3 Gemfile
-
-  gem 'validates_email_format_of', :git => 'git://github.com/alexdunae/validates_email_format_of.git'
+Or in your Gemfile:
 
+  gem 'validates_email_format_of'
 
 == Usage
 
- class Person < ActiveRecord::Base
-   validates_email_format_of :email
- end
-
- # Rails 3
- class Person < ActiveRecord::Base
-   validates :email, :email_format => {:message => 'is not looking good'}
- end
-
-As of version 1.4, it's possible to run e-mail validation tests (including MX 
-checks) without using ActiveRecord or even touching a database.  The 
-<tt>validate_email_format</tt> method will return <tt>nil</tt> on a valid 
-e-mail address or an array of error messages for invalid addresses.
-
-  results = ValidatesEmailFormatOf::validate_email_format(email, options)
+  # Rails
+  # I18n locales are loaded automatically.
+  class Person < ActiveRecord::Base
+    validates_email_format_of :email, :message => 'is not looking good'
+    # OR
+    validates :email, :email_format => { :message => 'is not looking good' }
+  end
 
-  if results.nil?
-    # success!
-  else
-    puts results.join(', ')
+  # Now you can test your model using RSpec:
+  require "validates_email_format_of/rspec_matcher"
+  describe Person do
+    it { should validate_email_format_of(:email).with_message('is not looking good') }
   end
 
+  # If you're not using Rails (which really means, if you're not using ActiveModel::Validations)
+  ValidatesEmailFormatOf::load_i18n_locales # Optional, if you want error messages to be in your language
+  I18n.locale = :pl # If, for example, you want Polish error messages.
+  ValidatesEmailFormatOf::validate_email_format("example@mydomain.com") # => nil
+  ValidatesEmailFormatOf::validate_email_format("invalid_because_there_is_no_at_symbol") # => ["does not appear to be a valid e-mail address"]
 
 === Options
 
   :message
-     String. A custom error message (default is: " does not appear to be a valid e-mail address")
-  :on
-     Symbol. Specifies when this validation is active (default is :save, other options :create, :update)
-  :allow_nil
-     Boolean. Allow nil values (default is false)
-  :allow_blank
-     Boolean. Allow blank values (default is false)
+     String. A custom error message when the email format is invalid (default is: "does not appear to be a valid e-mail address")
   :check_mx
      Boolean. Check domain for a valid MX record (default is false)
-  :if
-     Specifies a method, proc or string to call to determine if the validation should occur 
-     (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }). The method, 
-     proc or string should return or evaluate to a true or false value. 
-  :unless
-     See :if option.
+  :mx_message
+     String. A custom error message when the domain does not match a valid MX record (default is: "is not routable").  Ignored unless :check_mx option is true.
   :local_length
-    Maximum number of characters allowed in the local part (default is 64)
+    Maximum number of characters allowed in the local part (everything before the '@') (default is 64)
   :domain_length
-    Maximum number of characters allowed in the domain part (default is 255)
-
+    Maximum number of characters allowed in the domain part (everything after the '@') (default is 255)
+  :with
+    Specify a custom Regex as the valid email format.
+  :on, :if, :unless, :allow_nil, :allow_blank, :strict
+     Standard ActiveModel validation options.  These work in the ActiveModel/ActiveRecord/Rails syntax only.
+     See http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validates for details.
 
 == Testing
 
-To execute the unit tests run <tt>rake test</tt>.
+To execute the unit tests run <tt>rspec</tt>.
+
+Tested in Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1.2, JRuby and REE 1.8.7.
 
-The unit tests for this plugin use an in-memory sqlite3 database.
+== Contributing
 
-Tested in Ruby 1.8.7, 1.9.2, 1.9.3-rc1, JRuby and REE 1.8.7.
+If you think we're letting some rules about valid email formats slip through the cracks, don't just update the Regex.
+Instead, add a failing test, and demonstrate that the described email address should be treated differently.  A link to an appropriate RFC is the best way to do this.
+Then change the gem code to make the test pass.
 
-== Resources
+  describe "i_think_this_is_not_a_v@lid_email_addre.ss" do
+    # According to http://..., this email address IS NOT valid.
+    it { should have_errors_on_email.because("does not appear to be valid") }
+  end
+  describe "i_think_this_is_a_v@lid_email_addre.ss" do
+    # According to http://..., this email address IS valid.
+    it { should_not have_errors_on_email }
+  end
 
-* https://github.com/alexdunae/validates_email_format_of
+Yes, our Rspec syntax is that simple!
+
+== Homepage
+
+* https://github.com/validates-email-format-of/validates_email_format_of
 
 == Credits
 
@@ -90,4 +91,6 @@ Thanks to Travis Sinnott for creating the 1.3 update.
 
 Thanks to Denis Ahearn at Riverock Technologies (http://www.riverocktech.com/) for creating the 1.4 update.
 
-Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.
+Thanks to George Anderson (http://github.com/george) and 'history' (http://github.com/history) for creating the 1.4.1 update.
+
+Thanks to Isaac Betesh (https://github.com/betesh) for converting tests to Rspec and refactoring for version 1.6.0.

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  activemodel:
+    errors:
+      messages:
+        invalid_email_address: 'does not appear to be a valid e-mail address'
+        email_address_not_routable: 'is not routable'

data/config/locales/pl.yml

@@ -0,0 +1,6 @@
+pl:
+  activemodel:
+    errors:
+      messages:
+        invalid_email_address: 'nieprawidłowy adres e-mail'
+        email_address_not_routable: 'jest nieosiągalny'

data/gemfiles/Gemfile.active_model_2_1

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 2.1.0'

data/gemfiles/Gemfile.active_model_3_0

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 2.1.0'

data/gemfiles/Gemfile.active_model_3_1

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 3.1.0'

data/gemfiles/Gemfile.active_model_3_2

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 3.2.0'

data/gemfiles/Gemfile.active_model_3_3

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'active_model', '= 3.3.0'

data/gemfiles/Gemfile.active_model_4_0

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 4.0.0'

data/gemfiles/Gemfile.active_model_4_1

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'activemodel', '= 4.1.0'

data/lib/validates_email_format_of.rb

@@ -1,15 +1,18 @@
 # encoding: utf-8
-module ValidatesEmailFormatOf
-  require 'resolv'
+require 'validates_email_format_of/version'
 
-  VERSION = '1.5.3'
+module ValidatesEmailFormatOf
+  def self.load_i18n_locales
+    require 'i18n'
+    I18n.load_path += Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'locales', '*.yml')))
+  end
 
-  MessageScope = defined?(ActiveModel) ? :activemodel : :activerecord
+  require 'resolv'
 
   LocalPartSpecialChars = /[\!\#\$\%\&\'\*\-\/\=\?\+\-\^\_\`\{\|\}\~]/
 
   def self.validate_email_domain(email)
-    domain = email.match(/\@(.+)/)[1]
+    domain = email.to_s.downcase.match(/\@(.+)/)[1]
     Resolv::DNS.open do |dns|
       @mx = dns.getresources(domain, Resolv::DNS::Resource::IN::MX) + dns.getresources(domain, Resolv::DNS::Resource::IN::A)
     end
@@ -26,10 +29,16 @@ module ValidatesEmailFormatOf
   # * <tt>with</tt> The regex to use for validating the format of the email address (deprecated)
   # * <tt>local_length</tt> Maximum number of characters allowed in the local part (default is 64)
   # * <tt>domain_length</tt> Maximum number of characters allowed in the domain part (default is 255)
+  DEFAULT_MESSAGE = "does not appear to be valid"
+  DEFAULT_MX_MESSAGE = "is not routable"
+  def self.default_message
+    defined?(I18n) ? I18n.t(:invalid_email_address, :scope => [:activemodel, :errors, :messages], :default => DEFAULT_MESSAGE) : DEFAULT_MESSAGE
+  end
+
   def self.validate_email_format(email, options={})
-      default_options = { :message => I18n.t(:invalid_email_address, :scope => [MessageScope, :errors, :messages], :default => 'does not appear to be valid'),
+      default_options = { :message => default_message,
                           :check_mx => false,
-                          :mx_message => I18n.t(:email_address_not_routable, :scope => [MessageScope, :errors, :messages], :default => 'is not routable'),
+                          :mx_message => defined?(I18n) ? I18n.t(:email_address_not_routable, :scope => [:activemodel, :errors, :messages], :default => DEFAULT_MX_MESSAGE) : DEFAULT_MX_MESSAGE,
                           :domain_length => 255,
                           :local_length => 64
                           }
@@ -64,7 +73,7 @@ module ValidatesEmailFormatOf
 
       return nil    # represents no validation errors
   end
-  
+
 
   def self.validate_local_part_syntax(local)
     in_quoted_pair = false
@@ -74,27 +83,27 @@ module ValidatesEmailFormatOf
       ord = local[i].ord
 
       # accept anything if it's got a backslash before it
-      if in_quoted_pair 
+      if in_quoted_pair
         in_quoted_pair = false
         next
       end
-        
+
       # backslash signifies the start of a quoted pair
       if ord == 92 and i < local.length - 1
         return false if not in_quoted_string # must be in quoted string per http://www.rfc-editor.org/errata_search.php?rfc=3696
         in_quoted_pair = true
         next
       end
-        
+
       # double quote delimits quoted strings
       if ord == 34
         in_quoted_string = !in_quoted_string
         next
-      end    
+      end
 
       next if local[i,1] =~ /[a-z0-9]/i
       next if local[i,1] =~ LocalPartSpecialChars
-      
+
       # period must be followed by something
       if ord == 46
         return false if i == 0 or i == local.length - 1 # can't be first or last char
@@ -103,86 +112,34 @@ module ValidatesEmailFormatOf
 
       return false
     end
-    
+
     return false if in_quoted_string # unbalanced quotes
 
     return true
   end
-  
+
   def self.validate_domain_part_syntax(domain)
     parts = domain.downcase.split('.', -1)
-    
+
     return false if parts.length <= 1 # Only one domain part
 
     # Empty parts (double period) or invalid chars
-    return false if parts.any? { 
-      |part| 
-        part.nil? or 
-        part.empty? or 
+    return false if parts.any? {
+      |part|
+        part.nil? or
+        part.empty? or
         not part =~ /\A[[:alnum:]\-]+\Z/ or
         part[0,1] == '-' or part[-1,1] == '-' # hyphen at beginning or end of part
-    } 
-        
+    }
+
     # ipv4
     return true if parts.length == 4 and parts.all? { |part| part =~ /\A[0-9]+\Z/ and part.to_i.between?(0, 255) }
-        
-    return false if parts[-1].length < 2 or not parts[-1] =~ /[a-z\-]/ # TLD is too short or does not contain a char or hyphen
-    
-    return true
-  end
 
-  module Validations
-    # Validates whether the value of the specified attribute is a valid email address
-    #
-    #   class User < ActiveRecord::Base
-    #     validates_email_format_of :email, :on => :create
-    #   end
-    #
-    # Configuration options:
-    # * <tt>message</tt> - A custom error message (default is: "does not appear to be valid")
-    # * <tt>on</tt> - Specifies when this validation is active (default is :save, other options :create, :update)
-    # * <tt>allow_nil</tt> - Allow nil values (default is false)
-    # * <tt>allow_blank</tt> - Allow blank values (default is false)
-    # * <tt>check_mx</tt> - Check for MX records (default is false)
-    # * <tt>mx_message</tt> - A custom error message when an MX record validation fails (default is: "is not routable.")
-    # * <tt>if</tt> - Specifies a method, proc or string to call to determine if the validation should
-    #   occur (e.g. :if => :allow_validation, or :if => Proc.new { |user| user.signup_step > 2 }).  The
-    #   method, proc or string should return or evaluate to a true or false value.
-    # * <tt>unless</tt> - See <tt>:if</tt>
-    def validates_email_format_of(*attr_names)
-      options = { :on => :save,
-        :allow_nil => false,
-        :allow_blank => false }
-      options.update(attr_names.pop) if attr_names.last.is_a?(Hash)
-
-      validates_each(attr_names, options) do |record, attr_name, value|
-        v = value.to_s
-        errors = ValidatesEmailFormatOf::validate_email_format(v, options)
-        errors.each do |error|
-          record.errors.add(attr_name, error)
-        end unless errors.nil?
-      end
-    end
-  end
-end
-
-if defined?(ActiveModel)
-  class EmailFormatValidator < ActiveModel::EachValidator
-    def validate_each(record, attribute, value)
-      err = ValidatesEmailFormatOf::validate_email_format(value, options)
-      record.errors[attribute] << err unless err.nil?
-      record.errors[attribute].flatten!
-    end
-  end
+    return false if parts[-1].length < 2 or not parts[-1] =~ /[a-z\-]/ # TLD is too short or does not contain a char or hyphen
 
-  module ActiveModel::Validations::HelperMethods
-    def validates_email_format_of(*attr_names)
-      validates_with EmailFormatValidator, _merge_attributes(attr_names)
-    end
-  end
-else
-  class ActiveRecord::Base
-    extend ValidatesEmailFormatOf::Validations
+    return true
   end
 end
 
+require 'validates_email_format_of/active_model' if defined?(::ActiveModel) && !(ActiveModel::VERSION::MAJOR < 2 || (2 == ActiveModel::VERSION::MAJOR && ActiveModel::VERSION::MINOR < 1))
+require 'validates_email_format_of/railtie' if defined?(::Rails)

data/lib/validates_email_format_of/active_model.rb

@@ -0,0 +1,24 @@
+require 'validates_email_format_of'
+require 'active_model'
+
+if ActiveModel::VERSION::MAJOR < 2 || (2 == ActiveModel::VERSION::MAJOR && ActiveModel::VERSION::MINOR < 1)
+  puts "WARNING: ActiveModel validation helper methods in validates_email_format_of gem are not compatible with ActiveModel < 2.1.0.  Please use ValidatesEmailFormatOf::validate_email_format(email, options) or upgrade ActiveModel"
+end
+
+module ActiveModel
+  module Validations
+    class EmailFormatValidator < EachValidator
+      def validate_each(record, attribute, value)
+        (ValidatesEmailFormatOf::validate_email_format(value, options) || []).each do |error|
+          record.errors.add(attribute, error)
+        end
+      end
+    end
+
+    module HelperMethods
+      def validates_email_format_of(*attr_names)
+        validates_with EmailFormatValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end