validates_as_email_address 0.1.1 → 0.2.0

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 == master
 
+== 0.2.0 / 2008-12-14
+
+* Remove the PluginAWeek namespace
+
 == 0.1.1 / 2008-10-25
 
 * Fix major performance hit on long domains when in strict mode

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'validates_as_email_address'
-  s.version           = '0.1.1'
+  s.version           = '0.2.0'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds support for validating the format/length of email addresses'
   

data/lib/validates_as_email_address.rb

@@ -1,62 +1,60 @@
 require 'validates_as_email_address/rfc_822'
 require 'validates_as_email_address/rfc_1035'
 
-module PluginAWeek #:nodoc:
-  # Adds validations for email addresses
-  module ValidatesAsEmailAddress
-    # Validates whether the value of the specific attribute matches against the
-    # RFC822/RFC1035 specification.
-    # 
-    #   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, i.e. 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")
-    # 
-    # Miscellaneous configuration options:
-    # * +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 => lambda { |user| user.signup_step > 2 }).  The
-    # method, proc or string should return or evaluate to a true or false value.
-    # * +strict+ - Specifies if the domain part of the email should be compliant to RFC 1035 (default is true). If set to false domains such as '-online.com', '[127.0.0.1]' become valid.
-    def validates_as_email_address(*attr_names)
-      configuration = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
-      configuration.reverse_merge!(
-        :wrong_format => ActiveRecord::Errors.default_error_messages[:invalid_email],
-        :strict => true
-      )
-      
-      # Add format validation
-      format_configuration = configuration.dup
-      format_configuration[:message] = configuration.delete(:wrong_format)
-      format_configuration[:with] = configuration[:strict] ? RFC1035::EmailAddress : RFC822::EmailAddress
-      validates_format_of attr_names, format_configuration
-      
-      # Add length validation
-      length_configuration = configuration.dup
-      length_configuration.reverse_merge!(:within => 3..320) unless ([:minimum, :maximum, :is, :within, :in] & configuration.keys).any?
-      validates_length_of attr_names, length_configuration
-    end
+# Adds validations for email addresses
+module ValidatesAsEmailAddress
+  # Validates whether the value of the specific attribute matches against the
+  # RFC822/RFC1035 specification.
+  # 
+  #   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, i.e. 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")
+  # 
+  # Miscellaneous configuration options:
+  # * +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 => lambda { |user| user.signup_step > 2 }).  The
+  # method, proc or string should return or evaluate to a true or false value.
+  # * +strict+ - Specifies if the domain part of the email should be compliant to RFC 1035 (default is true). If set to false domains such as '-online.com', '[127.0.0.1]' become valid.
+  def validates_as_email_address(*attr_names)
+    configuration = attr_names.last.is_a?(Hash) ? attr_names.pop : {}
+    configuration.reverse_merge!(
+      :wrong_format => ActiveRecord::Errors.default_error_messages[:invalid_email],
+      :strict => true
+    )
+    
+    # Add format validation
+    format_configuration = configuration.dup
+    format_configuration[:message] = configuration.delete(:wrong_format)
+    format_configuration[:with] = configuration[:strict] ? RFC1035::EmailAddress : RFC822::EmailAddress
+    validates_format_of attr_names, format_configuration
+    
+    # Add length validation
+    length_configuration = configuration.dup
+    length_configuration.reverse_merge!(:within => 3..320) unless ([:minimum, :maximum, :is, :within, :in] & configuration.keys).any?
+    validates_length_of attr_names, length_configuration
   end
 end
 
 ActiveRecord::Base.class_eval do
-  extend PluginAWeek::ValidatesAsEmailAddress
+  extend ValidatesAsEmailAddress
 end
 
 # Add error messages specific to this validation

data/lib/validates_as_email_address/rfc_1035.rb

@@ -1,29 +1,27 @@
-module PluginAWeek #:nodoc:
-  module ValidatesAsEmailAddress
-    # The standard describing the format of domains
-    module RFC1035
-      # Matches domain according to the RFC 1035 standard, with the exception
-      # that domains can start with a letter *or* digit
-      Domain = begin
-        digit = "[\\d]"
-        letter = "[\\x61-\\x7a\\x41-\\x5a]"
-        let_dig = "(?:#{letter}|#{digit})"
-        let_dig_hyp = "(?:#{let_dig}|[\\x2d])"
-        label = "#{let_dig}(?:#{let_dig_hyp}*#{let_dig})?"
-        subdomain = "(?:#{label}\\.)*#{label}"
-        domain = "(?:#{subdomain}|\\x20)"
-        
-        /#{domain}/
-      end
+module ValidatesAsEmailAddress
+  # The standard describing the format of domains
+  module RFC1035
+    # Matches domain according to the RFC 1035 standard, with the exception
+    # that domains can start with a letter *or* digit
+    Domain = begin
+      digit = "[\\d]"
+      letter = "[\\x61-\\x7a\\x41-\\x5a]"
+      let_dig = "(?:#{letter}|#{digit})"
+      let_dig_hyp = "(?:#{let_dig}|[\\x2d])"
+      label = "#{let_dig}(?:#{let_dig_hyp}*#{let_dig})?"
+      subdomain = "(?:#{label}\\.)*#{label}"
+      domain = "(?:#{subdomain}|\\x20)"
       
