pager-validates_as_email_address 1.0.20080507

data/CHANGELOG

@@ -0,0 +1,9 @@
+*SVN*
+
+*0.0.2* (May 5th, 2008)
+
+* Update documentation
+
+*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,51 @@
+= validates_as_email_address
+
++validates_as_email_address+ adds support for validating the format/length of
+email addresses.
+
+== Resources
+
+Wiki
+
+* http://wiki.pluginaweek.org/Validates_as_email_address
+
+API
+
+* http://api.pluginaweek.org/validates_as_email_address
+
+Development
+
+* http://dev.pluginaweek.org/browser/trunk/validates_as_email_address
+
+Source
+
+* http://svn.pluginaweek.org/trunk/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
+
+== Testing
+
+Before you can run any tests, the following gem must be installed:
+* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+
+== 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.2'
+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'
+  s.email           = 'aaron@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('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+end
+
+desc 'Publish the API documentation'
+task :pdoc => [:rdoc] do
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+end
+
+desc 'Publish the API docs and gem'
+task :publish => [:pgem, :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/lib/validates_as_email_address.rb

@@ -0,0 +1,85 @@
+require 'validates_as_email_address/rfc_822'
+
+module PluginAWeek #:nodoc:
+  # Adds validations for email addresses
+  module ValidatesAsEmailAddress
+    # 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
+
+ActiveRecord::Base.class_eval do
+  extend PluginAWeek::ValidatesAsEmailAddress
+end
+
+ActiveRecord::Errors.default_error_messages.update(
+  :invalid_email => 'is an invalid email address'
+)

data/lib/validates_as_email_address/rfc_822.rb

@@ -0,0 +1,18 @@
+# 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

data/rails/init.rb

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

data/test/app_root/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  validates_as_email_address :email
+end

data/test/app_root/db/migrate/001_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :email, :null => false, :limit => 320
+    end
+  end
+  
+  def self.down
+    drop_table :users
+  end
+end

data/test/app_root/log/in_memory.log

@@ -0,0 +1,39 @@
+# Logfile created on Sun Apr 06 00:59:11 -0400 2008  SQL (0.000430)   select sqlite_version(*)
+  SQL (0.000442)   CREATE TABLE "schema_info" (version varchar(255))
+  SQL (0.000121)   INSERT INTO "schema_info" (version) VALUES(0)
+  SQL (0.000224)   SELECT version FROM schema_info
+Migrating to CreateUsers (1)
+  SQL (0.000223)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.000428)   select sqlite_version(*)
+  SQL (0.000429)   CREATE TABLE "schema_info" (version varchar(255))
+  SQL (0.000115)   INSERT INTO "schema_info" (version) VALUES(0)
+  SQL (0.000221)   SELECT version FROM schema_info
+Migrating to CreateUsers (1)
+  SQL (0.000359)   CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(320) NOT NULL) 
+  SQL (0.000106)   UPDATE schema_info SET version = 1
+  SQL (0.000431)   select sqlite_version(*)
+  SQL (0.000426)   CREATE TABLE "schema_info" (version varchar(255))
+  SQL (0.000114)   INSERT INTO "schema_info" (version) VALUES(0)
+  SQL (0.000224)   SELECT version FROM schema_info
+Migrating to CreateUsers (1)
+  SQL (0.000352)   CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(320) NOT NULL) 
+  SQL (0.000105)   UPDATE schema_info SET version = 1
+  SQL (0.000460)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.000260)   select sqlite_version(*)
+  SQL (0.000324)   CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+  SQL (0.000255)   CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+  SQL (0.000211)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.000150)   SELECT version FROM schema_migrations
+Migrating to CreateUsers (1)
+  SQL (0.000093)   SELECT version FROM schema_migrations
+  SQL (0.000361)   CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "email" varchar(320) NOT NULL) 
+  SQL (0.000151)   INSERT INTO schema_migrations (version) VALUES ('1')

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")

data/test/unit/validates_as_email_address_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ValidatesAsEmailAddressTest < Test::Unit::TestCase
+  def test_should_require_legal_rfc822_format
+    [
+      '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
+    
+    [
+      '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
+  
+  def test_not_allow_email_addresses_longer_than_320_characters
+    assert User.new(:email => 'a' * 314 + '@a.com').valid?
+    assert !User.new(:email => 'a' * 315 + '@a.com').valid?
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: pager-validates_as_email_address
+version: !ruby/object:Gem::Version 
+  version: 1.0.20080507
+platform: ruby
+authors: 
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-07 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: avanie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- CHANGELOG
+- LICENSE
+files: 
+- CHANGELOG
+- lib/validates_as_email_address/rfc_822.rb
+- lib/validates_as_email_address.rb
+- LICENSE
+- rails/init.rb
+- Rakefile
+- README
+- test/app_root/app/models/user.rb
+- test/app_root/db/migrate/001_create_users.rb
+- test/app_root/log/in_memory.log
+- test/test_helper.rb
+- test/unit/validates_as_email_address_test.rb
+has_rdoc: true
+homepage: http://github.com/pager/validates_as_email_address
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Gemified validates_as_email_address plugin
+test_files: 
+- test/app_root/app/models/user.rb
+- test/app_root/db/migrate/001_create_users.rb
+- test/app_root/log/in_memory.log
+- test/test_helper.rb
+- test/unit/validates_as_email_address_test.rb