validates_as_uk_postcode 2.0.1

data/README.mdown

@@ -0,0 +1,54 @@
+# Validates As UK Postcode (version 2.0)
+
+This Ruby on Rails plugin implements an ActiveRecord validation macro to allow validating of UK Postcodes. It is based on the following regular expression.
+
+  http://www.govtalk.gov.uk/gdsc/html/frames/PostCode.htm
+
+## Installation
+
+    gem install validates_as_uk_postcode
+
+### Rails 2.x
+
+    # environment.rb
+    config.gem "validates_as_uk_postcode"
+
+### Rails 3
+
+    # Gemfile
+    gem "validates_as_uk_postcode"
+
+## Usage
+
+
+### Rails 2.x
+
+    class MyClass < ActiveRecord::Base
+      validates_as_uk_postcode :postcode
+    end
+
+### Rails 3
+
+    class MyClass < ActiveRecord::Base
+      validates :postcode, :uk_postcode => true
+    end
+
+## Authors
+
+**Stephen Rushe** - http://deeden.co.uk
+**Dan Kubb** - http://autopilotmarketing.com
+**David Rice** - http://davidjrice.co.uk
+
+## License
+
+
+This code is released under a Creative Commons Attribution-Share Alike
+3.0 Unported License. The license can be seen here:
+
+  http://creativecommons.org/licenses/by-sa/3.0/
+
+The original version of the code (see History) was released under the
+Creative Commons Attribution-Share Alike 2.5 License, which can be seen
+at:
+
+  http://creativecommons.org/licenses/by-sa/2.5/

data/init.rb

@@ -0,0 +1 @@
+require 'validates_as_uk_postcode'

data/lib/rails2.rb

@@ -0,0 +1,27 @@
+module ValidatesAsUKPostcode
+  module Postcodes
+    UK = begin    
+      an_naa_or_ann_naa   = '^[A-PR-UWYZ]{1}\d{1,2}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      aan_naa_or_aann_naa = '^[A-PR-UWYZ]{1}[A-HK-Y]{1}\d{1,2}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      ana_naa             = '^[A-PR-UWYZ]{1}\d[A-HJKSTUW]{1}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      aana_naa            = '^[A-PR-UWYZ]{1}[A-HK-Y]{1}\d[ABEHMNPRVWXY]{1}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      historic_code="GIR\s?0AA"
+      postcode_spec = "#{an_naa_or_ann_naa}|#{aan_naa_or_aann_naa}|#{ana_naa}|#{aana_naa}|#{historic_code}"
+      pattern = /#{postcode_spec}/i
+    end
+  end
+
+  module Rails2
+
+    def validates_as_uk_postcode(*attr_names)
+      configuration = {
+        :message   => 'is an invalid uk postcode',
+        :with      => Postcodes::UK,
+        :allow_nil => true }
+      configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
+
+      validates_format_of attr_names, configuration
+    end
+
+  end
+end

data/lib/rails3.rb

@@ -0,0 +1,27 @@
+require 'active_support/concern'
+require 'active_model'
+
+module ValidatesAsUKPostcode
+  module Postcodes
+    UK = begin
+      an_naa_or_ann_naa   = '^[A-PR-UWYZ]{1}\d{1,2}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      aan_naa_or_aann_naa = '^[A-PR-UWYZ]{1}[A-HK-Y]{1}\d{1,2}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      ana_naa             = '^[A-PR-UWYZ]{1}\d[A-HJKSTUW]{1}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      aana_naa            = '^[A-PR-UWYZ]{1}[A-HK-Y]{1}\d[ABEHMNPRVWXY]{1}\s?\d[ABD-HJLNP-UWXYZ]{2}$'
+      historic_code="GIR\s?0AA"
+      postcode_spec = "#{an_naa_or_ann_naa}|#{aan_naa_or_aann_naa}|#{ana_naa}|#{aana_naa}|#{historic_code}"
+      pattern = /#{postcode_spec}/i
+    end
+  end
+
+  module Rails3
+    extend ActiveSupport::Concern
+
+    class PostcodeValidator < ActiveModel::EachValidator
+      def validate_each(object, attribute, value)
+        object.errors.add(attribute, "is an invalid UK postcode") unless value =~ Postcodes::UK
+      end
+    end
+  end
+
+end

