sixarm_ruby_email_address_validation 1.2.4 → 2.0.0

data/README.md

@@ -0,0 +1,147 @@
+# SixArm.com » Ruby » <br> Email address validation using RFC 822 pattern matching
+
+* Docs: <http://sixarm.com/sixarm_ruby_email_address_validation/doc>
+* Repo: <http://github.com/sixarm/sixarm_ruby_email_address_validation>
+* Email: Joel Parker Henderson, <joel@sixarm.com>
+
+
+## Introduction
+
+Email address regular expression to validate an email address using RFC 822.
+
+This is a gem wrapper around http://tfletcher.com/lib/rfc822.rb
+
+For docs go to <http://sixarm.com/sixarm_ruby_email_address_validation/doc>
+
+Want to help? We're happy to get pull requests.
+
+
+## Quickstart
+
+Install:
+
+    gem install sixarm_ruby_email_address_validation
+
+Bundler:
+
+    gem "sixarm_ruby_email_address_validation", "=1.3.0"
+
+Require:
+
+    require "sixarm_ruby_email_address_validation"
+
+
+## High Security (Optional)
+
+To enable high security for all our gems:
+
+    wget http://sixarm.com/sixarm.pem
+    gem cert --add sixarm.pem
+    gem sources --add http://sixarm.com
+
+To install with high security:
+
+    gem install sixarm_ruby_email_address_validation --test --trust-policy HighSecurity
+
+
+## Example
+
+    if EmailAddressValidation::Pattern=~"foo@bar.com"
+      puts "present" 
+    else
+      puts "absent"
+    end
+    => "found"
+
+
+## Pattern Match
+
+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 = EmailAddressValidation::Pattern=~'foo@bar.com'
+    => 0
+
+    match_position = EmailAddressValidation::Pattern=~'... foo@bar.com ...'
+    => 4
+
+    match_position = EmailAddressValidation::Pattern=~'... hello world ...'
+    => nil
+
+
+## Pattern Match Exact
+
+To do a pattern match to the entire string, use the EmailAddressValidation::PatternExact.
+
+The entire string must be one email address.
+
+Example of pattern match:
+
+    if EmailAddressValidation::PatternExact=~'foo@bar.com' 
+      puts "present" 
+    else
+      puts "absent"
+    end
+    => found
+
+    if EmailAddressValidation::PatternExact=~'... foo@bar.com ...' 
+      puts "present" 
+    else
+      puts "absent"
+    end
+    => absent
+
+This pattern is especialy useful to validate an email address.
+
+Example to validate an email address:
+
+    def valid?(email_address)
+      EmailAddressValidation::PatternExact=~email_address ? true : false
+    end
+
+
+## Rails Validation
+
+To add email address validation to a typical Ruby On Rails model:
+
+    class User
+      include EmailAddressValidation
+      validates :email_address, :format => { :with => EmailAddressValidation::PatternExact }
+    end
+
+
+## Changes
+
+* 2012-03-17 2.0.0 Upgrade for Ruby 1.9.3, minitest/spec, improved docs, new API.
+* 2011-04-24 1.2.2 Upgrade for Ruby 1.9.2 and Rails 3.0.6
+
+
+## License
+
+You may choose any of these open source licenses:
+
+  * Apache License
+  * BSD License
+  * CreativeCommons License, Non-commercial Share Alike
+  * GNU General Public License Version 2 (GPL 2)
+  * GNU Lesser General Public License (LGPL)
+  * MIT License
+  * Perl Artistic License
+  * Ruby License
+
+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.
+
+This license is for the included software that is created by SixArm;
+some of the included software may have its own licenses, copyrights, 
+authors, etc. and these do take precedence over the SixArm license.
+
+Copyright (c) 2005-2013 Joel Parker Henderson

data/lib/sixarm_ruby_email_address_validation.rb

@@ -1,24 +1,24 @@
 # -*- coding: utf-8 -*-
 =begin rdoc
-Please see README.rdoc
+Please see README
 =end
 
 
-module EmailAddressValidation
+class EmailAddressValidation
 
