Refactor to use PostalAddress helper from utils

Since we’re doing normalisation and line-count-checking of addresses in
multiple places it makes sense for that code to be shared. Which is
what happened here:
https://github.com/alphagov/notifications-utils/pull/713

This commit refactors the admin code to make use of the new utils code.

Note about placeholders:
- they now go into the session as `address_line_1` instead of `address
  line 1` because this is the format the API uses, so should be
  considered canonical
- they are now fetched from the session in a way that isn’t sensitive
  to case or underscores (using the `Columns` class)
- the API doesn’t care about case or underscores vs spaces in
  placeholder names because it’s checking an instance of `Template` to
  see if all the required placeholders are present (see
  401c8e41d6/app/notifications/process_notifications.py (L40))

app/main/forms.py

@@ -1,4 +1,3 @@
-import re
 import weakref
 from datetime import datetime, timedelta
 from itertools import chain
@@ -10,17 +9,13 @@ from flask_wtf import FlaskForm as Form
 from flask_wtf.file import FileAllowed
 from flask_wtf.file import FileField as FileField_wtf
 from notifications_utils.columns import Columns
-from notifications_utils.formatters import (
-    normalise_whitespace_and_newlines,
-    remove_whitespace_before_punctuation,
-    strip_whitespace,
-)
+from notifications_utils.formatters import strip_whitespace
+from notifications_utils.postal_address import PostalAddress
 from notifications_utils.recipients import (
     InvalidPhoneError,
     normalise_phone_number,
     validate_phone_number,
 )
-from notifications_utils.take import Take
 from wtforms import (
     BooleanField,
     DateField,
@@ -368,21 +363,10 @@ class StripWhitespaceStringField(StringField):
         super(StringField, self).__init__(label, **kwargs)
 
 
-class StripWhitespaceTextAreaField(TextAreaField):
+class PostalAddressField(TextAreaField):
     def process_formdata(self, valuelist):
         if valuelist:
-            self.data = Take(
-                valuelist[0]
-            ).then(
-                remove_whitespace_before_punctuation
-            ).then(
-                normalise_whitespace_and_newlines
-            ).then(
-                # similar to normalise_multiple_newlines but taking everything down to one `\n` instead of two
-                lambda value: re.compile(r'\n{2,}').sub('\n', value)
-            ).then(
-                str.strip
-            )
+            self.data = PostalAddress(valuelist[0]).normalised
 
 
 class OnOffField(RadioField):
@@ -765,40 +749,25 @@ class SMSTemplateForm(BaseTemplateForm):
 
 
 class LetterAddressForm(StripWhitespaceForm):
-    MIN_ADDRESS_LINES = 3
-    MAX_ADDRESS_LINES = 7
 
-    address = StripWhitespaceTextAreaField(
+    address = PostalAddressField(
         'Address',
         validators=[DataRequired(message="Cannot be empty")]
     )
 
     def validate_address(self, field):
-        lines = field.data.splitlines()
-        if len(lines) < self.MIN_ADDRESS_LINES:
-            raise ValidationError('Address must be at least 3 lines long')
-        if len(lines) > self.MAX_ADDRESS_LINES:
-            raise ValidationError('Address must be no more than 7 lines long')
 
-    @property
-    def as_address_lines_1_to_7_with_postcode(self):
-        lines = self.address.data.splitlines()
-        placeholders = {}
+        address = PostalAddress(field.data)
 
-        # set all placeholders to empty strings, or all_placeholders_in_session will always return false.
-        # note that it must be `address line #` with spaces, not underscores or dashes
-        for i in range(1, 7):
-            placeholders[f'address line {i}'] = ''
+        if not address.has_enough_lines:
+            raise ValidationError(
+                f'Address must be at least {PostalAddress.MIN_LINES} lines long'
+            )
 
-        # unroll the address into lines, and place into the session in the underlying placeholder names
-        # postcode is required so make sure we put the last value in that
-        # TODO: When postcode is no longer a required field, remove this special case and just use `address line #`
-        address_lines, last_address_line = lines[:-1], lines[-1]
-        for i, line in enumerate(address_lines, start=1):
-            placeholders[f'address line {i}'] = line
-        placeholders['postcode'] = last_address_line
-
-        return placeholders
+        if address.has_too_many_lines:
+            raise ValidationError(
+                f'Address must be no more than {PostalAddress.MAX_LINES} lines long'
+            )
 
 
 class EmailTemplateForm(BaseTemplateForm):

app/main/views/send.py

@@ -18,6 +18,10 @@ from notifications_python_client.errors import HTTPError
 from notifications_utils import LETTER_MAX_PAGE_COUNT, SMS_CHAR_COUNT_LIMIT
 from notifications_utils.columns import Columns
 from notifications_utils.pdf import is_letter_too_long
+from notifications_utils.postal_address import (
+    PostalAddress,
+    address_lines_1_to_6_and_postcode_keys,
+)
 from notifications_utils.recipients import (
     RecipientCSV,
     first_column_headings,
@@ -335,18 +339,6 @@ def get_notification_check_endpoint(service_id, template):
     ))
 
 
-def get_letter_address_from_session():
-    """
-    Takes non-blank-string address values out of the placeholders, and returns a multi line string
-    """
-    keys = [f'address line {i}' for i in range(1, 7)] + ['postcode']
-    return '\n'.join([
-        session['placeholders'][key]
-        for key in keys
-        if session['placeholders'].get(key)
-    ])
-
-
 @main.route(
     "/services/<uuid:service_id>/send/<uuid:template_id>/one-off/address",
     methods=['GET', 'POST']
@@ -376,12 +368,14 @@ def send_one_off_letter_address(service_id, template_id):
         sms_sender=None
     )
 
-    current_session_address = get_letter_address_from_session()
+    current_session_address = PostalAddress.from_personalisation(
+        get_normalised_placeholders_from_session()
+    )
 
-    form = LetterAddressForm(address=current_session_address)
+    form = LetterAddressForm(address=current_session_address.normalised)
 
     if form.validate_on_submit():
-        session['placeholders'].update(form.as_address_lines_1_to_7_with_postcode)
+        session['placeholders'].update(PostalAddress(form.address.data).as_personalisation)
 
         placeholders = fields_to_fill_in(
             template,
@@ -482,7 +476,9 @@ def send_test_step(service_id, template_id, step_index):
         ))
 
     # if we're in a letter, we should show address block rather than "address line #" or "postcode"
-    if db_template['template_type'] == 'letter' and current_placeholder in first_column_headings['letter']:
+    if template.template_type == 'letter' and current_placeholder in (
+        Columns.from_keys(address_lines_1_to_6_and_postcode_keys)
+    ):
         return redirect(url_for('.send_one_off_letter_address', service_id=service_id, template_id=template_id))
 
     optional_placeholder = (current_placeholder in optional_address_columns)
@@ -878,10 +874,7 @@ def fields_to_fill_in(template, prefill_current_user=False):
 
 
 def get_normalised_placeholders_from_session():
-    return {
-        key: ''.join(value or [])
-        for key, value in session.get('placeholders', {}).items()
-    }
+    return Columns(session.get('placeholders', {}))
 
 
 def get_recipient_and_placeholders_from_session(template_type):