uk_validators 0.1.0 → 0.2.0

data/README.md

@@ -4,6 +4,7 @@ This library contains Rails 3 custom validators for the following UK-centric dat
 
  * National Insurance Number
  * Post Code
+ * Driving Licence Number
 
 
 ## Installation
@@ -81,6 +82,37 @@ For the example Address model above, the customised en.yml would be:
                   postcode: "is not valid"
 
 
+## Driving Licence Number
+Validates the format of a UK Driving Licence Number covering the format used in England, Scotland and Wales. Northen Ireland has a different format containing 8 random alphanumeric characters.
+
+References: [DVLA](http://www.direct.gov.uk/prod_consum_dg/groups/dg_digitalassets/@dg/@en/@motor/documents/digitalasset/dg_068626.pdf), [uk-osint.net](http://www.uk-osint.net/usefulbits.html#How%20To%20Check%20UK%20Driving%20Licences)
+
+### Usage
+
+```ruby
+class User < ActiveRecord::Base
+  validates :licence_number, driving_licence: true
+end
+```
+
+### I18n
+
+The default error message is `is not a valid Driving Licence No.`
+
+This can be translated in the same was as any other Rails validation message using the key **:driving_licence**.
+
+For the example User model above, the customised en.yml would be:
+
+    en:
+      activerecord:
+        errors:
+          models:
+            user:
+              attributes:
+                licence_number:
+                  driving_licence: "is not valid"
+
+
 
 
 ## Contributing

data/lib/uk_validators/driving_licence_validator.rb

@@ -0,0 +1,57 @@
+class DrivingLicenceValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, invalid_message(record, attribute)) unless valid_driving_licence?(value)
+  end
+
+private
+
+  def valid_driving_licence?(value)
+    # first 5 letters of surname (padded with 9 if shorter than 5)
+    # decade of birth
+    # month of birth - 5 is added to first digit if female
+    # month day of birth
+    # year in decade of birth
+    # first name and second name initials (9 used if no second name)
+    # computer generated check digits (usually 9 followed by 2 alphabetics)
+    # Example: for Susan Ann Davis born 23 November 1978: DAVIS761238SA9WE
+    # value =~ /^[A-Z][A-Z9]{4}\d[0156]\d[0123]\d\d[A-Z][A-Z9]\d[A-Z]{2}$/i
+    valid = false
+    # if we get a valid match then check the date of birth looks valid
+    if value.present? && match = value.match(/^[A-Z][A-Z9]{4}(\d)([0156]\d)([0123]\d)(\d)[A-Z][A-Z9]\d[A-Z]{2}$/i)
+      decade, month, day, year = match.captures
+      yy = (decade + year).to_i
+      mm = month.to_i
+      dd = day.to_i
+      mm -= 50 if mm > 50
+
+      if dd > 0 && mm >= 1 && mm <= 12
+        if [4, 6, 9, 11].include? mm
+          valid = dd <= 30
+        elsif mm == 2
+          if dd <= 28
+            valid = true
+          else
+            if dd == 29
+              if Date.today.year > (2000 + yy)
+                valid = Date.leap?(2000 + yy) || Date.leap?(1900 + yy)
+              else
+                valid = Date.leap?(1900 + yy)
+              end
+            end
+          end
+        else
+          valid = dd <= 31
+        end
+      end
+    end
+    valid
+  end
+
+  def invalid_message(record, attribute)
+    I18n.t  :driving_licence,
+            scope: "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default: "is not a valid Driving Licence number"
+  end
+
+end

data/lib/uk_validators/version.rb

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

data/lib/uk_validators.rb

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

data/test/driving_licence_test.rb

@@ -0,0 +1,75 @@
+require_relative 'test_helper'
+
+class TestDrivingLicenceValidator < MiniTest::Unit::TestCase
+  class User < TestModel
+    validates :licence_number, driving_licence: true
+  end
+
+  def test_valid_driving_licences
+    valid_licences.each { |licence| assert User.new(licence_number: licence).valid?, "Licence should be valid: #{licence}" }
+  end
+
+  def test_invalid_driving_licences
+    invalid_licences.each { |licence| assert User.new(licence_number: licence).invalid?, "Licence should be invalid: #{licence}" }
+  end
+
+private
+
+  def valid_licences
+    [
+      'ABCDE703120AB9AB',
+      'ABCD9703120AB9AB',
+      'ABC99703120AB9AB',
+      'AB999703120AB9AB',
+      'A9999703120AB9AB',
+      'ABCDE752292AB9AB',
+      'ABCDE753120AB9AB',
+      'ABCDE761120AB9AB',
+      'ABCDE703220AB9AB',
+      'ABCDE703310AB9AB',
+    ]
+  end
+
+  def invalid_licences
+    [
+      '',
+      '1BCDE402149AB8AB',
+      'A2CDE402149AB8AB',
+      'AB3DE402149AB8AB',
+      'ABC4E402149AB8AB',
+      'ABCD5402149AB8AB',
+      'ABCDEF02149AB8AB',
+      'ABCDE4G2149AB8AB',
+      'ABCDE4GH149AB8AB',
+      'ABCDE4G2I49AB8AB',
+      'ABCDE4G21J9AB8AB',
+      'ABCDE4G214KAB8AB',
+      'ABCDE4G21491B8AB',
+      'ABCDE4G2149A28AB',
+      'ABCDE4G2149ABVAB',
+      'ABCDE4G2149AB81B',
+      'ABCDE4G2149AB8A2',
+      'ABCDE402149AB8A',
+      'ABCDE402149AB8',
+      'ABCDE402149AB',
+      'ABCDE402149A',
+      'ABCDE402149',
+      'ABCDE40214',
+      'ABCDE4021',
+      'ABCDE402',
+      'ABCDE40',
+      'ABCDE4',
+      'ABCDE',
+      'ABCD',
+      'ABC',
+      'AB',
+      'A',
+      'ABCDE402149AB8AB1',
+      'ABCDE763120AB9AB',
+      'ABCDE702300AB9AB',
+      'ABCDE752294AB9AB',
+
+    ]
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uk_validators
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,9 +88,11 @@ files:
 - README.md
 - Rakefile
 - lib/uk_validators.rb
+- lib/uk_validators/driving_licence_validator.rb
 - lib/uk_validators/nino_validator.rb
 - lib/uk_validators/postcode_validator.rb
 - lib/uk_validators/version.rb
+- test/driving_licence_test.rb
 - test/nino_test.rb
 - test/postcode_test.rb
 - test/test_helper.rb
@@ -110,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2750721584728170900
+      hash: -224961422204427896
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2750721584728170900
+      hash: -224961422204427896
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -127,6 +129,7 @@ signing_key:
 specification_version: 3
 summary: Rails validations for UK data
 test_files:
+- test/driving_licence_test.rb
 - test/nino_test.rb
 - test/postcode_test.rb
 - test/test_helper.rb