paf 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36b4513b6be17e49ed9962e9aafcdbbb4039ee3d
-  data.tar.gz: 1f2d2a352533a1fcfb6e6d8ccd321f3de40b2c75
+  metadata.gz: b233ff56fedadfea9e1f21508ea7b6fb85f852c1
+  data.tar.gz: 59dbbde56e750c387774368cad006e4d3e4a0a7c
 SHA512:
-  metadata.gz: 409df603f878fafd0b169d39fc65b26e3419b880d3a3bf8bf857bfff53625fedda83c62d64a629de03117fd22f984cbf13954eefe6414e5d67cfd2ff8e1fb0df
-  data.tar.gz: 00d5ae8fef08d1324f7998b1899451fecb1dc52a9e893f2210020085c12c415905acdd0612f862fed5b2f97079d55dca4e34ca5322498a27d89aac760c3e97b4
+  metadata.gz: c379a989578aa2c9a0398f26dddf50d0cce40d15f0ddc8394e54e24bd7c13c016b30734ff3f2375ff985d63caf707d9b024c8720edade1ac3cccbf7a67b78779
+  data.tar.gz: 7414a214e0a027bffa8c774f595844a208e75db227af5f2338e9e2f80804088f0e50a0ff39c69f2a5e01412582060d39faa36badd96365ebf630abc8a4a18579

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 May be used to format the PAF elements as an array of strings:
 
 ```ruby
-Paf.format(
+Paf.to_a(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',
   thoroughfare_descriptor: 'LANE',
@@ -35,6 +35,25 @@ Paf.format(
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 ```
 
