paf 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7138b6a5f3acbe97f7f227410d48f972310a7d1a
-  data.tar.gz: ce12de78a4ca2e7f7556375de50fbc9cf143a982
+SHA256:
+  metadata.gz: 269cc685e003a0106f7a804214b07e9b092b0eaa5a83819683c7e7fe84262860
+  data.tar.gz: b07e3c71d8f2563c463ebc884a9519c45113227d377851b7971932b9007263b6
 SHA512:
-  metadata.gz: ddc67a2e7ea3e1e5493a45d37e5b80473532f3d33bd8c2a733e4bf0a6529e88caa532c8ac44f10dad0ca2dd9036f52ab12d330a0f05f686ce2407e4b5bc6db3b
-  data.tar.gz: 7d5b94a394240e8406eb53e947cb5fb010ee9cf4a3123d1d392b5f775c25338df46b71f98e827764fbb0590c5b7e97c70a0f905312d06cb60969c2f617ae397b
+  metadata.gz: 67dc68a5c3f48cfbfb276d86dbbf9bcb9aa1e9cbee76a38fb2fae3c1807060ec8866daecad2ea8aca1182db343c85debe3cd74a1865013e15034b2b67485b1a1
+  data.tar.gz: e96a0558f766afd92fcd8a09110ca83ac4783c2293c3a05585a92d4f7e3002503f153cf3d69eb00cc0af14a16b3900b1d843aa5f2ff76a221b098b2b96cc74ac

data/.rubocop.yml

@@ -1,4 +1,13 @@
 require: rubocop-rspec
 
+AllCops:
+  TargetRubyVersion: 2.4
+
 RSpec/ExampleLength:
-  Max: 25
+  Max: 25
+
+Style/EndOfLine:
+  EnforcedStyle: lf
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/README.md

@@ -1,6 +1,6 @@
 # PAF
 
