postkode 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 742e3f8d4c57bb303470cb594686b30740c6383f
+  data.tar.gz: 50571a36fcca7c7d17af15d9a1e31dc826b4fcbd
+SHA512:
+  metadata.gz: dd024b1159a87ee8fde54d37bda5ab38334ac45728c2eaa8e7117372c4a7cfbf7a949d6c344f6624105d8861cab9d12de7904a607e73e16840316a132867ae12
+  data.tar.gz: 05b33cc24a2f3738aa9d7b32f328f0452093a1a44680ac26930e2c5ed433574de88c521e97641ef411fd4ed26d7f11771884d71b745f8bf7671e4a2b863c1d79

data/lib/postkode.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+# Handles validation of UK-style postcodes
+class Postkode
+
+  # Validating UK Postcodes
+  # Correct as at 2014-09-15
+  # References below
+  # https://www.gov.uk/government/uploads/system/uploads/attachment_data/file/283357/ILRSpecification2013_14Appendix_C_Dec2012_v1.pdf
+  # http://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom#Validation
+  # Areas with only single-digit districts: BR, FY, HA, HD, HG, HR, HS, HX, JE, LD, SM, SR, WC, WN, ZE (although WC is always subdivided by a further letter, e.g. WC1A).
+  # Areas with only double-digit districts: AB, LL, SO.
+  # Areas with a district '0' (zero): BL, BS, CM, CR, FY, HA, PR, SL, SS (BS is the only area to have both a district 0 and a district 10).
+  # The following central London single-digit districts have been further divided by inserting a letter after the digit and before the space: EC1–EC4 (but not EC50), SW1, W1, WC1, WC2, and part of E1 (E1W), N1 (N1C and N1P), NW1 (NW1W) and SE1 (SE1P).
+  # The letters QVX are not used in the first position.
+  # The letters IJZ are not used in the second position.
+  # The only letters to appear in the third position are ABCDEFGHJKPSTUW when the structure starts with A9A.
+  # The only letters to appear in the fourth position are ABEHMNPRVWXY when the structure starts with AA9A.
+  # The final two letters do not use the letters CIKMOV, so as not to resemble digits or each other when hand-written.
+  # Post code sectors are one of ten digits: 0 to 9 with 0 only used once 9 has been used in a post town, save for Croydon and Newport (see above).
+
+  A1    = "[A-PR-UWYZ]"
+  A2    = "[A-HK-Y]"
+  A3    = "[A-HJKPS-UW]"
+  A4    = "[ABEHMNPRV-XY]"
+  A5    = "[ABD-HJLN-UW-Z]"
+  N     = "[0-9]"
+  AANN  = A1 + A2 + N + N     # the six possible first-part combos
+  AANA  = A1 + A2 + N + A4
+  ANA   = A1 + N + A3
+  ANN   = A1 + N + N
+  AAN   = A1 + A2 + N
+  AN    = A1 + N
+  PART_ONE = [AANN, AANA, ANA, ANN, AAN, AN].join('|')
+  PART_TWO = N + A5 + A5
+
+  NORMAL_POSTCODE_VALID         = "^(#{PART_ONE})[ ]*(#{PART_TWO})$"
+  NORMAL_POSTCODE_PATTERN       = /(#{PART_ONE})[ ]*(#{PART_TWO})/
+  NORMAL_PART_POSTCODE_PATTERN  = /[ ]*(#{PART_ONE})[ ]*/
+  NORMAL_POSTCODE_RE = Regexp.new(NORMAL_POSTCODE_VALID, Regexp::IGNORECASE)
+
+  def self.validate(string, return_parts=false)
+    return false if string.nil? || string == "" || string == false
+    result = string.match(NORMAL_POSTCODE_RE)
+    return false if result.nil?
+
+    return_parts ? result[1..2] : true
+  end
+
+  def self.get_first_section(string)
+    self.get_outcode(string)
+  end
+
+  def self.get_outcode(string)
+    found = PostcodeHelper.validate(string, true)
+    found ? found[0] : nil
+  end
+  
+  def self.get_inward(string)
+    found = PostcodeHelper.validate(string, true)
+    found ? found[1] : nil
+  end
+
+  def self.find_in_string(string)
+    res = string.scan(NORMAL_POSTCODE_PATTERN)
+    res.length>0 ? res : nil
+  end
+
+  def self.find_partial_in_string(string)
+    res = string.scan(NORMAL_PART_POSTCODE_PATTERN)
+    res.length>0 ? res : nil
+  end
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: postkode
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- K M Lawrence
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Postcode validation module
+email: keith.lawrence@upbeatproductions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/postkode.rb
+homepage: http://rubygems.org/gems/postkode
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: postkode
+test_files: []