dancroak-validates_email_format_of 1.2.1

data/CHANGELOG

@@ -0,0 +1,21 @@
+= CHANGELOG
+
+== Version 1.0
+ * initial version
+
+== Version 1.1 (the Francis Hwang edition)
+ * moved Regexp out of class methods into the ValidatesEmailFormatOf module
+
+== Version 1.2 (the Ismael Santos Kafeltz and Michael MacDonald edition)
+ * added support for un-escaped and escaped special characters in the local part, per RFC 3696
+ * added :allow_nil option
+
+== Version 1.2.1 (the RTFM edition)
+ * added support for quoted local parts
+ * added length checks for domain and local parts
+ * corrected escaped character support for RFC 3696 Errata
+ * added :allow_blank option
+ * added :unless option
+
+== Unreleased
+ * Now available as a gem on GitHub

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Alex Dunae
+
+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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG
+init.rb
+lib/validates_email_format_of.rb
+MIT-LICENSE
+rails/init.rb
+rakefile
+README.markdown
+test/database.yml
+test/fixtures/people.yml
+test/fixtures/person.rb
+test/schema.rb
+test/test_helper.rb
+test/validates_email_format_of_test.rb
+Rakefile
+Manifest

data/README.markdown

@@ -0,0 +1,54 @@
+Validates email format
+======================
+
+Validate various formats of email address against RFC 2822.
+
+Usage
+-----
+
+    class Person < ActiveRecord::Base
+      validates_email_format_of :email
+    end
+
+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)
+
+    :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.
+
+Testing
+-------
+
+To execute the unit tests run <tt>rake test</tt>.
+
+The unit tests for this plugin use an in-memory sqlite3 database.
+
+Installing the gem
+------------------
+
+* gem sources -a http://gems.github.com (only needed once)
+* sudo gem install dancroak-validates\_email\_format\_of
+
+Credits
+-------
+
+Written by Alex Dunae (dunae.ca), 2006-07.
+
+Thanks to Francis Hwang (http://fhwang.net/) at Diversion Media for creating the 1.1 update.

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/validates_email_format_of.rb

@@ -0,0 +1,54 @@
+module ValidatesEmailFormatOf
+  LocalPartSpecialChars = Regexp.escape('!#$%&\'*-/=?+-^_`{|}~')
+  LocalPartUnquoted = '(([[:alnum:]' + LocalPartSpecialChars + ']+[\.\+]+))*[[:alnum:]' + LocalPartSpecialChars + '+]+'
+  LocalPartQuoted = '\"(([[:alnum:]' + LocalPartSpecialChars + '\.\+]*|(\\\\[\x00-\xFF]))*)\"'
+  Regex = Regexp.new('^((' + LocalPartUnquoted + ')|(' + LocalPartQuoted + ')+)@(((\w+\-+)|(\w+\.))*\w{1,63}\.[a-z]{2,6}$)', Regexp::EXTENDED | Regexp::IGNORECASE)
+end
+
+module ActiveRecord
+  module Validations
+    module ClassMethods
+      # 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 a valid e-mail address")
+      # * <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>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 = { :message => ' does not appear to be a valid e-mail address', 
+                    :on => :save, 
+                    :allow_nil => false,
+                    :allow_blank => false,
+                    :with => ValidatesEmailFormatOf::Regex }
+
+        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
+
+          # local part max is 64 chars, domain part max is 255 chars
+          # TODO: should this decode escaped entities before counting?
+          begin
+            domain, local = v.reverse.split('@', 2)
+          rescue
+            record.errors.add(attr_name, options[:message])
+            next
+          end
+
+          unless v =~ options[:with] and not v =~ /\.\./ and domain.length <= 255 and local.length <= 64
+            record.errors.add(attr_name, options[:message])
+          end
+        end
+      end
+    end   
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'validates_email_format_of'

data/rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'echoe'
+
+Echoe.new("validates_email_format_of") do |p|
+  p.author = "Alex Dunae"
+  p.summary = "Validate e-mail addreses against RFC 2822 and RFC 3696"
+  p.url = "http://code.dunae.ca/validates_email_format_of.html"
+  p.version = '1.2.1'
+  p.email = 'code@code.dunae.ca'
+end