data/lib/validates_as_uk_postcode.rb

@@ -0,0 +1,7 @@
+if Rails::VERSION::MAJOR >= 3
+  require 'rails3'
+  ActiveRecord::Base.send(:include, ValidatesAsUKPostcode::Rails3)
+else
+  require 'rails2'
+  ActiveRecord::Base.send(:extend,  ValidatesAsUKPostcode::Rails2)
+end

data/test/rails2/models/abstract_model.rb

@@ -0,0 +1,5 @@
+class AbstractModel < ActiveRecord::Base
+
+  validates_as_uk_postcode :postcode
+
+end

data/test/rails2/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+gem 'rails', '2.3.8'
+
+require 'sqlite3'
+require 'test/unit'
+require 'active_record'
+require 'active_record/base'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(
+  "adapter" =>  "sqlite3",
+  "database" => ":memory:"
+)
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rails2.rb')
+
+ActiveRecord::Base.send(:extend,  ValidatesAsUKPostcode::Rails2)
+
+autoload :AbstractModel, File.join(File.dirname(__FILE__), 'models', 'abstract_model.rb')

data/test/rails2/validates_as_uk_postcode_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper.rb'
+
+class ValidatesAsUkPostcodeTest < Test::Unit::TestCase
+  
+  def setup
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :abstract_models, :force => true do |t|
+        t.string :postcode
+      end
+    end
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.drop_table(:abstract_models)
+  end
+
+  def test_invalid_postcodes
+    postcodes = [
+      'Q1 1AA', 'V1 1AA', 'X1 1AA', 'M1 CAA', 'M1 IAA', 'M1 KAA', 'M1 MAA', 'M1 OAA', 'M1 VAA',
+
+      'Q60 1NW', 'V60 1NW', 'X60 1NW', 'M60 1CW', 'M60 1IW', 'M60 1KW', 'M60 1MW', 'M60 1OW', 
+      'M60 1VW', 'M60 1NC', 'M60 1NI', 'M60 1NK', 'M60 1NM', 'M60 1NO', 'M60 1NV', 
+
+      'QR2 6XH', 'VR2 6XH', 'XR2 6XH', 'CI2 6XH', 'CJ2 6XH', 'CZ2 6XH', 'CR2 6CH', 'CR2 6IH',
+      'CR2 6KH', 'CR2 6MH', 'CR2 6OH', 'CR2 6VH', 'CR2 6XC', 'CR2 6XI', 'CR2 6XK', 'CR2 6XM',
+      'CR2 6XO', 'CR2 6XV',
+
+      'QN55 1PT', 'VN55 1PT', 'XN55 1PT', 'DI55 1PT', 'DJ55 1PT', 'DZ55 1PT', 'DN55 1CT',
+      'DN55 1IT', 'DN55 1KT', 'DN55 1MT', 'DN55 1OT', 'DN55 1VT', 'DN55 1PC', 'DN55 1PI',
+      'DN55 1PK', 'DN55 1PM', 'DN55 1PO', 'DN55 1PV',
+
+      'Q1A 1HQ', 'V1A 1HQ', 'X1A 1HQ', 'W1I 1HQ', 'W1L 1HQ', 'W1M 1HQ', 'W1N 1HQ', 'W1O 1HQ',
+      'W1P 1HQ', 'W1Q 1HQ', 'W1R 1HQ', 'W1V 1HQ', 'W1X 1HQ', 'W1Y 1HQ', 'W1Z 1HQ', 'W1A 1CQ',
+      'W1A 1IQ', 'W1A 1KQ', 'W1A 1MQ', 'W1A 1OQ', 'W1A 1VQ', 'W1A 1HC', 'W1A 1HI', 'W1A 1HK',
+      'W1A 1HM', 'W1A 1HO', 'W1A 1HV',
+
+      'QC1A 1BB', 'VC1A 1BB', 'XC1A 1BB', 'EI1A 1BB', 'EJ1A 1BB', 'EZ1A 1BB', 'EC1C 1BB',
+      'EC1D 1BB', 'EC1F 1BB', 'EC1G 1BB', 'EC1I 1BB', 'EC1J 1BB', 'EC1K 1BB', 'EC1L 1BB',
+      'EC1O 1BB', 'EC1Q 1BB', 'EC1S 1BB', 'EC1T 1BB', 'EC1U 1BB', 'EC1Z 1BB', 'EC1A 1IB',
+      'EC1A 1MB', 'EC1A 1OB', 'EC1A 1VB', 'EC1A 1BC', 'EC1A 1BI', 'EC1A 1BK', 'EC1A 1BM',
+      'EC1A 1BO', 'EC1A 1BV',
+      ]
+    postcodes.each do |postcode|
+      assert !AbstractModel.new(:postcode => postcode).valid?, "#{postcode} should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.downcase).valid?, "#{postcode.downcase} should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.gsub(' ', '')).valid?, "#{postcode} (with no spaces) should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.downcase.gsub(' ', '')).valid?, "#{postcode.downcase} (with no spaces) should be illegal."
+    end
+  end
+
+  def test_valid_postcodes
+    postcodes = [
+      'M1 1AA',
+      'M60 1NW', 
+      'CR2 6XH',
+      'DN55 1PT',
+      'W1A 1HQ',
+      'EC1A 1BB',
+      'BT9 7JL',
+      'GIR 0AA',
+      ]
+    postcodes.each do |postcode|
+      assert AbstractModel.new(:postcode => postcode).valid?, "#{postcode} should be legal."
+      assert AbstractModel.new(:postcode => postcode.downcase).valid?, "#{postcode.downcase} should be legal."
+      assert AbstractModel.new(:postcode => postcode.gsub(' ', '')).valid?, "#{postcode} (with no spaces) should be legal."
+      assert AbstractModel.new(:postcode => postcode.downcase.gsub(' ', '')).valid?, "#{postcode.downcase} (with no spaces) should be legal."
+    end
+  end
+end

