active-model-email-validator 1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+doc

data/.yardopts

@@ -0,0 +1 @@
+--charset UTF-8 --markup markdown lib/**/*.rb - LICENSE

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License
+===============
+
+© 2011 Cody Robbins
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,51 @@
+Active Model Email Validator
+============================
+
+This is a simple ActiveModel validator for email addresses built on top of the [Mail gem](http://rubygems.org/gems/mail). Instead of trying to devise an overly complex custom (and probably incorrect) regular expression to validate email addresses that is compliant with RFC 5321/5322—a difficult task—it instead relies on the Mail gem to parse the address. Since the Mail gem is an actively maintained library for working with email, if it can’t deal with an address it’s probably not worth attempting to send to anyways.
+
+An additional check is performed to ensure that the domain name in the address has at least two components—that is, a top-level domain and one subdomain. The validator purposefully errs on the side of inclusivity rather than exclusivity: it might allow some invalid email addresses, but it hopefully doesn’t disallow valid addresses.
+
+Full documentation is at [RubyDoc.info](http://rubydoc.info/gems/active-model-email-validator).
+
+Example
+-------
+
+The following model uses `ActiveModel::Validations::PresenceValidator` and `ActiveRecord::Validations::UniquenessValidator` to ensure the presence and uniqueness of the user’s email attribute. The third line uses `EmailValidator` to check that the email address is valid.
+
+    class User < ActiveRecord::Base
+      validates(:email,
+                :presence   => {:message => "Email can't be blank"},
+                :uniqueness => {:message => 'Email must be unique'},
+                :email      => {:message => 'Email must be valid'})
+    end
+
+Note
+----
+
+Currently there isn’t a `validates_email` class-level helper method because I’ve never had the need for it in practice, but I may add one at some point.
+
+Colophon
+--------
+
+### See also
+
+If you like this gem, you may also want to check out [Static Model](http://codyrobbins.com/software/static-model), [Declarative Find](http://codyrobbins.com/software/declarative-find), [Create New](http://codyrobbins.com/software/create-new), [Save Changes To](http://codyrobbins.com/software/save-changes-to), and [HTTP Error](http://codyrobbins.com/software/http-error).
+
+### Tested with
+
+* ActiveModel 3.0.5 — 20 May 2011
+
+### Contributing
+
+* [Source](https://github.com/codyrobbins/active-model-email-validator)
+* [Bug reports](https://github.com/codyrobbins/active-model-email-validator/issues)
+
+To send patches, please fork on GitHub and submit a pull request.
+
+### Credits
+
+© 2011 [Cody Robbins](http://codyrobbins.com/). See LICENSE for details.
+
+* [Homepage](http://codyrobbins.com/software/active-model-email-validator)
+* [My other gems](http://codyrobbins.com/software#gems)
+* [Follow me on Twitter](http://twitter.com/codyrobbins)

data/active-model-email-validator.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name     = 'active-model-email-validator'
+  s.version  = '1.0'
+  s.summary  = 'An ActiveModel email validator based on the Mail gem.'
+  s.homepage = 'http://codyrobbins.com/software/active-model-email-validator'
+  s.author   = 'Cody Robbins'
+  s.email    = 'cody@codyrobbins.com'
+
+  s.post_install_message = '
+-------------------------------------------------------------
+Follow me on Twitter! http://twitter.com/codyrobbins
+-------------------------------------------------------------
+
+'
+
+  s.files = `git ls-files`.split
+
+  s.add_dependency('activemodel')
+  s.add_dependency('mail')
+end

data/lib/active-model-email-validator.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+
+# This is a simple ActiveModel validator for email addresses built on top of the [Mail gem](http://rubygems.org/gems/mail). Instead of trying to devise an overly complex custom (and probably incorrect) regular expression to validate email addresses that is compliant with RFC 5321/5322—a difficult task—it instead relies on the Mail gem to parse the address. Since the Mail gem is an actively maintained library for working with email, if it can’t deal with an address it’s probably not worth attempting to send to anyways.
+#
+# An additional check is performed to ensure that the domain name in the address has at least two components—that is, a top-level domain and one subdomain. The validator purposefully errs on the side of inclusivity rather than exclusivity: it might allow some invalid email addresses, but it hopefully doesn’t disallow valid addresses.
+#
+# Example
+# -------
+#
+# The following model uses `ActiveModel::Validations::PresenceValidator` and `ActiveRecord::Validations::UniquenessValidator` to ensure the presence and uniqueness of the user’s email attribute. The third line uses `EmailValidator` to check that the email address is valid.
+#
+#     class User < ActiveRecord::Base
+#       validates(:email,
+#                 :presence   => {:message => "Email can't be blank"},
+#                 :uniqueness => {:message => 'Email must be unique'},
+#                 :email      => {:message => 'Email must be valid'})
+#     end
+class EmailValidator < ActiveModel::EachValidator
+  # The interface that `ActiveModel::Validations` uses to invoke the validation. This method is not called directly.
+  def validate_each(object, attribute, value)
+    add_error_to(object, attribute) unless valid?(value)
+  end
+
+  protected
+
+  def valid?(value)
+    # Allow blank values to pass through.
+    return(true) if value.blank?
+
+    # Disallow unparseable addresses.
+    begin
+      parse_address(value)
+    rescue unparseable_address
+      return(false)
+    end
+
+    # Make sure the domain in the address is reasonable.
+    domain_present? && domain_has_more_than_one_component?
+  end
+
+  def add_error_to(object, attribute)
+    object.errors[attribute] << error_message
+  end
+
+  def error_message
+    options[:message] || 'is not a valid email'
+  end
+
+  def parse_address(value)
+    @address = Mail::Address.new(value)
+  end
+
+  def unparseable_address
+    Mail::Field::ParseError
+  end
+
+  def domain_present?
+    @address.domain.present?
+  end
+
+  def domain_has_more_than_one_component?
+    @address.send(:tree).domain.dot_atom_text.elements.size > 1
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: active-model-email-validator
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.0"
+platform: ruby
+authors: 
+- Cody Robbins
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: cody@codyrobbins.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .yardopts
+- LICENSE
+- README.markdown
+- active-model-email-validator.gemspec
+- lib/active-model-email-validator.rb
+has_rdoc: true
+homepage: http://codyrobbins.com/software/active-model-email-validator
+licenses: []
+
+post_install_message: "\n\
+  -------------------------------------------------------------\n\
+  Follow me on Twitter! http://twitter.com/codyrobbins\n\
+  -------------------------------------------------------------\n\n"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An ActiveModel email validator based on the Mail gem.
+test_files: []
+