donncha-validates_as_email 0.6.1

data/CHANGELOG

@@ -0,0 +1,33 @@
+0.6.0 - Jul 24th 2009
+ * Added :restrict_domain option to exclude single-part domains, e.g: user@example
+ * Added workaround for 'ActiveRecord::Base::Validations (NameError)' bug when running tests
+
+0.6.0 - Jul 24th 2009
+ * Compatibility with Ruby 1.9
+ * Support for I18n
+
+0.5.1 - Aug 15th 2008
+ * Repackaged original plugin by Ximon Eighteen for GitHub
+ * Gem'ified plugin
+
+0.1.4 - May 26th 2006
+  *  Thijs van der Vossen fixed a plugin load issue in the test suite and
+     provided another test to illustrate that test@example is considered
+     valid by RFC822, something most people wouldn't realise.
+
+0.1.3 - May 9th 2006
+  *  Thijs van der Vossen contributed some test cases.
+
+0.1.2 - April 24th 2006
+  *  Dan Kubb and Tim Fletcher have updated the RFC822 regular expression
+     on Tims website so I've put the latest version into this plugin. The
+     changes prevent matching of email addresses containing line breaks.
+
+0.1.1 - April 23rd 2006
+  *  Huge code cleanup & simplification by Dan Kubb.
+  *  Credit Tim Fletcher with the Ruby version of the RFC822 regular
+     expression.
+
+0.1.0 - April 4th 2006
+  *  First release, advertised on the Rails plugins page:
+     http://wiki.rubyonrails.org/rails/pages/Plugins

data/LICENSE

@@ -0,0 +1,5 @@
+Licensing terms follow:
+ 
+This software is placed under the Creative Commons Attribution-Share Alike 3.0 Unported License
+
+http://creativecommons.org/licenses/by-sa/3.0/

data/README

@@ -0,0 +1,54 @@
+ValidatesAsEmail
+================
+
+This gem/plugin is a re-packaged and gem'ified version of the original plugin with credit as follows:
+
+Donncha Redmond <dredmond@e-xact.com>
+Michal Zima <xhire@mujmalysvet.cz>
+Ximon Eighteen <ximon.eighteen@int.greenpeace.org>
+Dan Kubb <dan.kubb@autopilotmarketing.com>
+Thijs van der Vossen <thijs@fngtps.com>
+
+This Ruby on Rails plugin implements an ActiveRecord validation helper called
+validates_as_email. The helper acts as if validates_format_of was used with a
+regular expression that defines an RFC822 email address conformance test.
+
+The plugin implements the regular expression here:
+
+  http://tfletcher.com/lib/rfc822.rb
+
+Which is an implementation in Ruby of a regular expression published by Cal
+Henderson for PHP here:
+
+  http://www.iamcal.com/publish/articles/php/parsing_email
+
+Installation:
+=============
+gem sources -a http://gems.github.com
+
+Install the gem(s):
+sudo gem install donncha-validates_as_email
+
+Add to environment.rb initializer block:
+config.gem 'donncha-validates_as_email', :lib => 'validates_as_email', :source => 'http://gems.github.com'
+
+Usage:
+======
+In your model file do something like:
+
+class MyClass < ActiveRecord::Base
+  validates_as_email :email, :message => 'Invalid Email Address', :allow_nil => true
+end
+
+class MyOtherClass < ActiveRecord::Base
+  # will not accept addresses with a single part domain, e.g user@example
+  validates_as_email :email, :message => 'Invalid Email Address', :allow_nil => true, :restrict_domain => true
+end
+
+Tests:
+======
+Some tests have been added.
+
+License:
+========
+See the LICENSE file.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validates_as_email plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validates_as_email plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesAsEmail'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

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