-      # Matches email addresses with domains that follow the RFC 1035 standard
-      EmailAddress = begin
-        local_part = RFC822::LocalPart.source
-        domain = Domain.source
-        addr_spec = "(#{local_part})\\x40(#{domain})"
-        
-        /\A#{addr_spec}\z/
-      end
+      /#{domain}/
+    end
+    
+    # Matches email addresses with domains that follow the RFC 1035 standard
+    EmailAddress = begin
+      local_part = RFC822::LocalPart.source
+      domain = Domain.source
+      addr_spec = "(#{local_part})\\x40(#{domain})"
+      
+      /\A#{addr_spec}\z/
     end
   end
 end

data/lib/validates_as_email_address/rfc_822.rb

@@ -1,37 +1,35 @@
-module PluginAWeek #:nodoc:
-  module ValidatesAsEmailAddress
-    # The standard describing the format of email addresses
-    module RFC822
-      # Matches the two parts of an email address (before/after @)
-      LocalPart, Domain = begin
-        # Shared
-        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"
-        
-        # Local part
-        word = "(?:#{atom}|#{quoted_string})"
-        local_part = "#{word}(?:\\x2e#{word})*"
-        
-        # Domain
-        domain_ref = atom
-        sub_domain = "(?:#{domain_ref}|#{domain_literal})"
-        domain = "#{sub_domain}(?:\\x2e#{sub_domain})*"
-        
-        [/#{local_part}/, /#{domain}/]
-      end
+module ValidatesAsEmailAddress
+  # The standard describing the format of email addresses
+  module RFC822
+    # Matches the two parts of an email address (before/after @)
+    LocalPart, Domain = begin
+      # Shared
+      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"
       
-      # Matches email addresses according to the RFC822 standard
-      EmailAddress = begin
-        local_part = LocalPart.source
-        domain = Domain.source
-        addr_spec = "(#{local_part})\\x40(#{domain})"
-        
-        /\A#{addr_spec}\z/
-      end
+      # Local part
+      word = "(?:#{atom}|#{quoted_string})"
+      local_part = "#{word}(?:\\x2e#{word})*"
+      
+      # Domain
+      domain_ref = atom
+      sub_domain = "(?:#{domain_ref}|#{domain_literal})"
+      domain = "#{sub_domain}(?:\\x2e#{sub_domain})*"
+      
+      [/#{local_part}/, /#{domain}/]
+    end
+    
+    # Matches email addresses according to the RFC822 standard
+    EmailAddress = begin
+      local_part = LocalPart.source
+      domain = Domain.source
+      addr_spec = "(#{local_part})\\x40(#{domain})"
+      
+      /\A#{addr_spec}\z/
     end
   end
 end

data/test/unit/validates_as_email_address_test.rb

@@ -8,7 +8,7 @@ class ValidatesAsEmailAddressByDefaultTest < Test::Unit::TestCase
   def test_should_not_allow_email_addresses_shorter_than_3_characters
     user = new_user(:email => 'a@')
     assert !user.valid?
-    assert_equal 2, Array(user.errors.on(:email)).size
+    assert user.errors.invalid?(:email)
     
     user.email = 'a@a'
     assert user.valid?
@@ -20,7 +20,7 @@ class ValidatesAsEmailAddressByDefaultTest < Test::Unit::TestCase
     
     user.email += 'a'
     assert !user.valid?
-    assert_equal 1, Array(user.errors.on(:email)).size
+    assert user.errors.invalid?(:email)
   end
   
   def test_should_allow_legal_rfc822_formats
@@ -44,7 +44,7 @@ class ValidatesAsEmailAddressByDefaultTest < Test::Unit::TestCase
     ].each do |address|
       user = new_user(:email => address)
       assert !user.valid?, "#{address} should be illegal."
-      assert_equal 1, Array(user.errors.on(:email)).size
+      assert user.errors.invalid?(:email)
     end
   end
   
@@ -101,7 +101,7 @@ class ValidatesAsEmailAddressTest < Test::Unit::TestCase
     
     user = new_user(:email => 'a@')
     assert !user.valid?
-    assert_equal 1, Array(user.errors.on(:email)).size
+    assert user.errors.invalid?(:email)
   end
   
   def test_should_allow_exact_length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: validates_as_email_address
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-26 00:00:00 -04:00
+date: 2008-12-14 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -23,20 +23,20 @@ extra_rdoc_files: []
 
 files: 
 - lib/validates_as_email_address
-- lib/validates_as_email_address/rfc_1035.rb
 - lib/validates_as_email_address/rfc_822.rb
+- lib/validates_as_email_address/rfc_1035.rb
 - lib/validates_as_email_address.rb
+- test/factory.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/validates_as_email_address_test.rb
 - test/app_root
-- test/app_root/app
-- test/app_root/app/models
-- test/app_root/app/models/user.rb
 - test/app_root/db
 - test/app_root/db/migrate
 - test/app_root/db/migrate/001_create_users.rb
-- test/test_helper.rb
-- test/factory.rb
-- test/unit
-- test/unit/validates_as_email_address_test.rb
+- test/app_root/app
+- test/app_root/app/models
+- test/app_root/app/models/user.rb
 - CHANGELOG.rdoc
 - init.rb
 - LICENSE