uk_validators 0.0.1 → 0.0.2

data/README.md

@@ -1,8 +1,9 @@
 # UK Validators
 
-This library contains validators for the following UK-centric data:
+This library contains Rails 3 custom validators for the following UK-centric data:
 
  * National Insurance Number
+ * Post Code
 
 
 ## Installation
@@ -13,15 +14,73 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-## Usage
 
-### National Insurance Number (Nino)
+## National Insurance Number (Nino)
+Validates the format of a UK National Insurance Number.
+
+References: [HMRC](http://www.hmrc.gov.uk/manuals/nimmanual/nim39110.htm), [uk-osint.net](http://www.uk-osint.net/usefulbits.html#Understanding%20UK%20National%20Insurance%20Numbers), [Wikipedia](http://en.wikipedia.org/wiki/National_Insurance_number)
+
+### Usage
+
+```ruby
+class User < ActiveRecord::Base
+  validates :ni_number, nino: true
+end
+```
+
+### I18n
+
+The default error message is `is not a valid National Insurance No.`
+
+This can be translated in the same was as any other Rails validation message using the key **:nino**.
+
+For the example User model above, the customised en.yml would be:
+
+    en:
+      activerecord:
+        errors:
+          models:
+            user:
+              attributes:
+                ni_number:
+                  nino: "is not valid"
+
+
+
+## Post Code
+
+Validates the format of a UK postal code. This does not check whether the post code actually exists as this would require a lookup against approx. 1.8 million postal codes.
+
+References: [Royal Mail PAF Document](http://www.poweredbypaf.com/wp-content/themes/amu/paf_downloads/programmers_guide.pdf), [Wikipedia](http://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom)
+
+### Usage
+
+```ruby
+class Address < ActiveRecord::Base
+  validates :postal_code, postcode: true
+end
+```
+
+### I18n
+
+The default error message is `is not a valid postcode`
+
+This can be translated in the same was as any other Rails validation message using the key **:postcode**.
+
+For the example Address model above, the customised en.yml would be:
+
+    en:
+      activerecord:
+        errors:
+          models:
+            address:
+              attributes:
+                postal_code:
+                  postcode: "is not valid"
 
-Simply add the following to your model
 
-    validates :my_nino_attribute, nino: true
 
 
 ## Contributing

data/lib/uk_validators/postcode_validator.rb

@@ -0,0 +1,19 @@
+class PostcodeValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, invalid_message(record, attribute)) unless valid_postcode?(value)
+  end
+
+private
+
+  def valid_postcode?(value)
+    value =~ /^([A-PR-UWYZ]([0-9]{1,2}|([A-HK-Y][0-9]|[A-HK-Y][0-9]([0-9]|[ABEHMNPRV-Y]))|[0-9][A-HJKS-UW])\s?[0-9][ABD-HJLNP-UW-Z]{2}|(GIR\s?0AA)|(AI-2640)|(SAN\s?TA1)|(BFPO\s?(C\/O\s)?[0-9]{1,4})|((ASCN|BBND|[BFS]IQQ|PCRN|STHL|TDCU|TKCA)\s?1ZZ))$/i
+  end
+
+  def invalid_message(record, attribute)
+    I18n.t  :postcode,
+            scope: "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default: "is not a valid postcode."
+  end
+
+end

data/lib/uk_validators/version.rb

@@ -1,3 +1,3 @@
 module UkValidators
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/uk_validators.rb

@@ -1,5 +1,3 @@
 require "uk_validators/version"
 require "uk_validators/nino_validator"
-
-module UkValidators
-end
+require "uk_validators/postcode_validator"

data/test/nino_test.rb

@@ -6,11 +6,11 @@ class TestNinoValidator < MiniTest::Unit::TestCase
   end
 
   def test_valid_ninos
-    valid_ninos.each { |nino| assert User.new(ni_number: nino).valid?, "Bad nino #{nino}" }
+    valid_ninos.each { |nino| assert User.new(ni_number: nino).valid?, "Nino should be valid: #{nino}" }
   end
 
   def test_invalid_ninos
-    invalid_ninos.each { |nino| assert User.new(ni_number: nino).invalid? }
+    invalid_ninos.each { |nino| assert User.new(ni_number: nino).invalid?, "Nino should be invalid: #{nino}" }
   end
 
 private
@@ -21,7 +21,7 @@ private
       'bb940321b',
       'cc987654c',
       'ee903221d',
-      'gg849302 ', # apparently space is valid for the final character
+      'gg849302 ', # space is valid for the final character if it is not known
       'hh123849a',
       'jj123849b',
       'kk123849c',

data/test/postcode_test.rb

@@ -0,0 +1,118 @@
+require_relative 'test_helper'
+
+class TestPostcodeValidator < MiniTest::Unit::TestCase
+  class User < TestModel
+    validates :postcode, postcode: true
+  end
+
+  def test_valid_postcodes
+    valid_postcodes.each { |postcode| assert User.new(postcode: postcode).valid?, "Postcode should be valid: #{postcode}" }
+  end
+
+  def test_invalid_postcodes
+    invalid_postcodes.each { |postcode| assert User.new(postcode: postcode).invalid?, "Postcode should be invalid: #{postcode}" }
+  end
+
+private
+
+  def valid_postcodes
+    [
+      'EC2N 2DB',     # AA9A 9AA format
+      'EC1A1BB',
+      'W1A 1HQ',      # A9A 9AA format
+      'N1C1AA',
+      'S2 4SU',       # A9 9AA format
+      'M11AA',
+      'B33 8TH',      # A99 9AA format
+      'G109WW',
+      'CR2 6XH',      # AA9 9AA format
+      'BS13PE',
+      'RG12 1WA',     # AA99 9AA format
+      'EH991SP',
+      'AI-2640',      # Anguilla
+      'ASCN 1ZZ',     # Ascension Island
+      'ASCN1ZZ',
+      'STHL 1ZZ',     # St. Helena
+      'STHL1ZZ',
+      'TDCU 1ZZ',     # Tristanda Cunha
+      'TDCU1ZZ',
+      'BBND 1ZZ',     # British Indian Ocean Territory
+      'BBND1ZZ',
+      'BIQQ 1ZZ',     # British Antarctic Territory
+      'BIQQ1ZZ',
+      'FIQQ 1ZZ',     # Falkland Islands
+      'FIQQ1ZZ',
+      'GX11 1AA',     # Gibraltar
+      'GX111ZZ',
+      'PCRN 1ZZ',     # Pitcairn Islands
+      'PCRN1ZZ',
+      'SIQQ 1ZZ',     # South Georgia and South Sandwich Islands
+      'SIQQ1ZZ',
+      'TKCA 1ZZ',     # Turks and Caicos Islands
+      'TKCA1ZZ',
+      'GIR 0AA',      # Girobank / Santander
+      'GIR0AA',
+    ]
+  end
+
+  def invalid_postcodes
+    [
+      # invalid 1st pos characters - Q,V,X
+      'QB1 1AA',
+      'V2 4SU',
+      'XA12 2AB',
+
+      # invalid 2nd pos characters - I,J,Z
+      'BI9 1AA',
+      'CJ12 2SA',
+      'AZ9 9WC',
+
+      # invalid 3rd pos characters - I,L,M,N,O,Q,R,V,X,Y,Z
+      'W1I 1ST',
+      'W1L 1ST',
+      'W1M 1ST',
+      'W1N 1ST',
+      'W1O 1ST',
+      'W1Q 1ST',
+      'W1R 1ST',
+      'W1V 1ST',
+      'W1X 1ST',
+      'W1Y 1ST',
+      'W1Z 1ST',
+
+      # invalid 4th pos characters - C,D,F,G,I,J,K,L,O,Q,S,T,U,Z
+      'EC1C 2WA',
+      'EC1D 2WA',
+      'EC1F 2WA',
+      'EC1G 2WA',
+      'EC1I 2WA',
+      'EC1J 2WA',
+      'EC1K 2WA',
+      'EC1L 2WA',
+      'EC1O 2WA',
+      'EC1Q 2WA',
+      'EC1S 2WA',
+      'EC1T 2WA',
+      'EC1U 2WA',
+      'EC1Z 2WA',
+
+      # invalid final 2 letters, C,I,K,M,O,V
+      'BS15 3CE',
+      'BS15 3IE',
+      'BS15 3KE',
+      'BS15 3ME',
+      'BS15 3OE',
+      'BS15 3VE',
+      'BS15 3PC',
+      'BS15 3PI',
+      'BS15 3PK',
+      'BS15 3PM',
+      'BS15 3PO',
+      'BS15 3PV',
+
+      '',
+      ' ',
+      '1w23 12e'
+    ]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uk_validators
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-04 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,8 +89,10 @@ files:
 - Rakefile
 - lib/uk_validators.rb
 - lib/uk_validators/nino_validator.rb
+- lib/uk_validators/postcode_validator.rb
 - lib/uk_validators/version.rb
 - test/nino_test.rb
+- test/postcode_test.rb
 - test/test_helper.rb
 - uk_validators.gemspec
 homepage: https://github.com/tonyheadford/uk_validators
@@ -108,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1782607928652499814
+      hash: 4864723644629626
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1782607928652499814
+      hash: 4864723644629626
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -126,4 +128,5 @@ specification_version: 3
 summary: Rails validations for UK data
 test_files:
 - test/nino_test.rb
+- test/postcode_test.rb
 - test/test_helper.rb