data/lib/validates_as_email.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+#
+# RFC822 Email Address Regex
+# --------------------------
+#
+# Originally written by Cal Henderson
+# c.f. http://iamcal.com/publish/articles/php/parsing_email/
+#
+# Translated to Ruby by Tim Fletcher, with changes suggested by Dan Kubb.
+#
+# Licensed under a Creative Commons Attribution-ShareAlike 2.5 License
+# http://creativecommons.org/licenses/by-sa/2.5/
+#
+module RFC822
+  module Patterns
+    def self.compile(string)
+      Regexp.new string, nil, 'n'
+    end
+
+    QTEXT     = compile "[^\\x0d\\x22\\x5c\\x80-\\xff]"
+    DTEXT     = compile "[^\\x0d\\x5b-\\x5d\\x80-\\xff]"
+
+    ATOM_CORE = compile "[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+"
+    ATOM_EDGE = compile "[^\\x00-\\x20\\x22\\x28\\x29\\x2c-\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]"
+    ATOM      = compile "(?:#{ATOM_EDGE}{1,2}|#{ATOM_EDGE}#{ATOM_CORE}#{ATOM_EDGE})"
+
+    QPAIR     = compile "\\x5c[\\x00-\\x7f]"
+    QSTRING   = compile "\\x22(?:#{QTEXT}|#{QPAIR})*\\x22"
+
+    WORD      = compile "(?:#{ATOM}|#{QSTRING})"
+
+    DOMAIN_PT = compile "(?:[a-zA-Z0-9][\-a-zA-Z0-9]*[a-zA-Z0-9]|[a-zA-Z0-9]+)"
+
+    DOMAIN    = compile "#{DOMAIN_PT}(?:\\x2e#{DOMAIN_PT})*"
+    LOCAL_PT  = compile "#{WORD}(?:\\x2e#{WORD})*"
+
+    ADDRESS   = compile "#{LOCAL_PT}\\x40#{DOMAIN}"
+    NON_LOCAL_ADDRESS   = compile "#{LOCAL_PT}\\x40#{DOMAIN_PT}(\\x2e#{DOMAIN_PT})+"
+  end
+  EmailAddress = /\A#{Patterns::ADDRESS}\z/
+  NonLocalEmailAddress = /\A#{Patterns::NON_LOCAL_ADDRESS}\z/
+end
+
+# Validation helper for ActiveRecord derived objects that cleanly and simply
+# allows the model to check if the given string is a syntactically valid email
+# address (by using the RFC822 module above).
+#
+# Original code by Ximon Eighteen <ximon.eightee@int.greenpeace.org> which was
+# heavily based on code I can no longer find on the net, my apologies to the
+# author!
+#
+# Huge credit goes to Dan Kubb <dan.kubb@autopilotmarketing.com> for
+# submitting a patch to massively simplify this code and thereby instruct me
+# in the ways of Rails too! I reflowed the patch a little to keep the line
+# length to a maximum of 78 characters, an old habit.
+
+module ActiveRecord
+  module Validations
+    module ClassMethods
+      def validates_as_email(*attr_names)
+        options = attr_names.pop if attr_names.last.is_a?(Hash)
+        restrict_domain = options.delete(:restrict_domain) if options
+        configuration = {
+          :message   => (I18n.translate(:'activerecord.errors.messages.invalid_email', :raise => true) rescue 'is an invalid email'),
+          :with      => restrict_domain ? RFC822::NonLocalEmailAddress : RFC822::EmailAddress,
+          :allow_nil => false }
+        configuration.update(options) if options
+
+        validates_format_of attr_names, configuration
+      end
+    end
+  end
+end

data/test/validates_as_email_test.rb

@@ -0,0 +1,72 @@
+require 'test/unit'
+
+begin
+  require File.dirname(__FILE__) + '/../../../../config/boot'
+  require 'active_record'
+  require 'validates_as_email'
+rescue LoadError
+  require 'rubygems'
+  require 'active_record'
+  # BUG: https://rails.lighthouseapp.com/projects/8994/tickets/2577-when-using-activerecordassociations-outside-of-rails-a-nameerror-is-thrown
+  ActiveRecord::ActiveRecordError
+  require File.dirname(__FILE__) + '/../lib/validates_as_email'
+end
+
+class TestRecord < ActiveRecord::Base
+  def self.columns; []; end
+  attr_accessor :email
+  validates_as_email :email
+end
+class LocalTestRecord < ActiveRecord::Base
+  def self.columns; []; end
+  attr_accessor :email
+  validates_as_email :email, :restrict_domain => true
+end
+
+class ValidatesAsEmailTest < Test::Unit::TestCase
+  def test_illegal_rfc822_email_address
+    addresses = [
+      'Max@Job 3:14', 
+      'Job@Book of Job',
+      'J. P. \'s-Gravezande, a.k.a. The Hacker!@example.com',
+      ]
+    addresses.each do |address|
+      assert !TestRecord.new(:email => address).valid?, "#{address} should be illegal."
+    end
+  end
+
+  def test_legal_rfc822_email_address
+    addresses = [
+      'test@example',
+      'test@example.com', 
+      'test@example.co.uk',
+      '"J. P. \'s-Gravezande, a.k.a. The Hacker!"@example.com',
+      'me@[187.223.45.119]',
+      'someone@123.com',
+      ]
+    addresses.each do |address|
+      assert TestRecord.new(:email => address).valid?, "#{address} should be legal."
+    end
+  end
+
+  # insist on a domain of at least two parts, and no IP addresses
+  def test_restricted_domains
+    addresses = [
+      'test@example.com', 
+      'test@example.co.uk',
+      '"J. P. \'s-Gravezande, a.k.a. The Hacker!"@example.com',
+      'someone@123.com',
+      ]
+    addresses.each do |address|
+      assert LocalTestRecord.new(:email => address).valid?, "#{address} should be legal."
+    end
+
+    addresses = [
+      'test@example',
+      'me@[187.223.45.119]',
+      ]
+    addresses.each do |address|
+      assert !LocalTestRecord.new(:email => address).valid?, "non-traditional domain #{address} should not be legal."
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: donncha-validates_as_email
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 1
+  version: 0.6.1
+platform: ruby
+authors: 
+- Michal Zima
+- Ximon Eighteen
+- Dan Kubb
+- Thijs van der Vossen
+- Donncha Redmond
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 +11:00
+default_executable: 
+dependencies: []
+
+description: Rails gem/plugin that implements an ActiveRecord validation helper called validates_as_email which validates email address (RFC822)
+email: dredmond@e-xact.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- init.rb
+- lib/validates_as_email.rb
+- test/validates_as_email_test.rb
+has_rdoc: true
+homepage: http://github.com/donncha/validates_as_email
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails gem/plugin to validate format of email addresses (RFC822)
+test_files: 
+- test/validates_as_email_test.rb