data/test/rails3/models/abstract_model.rb

@@ -0,0 +1,5 @@
+class AbstractModel < ActiveRecord::Base
+
+  validates :postcode, :postcode => true
+
+end

data/test/rails3/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+gem 'rails', '3.0.5'
+
+require 'sqlite3'
+require 'test/unit'
+require 'active_record'
+require 'active_record/base'
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(
+  "adapter" =>  "sqlite3",
+  "database" => ":memory:"
+)
+
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rails3.rb')
+
+ActiveRecord::Base.send(:include,  ValidatesAsUKPostcode::Rails3)
+
+autoload :AbstractModel, File.join(File.dirname(__FILE__), 'models', 'abstract_model.rb')

data/test/rails3/validates_as_uk_postcode_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper.rb'
+
+class ValidatesAsUkPostcodeTest < Test::Unit::TestCase
+  
+  def setup
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :abstract_models, :force => true do |t|
+        t.string :postcode
+      end
+    end
+  end
+
+  def teardown
+    ActiveRecord::Base.connection.drop_table(:abstract_models)
+  end
+
+  def test_invalid_postcodes
+    postcodes = [
+      'Q1 1AA', 'V1 1AA', 'X1 1AA', 'M1 CAA', 'M1 IAA', 'M1 KAA', 'M1 MAA', 'M1 OAA', 'M1 VAA',
+
+      'Q60 1NW', 'V60 1NW', 'X60 1NW', 'M60 1CW', 'M60 1IW', 'M60 1KW', 'M60 1MW', 'M60 1OW', 
+      'M60 1VW', 'M60 1NC', 'M60 1NI', 'M60 1NK', 'M60 1NM', 'M60 1NO', 'M60 1NV', 
+
+      'QR2 6XH', 'VR2 6XH', 'XR2 6XH', 'CI2 6XH', 'CJ2 6XH', 'CZ2 6XH', 'CR2 6CH', 'CR2 6IH',
+      'CR2 6KH', 'CR2 6MH', 'CR2 6OH', 'CR2 6VH', 'CR2 6XC', 'CR2 6XI', 'CR2 6XK', 'CR2 6XM',
+      'CR2 6XO', 'CR2 6XV',
+
+      'QN55 1PT', 'VN55 1PT', 'XN55 1PT', 'DI55 1PT', 'DJ55 1PT', 'DZ55 1PT', 'DN55 1CT',
+      'DN55 1IT', 'DN55 1KT', 'DN55 1MT', 'DN55 1OT', 'DN55 1VT', 'DN55 1PC', 'DN55 1PI',
+      'DN55 1PK', 'DN55 1PM', 'DN55 1PO', 'DN55 1PV',
+
+      'Q1A 1HQ', 'V1A 1HQ', 'X1A 1HQ', 'W1I 1HQ', 'W1L 1HQ', 'W1M 1HQ', 'W1N 1HQ', 'W1O 1HQ',
+      'W1P 1HQ', 'W1Q 1HQ', 'W1R 1HQ', 'W1V 1HQ', 'W1X 1HQ', 'W1Y 1HQ', 'W1Z 1HQ', 'W1A 1CQ',
+      'W1A 1IQ', 'W1A 1KQ', 'W1A 1MQ', 'W1A 1OQ', 'W1A 1VQ', 'W1A 1HC', 'W1A 1HI', 'W1A 1HK',
+      'W1A 1HM', 'W1A 1HO', 'W1A 1HV',
+
+      'QC1A 1BB', 'VC1A 1BB', 'XC1A 1BB', 'EI1A 1BB', 'EJ1A 1BB', 'EZ1A 1BB', 'EC1C 1BB',
+      'EC1D 1BB', 'EC1F 1BB', 'EC1G 1BB', 'EC1I 1BB', 'EC1J 1BB', 'EC1K 1BB', 'EC1L 1BB',
+      'EC1O 1BB', 'EC1Q 1BB', 'EC1S 1BB', 'EC1T 1BB', 'EC1U 1BB', 'EC1Z 1BB', 'EC1A 1IB',
+      'EC1A 1MB', 'EC1A 1OB', 'EC1A 1VB', 'EC1A 1BC', 'EC1A 1BI', 'EC1A 1BK', 'EC1A 1BM',
+      'EC1A 1BO', 'EC1A 1BV',
+      ]
+    postcodes.each do |postcode|
+      assert !AbstractModel.new(:postcode => postcode).valid?, "#{postcode} should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.downcase).valid?, "#{postcode.downcase} should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.gsub(' ', '')).valid?, "#{postcode} (with no spaces) should be illegal."
+      assert !AbstractModel.new(:postcode => postcode.downcase.gsub(' ', '')).valid?, "#{postcode.downcase} (with no spaces) should be illegal."
+    end
+  end
+
+  def test_valid_postcodes
+    postcodes = [
+      'M1 1AA',
+      'M60 1NW', 
+      'CR2 6XH',
+      'DN55 1PT',
+      'W1A 1HQ',
+      'EC1A 1BB',
+      'BT9 7JL',
+      'GIR 0AA',
+      ]
+    postcodes.each do |postcode|
+      assert AbstractModel.new(:postcode => postcode).valid?, "#{postcode} should be legal."
+      assert AbstractModel.new(:postcode => postcode.downcase).valid?, "#{postcode.downcase} should be legal."
+      assert AbstractModel.new(:postcode => postcode.gsub(' ', '')).valid?, "#{postcode} (with no spaces) should be legal."
+      assert AbstractModel.new(:postcode => postcode.downcase.gsub(' ', '')).valid?, "#{postcode.downcase} (with no spaces) should be legal."
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: validates_as_uk_postcode
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 2
+  - 0
+  - 1
+  version: 2.0.1
+platform: ruby
+authors: 
+- Steven Rushe
+- David Rice
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A library for validating uk postcodes
+email: 
+- me@davidjrice.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.mdown
+files: 
+- init.rb
+- lib/rails2.rb
+- lib/rails3.rb
+- lib/validates_as_uk_postcode.rb
+- README.mdown
+has_rdoc: true
+homepage: http://github.com/davidjrice/validates_as_uk_postcode
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Validates a field is a valid UK postcode
+test_files: 
+- test/rails2/models/abstract_model.rb
+- test/rails2/test_helper.rb
+- test/rails2/validates_as_uk_postcode_test.rb
+- test/rails3/models/abstract_model.rb
+- test/rails3/test_helper.rb
+- test/rails3/validates_as_uk_postcode_test.rb