-  EMAIL_ADDRESS_QTEXT           = Regexp.new '[^\\x0d\\x22\\x5c\\x80-\\xff]', nil, 'n'
-  EMAIL_ADDRESS_DTEXT           = Regexp.new '[^\\x0d\\x5b-\\x5d\\x80-\\xff]', nil, 'n'
-  EMAIL_ADDRESS_ATOM            = Regexp.new '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+', nil, 'n'
-  EMAIL_ADDRESS_QUOTED_PAIR     = Regexp.new '\\x5c[\\x00-\\x7f]', nil, 'n'
-  EMAIL_ADDRESS_DOMAIN_LITERAL  = Regexp.new "\\x5b(?:#{EMAIL_ADDRESS_DTEXT}|#{EMAIL_ADDRESS_QUOTED_PAIR})*\\x5d", nil, 'n'
-  EMAIL_ADDRESS_QUOTED_STRING   = Regexp.new "\\x22(?:#{EMAIL_ADDRESS_QTEXT}|#{EMAIL_ADDRESS_QUOTED_PAIR})*\\x22", nil, 'n'
-  EMAIL_ADDRESS_DOMAIN_REF      = EMAIL_ADDRESS_ATOM
-  EMAIL_ADDRESS_SUB_DOMAIN      = "(?:#{EMAIL_ADDRESS_DOMAIN_REF}|#{EMAIL_ADDRESS_DOMAIN_LITERAL})"
-  EMAIL_ADDRESS_WORD            = "(?:#{EMAIL_ADDRESS_ATOM}|#{EMAIL_ADDRESS_QUOTED_STRING})"
-  EMAIL_ADDRESS_DOMAIN          = "#{EMAIL_ADDRESS_SUB_DOMAIN}(?:\\x2e#{EMAIL_ADDRESS_SUB_DOMAIN})*"
-  EMAIL_ADDRESS_LOCAL_PART      = "#{EMAIL_ADDRESS_WORD}(?:\\x2e#{EMAIL_ADDRESS_WORD})*"
-  EMAIL_ADDRESS_SPEC            = "#{EMAIL_ADDRESS_LOCAL_PART}\\x40#{EMAIL_ADDRESS_DOMAIN}"
-  EMAIL_ADDRESS_INNER_PATTERN   = Regexp.new "#{EMAIL_ADDRESS_SPEC}", nil, 'n'
-  EMAIL_ADDRESS_EXACT_PATTERN   = Regexp.new "\\A#{EMAIL_ADDRESS_SPEC}\\z", nil, 'n'
+  QuotedText      = Regexp.new '[^\\x0d\\x22\\x5c\\x80-\\xff]', nil, 'n'
+  DomainText      = Regexp.new '[^\\x0d\\x5b-\\x5d\\x80-\\xff]', nil, 'n'
+  Atom            = Regexp.new '[^\\x00-\\x20\\x22\\x28\\x29\\x2c\\x2e\\x3a-\\x3c\\x3e\\x40\\x5b-\\x5d\\x7f-\\xff]+', nil, 'n'
+  QuotedPair      = Regexp.new '\\x5c[\\x00-\\x7f]', nil, 'n'
+  DomainLiteral   = Regexp.new "\\x5b(?:#{QuotedText}|#{QuotedPair})*\\x5d", nil, 'n'
+  QuotedString    = Regexp.new "\\x22(?:#{QuotedText}|#{QuotedPair})*\\x22", nil, 'n'
+  DomainRef       = Atom
+  SubDomain       = "(?:#{DomainRef}|#{DomainLiteral})"
+  Word            = "(?:#{Atom}|#{QuotedString})"
+  Domain          = "#{SubDomain}(?:\\x2e#{SubDomain})*"
+  LocalPart       = "#{Word}(?:\\x2e#{Word})*"
+  Spec            = "#{LocalPart}\\x40#{Domain}"
+  Pattern         = Regexp.new "#{Spec}", nil, 'n'
+  PatternExact    = Regexp.new "\\A#{Spec}\\z", nil, 'n'
 
 end

data/test/sixarm_ruby_email_address_validation_test.rb

@@ -1,40 +1,62 @@
 # -*- coding: utf-8 -*-
-require 'test/unit'
-require 'sixarm_ruby_email_address_validation'
+require 'minitest/autorun'
 require 'simplecov'
 SimpleCov.start
