postman_paf 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c9d116c12727c20da2d3ff68940d59f958e4d3ad45a75a533c39d544d8e8c0
-  data.tar.gz: a8bb01aacc41ab7fa5fe07b09b236801438e9f98cbf2df5307ff793667c5ce02
+  metadata.gz: 4ada41fa8df5879ed93ec3f087cadd6ad5366f17d4454500c69251aac208a18f
+  data.tar.gz: 247ff8b4e797883415ca63345543074cdf82380453317bb5eb47dfc42708c96d
 SHA512:
-  metadata.gz: 3232296fa683d32a639cd1d21793881bbcd3664c4d8cd782cb023f34b16d9d58d65f1b062132c7889c42bdfb0f557a695382bc18f83573a35bf6ff1e3ff5647c
-  data.tar.gz: 5fe99352caea2a57198b7614ad2348ecdaf2a34d15fd882f53015664c128f4860057cae955ce43c4a9e7cf4aff9051e950ca1093b91f20816623a09ae250defa
+  metadata.gz: 77ed4809072adf72999c5260c08c0549e73db0efb80dc909545751400c6ede7a942d036b21e00a09804a84b18f4db1c404e458b88c575d1b1f2815688c7a1fe5
+  data.tar.gz: 9e5d453fe856805bbe3ad15efc31970a0fab223c5e3cbe21f1f5ce177a51471ba8f6492b0af1d20c7f692b7863ae8045c61969ff40ae806564ea0497f86f34b9

data/README.md

@@ -1,6 +1,6 @@
 # PostmanPAF
 
-Convert PAF (Postcode Address File) addresses to a printable format for an envelope or address label.
+Converts Royal Mail PAF (Postcode Address File) addresses to a printable format for an envelope or address label.
 
 This is an unofficial gem to apply Royal Mail Rules & Exceptions when converting PAF addresses. 
 Based on the [Royal Mail Programmers' Guide](https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf), 'Formatting a PAF address for printing' (page 27).

data/lib/postman_paf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PostmanPAF
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/postman_paf.rb

@@ -4,9 +4,27 @@ require 'json'
 require 'logger'
 require 'simple_symbolize'
 
-Dir['./lib/postman_paf/**/*.rb'].each do |file|
-  require file
-end
+require_relative 'postman_paf/exceptions/exceptions'
+require_relative 'postman_paf/exceptions/last_part_exceptions'
+require_relative 'postman_paf/exceptions/rule_3_exceptions'
+require_relative 'postman_paf/exceptions/rule_5_and_7_exceptions'
+require_relative 'postman_paf/exceptions/rule_6_exceptions'
+require_relative 'postman_paf/exceptions/which_exception'
+require_relative 'postman_paf/rules/address_builder'
+require_relative 'postman_paf/rules/building_number'
+require_relative 'postman_paf/rules/rule_1'
+require_relative 'postman_paf/rules/rule_2'
+require_relative 'postman_paf/rules/rule_3'
+require_relative 'postman_paf/rules/rule_4'
+require_relative 'postman_paf/rules/rule_5'
+require_relative 'postman_paf/rules/rule_6'
+require_relative 'postman_paf/rules/rule_7'
+require_relative 'postman_paf/rules/rules'
+require_relative 'postman_paf/rules/which_rule'
+require_relative 'postman_paf/converter'
+require_relative 'postman_paf/printable_address'
+require_relative 'postman_paf/validator'
+require_relative 'postman_paf/version'
 
 module PostmanPAF
   # Initialise Logger output.

data/postman_paf.gemspec

@@ -8,26 +8,22 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Driver and Vehicle Licensing Agency (DVLA)', 'Mark Isaac']
   spec.email         = ['mark.isaac@dvla.gov.uk']
 
-  spec.summary       = 'Convert PAF (Postcode Address File) addresses to a printable format for an envelope or address label.'
+  spec.summary       = 'Converts Royal Mail PAF (Postcode Address File) addresses to a printable format.'
 
   spec.description   = <<-DESCRIPTION
-    Unofficial gem to apply Royal Mail Rules & Exceptions to PAF (Postcode Address File) addresses when converting to a printable format. Based on the Royal Mail Programmers' Guide:
-    https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf,'Formatting a PAF address for printing' (page 27). Addresses conversions
-    aim to resemble addresses returned by Royal Mail Find a PostCode as accurately as possible: https://www.royalmail.com/find-a-postcode.
+    Converts Royal Mail PAF (Postcode Address File) addresses to a printable format for an envelope or address label.
+
+    This is an unofficial gem to apply Royal Mail Rules & Exceptions when converting PAF addresses.
+
+    Based on the Royal Mail Programmers' Guide: https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf, 'Formatting a PAF address for printing' (page 27).
+
+    Conversions aim to resemble addresses returned by Royal Mail Find a PostCode as accurately as possible: https://www.royalmail.com/find-a-postcode.
   DESCRIPTION
 
-  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  spec.homepage = 'https://github.com/dvla/postman-paf'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.0'
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
-
-  # spec.metadata['homepage_uri'] = spec.homepage
-  # spec.metadata['source_code_uri'] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata['changelog_uri'] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
@@ -35,11 +31,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
   spec.add_development_dependency 'hash_miner', '~> 1.1'
   spec.add_development_dependency 'pry', '~> 0.14'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postman_paf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Driver and Vehicle Licensing Agency (DVLA)
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -138,9 +138,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 description: |2
-      Unofficial gem to apply Royal Mail Rules & Exceptions to PAF (Postcode Address File) addresses when converting to a printable format. Based on the Royal Mail Programmers' Guide:
-      https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf,'Formatting a PAF address for printing' (page 27). Addresses conversions
-      aim to resemble addresses returned by Royal Mail Find a PostCode as accurately as possible: https://www.royalmail.com/find-a-postcode.
+      Converts Royal Mail PAF (Postcode Address File) addresses to a printable format for an envelope or address label.
+
+      This is an unofficial gem to apply Royal Mail Rules & Exceptions when converting PAF addresses.
+
+      Based on the Royal Mail Programmers' Guide: https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf, 'Formatting a PAF address for printing' (page 27).
+
+      Conversions aim to resemble addresses returned by Royal Mail Find a PostCode as accurately as possible: https://www.royalmail.com/find-a-postcode.
 email:
 - mark.isaac@dvla.gov.uk
 executables: []
@@ -183,7 +187,7 @@ files:
 - lib/postman_paf/validator.rb
 - lib/postman_paf/version.rb
 - postman_paf.gemspec
-homepage: 
+homepage: https://github.com/dvla/postman-paf
 licenses:
 - MIT
 metadata: {}
@@ -205,6 +209,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
-summary: Convert PAF (Postcode Address File) addresses to a printable format for an
-  envelope or address label.
+summary: Converts Royal Mail PAF (Postcode Address File) addresses to a printable
+  format.
 test_files: []