uk_postcode 2.0.0.alpha → 2.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2918ca3cc4b63e92b62146b63e57897b31166f0
-  data.tar.gz: c6689e38f4f8e4583d74f9bf06c5c617a16f66b9
+  metadata.gz: 8fa8f457586bb74272addb1cc2680a90718688c4
+  data.tar.gz: 232794c36025c24b7d9c7051c7bb37d20daa3ba2
 SHA512:
-  metadata.gz: ea95753c01bc600400b6223b5da95957170db8d1e39f10b80f045e5379f248235a33e38b558c64f91b9c3548d616414dfac2f35172cc18b1d29da372418df458
-  data.tar.gz: d34d691408d759e967cf626aecec25f92bbff1a10507bff46a082ca96a5ab37e44a2ad185116998a6f4d040c68bcdea1863cbf7487541dbf6928f40ec2b3a8f4
+  metadata.gz: 5512f266cbb5ecd1de324af09bb07b0eb0600214a75fbc04c4467eb3887a5fc9363479dde70722161e4f6c9667940bf2baf357ef6001f46e2f97e783e83460ab
+  data.tar.gz: 5631dca91102f422254fad3672836cb92ef54834284b32346eecaf90d90f38fb88ab807b9e84e7d2125d0a58aaf037a8b21b2639a766ae3f643b84207eee179e

data/COPYING.txt

@@ -22,4 +22,7 @@ The regular expressions in lookup.rb are generated from the ONS Postcode
 Directory under the terms of the Open Government Licence (OGL). The following
 source accreditation is given to fulfil the terms of this licence.
 
+Contains public sector information licensed under the Open Government Licence
+v3.0.
+
 http://www.ons.gov.uk/ons/guide-method/geography/products/postcode-directories/-nspp-/index.html

data/lib/uk_postcode/abstract_postcode.rb

@@ -0,0 +1,36 @@
+module UKPostcode
+  class AbstractPostcode
+    NotImplemented = Class.new(StandardError)
+
+    def self.parse(_str)
+      raise NotImplemented
+    end
+
+    def initialize(*)
+      raise NotImplemented
+    end
+
+    def area;     nil; end
+    def district; nil; end
+    def sector;   nil; end
+    def unit;     nil; end
+    def incode;   nil; end
+    def outcode;  nil; end
+
+    def to_s
+      raise NotImplemented
+    end
+
+    def full?
+      false
+    end
+
+    def valid?
+      false
+    end
+
+    def country
+      :unknown
+    end
+  end
+end

data/lib/uk_postcode/geographic_postcode.rb

@@ -1,4 +1,5 @@
 require "uk_postcode/country_finder"
+require "uk_postcode/abstract_postcode"
 
 module UKPostcode
 
@@ -8,14 +9,14 @@ module UKPostcode
   # Despite the name, it also handles non-geographic postcodes that follow the
   # geographic format.
   #
-  class GeographicPostcode
-    PATTERN = %r{
-      \A ( [A-PR-UWYZ01][A-HJ-Z0]? )        # area
+  class GeographicPostcode < AbstractPostcode
+    PATTERN = /
+      \A ( [A-PR-UWYZ01][A-HJ-Z0]? )     # area
       (?: ( [0-9IO][0-9A-HJKMNPR-YIO]? ) # district
         (?: \s* ( [0-9IO] )              # sector
           ( [ABD-HJLNPQ-Z]{2} )? )? )?   # unit
       \Z
-    }ix
+    /ix
 
     # Attempts to parse the postcode given in str, and returns an instance of
     # GeographicPostcode on success, or nil on failure.
@@ -74,7 +75,7 @@ module UKPostcode
     end
 
     # Find the country associated with the postcode. Possible values are
-    # :england, :scotland, :wales, :northern_ireland, :isle_of_man, 
+    # :england, :scotland, :wales, :northern_ireland, :isle_of_man,
     # :channel_islands, or :unknown.
     #
     # Note that, due to limitations in the underlying data, the country might
@@ -85,6 +86,7 @@ module UKPostcode
     end
 
   private
+
     def letters(str)
       return nil unless str
       str.upcase.tr("10", "IO")

data/lib/uk_postcode/giro_postcode.rb

@@ -1,4 +1,5 @@
 require "singleton"
+require "uk_postcode/abstract_postcode"
 
 module UKPostcode
 
@@ -8,7 +9,7 @@ module UKPostcode
   # area, district, sector, and unit all return nil, because this postcode
   # does not meaningfully possess these distinctions.
   #
-  class GiroPostcode
+  class GiroPostcode < AbstractPostcode
     include Singleton
 
     PATTERN = /\A G[I1]R \s* [0O]AA \z/ix
@@ -20,7 +21,8 @@ module UKPostcode
       PATTERN.match(str.strip) ? instance : nil
     end
 