+require 'sixarm_ruby_email_address_validation'
+
+describe EmailAddressValidation do
+
+  describe "pattern" do
+
+    describe "with typical" do
+
+      it "success" do
+        (EmailAddressValidation::Pattern=~'foo@bar.com').must_equal 0
+      end
+
+      it "failure" do
+        (EmailAddressValidation::Pattern=~'foo').must_equal nil
+      end
+
+      describe "with chaff" do
+
+        it "success" do
+          (EmailAddressValidation::Pattern=~'... foo@bar.com ...').must_equal 4
+        end
+
+        it "failure" do
+          (EmailAddressValidation::Pattern=~'... foo ...').must_equal nil
+        end
+
+      end
+
+    end
 
-class Testing < Test::Unit::TestCase
+  end
 
- include EmailAddressValidation
+  describe "pattern exact" do
 
- def test_inner_pattern_success
-  assert_equal(0,EMAIL_ADDRESS_INNER_PATTERN=~'foo@bar.com')
- end
+    describe "with typical" do
 
- def test_inner_pattern_failure
-  assert_equal(nil,EMAIL_ADDRESS_INNER_PATTERN=~'foo')
- end
+      it "success" do
+        (EmailAddressValidation::PatternExact=~'foo@bar.com').must_equal 0
+      end
 
- def test_inner_pattern_chaff_success
-  assert_equal(4,EMAIL_ADDRESS_INNER_PATTERN=~'... foo@bar.com ...')
- end
+    end
 
- def test_inner_pattern_chaff_failure
-  assert_equal(nil,EMAIL_ADDRESS_INNER_PATTERN=~'... foo ...')
- end
+    describe "with chaff" do
 
- def test_exact_pattern_success
-   assert_equal(0,EMAIL_ADDRESS_EXACT_PATTERN=~'foo@bar.com')
- end
+      it "failure due to left chaff" do
+        (EmailAddressValidation::PatternExact=~'... foo@bar.com').must_equal nil
+      end
 
- def test_exact_pattern_failure_due_to_left_chaff
-   assert_equal(nil,EMAIL_ADDRESS_EXACT_PATTERN=~'... foo@bar.com')
- end
+      it "failure due to right chaff" do
+        (EmailAddressValidation::PatternExact=~'foo@bar.com ...').must_equal nil
+      end
 
- def test_exact_pattern_failure_due_to_right_chaff
-   assert_equal(nil,EMAIL_ADDRESS_EXACT_PATTERN=~'foo@bar.com ...')
- end
+    end
 
+  end
+  
 end
 

metadata

@@ -1,84 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sixarm_ruby_email_address_validation
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  version: 1.2.4
 platform: ruby
