uk_validators 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in uk_validators.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tony Headford
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.md

@@ -0,0 +1,33 @@
+# UK Validators
+
+This library contains validators for the following UK-centric data:
+
+ * National Insurance Number
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'uk_validators'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### National Insurance Number (Nino)
+
+Simply add the following to your model
+
+    validates :my_nino_attribute, nino: true
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.test_files = FileList['test/**/*_test.rb']
+end
+

data/lib/uk_validators/nino_validator.rb

@@ -0,0 +1,19 @@
+class NinoValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute, invalid_message(record, attribute)) unless valid_nino?(value)
+  end
+
+private
+
+  def valid_nino?(value)
+    value =~ /^[A-CEGHJ-PRSTW-Z][A-CEGHJ-NPRSTW-Z][0-9]{6}[A-D\s]$/i && value !~ /^(GB|BG|NK|KN|TN|NT|ZZ)/i
+  end
+
+  def invalid_message(record, attribute)
+    I18n.t  :nino,
+            scope: "#{record.class.i18n_scope}.errors.models.#{record.class.model_name.i18n_key}.attributes.#{attribute}",
+            default: "is not a valid National Insurance No."
+  end
+
+end

data/lib/uk_validators/version.rb

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

data/lib/uk_validators.rb

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

data/test/nino_test.rb

@@ -0,0 +1,93 @@
+require_relative 'test_helper'
+
+class TestNinoValidator < MiniTest::Unit::TestCase
+  class User < TestModel
+    validates :ni_number, nino: true
+  end
+
+  def test_valid_ninos
+    valid_ninos.each { |nino| assert User.new(ni_number: nino).valid?, "Bad nino #{nino}" }
+  end
+
+  def test_invalid_ninos
+    invalid_ninos.each { |nino| assert User.new(ni_number: nino).invalid? }
+  end
+
+private
+
+  def valid_ninos
+    [
+      'aa123456a',
+      'bb940321b',
+      'cc987654c',
+      'ee903221d',
+      'gg849302 ', # apparently space is valid for the final character
+      'hh123849a',
+      'jj123849b',
+      'kk123849c',
+      'll123849d',
+      'mm123849 ',
+      'nn123849a',
+      'on123849b',
+      'pp123849c',
+      'rr123849d',
+      'ss123849 ',
+      'tt123849a',
+      'ww123849b',
+      'xx123849c',
+      'yy123849d',
+      'za123849 '
+    ]
+  end
+
+  def invalid_ninos
+    [
+      'aa123456e',
+      'bb940321f',
+      'cc987654g',
+      'ee903221h',
+      'gg849302i',
+      'hh123849j',
+      'jj123849k',
+      'kk123849l',
+      'll123849m',
+      'mm123849n',
+      'nn123849o',
+      'on123849p',
+      'pp123849q',
+      'rr123849r',
+      'ss123849s',
+      'tt123849t',
+      'ww123849u',
+      'xx123849v',
+      'yy123849w',
+      'zz123849x',
+      'aa123456y',
+      'bb940321z',
+      'cc9854c',
+      'e',
+      'ga',
+      '1w',
+      'a ',
+      'a1',
+      ' ',
+      '2s123456a',
+      'a4123849c',
+      'll 23849d',
+      'mm1e3849 ',
+      'nn12f849a',
+      'on123b49b',
+      'pp1238v9c',
+      'rr12389md',
+      's1238492a',
+      'gb123849a',
+      'bg123849b',
+      'nk123849c',
+      'kn123849d',
+      'tn123849a',
+      'nt123849b',
+      'zz123849c'
+    ]
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'active_model'
+require 'minitest/autorun'
+require 'uk_validators'
+
+class TestModel
+  include ActiveModel::Validations
+
+  def initialize(attributes = {})
+    @attributes = attributes
+  end
+
+  def read_attribute_for_validation(key)
+    @attributes[key]
+  end
+end

data/uk_validators.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uk_validators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uk_validators"
+  spec.version       = UkValidators::VERSION
+  spec.authors       = ["Tony Headford"]
+  spec.email         = ["tony@binarycircus.com"]
+  spec.description   = %q{Rails Validations for typically UK specific data}
+  spec.summary       = %q{Rails validations for UK data }
+  spec.homepage      = "https://github.com/tonyheadford/uk_validators"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "activemodel", ">= 3.2"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: uk_validators
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tony Headford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Rails Validations for typically UK specific data
+email:
+- tony@binarycircus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uk_validators.rb
+- lib/uk_validators/nino_validator.rb
+- lib/uk_validators/version.rb
+- test/nino_test.rb
+- test/test_helper.rb
+- uk_validators.gemspec
+homepage: https://github.com/tonyheadford/uk_validators
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1782607928652499814
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1782607928652499814
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Rails validations for UK data
+test_files:
+- test/nino_test.rb
+- test/test_helper.rb