webget-email_address_pattern_match_validation 1.0.0

data/lib/email_address_pattern_match_validation.rb

@@ -0,0 +1,78 @@
+# = EmailAddressPatternMatchValidation
+#
+# Author:: Joel Parker Henderson, joelparkerhenderson@gmail.com
+# Copyright:: Copyright (c) 2006-2008 Joel Parker Henderson
+# License:: CreativeCommons License, Non-commercial Share Alike
+# License:: LGPL, GNU Lesser General Public License
+#
+# Email address regex, to validate an email address using RFC 822.
+#
+# This is a gem wrapper around http://tfletcher.com/lib/rfc822.rb
+#
+# ==Example
+#   if EmailAddressPattern=~'foo@bar.com'
+#     puts "found" 
+#   else
+#     puts "not found"
+#   end
+#   => found
+#
+# To find an email address in a string, do the pattern match
+# then use the result, which is the match's string position:
+#
+# ==Example of match position
+#   match_position = EmailAddressPattern=~'foo@bar.com'
+#   => 0
+#
+#   match_position = EmailAddressPattern=~'... foo@bar.com ...'
+#   => 4
+#
+#   match_position = EmailAddressPattern=~'... hello world ...'
+#   => nil
+#
+# To do an exact pattern match, use the EmailAddressExactPattern.
+# This matches the entire string from start to end; in other words,
+# the entire string must be one email address.
+#
+# ==Example of exact pattern match 
+#   if EmailAddressExactPattern=~'foo@bar.com' 
+#     puts "found" 
+#   else
+#     puts "not found"
+#   end
+#   => found
+#
+#   if EmailAddressExactPattern=~'... foo@bar.com ...' 
+#     puts "found" 
+#   else
+#     puts "not found"
+#   end
+#   => not found
+#
+# The exact pattern is especialy useful to validate an email address.
+#
+# ==Example to validate an email address
+#   def valid?(email_address)
+#     EmailAddressExactPattern=~email_address ? true : false
+#   end
+##
+
+module EmailAddressPatternMatchValidation
+
+  EmailAddressQText = '[^\\x0d\\x22\\x5c\\x80-\\xff]'
+  EmailAddressDText = '[^\\x0d\\x5b-\\x5d\\x80-\\xff]'
+  EmailAddressAtom = '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+'
+  EmailAddressQuotedPair = '\\x5c[\\x00-\\x7f]'
+  EmailAddressDomainLiteral = "\\x5b(?:#{EmailAddressDText}|#{EmailAddressQuotedPair})*\\x5d"
+  EmailAddressQuotedString = "\\x22(?:#{EmailAddressQText}|#{EmailAddressQuotedPair})*\\x22"
+  EmailAddressDomainRef = EmailAddressAtom
+  EmailAddressSubDomain = "(?:#{EmailAddressDomainRef}|#{EmailAddressDomainLiteral})"
+  EmailAddressWord = "(?:#{EmailAddressAtom}|#{EmailAddressQuotedString})"
+  EmailAddressDomain = "#{EmailAddressSubDomain}(?:\\x2e#{EmailAddressSubDomain})*"
+  EmailAddressLocalPart = "#{EmailAddressWord}(?:\\x2e#{EmailAddressWord})*"
+  EmailAddressSpec = "#{EmailAddressLocalPart}\\x40#{EmailAddressDomain}"
+
+  EmailAddressPattern = /#{EmailAddressSpec}/
+  EmailAddressExactPattern = /\A#{EmailAddressSpec}\z/
+
+end

data/test/unit/email_address_pattern_match_validation_test.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'email_address_pattern_match_validation'
+
+class EmailAddressPatternMatchValidationTest < Test::Unit::TestCase
+
+ include EmailAddressPatternMatchValidation
+
+ def test_pattern_success
+  assert_equal(0,EmailAddressPattern=~'foo@bar.com')
+ end
+
+ def test_pattern_failure
+  assert_equal(nil,EmailAddressPattern=~'foo')
+ end
+
+ def test_pattern_chaff_success
+  assert_equal(4,EmailAddressPattern=~'... foo@bar.com ...')
+ end
+
+ def test_pattern_chaff_failure
+  assert_equal(nil,EmailAddressPattern=~'... foo ...')
+ end
+
+ def test_exact_pattern_success
+   assert_equal(0,EmailAddressExactPattern=~'foo@bar.com')
+ end
+
+ def test_exact_pattern_failure_due_to_left_chaff
+   assert_equal(nil,EmailAddressExactPattern=~'... foo@bar.com')
+ end
+
+ def test_exact_pattern_failure_due_to_right_chaff
+   assert_equal(nil,EmailAddressExactPattern=~'foo@bar.com ...')
+ end
+
+end
+

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+name: webget-email_address_pattern_match_validation
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- WebGet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-05 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: webget@webget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/email_address_pattern_match_validation.rb
+has_rdoc: true
+homepage: http://webget.com/
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Validate an email address using RFC 822 pattern match regex regular expressions
+test_files: 
+- test/unit/email_address_pattern_match_validation_test.rb