pukka 0.0.1 → 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 1.0.0 (13 October 2011)
+
+* Email format validator.

data/README.md

@@ -0,0 +1,26 @@
+# Pukka
+
+Keep your data Pukka with these custom ActiveModel validators.
+
+
+## Quick Start
+
+Add `gem 'pukka'` to your Gemfile, run `bundle install`, then just use the validators in your models.
+
+For example:
+
+    class Person < ActiveRecord::Base
+      validates :email, :email_format => true
+    end
+
+
+## Questions, Problems, Feedback
+
+Please use the GitHub [issue tracker](https://github.com/airblade/pukka/issues) or email me.
+
+
+## Intellectual property
+
+Copyright 2011 Andy Stewart (boss@airbladesoftware.com).
+
+Released under the MIT licence.

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/pukka.rb

@@ -1,5 +1,6 @@
-require "pukka/version"
+require 'pukka/version'
+require 'pukka/email_format_validator'
 
 module Pukka
-  # Your code goes here...
+  #autoload :EmailFormatValidator, 'pukka/email_format_validator'
 end

data/lib/pukka/email_format_validator.rb

@@ -0,0 +1,18 @@
+# Email addresses are notoriously difficult to validate.  The only real way is to
+# try to send an email to the address and receive confirmation that it arrived.
+# Clearly this is impractical most of the time.
+#
+# The regexp below is James Watts and Francisco Martin Moreno's one from
+# http://fightingforalostcause.net/misc/2006/compare-email-regex.php
+#
+# There are better ones on that page but they displease Ruby.
+#
+# It's worth reading the discussion there.
+class EmailFormatValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors[attribute] << (options[:message] || 'is not an email address') unless
+      value =~ /^([\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+\.)*[\w\!\#$\%\&\'\*\+\-\/\=\?\^\`{\|\}\~]+@((((([a-z0-9]{1}[a-z0-9\-]{0,62}[a-z0-9]{1})|[a-z])\.)+[a-z]{2,6})|(\d{1,3}\.){3}\d{1,3}(\:\d{1,5})?)$/i
+  end
+
+end

data/lib/pukka/version.rb

@@ -1,3 +1,3 @@
 module Pukka
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/pukka.gemspec

@@ -1,15 +1,15 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "pukka/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'pukka/version'
 
 Gem::Specification.new do |s|
-  s.name        = "pukka"
+  s.name        = 'pukka'
   s.version     = Pukka::VERSION
-  s.authors     = ["Andy Stewart"]
-  s.email       = ["boss@airbladesoftware.com"]
-  s.homepage    = ""
+  s.authors     = ['Andy Stewart']
+  s.email       = ['boss@airbladesoftware.com']
+  s.homepage    = 'https://github.com/airblade/pukka'
   s.summary     = 'A handful of custom ActiveModel validators.'
-  s.description = s.summary
+  s.description = 'Keep your data pukka with these custom ActiveModel validators.'
 
   s.rubyforge_project = "pukka"
 
@@ -19,6 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'activemodel', '~> 3.0'
-  s.add_development_dependency 'activesupport', '~> 3.0'
   s.add_development_dependency 'rake', '0.8.7'
 end

data/test/email_format_validator_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+require 'pukka/email_format_validator'
+
+class Thingy
+  include ActiveModel::Validations
+  attr_accessor :email
+  validates :email, :email_format => true
+end
+
+
+class EmailFormatValidatorTest < Test::Unit::TestCase
+
+  def setup
+    @thingy = Thingy.new
+  end
+
+  def test_valid_formats
+    %w[
+      abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ@letters-in-local.org
+      01234567890@numbers-in-local.net
+      &'*+-./=?^_{}~@other-valid-characters-in-local.net
+      mixed-1234-in-{+^}-local@sld.net
+      a@single-character-in-local.org
+      one-character-third-level@a.example.com
+      single-character-in-sld@x.org
+      local@dash-in-sld.com
+      letters-in-sld@123.com
+      one-letter-sld@x.org
+      uncommon-tld@sld.museum
+      uncommon-tld@sld.travel
+      uncommon-tld@sld.mobi
+      country-code-tld@sld.uk
+      country-code-tld@sld.rw
+      local@sld.newTLD
+      local@sub.domains.com
+    ].each do |email|
+      @thingy.email = email
+      assert @thingy.valid?, "#{email} should be valid"
+    end
+  end
+
+  def test_valid_formats_incorrectly_judged_invalid
+    %w[
+      "quoted"@sld.com
+      "\e\s\c\a\p\e\d"@sld.com
+      "quoted-at-sign@sld.org"@sld.com
+      "escaped\"quote"@sld.com
+      "back\slash"@sld.com
+      punycode-numbers-in-tld@sld.xn--3e0b707e
+      bracketed-IP-instead-of-domain@[127.0.0.1]
+      the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters-and-this-address-is-254-characters-exactly-so-it-should-be-valid-and-im-going-to-add-some-more-words-here-to-increase-the-lenght-blah-blah-blah-blah-bla.org
+    ].each do |email|
+      @thingy.email = email
+      assert @thingy.valid?, "#{email} should be valid"
+    end
+  end
+
+  def test_invalid_formats
+    %w[
+      @missing-local.org
+      !\ #$%`|@invalid-characters-in-local.org
+      (),:;`|@more-invalid-characters-in-local.org
+      <>@[]\`|@even-more-invalid-characters-in-local.org
+      .local-starts-with-dot@sld.com
+      local-ends-with-dot.@sld.com
+      two..consecutive-dots@sld.com
+      partially."quoted"@sld.com
+      missing-sld@.com
+      sld-starts-with-dashsh@-sld.com
+      sld-ends-with-dash@sld-.com
+      invalid-characters-in-sld@!\ "#$%(),/;<>_[]`|.org
+      missing-dot-before-tld@com
+      missing-tld@sld.
+      invalid
+      the-total-length@of-an-entire-address-cannot-be-longer-than-two-hundred-and-fifty-four-characters-and-this-address-is-255-characters-exactly-so-it-should-be-invalid-and-im-going-to-add-some-more-words-here-to-increase-the-lenght-blah-blah-blah-blah-bl.org
+      missing-at-sign.net
+      invalid-ip@127.0.0.1.26
+    ].each do |email|
+      @thingy.email = email
+      assert !@thingy.valid?, "#{email} should not be valid"
+    end
+  end
+
+  def test_invalid_formats_incorrectly_judged_valid
+    %w[
+      the-local-part-is-invalid-if-it-is-longer-than-sixty-four-characters@sld.net
+      unbracketed-IP@127.0.0.1
+      another-invalid-ip@127.0.0.256
+      IP-and-port@127.0.0.1:25
+    ].each do |email|
+      @thingy.email = email
+      assert !@thingy.valid?, "#{email} should not be valid"
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'active_model'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pukka
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-08 00:00:00 +02:00
+date: 2011-10-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,25 +33,10 @@ dependencies:
         version: "3.0"
   type: :runtime
   requirement: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  type: :development
-  requirement: *id002
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -63,8 +48,8 @@ dependencies:
         - 7
         version: 0.8.7
   type: :development
-  requirement: *id003
-description: A handful of custom ActiveModel validators.
+  requirement: *id002
+description: Keep your data pukka with these custom ActiveModel validators.
 email: 
 - boss@airbladesoftware.com
 executables: []
@@ -75,13 +60,18 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- README.md
 - Rakefile
 - lib/pukka.rb
+- lib/pukka/email_format_validator.rb
 - lib/pukka/version.rb
 - pukka.gemspec
+- test/email_format_validator_test.rb
+- test/test_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/airblade/pukka
 licenses: []
 
 post_install_message: 
@@ -114,5 +104,6 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A handful of custom ActiveModel validators.
-test_files: []
-
+test_files: 
+- test/email_format_validator_test.rb
+- test/test_helper.rb