+Or as a hash of strings:
+
+```ruby
+Paf.to_h(
+  building_name: '1-2',
+  thoroughfare_name: 'NURSERY',
+  thoroughfare_descriptor: 'LANE',
+  dependent_locality: 'PENN',
+  post_town: 'HIGH WYCOMBE',
+  postcode: 'HP10 8LS'
+)
+
+{
+  lines: ['1-2 NURSERY LANE', 'PENN'],
+  post_town: 'HIGH WYCOMBE',
+  postcode: 'HP10 8LS'
+}
+```
+
 Or as a single string:
 
 ```ruby
@@ -61,10 +80,26 @@ paf = Paf.new(
   post_town: 'HIGH WYCOMBE',
   postcode: 'HP10 8LS'
 )
-paf.format
+paf.to_a
 
 ['1-2 NURSERY LANE', 'PENN', 'HIGH WYCOMBE', 'HP10 8LS']
 
+paf = Paf.new(
+  building_name: '1-2',
+  thoroughfare_name: 'NURSERY',
+  thoroughfare_descriptor: 'LANE',
+  dependent_locality: 'PENN',
+  post_town: 'HIGH WYCOMBE',
+  postcode: 'HP10 8LS'
+)
+paf.to_h
+
+{
+  lines: ['1-2 NURSERY LANE', 'PENN'],
+  post_town: 'HIGH WYCOMBE',
+  postcode: 'HP10 8LS'
+}
+
 paf = Paf.new(
   building_name: '1-2',
   thoroughfare_name: 'NURSERY',

data/lib/paf.rb

@@ -35,7 +35,7 @@ class Paf
   private
 
   def concatenated(attrs)
-    value = attrs.map { |attr| send(attr) }.condense.join(' ')
+    value = attrs.map { |attr| send(attr) }.condense(' ')
     value unless value.vacant?
   end
 end

data/lib/paf/array_formatter.rb

@@ -0,0 +1,15 @@
+require 'paf/formatter'
+
+class Paf
+  # Processing to format a PAF entry as an array
+  class ArrayFormatter < Formatter
+    def format(paf)
+      super(paf)
+      lines.clone.tap do |array|
+        post_attrs.each do |attr|
+          array << send(attr) unless send(attr).vacant?
+        end
+      end
+    end
+  end
+end

data/lib/paf/core_ext/array.rb

@@ -4,8 +4,8 @@ class Paf
   module CoreExt
     # Extend the core Array class with PAF specific processing
     module Array
-      def condense
-        reject(&:vacant?)
+      def condense(separator)
+        reject(&:vacant?).join(separator)
       end
     end
   end

data/lib/paf/core_ext/string.rb

@@ -2,12 +2,20 @@ class Paf
   module CoreExt
     # Extend the core String class with PAF specific processing
     module String
-      def paf_exception?
+      def exception?
         !/^(.|[\d][[:alpha:]]|[\d].*?[\d][[:alpha:]]?)$/.match(self).nil?
       end
 
-      def paf_split_exception?
-        paf_exception? && /^\d+$/.match(self).nil?
+      def split_exception?
+        last_word.exception? && /^\d+$/.match(last_word).nil?
+      end
+
+      def last_word
+        split.last
+      end
+
+      def but_last_word
+        self[0...rindex(' ')]
       end
     end
   end

data/lib/paf/formattable.rb

@@ -1,47 +1,49 @@
-require 'paf/lineable'
-require 'paf/premises'
-require 'paf/thoroughfare_locality'
+require 'paf/array_formatter'
+require 'paf/hash_formatter'
+require 'paf/string_formatter'
 
 class Paf
   # Processing to format a PAF entry
   module Formattable
+    attr_accessor :formatter, :concatenation_indicator
+    private :concatenation_indicator=
+
     def self.included(base)
+      base.prepend Initializer
       base.extend ClassMethods
-      base.class_eval do
-        include Lineable
-        include Premises
-        include ThoroughfareLocality
-      end
     end
     private_class_method :included
 
+    # initialize method to be prepended to the including class
+    module Initializer
+      def initialize(*)
+        super if defined? super
+        @formatter ||= Paf::ArrayFormatter.new
+      end
+    end
+
     # Methods to be added to the including class
     module ClassMethods
-      # Formats a hash of PAF address elements into an array of strings
-      def format(args)
-        new(args).format
+      %i[to_a to_h format].each do |method|
+        define_method method do |args|
+          new(args).send(method)
+        end
       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
-      self.class.post_attrs.each do |attr|
-        array << send(attr) unless send(attr).vacant?
+    { to_a: :Array, to_h: :Hash, to_s: :String }.each do |key, value|
+      define_method key do
+        Kernel.const_get("Paf::#{value}Formatter").format(self)
       end
-      array
     end
 
-    # Formats a Paf instance into a string
-    def to_s
-      string = (lines + [post_town]).condense.join(', ')
-      ([string] + [postcode]).condense.join('. ')
+    def format
+      formatter.format(self)
     end
   end
 end

data/lib/paf/formatter.rb

@@ -0,0 +1,25 @@
+require 'paf/lineable'
+
+class Paf
+  # Processing to format a PAF entry
+  class Formatter
+    def self.format(paf)
+      new.format(paf)
+    end
+
+    def format(paf)
+      @paf = paf.clone
+      @paf.extend Lineable
+    end
+
+    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
+
+    def respond_to_missing?(method_name, include_private = false)
+      @paf.respond_to?(method) || @paf.class.respond_to?(method) || super
+    end
+  end
+end

data/lib/paf/hash_formatter.rb

@@ -0,0 +1,15 @@
+require 'paf/formatter'
+
+class Paf
+  # Processing to format a PAF entry as a hash
+  class HashFormatter < Formatter
+    def format(paf)
+      super(paf)
+      {}.tap do |hash|
+        ([:lines] + post_attrs).each do |attr|
+          hash[attr] = send(attr) unless send(attr).vacant?
+        end
+      end
+    end
+  end
+end

data/lib/paf/lineable.rb

@@ -1,27 +1,28 @@
+require 'paf/premises'
+require 'paf/thoroughfare_locality'
+
 class Paf
   # Processing to format PAF entry lines
   module Lineable
-    def self.included(base)
-      base.extend ClassMethods
+    def self.extended(base)
+      base.extend Premises
+      base.extend ThoroughfareLocality
     end
-    private_class_method :included
 
-    # Methods to be added to the including class
-    module ClassMethods
-      def lines_methods
-        organisation_attrs + %i[po_box premises thoroughfares_and_localities]
+    def lines
+      [].tap do |lines|
+        lines_methods.each do |method|
+          value = send(method)
+          (lines << value).flatten! unless value.vacant?
+        end
       end
     end
 
     private
 
-    def lines
-      lines = []
-      self.class.lines_methods.each do |method|
-        value = send(method)
-        (lines << value).flatten! unless value.vacant?
-      end
-      lines
+    def lines_methods
+      self.class.organisation_attrs +
+        %i[po_box premises thoroughfares_and_localities]
     end
   end
 end

data/lib/paf/premises.rb

@@ -5,26 +5,17 @@ class Paf
   module Premises
     include Common
 
-    def self.included(base)
-      base.prepend Initializer
+    def self.extended(base)
+      base.extend_premises_rule
     end
-    private_class_method :included
-
-    # initialize method to be prepended to the including class
-    module Initializer
-      def initialize(*)
-        super if defined? super
-        extend_premises_rule
-      end
-    end
-
-    private
 
     def extend_premises_rule
       require premises_rule_filename
       extend premises_rule_module
     end
 
+    private
+
     def premises_rule_filename
       "paf/premises/rule#{rule_key}"
     end

data/lib/paf/premises/common.rb

@@ -2,9 +2,6 @@ class Paf
   module Premises
     # Common processing for premises elements of a PAF entry
     module Common
-      attr_accessor :concatenation_indicator
-      private :concatenation_indicator=
-
       private
 
       def concatenate?

data/lib/paf/premises/rule000.rb

@@ -2,12 +2,12 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 1
     module Rule000
-      private
-
       def premises
         []
       end
 
+      private
+
       def premises_includes_first_thoroughfare_or_locality?
         false
       end

data/lib/paf/premises/rule001.rb

@@ -2,12 +2,12 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 2
     module Rule001
-      private
-
       def premises
         [number_and_thoroughfare_or_locality]
       end
 
+      private
+
       def premises_includes_first_thoroughfare_or_locality?
         true
       end

data/lib/paf/premises/rule010.rb

@@ -2,35 +2,25 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 3
     module Rule010
-      private
-
       def premises
-        return [name_and_thoroughfare_or_locality] if
-          building_name.paf_exception?
-        if building_name_last_word.paf_split_exception?
+        return [name_and_thoroughfare_or_locality] if building_name.exception?
+        if building_name.split_exception?
           return [
-            building_name_but_last_word,
+            building_name.but_last_word,
             name_last_word_and_thoroughfare_or_locality
           ]
         end
         [building_name]
       end
 
-      def premises_includes_first_thoroughfare_or_locality?
-        building_name.paf_exception? ||
-          building_name_last_word.paf_split_exception?
-      end
-
-      def building_name_but_last_word
-        building_name[0...building_name.rindex(' ')]
-      end
+      private
 
-      def building_name_last_word
-        building_name.split.last
+      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}"
+        "#{building_name.last_word} #{first_thoroughfare_or_locality}"
       end
     end
   end

data/lib/paf/premises/rule011.rb

@@ -2,12 +2,12 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 4
     module Rule011
-      private
-
       def premises
         [building_name, number_and_thoroughfare_or_locality]
       end
 
+      private
+
       def premises_includes_first_thoroughfare_or_locality?
         true
       end

data/lib/paf/premises/rule101.rb

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

data/lib/paf/premises/rule110.rb

@@ -2,17 +2,17 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 6
     module Rule110
-      private
-
       def premises
-        return [sub_name_and_name] if sub_building_name.paf_exception?
+        return [sub_name_and_name] if sub_building_name.exception?
         return [sub_building_name, name_and_thoroughfare_or_locality] if
-          building_name.paf_exception?
+          building_name.exception?
         [sub_building_name, building_name]
       end
 
+      private
+
       def premises_includes_first_thoroughfare_or_locality?
-        !sub_building_name.paf_exception? && building_name.paf_exception?
+        !sub_building_name.exception? && building_name.exception?
       end
     end
   end

data/lib/paf/premises/rule111.rb

@@ -2,14 +2,14 @@ class Paf
   module Premises
     # Processing for premises elements of a PAF entry under Rule 7
     module Rule111
-      private
-
       def premises
         return [sub_name_and_name, number_and_thoroughfare_or_locality] if
-          sub_building_name.paf_exception?
+          sub_building_name.exception?
         [sub_building_name, building_name, number_and_thoroughfare_or_locality]
       end
 
+      private
+
       def premises_includes_first_thoroughfare_or_locality?
         true
       end

data/lib/paf/string_formatter.rb

@@ -0,0 +1,11 @@
+require 'paf/formatter'
+
+class Paf
+  # Processing to format a PAF entry as a string
+  class StringFormatter < Formatter
+    def format(paf)
+      super(paf)
+      ([(lines + [post_town]).condense(', ')] + [postcode]).condense('. ')
+    end
+  end
+end

data/lib/paf/thoroughfare_locality.rb

@@ -1,37 +1,29 @@
 class Paf
   # Processing for thoroughfare and locality elements of a PAF entry
   module ThoroughfareLocality
-    def self.included(base)
-      base.extend ClassMethods
+    def thoroughfare_and_locality_attrs
+      %i[dependent_thoroughfare thoroughfare] + self.class.locality_attrs
     end
-    private_class_method :included
 
-    # Methods to be added to the including class
-    module ClassMethods
-      def thoroughfare_and_locality_attrs
-        %i[dependent_thoroughfare thoroughfare] + locality_attrs
+    def thoroughfares_and_localities
+      [].tap do |array|
+        thoroughfare_and_locality_attrs.each do |attr|
+          next if used?(attr)
+          value = send(attr)
+          array << value unless value.vacant?
+        end
       end
     end
 
     private
 
-    def thoroughfares_and_localities
-      array = []
-      self.class.thoroughfare_and_locality_attrs.each do |attr|
-        next if used?(attr)
-        value = send(attr)
-        array << value unless value.vacant?
-      end
-      array
-    end
-
     def first_thoroughfare_or_locality
       send(first_thoroughfare_or_locality_attr) unless
         first_thoroughfare_or_locality_attr.nil?
     end
 
     def first_thoroughfare_or_locality_attr
-      self.class.thoroughfare_and_locality_attrs.find do |attr|
+      thoroughfare_and_locality_attrs.find do |attr|
         !send(attr).vacant?
       end
     end

data/lib/paf/version.rb

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

data/paf.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |spec|
   spec.version       = Paf::VERSION
   spec.authors       = ['John Bard']
   spec.email         = ['johnbard@globalnet.co.uk']
+  spec.homepage      = 'https://github.com/drabjay/paf'
 
   spec.summary       = 'Royal Mail Postcode Address File (PAF) Formatter'
   spec.description   = <<-EOF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paf
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - John Bard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-29 00:00:00.000000000 Z
+date: 2017-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,11 +103,14 @@ files:
 - bin/console
 - bin/setup
 - lib/paf.rb
+- lib/paf/array_formatter.rb
 - lib/paf/attribute.rb
 - lib/paf/core_ext/array.rb
 - lib/paf/core_ext/object.rb
 - lib/paf/core_ext/string.rb
 - lib/paf/formattable.rb
+- lib/paf/formatter.rb
+- lib/paf/hash_formatter.rb
 - lib/paf/lineable.rb
 - lib/paf/premises.rb
 - lib/paf/premises/common.rb
@@ -118,10 +121,11 @@ files:
 - lib/paf/premises/rule101.rb
 - lib/paf/premises/rule110.rb
 - lib/paf/premises/rule111.rb
+- lib/paf/string_formatter.rb
 - lib/paf/thoroughfare_locality.rb
 - lib/paf/version.rb
 - paf.gemspec
-homepage: 
+homepage: https://github.com/drabjay/paf
 licenses:
 - MIT
 metadata: {}