-    attr_reader :area, :district, :sector, :unit
+    def initialize
+    end
 
     # The left-hand part of the postcode, always "GIR".
     #

data/lib/uk_postcode/invalid_postcode.rb

@@ -1,3 +1,5 @@
+require "uk_postcode/abstract_postcode"
+
 module UKPostcode
 
   # InvalidPostcode is a singleton null object returned by UKPostcode.parse
@@ -5,7 +7,7 @@ module UKPostcode
   #
   # The sub-fields of the postcode (outcode, area, etc.) are all nil.
   #
-  class InvalidPostcode
+  class InvalidPostcode < AbstractPostcode
     def self.parse(str)
       new(str)
     end
@@ -14,25 +16,11 @@ module UKPostcode
       @input = input
     end
 
-    attr_reader :area, :district, :sector, :unit, :incode, :outcode
-
     # Returns the literal string supplied at initialisation. This may be
     # helpful when returning erroneous input to the user.
     #
     def to_s
       @input
     end
-
-    def full?
-      false
-    end
-
-    def valid?
-      false
-    end
-
-    def country
-      :unknown
-    end
   end
 end

data/lib/uk_postcode/parser_chain.rb

@@ -0,0 +1,15 @@
+module UKPostcode
+  class ParserChain
+    def initialize(*parsers)
+      @parsers = parsers
+    end
+
+    def parse(str)
+      @parsers.each do |klass|
+        parsed = klass.parse(str)
+        return parsed if parsed
+      end
+      nil
+    end
+  end
+end

data/lib/uk_postcode/version.rb

@@ -1,3 +1,3 @@
 module UKPostcode
-  VERSION = "2.0.0.alpha"
+  VERSION = "2.0.0.beta"
 end

data/lib/uk_postcode.rb

@@ -2,18 +2,20 @@ require "uk_postcode/version"
 require "uk_postcode/geographic_postcode"
 require "uk_postcode/giro_postcode"
 require "uk_postcode/invalid_postcode"
+require "uk_postcode/parser_chain"
 
 module UKPostcode
-  module_function
+  DEFAULT_PARSER_CHAIN = ParserChain.new(
+    GiroPostcode, GeographicPostcode, InvalidPostcode
+  )
 
   # Attempt to parse the string str as a postcode. Returns an object
   # representing the postcode, or an InvalidPostcode if the string cannot be
   # parsed.
   #
   def parse(str)
-    [GiroPostcode, GeographicPostcode, InvalidPostcode].each do |klass|
-      pc = klass.parse(str)
-      return pc if pc
-    end
+    DEFAULT_PARSER_CHAIN.parse(str)
   end
+
+  module_function :parse
 end

data/test/full_postcode_test.rb

@@ -15,21 +15,20 @@ describe "Full set of postcodes" do
   }
 
   it "should correctly parse and find the country of every extant postcode" do
-    if File.exist?(CSV_PATH)
-      CSV.foreach(CSV_PATH, headers: [:postcode, :country]) do |row|
-        outcode = row[:postcode][0,4].strip
-        incode  = row[:postcode][4,3].strip
-        country = COUNTRIES.fetch(row[:country])
+    skip "Skipping because SKIP_FULL_TEST was set" if ENV['SKIP_FULL_TEST']
+    skip "Skipping because #{CSV_PATH} does not exist" unless File.exist?(CSV_PATH)
 
-        postcode = UKPostcode.parse(outcode + incode)
+    CSV.foreach(CSV_PATH, headers: [:postcode, :country]) do |row|
+      outcode = row[:postcode][0, 4].strip
+      incode  = row[:postcode][4, 3].strip
+      country = COUNTRIES.fetch(row[:country])
 
-        postcode.wont_be_nil
-        postcode.outcode.must_equal outcode
-        postcode.incode.must_equal incode
-        postcode.country.must_equal country
-      end
-    else
-      skip "Skipping because #{CSV_PATH} does not exist"
+      postcode = UKPostcode.parse(outcode + incode)
+
+      postcode.wont_be_nil
+      postcode.outcode.must_equal outcode
+      postcode.incode.must_equal incode
+      postcode.country.must_equal country
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uk_postcode
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha
+  version: 2.0.0.beta
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2015-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -33,11 +33,13 @@ files:
 - COPYING.txt
 - README.md
 - lib/uk_postcode.rb
+- lib/uk_postcode/abstract_postcode.rb
 - lib/uk_postcode/country_finder.rb
 - lib/uk_postcode/country_lookup.rb
 - lib/uk_postcode/geographic_postcode.rb
 - lib/uk_postcode/giro_postcode.rb
 - lib/uk_postcode/invalid_postcode.rb
+- lib/uk_postcode/parser_chain.rb
 - lib/uk_postcode/tree.rb
 - lib/uk_postcode/version.rb
 - test/country_finder_test.rb