data/test/test_helper.rb

@@ -0,0 +1,61 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'active_record'
+
+require 'validates_email_format_of'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:')
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :people, :force => true do |t|
+    t.column 'email', :string
+  end
+end
+
+class Person < ActiveRecord::Base
+  validates_email_format_of :email, :on => :create, :message => 'fails with custom message', :allow_nil => true
+end
+
+# Set up Feedback testing framework, a la carte
+
+require 'test/unit'
+require 'shoulda'
+require "#{File.dirname(__FILE__)}/../init"
+
+class Test::Unit::TestCase #:nodoc:
+  
+  def self.should_allow_values(*good_values)
+    get_options!(good_values)
+    good_values.each do |v|
+      should "allow email to be set to #{v.inspect}" do
+        user = User.new(:email => v)
+        user.save
+        assert_nil user.errors.on(:email)
+      end
+    end
+  end
+
+  def self.should_not_allow_values(*bad_values)
+    message = get_options!(bad_values, :message)
+    message ||= /invalid/
+    bad_values.each do |v|
+      should "not allow email to be set to #{v.inspect}" do
+        user = User.new(:email => v)
+        assert !user.save, "Saved user with email set to \"#{v}\""
+        assert user.errors.on(:email), "There are no errors set on email after being set to \"#{v}\""
+      end
+    end
+  end
+  
+  def self.get_options!(args, *wanted)
+    ret  = []
+    opts = (args.last.is_a?(Hash) ? args.pop : {})
+    wanted.each {|w| ret << opts.delete(w)}
+    raise ArgumentError, "Unsuported options given: #{opts.keys.join(', ')}" unless opts.keys.empty?
+    return *ret
+  end
+  
+end

data/test/validates_email_format_of_test.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ValidatesEmailFormatOfTest < Test::Unit::TestCase
+  @@valid_email = 'valid@example.com'
+  @@invalid_email = 'invalid@example.'
+  
+  @@valid_emails = ['valid@example.com',
+     'Valid@test.example.com',
+     'valid+valid123@test.example.com',
+     'valid_valid123@test.example.com',
+     'valid-valid+123@test.example.co.uk',
+     'valid-valid+1.23@test.example.com.au',
+     'valid@example.co.uk',
+     'v@example.com',
+     'valid@example.ca',
+     'valid_@example.com',
+     'valid123.456@example.org',
+     'valid123.456@example.travel',
+     'valid123.456@example.museum',
+     'valid@example.mobi',
+     'valid@example.info',
+     'valid-@example.com',
+  # from RFC 3696, page 6
+     'customer/department=shipping@example.com',
+     '$A12345@example.com',
+     '!def!xyz%abc@example.com',
+     '_somename@example.com',
+  # apostrophes
+     "test'test@example.com",
+     ]
+     
+  def test_should_allow_valid_email_addresses
+    @@valid_emails.each do |email|
+      p = create_person(:email => email)
+      save_passes(p, email)
+    end
+  end
+  
+  @@invalid_emails = ['invalid@example-com',
+  # period can not start local part
+     '.invalid@example.com',
+  # period can not end local part
+     'invalid.@example.com', 
+  # period can not appear twice consecutively in local part
+     'invali..d@example.com',
+     'invalid@example.com.',
+     'invalid@example.com_',
+     'invalid@example.com-',
+     'invalid-example.com',
+     'invalid@example.b#r.com',
+     'invalid@example.c',
+     'invali d@example.com',
+     'invalidexample.com',
+     'invalid@example.']
+
+  def test_should_not_allow_invalid_email_addresses
+    @@invalid_emails.each do |email|
+      p = create_person(:email => email)
+      save_fails(p, email)
+    end
+  end
+  
+  @@quoted_emails = ['"Abc\@def"@example.com',     
+   '"Fred\ Bloggs"@example.com',
+   '"Joe.\\Blow"@example.com',
+   ]
+
+  # from http://www.rfc-editor.org/errata_search.php?rfc=3696
+  def test_should_allow_quoted_characters
+    @@quoted_emails.each do |email|
+      p = create_person(:email => email)
+      save_passes(p, email)
+    end
+  end
+  
+  @@unescaped_emails = ['Fred\ Bloggs_@example.com',
+   'Abc\@def+@example.com',
+   'Joe.\\Blow@example.com'
+   ]
+
+  # from http://tools.ietf.org/html/rfc3696, page 5
+  # corrected in http://www.rfc-editor.org/errata_search.php?rfc=3696
+  def test_should_not_allow_escaped_characters_without_quotes
+    @@unescaped_emails.each do |email|
+      p = create_person(:email => email)
+      save_fails(p, email)
+    end
+  end
+  
+  @@long_emails = ['aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa@example.com',
+   'test@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.com'
+   ]
+
+  def test_should_check_length_limits
+    @@long_emails.each do |email|
+      p = create_person(:email => email)
+      save_fails(p, email)
+    end
+  end
+
+  def test_should_respect_validate_on_option
+    p = create_person(:email => @@valid_email)
+    save_passes(p)
+    
+    # we only asked to validate on :create so this should fail
+    assert p.update_attributes(:email => @@invalid_email)
+    assert_equal @@invalid_email, p.email
+  end
+  
+  def test_should_allow_custom_error_message
+    p = create_person(:email => @@invalid_email)
+    save_fails(p)
+    assert_equal 'fails with custom message', p.errors.on(:email)
+  end
+
+  def test_should_allow_nil
+    p = create_person(:email => nil)
+    save_passes(p)
+  end
+
+  protected
+    def create_person(params)
+      Person.new(params)
+    end
+
+    def save_passes(p, email = '')
+      assert p.valid?, " validating #{email}"
+      assert p.save
+      assert_nil p.errors.on(:email)
+    end
+    
+    def save_fails(p, email = '')
+      assert !p.valid?, " validating #{email}"
+      assert !p.save
+      assert p.errors.on(:email)
+    end
+end