-A gem to format the elements of a Royal Mail Postcode Address File entry according to the rules described in the [Royal Mail Programmer's Guide Edition 7, Version 5.0](http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
+A gem to format the elements of a Royal Mail Postcode Address File entry according to the rules described in the [Royal Mail Programmer's Guide Edition 7, Version 6.2](https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
 
 ## Installation
 
@@ -20,10 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
-May be used to format the PAF elements as an array of strings:
+May be used to format the Paf::Address elements as an array of strings:
 
 ```ruby
-Paf.to_a(
+Paf::Address.to_a(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -38,7 +38,7 @@ Paf.to_a(
 Or as a hash of strings:
 
 ```ruby
-Paf.to_h(
+Paf::Address.to_h(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -57,7 +57,7 @@ Paf.to_h(
 Or as a single string:
 
 ```ruby
-Paf.to_s(
+Paf::Address.to_s(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -69,10 +69,10 @@ Paf.to_s(
 '1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
 ```
 
-Or from a Paf instance:
+Or from a Paf::Address instance:
 
 ```ruby
-paf = Paf.new(
+address = Paf::Address.new(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -80,11 +80,11 @@ paf = Paf.new(
   post_town: 'HIGH WYCOMBE',
   postcode: 'HP10 8LS'
 )
-paf.to_a
+address.to_a
 
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 
-paf = Paf.new(
+address = Paf::Address.new(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -92,7 +92,7 @@ paf = Paf.new(
   post_town: 'HIGH WYCOMBE',
   postcode: 'HP10 8LS'
 )
-paf.to_h
+address.to_h
 
 {
   lines: ['1-2 NURSERY LANE', 'PENN'],
@@ -100,7 +100,7 @@ paf.to_h
   postcode: 'HP10 8LS'
 }
 
-paf = Paf.new(
+address = Paf::Address.new(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -108,7 +108,7 @@ paf = Paf.new(
   post_town: 'HIGH WYCOMBE',
   postcode: 'HP10 8LS'
 )
-paf.to_s
+address.to_s
 
 '1-2 NURSERY LANE, PENN, HIGH WYCOMBE. HP10 8LS'
 ```

data/lib/paf/address.rb

@@ -0,0 +1,39 @@
+require 'paf/attribute'
+require 'paf/formattable'
+
+module Paf
+  # Base class from the elements of a UK Royal Mail Postcode Address File entry
+  class Address
+    include Paf::Attribute
+    include Paf::Formattable
+
+    attr_accessor(*attrs)
+    private(*attrs.map { |attr| "#{attr}=" }) # rubocop:disable Style/AccessModifierDeclarations
+
+    def initialize(args)
+      args.each { |k, v| send("#{k}=", v) }
+    end
+
+    # PO Box number prepended with the string PO BOX
+    def po_box
+      "PO BOX #{po_box_number}" unless po_box_number.vacant?
+    end
+
+    # Dependent thoroughfare name and descriptor
+    def dependent_thoroughfare
+      concatenated(self.class.dependent_thoroughfare_attrs)
+    end
+
+    # Thoroughfare name and descriptor
+    def thoroughfare
+      concatenated(self.class.thoroughfare_attrs)
+    end
+
+    private
+
+    def concatenated(attrs)
+      value = attrs.map { |attr| send(attr) }.condense(' ')
+      value unless value.vacant?
+    end
+  end
+end

data/lib/paf/array_formatter.rb

@@ -1,6 +1,6 @@
 require 'paf/formatter'
 
-class Paf
+module Paf
   # Processing to format a PAF entry as an array
   class ArrayFormatter < Formatter
     def format(paf)

data/lib/paf/attribute.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   # Basic attributes or elements that make up a PAF entry
   module Attribute
     def self.included(base)

data/lib/paf/core_ext/array.rb

@@ -1,6 +1,6 @@
 require 'paf/core_ext/string'
 
-class Paf
+module Paf
   module CoreExt
     # Extend the core Array class with PAF specific processing
     module Array

data/lib/paf/core_ext/object.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   module CoreExt
     # Extend the core Object class with PAF specific processing
     module Object

data/lib/paf/core_ext/string.rb

@@ -1,13 +1,32 @@
-class Paf
+module Paf
   module CoreExt
     # Extend the core String class with PAF specific processing
     module String
+      def exception_i?
+        !/\A\d.*\d\z/.match(self).nil?
+      end
+
+      def exception_ii?
+        !/\A\d[A-Za-z]\z|\A\d.*\d[A-Za-z]\z/.match(self).nil?
+      end
+
+      def exception_iii?
+        !/\A\S\z/.match(self).nil?
+      end
+
       def exception?
         !/^(.|[\d][[:alpha:]]|[\d].*?[\d][[:alpha:]]?)$/.match(self).nil?
       end
 
       def split_exception?
-        last_word.exception? && /^\d+$/.match(last_word).nil?
+        (last_word.exception_i? || last_word.exception_ii?) &&
+          /^\d+$/.match(last_word).nil? &&
+          !but_last_word.known_building_type? &&
+          !penultimate_word.known_split_building_type?
+      end
+
+      def penultimate_word
+        but_last_word.last_word
       end
 
       def last_word
@@ -17,6 +36,18 @@ class Paf
       def but_last_word
         self[0...rindex(' ')]
       end
+
+      def known_building_type?
+        [
+          'BACK OF', 'BLOCK', 'BLOCKS', 'BUILDING', 'MAISONETTE', 'MAISONETTES', 'REAR OF',
+          'SHOP', 'SHOPS', 'STALL', 'STALLS', 'SUITE', 'SUITES', 'UNIT', 'UNITS',
+          'FLAT', 'FLATS', 'PO BOX'
+        ].include?(self)
+      end
+
+      def known_split_building_type?
+        ['UNIT'].include?(self)
+      end
     end
   end
 end

data/lib/paf/formattable.rb

@@ -2,7 +2,7 @@ require 'paf/array_formatter'
 require 'paf/hash_formatter'
 require 'paf/string_formatter'
 
-class Paf
+module Paf
   # Processing to format a PAF entry
   module Formattable
     attr_accessor :formatter, :concatenation_indicator
@@ -32,6 +32,7 @@ class Paf
 
       def to_s(*args)
         return super if args.empty?
+
         new(args[0]).to_s
       end
     end

data/lib/paf/formatter.rb

@@ -1,6 +1,6 @@
 require 'paf/lineable'
 
-class Paf
+module Paf
   # Processing to format a PAF entry
   class Formatter
     def self.format(paf)
@@ -15,6 +15,7 @@ class Paf
     def method_missing(method, *args)
       return @paf.send(method, *args) if @paf.respond_to?(method)
       return @paf.class.send(method, *args) if @paf.class.respond_to?(method)
+
       super
     end
 

data/lib/paf/hash_formatter.rb

@@ -1,6 +1,6 @@
 require 'paf/formatter'
 
-class Paf
+module Paf
   # Processing to format a PAF entry as a hash
   class HashFormatter < Formatter
     def format(paf)

data/lib/paf/lineable.rb

@@ -1,7 +1,7 @@
 require 'paf/premises'
 require 'paf/thoroughfare_locality'
 
-class Paf
+module Paf
   # Processing to format PAF entry lines
   module Lineable
     def self.extended(base)

data/lib/paf/premises/common.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   module Premises
     # Common processing for premises elements of a PAF entry
     module Common
@@ -19,6 +19,10 @@ class Paf
       def name_and_thoroughfare_or_locality
         "#{building_name} #{first_thoroughfare_or_locality}"
       end
+
+      def name_last_word_and_thoroughfare_or_locality
+        "#{building_name.last_word} #{first_thoroughfare_or_locality}"
+      end
     end
   end
 end

data/lib/paf/premises/rule000.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 1
     module Rule000

data/lib/paf/premises/rule001.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 2
     module Rule001

data/lib/paf/premises/rule010.rb

@@ -1,9 +1,10 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 3
     module Rule010
       def premises
         return [name_and_thoroughfare_or_locality] if building_name.exception?
+
         if building_name.split_exception?
           return [
             building_name.but_last_word,
@@ -18,10 +19,6 @@ class Paf
       def premises_includes_first_thoroughfare_or_locality?
         building_name.exception? || building_name.split_exception?
       end
-
-      def name_last_word_and_thoroughfare_or_locality
-        "#{building_name.last_word} #{first_thoroughfare_or_locality}"
-      end
     end
   end
 end

data/lib/paf/premises/rule011.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 4
     module Rule011

data/lib/paf/premises/rule100.rb

@@ -0,0 +1,22 @@
+module Paf
+  module Premises
+    # Processing for premises elements of a PAF entry under Rule X
+    module Rule100
+      def premises
+        return [sub_name_and_thoroughfare_or_locality] if sub_building_name.exception?
+
+        [sub_building_name]
+      end
+
+      private
+
+      def premises_includes_first_thoroughfare_or_locality?
+        sub_building_name.exception?
+      end
+
+      def sub_name_and_thoroughfare_or_locality
+        "#{sub_building_name} #{first_thoroughfare_or_locality}"
+      end
+    end
+  end
+end

data/lib/paf/premises/rule101.rb

@@ -1,9 +1,10 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 5
     module Rule101
       def premises
         return [number_sub_name_and_thoroughfare_or_locality] if concatenate?
+
         [sub_building_name, number_and_thoroughfare_or_locality]
       end
 

data/lib/paf/premises/rule110.rb

@@ -1,18 +1,28 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 6
     module Rule110
       def premises
+        if sub_building_name.exception? && building_name.split_exception?
+          return [sub_and_building_name_but_last_word, name_last_word_and_thoroughfare_or_locality]
+        end
         return [sub_name_and_name] if sub_building_name.exception?
-        return [sub_building_name, name_and_thoroughfare_or_locality] if
-          building_name.exception?
+        return [sub_building_name, name_and_thoroughfare_or_locality] if building_name.exception?
+        if building_name.split_exception?
+          return [sub_building_name, building_name.but_last_word, name_last_word_and_thoroughfare_or_locality]
+        end
+
         [sub_building_name, building_name]
       end
 
       private
 
       def premises_includes_first_thoroughfare_or_locality?
-        !sub_building_name.exception? && building_name.exception?
+        building_name.split_exception? || (!sub_building_name.exception? && building_name.exception?)
+      end
+
+      def sub_and_building_name_but_last_word
+        "#{sub_building_name} #{building_name.but_last_word}"
       end
     end
   end

data/lib/paf/premises/rule111.rb

@@ -1,17 +1,23 @@
-class Paf
+module Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 7
     module Rule111
       def premises
+        return [sub_name_comma_name] if building_number.zero?
         return [sub_name_and_name, number_and_thoroughfare_or_locality] if
           sub_building_name.exception?
+
         [sub_building_name, building_name, number_and_thoroughfare_or_locality]
       end
 
       private
 
       def premises_includes_first_thoroughfare_or_locality?
-        true
+        !building_number.zero?
+      end
+
+      def sub_name_comma_name
+        "#{sub_building_name}, #{building_name}"
       end
     end
   end

data/lib/paf/premises.rb

@@ -1,6 +1,6 @@
 require 'paf/premises/common'
 
-class Paf
+module Paf
   # Determine which premises rule is applicable
   module Premises
     include Common

data/lib/paf/string_formatter.rb

@@ -1,6 +1,6 @@
 require 'paf/formatter'
 
-class Paf
+module Paf
   # Processing to format a PAF entry as a string
   class StringFormatter < Formatter
     def format(paf)

data/lib/paf/thoroughfare_locality.rb

@@ -1,4 +1,4 @@
-class Paf
+module Paf
   # Processing for thoroughfare and locality elements of a PAF entry
   module ThoroughfareLocality
     def thoroughfares_and_localities

data/lib/paf/version.rb

@@ -1,4 +1,4 @@
 # PAF gem version
-class Paf
-  VERSION = '0.5.0'.freeze
+module Paf
+  VERSION = '1.0.0'.freeze
 end

data/lib/paf.rb

@@ -1,41 +1,9 @@
 require 'paf/version'
-require 'paf/attribute'
-require 'paf/formattable'
+require 'paf/address'
 require 'paf/core_ext/object'
 require 'paf/core_ext/string'
 require 'paf/core_ext/array'
 
-# Base class from the elements of a UK Royal Mail Postcode Address File entry
-class Paf
-  include Paf::Attribute
-  include Paf::Formattable
-
-  attr_accessor(*attrs)
-  private(*attrs.map { |attr| "#{attr}=" })
-
-  def initialize(args)
-    args.each { |k, v| send("#{k}=", v) }
-  end
-
-  # PO Box number prepended with the string PO BOX
-  def po_box
-    "PO BOX #{po_box_number}" unless po_box_number.vacant?
-  end
-
-  # Dependent thoroughfare name and descriptor
-  def dependent_thoroughfare
-    concatenated(self.class.dependent_thoroughfare_attrs)
-  end
-
-  # Thoroughfare name and descriptor
-  def thoroughfare
-    concatenated(self.class.thoroughfare_attrs)
-  end
-
-  private
-
-  def concatenated(attrs)
-    value = attrs.map { |attr| send(attr) }.condense(' ')
-    value unless value.vacant?
-  end
+# Base module for UK Royal Mail Postcode Address File processing
+module Paf
 end

data/paf.gemspec

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paf/version'
 
@@ -12,12 +10,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/drabjay/paf'
 
   spec.summary       = 'Royal Mail Postcode Address File (PAF) Formatter'
-  spec.description   = <<-EOF
+  spec.description   = <<-DESC
     A gem to format the elements of a Royal Mail Postcode Address File entry
     according to the rules described in the Royal Mail Programmer's Guide
-    Edition 7, Version 5.0
-    (http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
-  EOF
+    Edition 7, Version 6.2
+    (https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
+  DESC
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -27,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4'
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'rspec', '~> 3.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paf
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - John Bard
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-07-08 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,8 +83,8 @@ dependencies:
 description: |2
       A gem to format the elements of a Royal Mail Postcode Address File entry
       according to the rules described in the Royal Mail Programmer's Guide
-      Edition 7, Version 5.0
-      (http://www.royalmail.com/sites/default/files/docs/pdf/programmers_guide_edition_7_v5.pdf)
+      Edition 7, Version 6.2
+      (https://www.poweredbypaf.com/wp-content/uploads/2024/11/Latest-Programmers_guide_Edition-7-Version-6-2.pdf)
 email:
 - johnbard@globalnet.co.uk
 executables: []
@@ -103,6 +103,7 @@ files:
 - bin/console
 - bin/setup
 - lib/paf.rb
+- lib/paf/address.rb
 - lib/paf/array_formatter.rb
 - lib/paf/attribute.rb
 - lib/paf/core_ext/array.rb
@@ -118,6 +119,7 @@ files:
 - lib/paf/premises/rule001.rb
 - lib/paf/premises/rule010.rb
 - lib/paf/premises/rule011.rb
+- lib/paf/premises/rule100.rb
 - lib/paf/premises/rule101.rb
 - lib/paf/premises/rule110.rb
 - lib/paf/premises/rule111.rb
@@ -129,7 +131,7 @@ homepage: https://github.com/drabjay/paf
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,16 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Royal Mail Postcode Address File (PAF) Formatter
 test_files: []