-authors: 
+authors:
 - SixArm
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDBDCCAm2gAwIBAgIJAKPwEETU5bHoMA0GCSqGSIb3DQEBBQUAMGAxCzAJBgNV
-  BAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMRYwFAYDVQQHEw1TYW4gRnJhbmNp
-  c2NvMQ8wDQYDVQQKEwZTaXhBcm0xEzARBgNVBAMTCnNpeGFybS5jb20wHhcNMTAx
-  MjEzMjMyNzEzWhcNMTMwOTA4MjMyNzEzWjBgMQswCQYDVQQGEwJVUzETMBEGA1UE
-  CBMKQ2FsaWZvcm5pYTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEPMA0GA1UEChMG
-  U2l4QXJtMRMwEQYDVQQDEwpzaXhhcm0uY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GN
-  ADCBiQKBgQC94mD9JDwBsunsOI0VR3CXXbOWg9cWaWciwFyJNFiM7A9I8KPLfXUw
-  QC4czUe5ZuG4WHvinrWhkrCK+1dWBqoEClxdF/FoKO5a+tonGCjjmfy81JmFjjyx
-  eTsjsHyvw+Qik9kpf9aj6+pnkNrVswgNHVea2o9yabbEiS6VSeJWoQIDAQABo4HF
-  MIHCMB0GA1UdDgQWBBQzPJtqmSgc53eDN7aSzDQwr9TALDCBkgYDVR0jBIGKMIGH
-  gBQzPJtqmSgc53eDN7aSzDQwr9TALKFkpGIwYDELMAkGA1UEBhMCVVMxEzARBgNV
-  BAgTCkNhbGlmb3JuaWExFjAUBgNVBAcTDVNhbiBGcmFuY2lzY28xDzANBgNVBAoT
-  BlNpeEFybTETMBEGA1UEAxMKc2l4YXJtLmNvbYIJAKPwEETU5bHoMAwGA1UdEwQF
-  MAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAooEexP/oPam1TP71SyuhxMb+uTrZbSQe
-  jVB+ExRwWadGwaNPUA56d39qwavwP+iu+3JpeonNMVvbWXF5naCX/dNFIeREHzER
-  ZDRQYMqru9TEMna6HD9zpcstF7vwThGovlOQ+3Y6plQ4nMzipXcZ9THqs65PIL0q
-  eabwpCbAopo=
-  -----END CERTIFICATE-----
-
-date: 2011-07-08 00:00:00 -07:00
-default_executable: 
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURCRENDQW0yZ0F3SUJB
+  Z0lKQUtQd0VFVFU1YkhvTUEwR0NTcUdTSWIzRFFFQkJRVUFNR0F4Q3pBSkJn
+  TlYKQkFZVEFsVlRNUk13RVFZRFZRUUlFd3BEWVd4cFptOXlibWxoTVJZd0ZB
+  WURWUVFIRXcxVFlXNGdSbkpoYm1OcApjMk52TVE4d0RRWURWUVFLRXdaVGFY
+  aEJjbTB4RXpBUkJnTlZCQU1UQ25OcGVHRnliUzVqYjIwd0hoY05NVEF4Ck1q
+  RXpNak15TnpFeldoY05NVE13T1RBNE1qTXlOekV6V2pCZ01Rc3dDUVlEVlFR
+  R0V3SlZVekVUTUJFR0ExVUUKQ0JNS1EyRnNhV1p2Y201cFlURVdNQlFHQTFV
+  RUJ4TU5VMkZ1SUVaeVlXNWphWE5qYnpFUE1BMEdBMVVFQ2hNRwpVMmw0UVhK
+  dE1STXdFUVlEVlFRREV3cHphWGhoY20wdVkyOXRNSUdmTUEwR0NTcUdTSWIz
+  RFFFQkFRVUFBNEdOCkFEQ0JpUUtCZ1FDOTRtRDlKRHdCc3Vuc09JMFZSM0NY
+  WGJPV2c5Y1dhV2Npd0Z5Sk5GaU03QTlJOEtQTGZYVXcKUUM0Y3pVZTVadUc0
+  V0h2aW5yV2hrckNLKzFkV0Jxb0VDbHhkRi9Gb0tPNWErdG9uR0Nqam1meTgx
+  Sm1Gamp5eAplVHNqc0h5dncrUWlrOWtwZjlhajYrcG5rTnJWc3dnTkhWZWEy
+  bzl5YWJiRWlTNlZTZUpXb1FJREFRQUJvNEhGCk1JSENNQjBHQTFVZERnUVdC
+  QlF6UEp0cW1TZ2M1M2VETjdhU3pEUXdyOVRBTERDQmtnWURWUjBqQklHS01J
+  R0gKZ0JRelBKdHFtU2djNTNlRE43YVN6RFF3cjlUQUxLRmtwR0l3WURFTE1B
+  a0dBMVVFQmhNQ1ZWTXhFekFSQmdOVgpCQWdUQ2tOaGJHbG1iM0p1YVdFeEZq
+  QVVCZ05WQkFjVERWTmhiaUJHY21GdVkybHpZMjh4RHpBTkJnTlZCQW9UCkJs
+  TnBlRUZ5YlRFVE1CRUdBMVVFQXhNS2MybDRZWEp0TG1OdmJZSUpBS1B3RUVU
+  VTViSG9NQXdHQTFVZEV3UUYKTUFNQkFmOHdEUVlKS29aSWh2Y05BUUVGQlFB
+  RGdZRUFvb0VleFAvb1BhbTFUUDcxU3l1aHhNYit1VHJaYlNRZQpqVkIrRXhS
+  d1dhZEd3YU5QVUE1NmQzOXF3YXZ3UCtpdSszSnBlb25OTVZ2YldYRjVuYUNY
+  L2RORkllUkVIekVSClpEUlFZTXFydTlURU1uYTZIRDl6cGNzdEY3dndUaEdv
+  dmxPUSszWTZwbFE0bk16aXBYY1o5VEhxczY1UElMMHEKZWFid3BDYkFvcG89
+  Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
+date: 2012-03-17 00:00:00.000000000 Z
 dependencies: []
