uk_validators 0.2.0 → 0.3.0

data/README.md

@@ -5,6 +5,7 @@ This library contains Rails 3 custom validators for the following UK-centric dat
  * National Insurance Number
  * Post Code
  * Driving Licence Number
+ * Passport Number
 
 
 ## Installation
@@ -113,6 +114,36 @@ For the example User model above, the customised en.yml would be:
                   driving_licence: "is not valid"
 
 
+## Passport Number
+A UK passport number is simply made up of 9 numeric characters.
+
+References: [NHS Data Dictionary](http://www.datadictionary.nhs.uk/version2/data_dictionary/data_field_notes/p/passport_number__o_new_c__de.asp?shownav=1), [highprogrammer.com](http://www.highprogrammer.com/alan/numbers/mrp.html)
+
+### Usage
+
+```ruby
+class HolidayMaker < ActiveRecord::Base
+  validates :passport, passport_number: true
+end
+```
+
+### I18n
+
+The default error message is `is not a valid Passport No.`
+
+This can be translated in the same was as any other Rails validation message using the key **:passport_number**.
+
+For the example HolidayMaker model above, the customised en.yml would be:
+
+    en:
+      activerecord:
+        errors:
+          models:
+            holiday_maker:
+              attributes:
+                passport:
+                  passport_number: "is not valid"
+
 
 
 ## Contributing

data/lib/uk_validators.rb

@@ -2,3 +2,4 @@ require "uk_validators/version"
 require "uk_validators/nino_validator"
 require "uk_validators/postcode_validator"
 require "uk_validators/driving_licence_validator"
+require "uk_validators/passport_number_validator"

data/lib/uk_validators/passport_number_validator.rb

@@ -0,0 +1,20 @@
+class PassportNumberValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, invalid_message(record, attribute)) unless valid_passport_number?(value)
+  end
+
+private
+
+  # UK format is simply 9 digits
+  def valid_passport_number?(value)
+    value =~ /^[0-9]{9}$/
+  end
+
+  def invalid_message(record, attribute)
+    I18n.t  :passport_number,
+            scope: "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default: "is not a valid Passport No."
+  end
+
+end

data/lib/uk_validators/version.rb

@@ -1,3 +1,3 @@
 module UkValidators
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/passport_number_test.rb

@@ -0,0 +1,60 @@
+require_relative 'test_helper'
+
+class TestPassportNumberValidator < MiniTest::Unit::TestCase
+  class HolidayMaker < TestModel
+    validates :passport, passport_number: true
+  end
+
+  def test_valid_passport_numbers
+    valid_passport_numbers.each { |passport| assert HolidayMaker.new(passport: passport).valid?, "Passport No. should be valid: #{passport}" }
+  end
+
+  def test_invalid_passport_numbers
+    invalid_passport_numbers.each { |passport| assert HolidayMaker.new(passport: passport).invalid?, "Passport No. should be invalid: #{passport}" }
+  end
+
+private
+
+  def valid_passport_numbers
+    [
+      '012345678',
+      '987654321',
+      '000000000',
+      '111111111',
+      '222222222',
+      '333333333',
+      '444444444',
+      '555555555',
+      '666666666',
+      '777777777',
+      '888888888',
+      '999999999',
+    ]
+  end
+
+  def invalid_passport_numbers
+    [
+      '01234567',
+      '9876543',
+      '012345',
+      '98765',
+      '0123',
+      '987',
+      '01',
+      '9',
+      '',
+      ' ',
+      'a12345678',
+      '0b2345678',
+      '01b345678',
+      '012c45678',
+      '0123d5678',
+      '01234e678',
+      '012345f78',
+      '0123456g8',
+      '01234567h',
+      'ijklmnopq',
+      '1234&*()['
+    ]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uk_validators
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -90,10 +90,12 @@ files:
 - lib/uk_validators.rb
 - lib/uk_validators/driving_licence_validator.rb
 - lib/uk_validators/nino_validator.rb
+- lib/uk_validators/passport_number_validator.rb
 - lib/uk_validators/postcode_validator.rb
 - lib/uk_validators/version.rb
 - test/driving_licence_test.rb
 - test/nino_test.rb
+- test/passport_number_test.rb
 - test/postcode_test.rb
 - test/test_helper.rb
 - uk_validators.gemspec
@@ -112,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -224961422204427896
+      hash: -1062937670582392056
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -224961422204427896
+      hash: -1062937670582392056
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -131,5 +133,6 @@ summary: Rails validations for UK data
 test_files:
 - test/driving_licence_test.rb
 - test/nino_test.rb
+- test/passport_number_test.rb
 - test/postcode_test.rb
 - test/test_helper.rb