data/validates_email_format_of.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name = %q{validates_email_format_of}
+  s.version = "1.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new("= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alex Dunae"]
+  s.date = %q{2008-07-02}
+  s.description = %q{Validate e-mail addreses against RFC 2822 and RFC 3696}
+  s.email = %q{code@code.dunae.ca}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/validates_email_format_of.rb", "README.markdown"]
+  s.files = ["CHANGELOG", "init.rb", "lib/validates_email_format_of.rb", "MIT-LICENSE", "rails/init.rb", "rakefile", "README", "test/database.yml", "test/fixtures/people.yml", "test/fixtures/person.rb", "test/schema.rb", "test/test_helper.rb", "test/validates_email_format_of_test.rb", "Rakefile", "Manifest", "validates_email_format_of.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://code.dunae.ca/validates_email_format_of.html}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Validates_email_format_of"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{validates_email_format_of}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Validate e-mail addreses against RFC 2822 and RFC 3696}
+  s.test_files = ["test/test_helper.rb", "test/validates_email_format_of_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: dancroak-validates_email_format_of
+version: !ruby/object:Gem::Version 
+  version: 1.2.1
+platform: ruby
+authors: 
+- Alex Dunae
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Validate e-mail addreses against RFC 2822 and RFC 3696
+email: code@code.dunae.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/validates_email_format_of.rb
+- README.markdown
+files: 
+- CHANGELOG
+- init.rb
+- lib/validates_email_format_of.rb
+- MIT-LICENSE
+- rails/init.rb
+- rakefile
+- README
+- test/database.yml
+- test/fixtures/people.yml
+- test/fixtures/person.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/validates_email_format_of_test.rb
+- Rakefile
+- Manifest
+- validates_email_format_of.gemspec
+- README.markdown
+has_rdoc: true
+homepage: http://code.dunae.ca/validates_email_format_of.html
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Validates_email_format_of
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: validates_email_format_of
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Validate e-mail addreses against RFC 2822 and RFC 3696
+test_files: 
+- test/test_helper.rb
+- test/validates_email_format_of_test.rb