paf 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a90b60fc8b43ca2ff87c48f4f9f18d4a7e25e3fa
-  data.tar.gz: 2b6baa0e31314fd255162ad545485c21079e68f3
+  metadata.gz: 6dd17987d33a92bdf4f5fe218b0ad72c570add4f
+  data.tar.gz: d8c7802c5b9bf6cd4cd02dbd6b56d33a8d89629d
 SHA512:
-  metadata.gz: 236d1dbf47af7c6bf6f0e4dc90fb6bd9a4955d932e12e184dea32d01a768eaa900ae04483f295f09f14c24fd20b24c66c29a6694527349d52a8e6abd1f1025e7
-  data.tar.gz: 26a859d3c1085e3722bb2641ca2ce72f0cb2b321747b68a175cacbad188717db4f00a3d3350f82c684df4f36f14e4371fc3788059219cf9b6b5665a67bfed1b6
+  metadata.gz: a38a0e2a2922cbaa10f98adfb594ae3abdddf7283d0cc08c4266ab88ecfa0de8cac08f25a185aa8b32325f7c484d3fb0a3fcc083ad7bbd6b5362d8b7a643ea8d
+  data.tar.gz: b3ba1f6afaca1d5b4654f0186f99e2465be036550310757a15090fae9aee65d2ce14e0cec066e14043bc84f4ccb53348df8115c5c9b79e5cb279d0b9bba259d2

data/lib/paf.rb

@@ -2,7 +2,7 @@ require 'paf/version'
 require 'paf/attribute'
 require 'paf/formattable'
 
-# BCore class from the elements of a UK Royal Mail Postcode Address File entry
+# Base class from the elements of a UK Royal Mail Postcode Address File entry
 class Paf
   include Paf::Attribute
   include Paf::Formattable
@@ -14,14 +14,17 @@ class Paf
     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.to_s.empty?
   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

data/lib/paf/attribute.rb

@@ -1,9 +1,10 @@
 class Paf
-  # Basic attributes that make up a PAF entry
+  # Basic attributes or elements that make up a PAF entry
   module Attribute
     def self.included(base)
       base.extend ClassMethods
     end
+    private_class_method :included
 
     # Methods to be added to the including class
     module ClassMethods

data/lib/paf/formattable.rb

@@ -11,6 +11,7 @@ class Paf
         include ThoroughfareLocality
       end
     end
+    private_class_method :included
 
     # Methods to be added to the including class
     module ClassMethods
@@ -24,16 +25,19 @@ class Paf
         ]
       end
 
+      # Formats a hash of PAF address elements into an array of strings
       def format(args)
         new(args).format
       end
 
+      # Formats a hash of PAF address elements into a string
       def to_s(*args)
         return super if args.empty?
         new(args[0]).to_s
       end
     end
 
+    # Formats a Paf instance into an array of strings
     def format
       array = lines
       %i[post_town postcode].each do |attr|
@@ -42,6 +46,7 @@ class Paf
       array
     end
 
+    # Formats a Paf instance into a string
     def to_s
       string = (lines + [post_town.to_s]).reject(&:empty?).join(', ')
       ([string] + [postcode]).reject(&:empty?).join('. ')

data/lib/paf/premises.rb

@@ -9,6 +9,7 @@ class Paf
     def self.included(base)
       base.prepend Initializer
     end
+    private_class_method :included
 
     # initialize method to be prepended to the including class
     module Initializer

data/lib/paf/premises/common.rb

@@ -7,6 +7,10 @@ class Paf
 
       private
 
+      def concatenate?
+        concatenation_indicator == 'Y'
+      end
+
       def sub_name_and_name
         "#{sub_building_name} #{building_name}"
       end

data/lib/paf/premises/rule101.rb

@@ -13,10 +13,6 @@ class Paf
         true
       end
 
-      def concatenate?
-        concatenation_indicator == 'Y'
-      end
-
       def number_sub_name_and_thoroughfare_or_locality
         "#{building_number}#{sub_building_name} "\
           "#{first_thoroughfare_or_locality}"

data/lib/paf/thoroughfare_locality.rb

@@ -4,6 +4,7 @@ class Paf
     def self.included(base)
       base.extend ClassMethods
     end
+    private_class_method :included
 
     # Methods to be added to the including class
     module ClassMethods

data/lib/paf/version.rb

@@ -1,4 +1,4 @@
 # PAF gem version
 class Paf
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/paf.gemspec

@@ -10,7 +10,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['John Bard']
   spec.email         = ['johnbard@globalnet.co.uk']
 
-  spec.summary       = 'Royal Mail PAF Formatter'
+  spec.summary       = 'Royal Mail Postcode Address File (PAF) Formatter'
+  spec.description   = <<-EOF
+    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
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Bard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-20 00:00:00.000000000 Z
+date: 2017-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: 
+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)
 email:
 - johnbard@globalnet.co.uk
 executables: []
@@ -137,5 +141,5 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Royal Mail PAF Formatter
+summary: Royal Mail Postcode Address File (PAF) Formatter
 test_files: []