-
 description: 
 email: sixarm@sixarm.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gemtest
-- CHANGELOG.txt
-- INSTALL.txt
-- LICENSE.txt
 - Rakefile
-- README.rdoc
+- README.md
 - VERSION
 - lib/sixarm_ruby_email_address_validation.rb
 - test/sixarm_ruby_email_address_validation_test.rb
-has_rdoc: true
 homepage: http://sixarm.com/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.9.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: "SixArm \xC2\xBB Ruby \xC2\xBB Email address validation using RFC 822 pattern match regex regular expressions"
-test_files: 
+summary: SixArm » Ruby » Email address validation using RFC 822 pattern match regex
+  regular expressions
+test_files:
 - test/sixarm_ruby_email_address_validation_test.rb
+has_rdoc: true

data/CHANGELOG.txt

@@ -1,3 +0,0 @@
-CHANGELOG
-2011-06-12 1.2.4 Rename EMAIL_ADDRESS_PATTERN to EMAIL_ADDRESS_INNER_PATTERN for clarity
-2011-04-24 1.2.2 Update for Ruby 1.9.2 and Rails 3.0.6

data/INSTALL.txt

@@ -1,32 +0,0 @@
-
-= SixArm.com Ruby Gem Install
-
-
-First-time users: add our gem certificate and source.
-When you do this once, it works for all our gems.
-
-  sudo wget http://sixarm.com/sixarm.pem
-  sudo gem cert --add sixarm.pem   
-  sudo gem sources --add http://sixarm.com
-
-Install the gem with advanced options.
-
-  sudo gem install sixarm_ruby_email_address_validation --test --trust-policy HighSecurity
-
-
-== Notes
-
-Do you have any questions, comments, suggestions, or feedback?
-Let us know, we're happy to help. Our email is sixarm@sixarm.com
-
-Do you want to create your own high security gems?
-Learn how at http://www.rubygems.org/read/chapter/21
-
-To see your current gem certificate list:
-
-  sudo gem cert --list
-
-Our cert looks like this:
-
-  /C=US/ST=California/L=San Francisco/O=SixArm/CN=sixarm.com
-

data/LICENSE.txt

@@ -1,12 +0,0 @@
-LICENSE
-
-You may choose any of these licenses:
-
-  - CreativeCommons License, Non-commercial Share Alike
-  - LGPL, GNU Lesser General Public License
-  - MIT License
-  - Ruby License
-
-THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

data/README.rdoc

@@ -1,75 +0,0 @@
-= SixArm.com » Ruby » Email address validation using RFC 822 pattern matching
-
-Author:: Joel Parker Henderson, joel@joelparkerhenderson.com
-Copyright:: Copyright (c) 2006-2011 Joel Parker Henderson
-License:: See LICENSE.txt file
-
-Email address regular expression to validate an email address using RFC 822.
-
-This is a gem wrapper around http://tfletcher.com/lib/rfc822.rb
-
-Example:
-  if EMAIL_ADDRESS_INNER_PATTERN=~'foo@bar.com'
-    puts "found" 
-  else
-    puts "not found"
-  end
-  => found
-
-
-== Pattern Match
-
-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 = EMAIL_ADDRESS_INNER_PATTERN=~'foo@bar.com'
-  => 0
-
-  match_position = EMAIL_ADDRESS_INNER_PATTERN=~'... foo@bar.com ...'
-  => 4
-
-  match_position = EMAIL_ADDRESS_INNER_PATTERN=~'... hello world ...'
-  => nil
-
-
-== Exact Pattern Match
-
-To do an exact pattern match, use the EMAIL_ADDRESS_EXACT_PATTERN.
-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 EMAIL_ADDRESS_EXACT_PATTERN=~'foo@bar.com' 
-    puts "found" 
-  else
-    puts "not found"
-  end
-  => found
-
-  if EMAIL_ADDRESS_EXACT_PATTERN=~'... 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)
-    EMAIL_ADDRESS_EXACT_PATTERN=~email_address ? true : false
-  end
-
-
-== Rails Validation
-
-To add email address validation to a typical Ruby On Rails model:
-
-  class User
-    include EmailAddressValidation
-    validates :email_address, :format => { :with => EMAIL_ADDRESS_EXACT_PATTERN },
-  end
-
-
-