validates_as_email_address 0.0.1

data/CHANGELOG

@@ -0,0 +1,5 @@
+*SVN*
+
+*0.0.1* (September 26th, 2007)
+
+* Add documentation

data/LICENSE

@@ -0,0 +1,2 @@
+Licensed under a Creative Commons Attribution-ShareAlike 2.5 License
+http://creativecommons.org/licenses/by-sa/2.5/

data/README

@@ -0,0 +1,50 @@
+= validates_as_email_address
+
++validates_as_email_address+ adds support for validating the format/length of
+email addresses.
+
+== Resources
+
+API
+
+* http://api.pluginaweek.org/validates_as_email_address
+
+Wiki
+
+* http://wiki.pluginaweek.org/Validates_as_email_address
+
+Announcement
+
+* http://www.pluginaweek.org
+
+Source
+
+* http://svn.pluginaweek.org/trunk/plugins/active_record/validations/validates_as_email_address
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/validations/validates_as_email_address
+
+== Description
+
+Consistently reliable email address validations are difficult to find and hard
+to choose as there are far too many implementations in various programming
+languages.  This plugins builds on Thijs van der Vossen's validates_as_email
+by adding advanced validation option support and also validating the length of
+the email address.
+
+== Usage
+
+=== Example
+
+  class Person < ActiveRecord::Base
+    validates_as_email_address :email, :on => :create
+  end
+
+== References
+
+* Cal Henderson - {Parsing Email Adresses in PHP}[http://iamcal.com/publish/articles/php/parsing_email]
+* Tim Fletcher - {Ruby Translation}[http://tfletcher.com/lib/rfc822.rb]
+* Dan Kubb[dan.kubb@autopilotmarketing.com]
+* Ximon Eighteen[ximon.eightee@int.greenpeace.org]
+* Thijs van der Vossen - validates_as_email[https://svn.greenpeace.org/repositories/rails_plugins/validates_as_email]

data/Rakefile

@@ -0,0 +1,79 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+require 'rake/contrib/sshpublisher'
+
+PKG_NAME           = 'validates_as_email_address'
+PKG_VERSION        = '0.0.1'
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+RUBY_FORGE_PROJECT = 'pluginaweek'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validates_as_email_address 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_address plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesAsEmailAddress'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = PKG_NAME
+  s.version         = PKG_VERSION
+  s.platform        = Gem::Platform::RUBY
+  s.summary         = 'Adds support for validating the format/length of email addresses'
+  
+  s.files           = FileList['{lib,test}/**/*'].to_a + %w(CHANGELOG init.rb LICENSE Rakefile README)
+  s.require_path    = 'lib'
+  s.autorequire     = 'validates_as_email_address'
+  s.has_rdoc        = true
+  s.test_files      = Dir['test/**/*_test.rb']
+  
+  s.author          = 'Aaron Pfeifer, Neil Abraham'
+  s.email           = 'info@pluginaweek.org'
+  s.homepage        = 'http://www.pluginaweek.org'
+end
+  
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+desc 'Publish the beta gem'
+task :pgem => [:package] do
+  Rake::SshFilePublisher.new('pluginaweek@pluginaweek.org', '/home/pluginaweek/gems.pluginaweek.org/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pdoc, :release]
+
+desc 'Publish the release files to RubyForge.'
+task :release => [:gem, :package] do
+  require 'rubyforge'
+  
+  ruby_forge = RubyForge.new
+  ruby_forge.login
+
+  %w( gem tgz zip ).each do |ext|
+    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+    puts "Releasing #{File.basename(file)}..."
+    
+    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+  end
+end

data/init.rb

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

data/lib/validates_as_email_address.rb

@@ -0,0 +1,104 @@
+# The standard describing the format of email addresses
+module RFC822
+  EmailAddress = begin
+    qtext = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
+    dtext = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]'
+    atom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+'
+    quoted_pair = '\\x5c[\\x00-\\x7f]'
+    domain_literal = "\\x5b(?:#{dtext}|#{quoted_pair})*\\x5d"
+    quoted_string = "\\x22(?:#{qtext}|#{quoted_pair})*\\x22"
+    domain_ref = atom
+    sub_domain = "(?:#{domain_ref}|#{domain_literal})"
+    word = "(?:#{atom}|#{quoted_string})"
+    domain = "#{sub_domain}(?:\\x2e#{sub_domain})*"
+    local_part = "#{word}(?:\\x2e#{word})*"
+    addr_spec = "(#{local_part})\\x40(#{domain})"
+    pattern = /\A#{addr_spec}\z/
+  end
+end
+
+module PluginAWeek #:nodoc:
+  module Validates #:nodoc:
+    # Adds validations for email addresses
+    module EmailAddress
+      # The options that can be used when validating the format of the email address
+      EMAIL_FORMAT_OPTIONS = [
+        :wrong_format,
+        :allow_nil,
+        :on,
+        :if
+      ]
+      
+      # The options that can be used when validating the length of the email address
+      EMAIL_LENGTH_OPTIONS = [
+        :minimum,
+        :maximum,
+        :is,
+        :within,
+        :in,
+        :too_long,
+        :too_short,
+        :wrong_length,
+        :allow_nil,
+        :on,
+        :if
+      ]
+      
+      # Validates whether the value of the specific attribute matches against the
+      # RFC822 specificiation.
+      # 
+      #   class Person < ActiveRecord::Base
+      #     validates_as_email_address :email, :on => :create
+      #   end
+      # 
+      # This will also validate that the email address is within the specification
+      # limits, specifically between 3 and 320 characters in length.
+      # 
+      # Configuration options for length:
+      # * +minimum+ - The minimum size of the attribute
+      # * +maximum+ - The maximum size of the attribute
+      # * +is+ - The exact size of the attribute
+      # * +within+ - A range specifying the minimum and maximum size of the attribute
+      # * +in+ - A synonym(or alias) for :within
+      # * +too_long+ - The error message if the attribute goes over the maximum (default is: "is too long (maximum is %d characters)")
+      # * +too_short+ - The error message if the attribute goes under the minimum (default is: "is too short (minimum is %d characters)")
+      # * +wrong_length+ - The error message if using the :is method and the attribute is the wrong size (default is: "is the wrong length (should be %d characters)")
+      # 
+      # Configuration options for format:
+      # * +wrong_format+ - A custom error message (default is: "is an invalid email address")
+      # 
+      # Configuration options for both length and format:
+      # * +allow_nil+ - Attribute may be nil; skip validation.
+      # * +on+ - Specifies when this validation is active (default is :save, other options :create, :update)
+      # * +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.
+      def validates_as_email_address(*attr_names)
+        configuration = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
+        configuration.assert_valid_keys(EMAIL_FORMAT_OPTIONS | EMAIL_LENGTH_OPTIONS)
+        configuration.reverse_merge!(
+          :wrong_format => ActiveRecord::Errors.default_error_messages[:invalid_email]
+        )
+        
+        # Add format validation
+        format_configuration = configuration.reject {|key, value| !EMAIL_FORMAT_OPTIONS.include?(key)}
+        format_configuration[:message] = format_configuration.delete(:wrong_format)
+        format_configuration[:with] = RFC822::EmailAddress
+        validates_format_of attr_names, format_configuration
+        
+        # Add length validation
+        length_configuration = configuration.reject {|key, value| !EMAIL_LENGTH_OPTIONS.include?(key)}
+        length_configuration.reverse_merge!(:within => 3..320)
+        validates_length_of attr_names, length_configuration
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend PluginAWeek::Validates::EmailAddress
+end
+
+ActiveRecord::Errors.default_error_messages.update(
+  :invalid_email => 'is an invalid email address'
+)

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require File.dirname(__FILE__) + '/../init'

data/test/validates_as_email_address_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class User < ActiveRecord::Base
+  def self.columns
+    []
+  end
+  
+  attr_accessor :email
+  validates_as_email_address :email
+end
+
+class ValidatesAsEmailAddressTest < Test::Unit::TestCase
+  def test_illegal_rfc822_email_address_should_not_be_valid
+    [
+      'Max@Job 3:14', 
+      'Job@Book of Job',
+      'J. P. \'s-Gravezande, a.k.a. The Hacker!@example.com',
+    ].each do |address|
+      assert !User.new(:email => address).valid?, "#{address} should be illegal."
+    end
+  end
+  
+  def test_legal_rfc822_email_address_should_be_valid
+    [
+      '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',
+    ].each do |address|
+      assert User.new(:email => address).valid?, "#{address} should be legal."
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: validates_as_email_address
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-09-26 00:00:00 -04:00
+summary: Adds support for validating the format/length of email addresses
+require_paths: 
+- lib
+email: info@pluginaweek.org
+homepage: http://www.pluginaweek.org
+rubyforge_project: 
+description: 
+autorequire: validates_as_email_address
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Aaron Pfeifer, Neil Abraham
+files: 
+- lib/validates_as_email_address.rb
+- test/test_helper.rb
+- test/validates_as_email_address_test.rb
+- CHANGELOG
+- init.rb
+- LICENSE
+- Rakefile
+- README
+test_files: 
+- test/validates_as_email_address_test.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+