postman_paf 0.3.0

data/lib/postman_paf/validator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PostmanPAF
+  # Validator class for user input. Verifies input contains required PAF
+  #   address elements for mailing.
+  # @see https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf Page 12
+  class Validator
+    POST_TOWN = 'postTown'
+    POSTCODE = 'postcode'
+
+    # @param input the object to be validated.
+    # @return Validator object.
+    def initialize(input:)
+      @input = input
+    end
+
+    # Verifies input meets minimum requirements for address conversion.
+    # @raise [ArgumentError] if input is not a Hash or Array.
+    # @return [nil] if Hash or Array meet address conversion
+    #   requirements.
+    def validate
+      if @input.is_a?(Hash)
+        validate_single_address
+      elsif @input.is_a?(Array) && @input.size.positive?
+        validate_multiple_addresses
+      else
+        raise ArgumentError, 'Conversion input must be either a hash containing data for an address, or an array of hashes each containing data for an address'
+      end
+      nil
+    end
+
+    private
+
+    # Verifies input of single Hash contains required address elements.
+    # @raise [ArgumentError] if Hash is missing required address elements.
+    # @return [nil] if Hash contains required address elements.
+    def validate_single_address
+      raise ArgumentError, "Hash of address data must contain 'postTown' and 'postcode' keys" unless criteria_for_paf_address?(hash: @input)
+    end
+
+    # Verifies input of Array contains a Hash as each element and that
+    #   each Hash contains required address elements.
+    # @raise [ArgumentError] if an Array elements is not a Hash.
+    # @raise [ArgumentError] if Hash element is missing required
+    #   address elements.
+    # @return [nil] if each Array element is a Hash which contains
+    #   required PAF address elements.
+    def validate_multiple_addresses
+      @input.each do |element|
+        raise ArgumentError, 'Each address element in the array must be a hash' unless element.is_a?(Hash)
+
+        raise ArgumentError, "Hash of address data must contain 'postTown' and 'postcode' keys" unless criteria_for_paf_address?(hash: element)
+      end
+    end
+
+    # Checks if postTown and postcode keys exist within a Hash
+    #   (Ruby or JSON Hash syntax).
+    # @param hash [Hash] the Hash object.
+    # @return [Boolean] whether both keys were found.
+    def criteria_for_paf_address?(hash:)
+      hash = hash.transform_keys { |k| SimpleSymbolize.camelize(k).to_s }
+      hash.keys.include?(POST_TOWN) && hash.keys.include?(POSTCODE)
+    end
+  end
+end

data/lib/postman_paf/version.rb

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

data/lib/postman_paf.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'logger'
+require 'simple_symbolize'
+
+Dir['./lib/postman_paf/**/*.rb'].each do |file|
+  require file
+end
+
+module PostmanPAF
+  # Initialise Logger output.
+  LOG = Logger.new($stdout)
+  LOG.formatter = proc { |severity, datetime, _progname, msg| "[#{datetime}  #{severity}  PostmanPAF] -- #{msg}\n" }
+
+  # Converts PAF address data to printable format based on Royal Mail
+  #   rules and exceptions.
+  # @see https://www.poweredbypaf.com/wp-content/uploads/2017/07/Latest-Programmers_guide_Edition-7-Version-6.pdf
+  # @param input [Hash, Array<Hash>] PAF address data.
+  # @param max_line_length [Integer, String] optional argument to set
+  #   max length of printable address lines 1-5.
+  # @param logging [Boolean] optional argument to log rule and
+  #   exception(s) applied during conversion.
+  # @raises [ArgumentError] if invalid input given.
+  # @return [Hash, Array<Hash>, nil] converted address data, nil if
+  #   conversion data ineligible for conversion.
+  def self.convert(input, max_line_length: nil, logging: false)
+    Validator.new(input: input).validate
+
+    Converter.new(paf_address_data: input, max_line_length: max_line_length, logging: logging).convert
+  end
+end

data/postman_paf.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'lib/postman_paf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'postman_paf'
+  spec.version       = PostmanPAF::VERSION
+  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.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.
+  DESCRIPTION
+
+  # spec.homepage = "TODO: Put your gem's website or public repo URL here."
+  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
+  spec.bindir        = 'exe'
+  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'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.54'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'simplecov-console', '~> 0.9'
+
+  spec.add_runtime_dependency 'simple_symbolize', '~> 4.0'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: postman_paf
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Driver and Vehicle Licensing Agency (DVLA)
+- Mark Isaac
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hash_miner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simple_symbolize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- mark.isaac@dvla.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/gem-test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/postman_paf.rb
+- lib/postman_paf/converter.rb
+- lib/postman_paf/exceptions/exceptions.rb
+- lib/postman_paf/exceptions/last_part_exceptions.rb
+- lib/postman_paf/exceptions/rule_3_exceptions.rb
+- lib/postman_paf/exceptions/rule_5_and_7_exceptions.rb
+- lib/postman_paf/exceptions/rule_6_exceptions.rb
+- lib/postman_paf/exceptions/which_exception.rb
+- lib/postman_paf/printable_address.rb
+- lib/postman_paf/rules/address_builder.rb
+- lib/postman_paf/rules/building_number.rb
+- lib/postman_paf/rules/rule_1.rb
+- lib/postman_paf/rules/rule_2.rb
+- lib/postman_paf/rules/rule_3.rb
+- lib/postman_paf/rules/rule_4.rb
+- lib/postman_paf/rules/rule_5.rb
+- lib/postman_paf/rules/rule_6.rb
+- lib/postman_paf/rules/rule_7.rb
+- lib/postman_paf/rules/rules.rb
+- lib/postman_paf/rules/which_rule.rb
+- lib/postman_paf/validator.rb
+- lib/postman_paf/version.rb
+- postman_paf.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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.
+test_files: []