validates_as_email_address 0.0.1 → 0.0.2

data/CHANGELOG

@@ -1,5 +1,9 @@
 *SVN*
 
+*0.0.2* (May 5th, 2008)
+
+* Update documentation
+
 *0.0.1* (September 26th, 2007)
 
 * Add documentation

data/README

@@ -5,25 +5,21 @@ email addresses.
 
 == Resources
 
-API
-
-* http://api.pluginaweek.org/validates_as_email_address
-
 Wiki
 
 * http://wiki.pluginaweek.org/Validates_as_email_address
 
-Announcement
+API
 
-* http://www.pluginaweek.org
+* http://api.pluginaweek.org/validates_as_email_address
 
-Source
+Development
 
-* http://svn.pluginaweek.org/trunk/plugins/active_record/validations/validates_as_email_address
+* http://dev.pluginaweek.org/browser/trunk/validates_as_email_address
 
-Development
+Source
 
-* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/validations/validates_as_email_address
+* http://svn.pluginaweek.org/trunk/validates_as_email_address
 
 == Description
 
@@ -41,6 +37,11 @@ the email address.
     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]

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
 PKG_NAME           = 'validates_as_email_address'
-PKG_VERSION        = '0.0.1'
+PKG_VERSION        = '0.0.2'
 PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
 RUBY_FORGE_PROJECT = 'pluginaweek'
 
@@ -39,8 +39,8 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc        = true
   s.test_files      = Dir['test/**/*_test.rb']
   
-  s.author          = 'Aaron Pfeifer, Neil Abraham'
-  s.email           = 'info@pluginaweek.org'
+  s.author          = 'Aaron Pfeifer'
+  s.email           = 'aaron@pluginaweek.org'
   s.homepage        = 'http://www.pluginaweek.org'
 end
   
@@ -52,12 +52,12 @@ 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
+  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('pluginaweek@pluginaweek.org', "/home/pluginaweek/api.pluginaweek.org/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -69,7 +69,7 @@ task :release => [:gem, :package] do
   
   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)}..."

data/lib/validates_as_email_address.rb

@@ -1,102 +1,83 @@
-# 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
+require 'validates_as_email_address/rfc_822'
 
 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
-      ]
+  # 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]
+      )
       
-      # 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
-      ]
+      # 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
       
-      # 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
+      # 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::Validates::EmailAddress
+  extend PluginAWeek::ValidatesAsEmailAddress
 end
 
 ActiveRecord::Errors.default_error_messages.update(

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/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

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

data/test/{validates_as_email_address_test.rb → unit/validates_as_email_address_test.rb}

@@ -1,16 +1,7 @@
-require File.dirname(__FILE__) + '/test_helper'
-
-class User < ActiveRecord::Base
-  def self.columns
-    []
-  end
-  
-  attr_accessor :email
-  validates_as_email_address :email
-end
+require File.dirname(__FILE__) + '/../test_helper'
 
 class ValidatesAsEmailAddressTest < Test::Unit::TestCase
-  def test_illegal_rfc822_email_address_should_not_be_valid
+  def test_should_require_legal_rfc822_format
     [
       'Max@Job 3:14', 
       'Job@Book of Job',
@@ -18,9 +9,7 @@ class ValidatesAsEmailAddressTest < Test::Unit::TestCase
     ].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', 
@@ -32,4 +21,9 @@ class ValidatesAsEmailAddressTest < Test::Unit::TestCase
       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

@@ -1,53 +1,72 @@
 --- !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: 
+  version: 0.0.2
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
-- Aaron Pfeifer, Neil Abraham
+- Aaron Pfeifer
+autorequire: validates_as_email_address
+bindir: bin
+cert_chain: []
+
+date: 2008-05-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: aaron@pluginaweek.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - lib/validates_as_email_address.rb
+- lib/validates_as_email_address
+- lib/validates_as_email_address/rfc_822.rb
+- test/app_root
+- test/app_root/log
+- test/app_root/log/in_memory.log
+- test/app_root/db
+- test/app_root/db/migrate
+- test/app_root/db/migrate/001_create_users.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/user.rb
 - test/test_helper.rb
-- test/validates_as_email_address_test.rb
+- test/unit
+- test/unit/validates_as_email_address_test.rb
 - CHANGELOG
 - init.rb
 - LICENSE
 - Rakefile
 - README
-test_files: 
-- test/validates_as_email_address_test.rb
+has_rdoc: true
+homepage: http://www.pluginaweek.org
+post_install_message: 
 rdoc_options: []
 
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+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: []
 
-dependencies: []
-
+rubyforge_project: 
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: Adds support for validating the format/length of email addresses
+test_files: 
+- test/unit/validates_as_email_address_test.rb