From ddeed88210052644f77c3f138ca1574dd7349e19 Mon Sep 17 00:00:00 2001
From: Chris Hill-Scott <me@quis.cc>
Date: Thu, 20 Jul 2017 08:59:49 +0100
Subject: [PATCH] Refactor check page into 3 separate templates
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

The check page is a very complex Jinja template. It needs breaking up
to make it easier to understand what’s going on.

I think there are three di
---
 app/main/views/send.py                        |  14 +-
 .../{check.html => check/column-errors.html}  |   0
 app/templates/views/check/ok.html             | 235 ++++++++++++++++++
 app/templates/views/check/row-errors.html     | 235 ++++++++++++++++++
 4 files changed, 480 insertions(+), 4 deletions(-)
 rename app/templates/views/{check.html => check/column-errors.html} (100%)
 create mode 100644 app/templates/views/check/ok.html
 create mode 100644 app/templates/views/check/row-errors.html

diff --git a/app/main/views/send.py b/app/main/views/send.py
index 8b72c3b9a..9cdd56419 100644
--- a/app/main/views/send.py
+++ b/app/main/views/send.py
@@ -447,10 +447,16 @@ def _check_messages(service_id, template_type, upload_id, letters_as_pdf=False):
 @login_required
 @user_has_permissions('send_texts', 'send_emails', 'send_letters')
 def check_messages(service_id, template_type, upload_id):
-    return render_template(
-        'views/check.html',
-        **_check_messages(service_id, template_type, upload_id)
-    )
+
+    data = _check_messages(service_id, template_type, upload_id)
+
+    if data['row_errors']:
+        return render_template('views/check/row-errors.html', **data)
+
+    if data['errors']:
+        return render_template('views/check/column-errors.html', **data)
+
+    return render_template('views/check/ok.html', **data)
 
 
 @main.route("/services/<service_id>/<template_type>/check/<upload_id>.<filetype>", methods=['GET'])
diff --git a/app/templates/views/check.html b/app/templates/views/check/column-errors.html
similarity index 100%
rename from app/templates/views/check.html
rename to app/templates/views/check/column-errors.html
diff --git a/app/templates/views/check/ok.html b/app/templates/views/check/ok.html
new file mode 100644
index 000000000..ebb207edd
--- /dev/null
+++ b/app/templates/views/check/ok.html
@@ -0,0 +1,235 @@
+{% extends "withnav_template.html" %}
+{% from "components/banner.html" import banner_wrapper %}
+{% from "components/radios.html" import radio_select %}
+{% from "components/table.html" import list_table, field, text_field, index_field, hidden_field_heading %}
+{% from "components/file-upload.html" import file_upload %}
+{% from "components/page-footer.html" import page_footer %}
+{% from "components/message-count-label.html" import message_count_label %}
+
+{% set file_contents_header_id = 'file-preview' %}
+{% macro skip_to_file_contents() %}
+  <p class="visually-hidden">
+    <a href="#{{ file_contents_header_id }}">Skip to file contents</a>
+  </p>
+{% endmacro %}
+
+{% block service_page_title %}
+  {{ "Error" if errors else "Preview of {}".format(template.name) }}
+{% endblock %}
+
+{% block maincolumn_content %}
+
+  {% if recipients.too_many_rows %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file has too many rows
+        </h1>
+        <p>
+          Notify can process up to
+          {{ "{:,}".format(recipients.max_rows) }} rows at once. Your
+          file has {{ "{:,}".format(recipients|length) }} rows.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not count_of_recipients %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file is missing some rows
+        </h1>
+        <p>
+          It needs at least one row of data, and {{ recipients.missing_column_headers | sort() | formatted_list(
+            prefix='a column called',
+            prefix_plural='columns called'
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not recipients.has_recipient_columns %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file needs {{ recipients.recipient_column_headers | formatted_list(
+            prefix='a column called',
+            prefix_plural='columns called'
+          ) }}
+        </h1>
+        <p>
+          Right now it has {{ recipients.column_headers | formatted_list(
+            prefix='one column, called ',
+            prefix_plural='columns called '
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif recipients.missing_column_headers %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          The columns in your file need to match the double brackets in
+          your template
+        </h1>
+        <p>
+          Your file is missing {{ recipients.missing_column_headers | formatted_list(
+            conjunction='and',
+            prefix='a column called ',
+            prefix_plural='columns called '
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif row_errors %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        {% if row_errors|length == 1 %}
+          <h1 class='banner-title'>
+            There is a problem with your data
+          </h1>
+          <p>
+            You need to {{ row_errors[0] }}
+          </p>
+        {% else %}
+          <h1 class='banner-title'>
+            There are some problems with your data
+          </h1>
+          <p>
+            You need to:
+          </p>
+          <ul class="list-bullet">
+            {% for error in row_errors %}
+              <li>{{ error }}</li>
+            {% endfor %}
+          </ul>
+        {% endif %}
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not recipients.allowed_to_send_to %}
+    {% with
+      count_of_recipients=count_of_recipients,
+      template_type_label=recipients.recipient_column_headers[0]
+    %}
+      {% include "partials/check/not-allowed-to-send-to.html" %}
+    {% endwith %}
+  {% elif recipients.more_rows_than_can_send %}
+    {% include "partials/check/too-many-messages.html" %}
+  {% else %}
+
+    <h1 class="heading-large">
+      Preview of {{ template.name }}
+    </h1>
+    {{ skip_to_file_contents() }}
+
+  {% endif %}
+
+  {% if not errors %}
+    {{ template|string }}
+  {% endif %}
+
+  <div class="bottom-gutter-3-2">
+  {% if errors %}
+    {% if request.args.from_test %}
+      <a href="{{ back_link }}" class="page-footer-back-link">Back</a>
+    {% else %}
+      {{file_upload(form.file, button_text='Re-upload your file')}}
+    {% endif %}
+  {% else %}
+    <form method="post" enctype="multipart/form-data" action="{{url_for('main.start_job', service_id=current_service.id, upload_id=upload_id)}}" class='page-footer'>
+      <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
+      <input type="hidden" name="help" value="{{ '3' if help else 0 }}" />
+      {% if choose_time_form and template.template_type != 'letter' %}
+        {{ radio_select(
+          choose_time_form.scheduled_for,
+          wrapping_class='bottom-gutter-2-3'
+        ) }}
+      {% endif %}
+      {% if template.template_type != 'letter' or not request.args.from_test %}
+      <input type="submit" class="button" value="Send {{ count_of_recipients }} {{ message_count_label(count_of_recipients, template.template_type, suffix='') }}" />
+      {% else %}
+        <a href="{{ url_for('main.check_messages_preview', service_id=current_service.id, template_type=template.template_type, upload_id=upload_id, filetype='pdf') }}" download="download" class="button">Download as a printable PDF</a>
+      {% endif %}
+      <a href="{{ back_link }}" class="page-footer-back-link">Back</a>
+    </form>
+  {% endif %}
+  </div>
+
+  {% if not request.args.from_test %}
+
+    <h2 class="heading-medium" id="{{ file_contents_header_id }}">{{ original_file_name }}</h2>
+
+    {% call(item, row_number) list_table(
+      recipients.initial_annotated_rows_with_errors if row_errors and not recipients.missing_column_headers else recipients.initial_annotated_rows,
+      caption=original_file_name,
+      caption_visible=False,
+      field_headings=[
+        '<span class="visually-hidden">Row in file</span><span aria-hidden="true" class="{}">1</span>'.format("table-field-invisible-error" if errors else "")|safe
+      ] + recipients.column_headers
+    ) %}
+      {% call index_field() %}
+        <span class="{% if item.index in recipients.rows_with_errors %}table-field-error{% endif %}">
+          {{ item.index + 2 }}
+        </span>
+      {% endcall %}
+      {% for column in recipients.column_headers %}
+        {% if item['columns'][column].error and not recipients.missing_column_headers %}
+          {% call field() %}
+            <span>
+              <span class="table-field-error-label">{{ item['columns'][column].error }}</span>
+              {{ item['columns'][column].data if item['columns'][column].data != None }}
+            </span>
+          {% endcall %}
+        {% elif item['columns'][column].ignore %}
+          {{ text_field(item['columns'][column].data or '', status='default') }}
+        {% else %}
+          {{ text_field(item['columns'][column].data or '') }}
+        {% endif %}
+      {% endfor %}
+      {% if item['columns'].get(None) %}
+        {% for column in item['columns'][None].data %}
+          {{ text_field(column, status='default') }}
+        {% endfor %}
+      {% endif %}
+    {% endcall %}
+
+  {% endif %}
+
+
+  {% if recipients.too_many_rows %}
+    <p class="table-show-more-link">
+      Can’t show the contents of this file
+    </p>
+  {% elif count_of_displayed_recipients < count_of_recipients %}
+    <p class="table-show-more-link">
+      {% if row_errors and not recipients.missing_column_headers %}
+        Only showing the first {{ count_of_displayed_recipients }} rows with errors
+      {% else %}
+        Only showing the first {{ count_of_displayed_recipients }} rows
+      {% endif %}
+    </p>
+  {% elif row_errors and not recipients.missing_column_headers %}
+    <p class="table-show-more-link">
+      Only showing rows with errors
+    </p>
+  {% endif %}
+
+  {% if errors %}
+    <h2 class="heading-medium">Preview of {{ template.name }}</h2>
+    {{ template|string }}
+  {% endif %}
+
+{% endblock %}
diff --git a/app/templates/views/check/row-errors.html b/app/templates/views/check/row-errors.html
new file mode 100644
index 000000000..ebb207edd
--- /dev/null
+++ b/app/templates/views/check/row-errors.html
@@ -0,0 +1,235 @@
+{% extends "withnav_template.html" %}
+{% from "components/banner.html" import banner_wrapper %}
+{% from "components/radios.html" import radio_select %}
+{% from "components/table.html" import list_table, field, text_field, index_field, hidden_field_heading %}
+{% from "components/file-upload.html" import file_upload %}
+{% from "components/page-footer.html" import page_footer %}
+{% from "components/message-count-label.html" import message_count_label %}
+
+{% set file_contents_header_id = 'file-preview' %}
+{% macro skip_to_file_contents() %}
+  <p class="visually-hidden">
+    <a href="#{{ file_contents_header_id }}">Skip to file contents</a>
+  </p>
+{% endmacro %}
+
+{% block service_page_title %}
+  {{ "Error" if errors else "Preview of {}".format(template.name) }}
+{% endblock %}
+
+{% block maincolumn_content %}
+
+  {% if recipients.too_many_rows %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file has too many rows
+        </h1>
+        <p>
+          Notify can process up to
+          {{ "{:,}".format(recipients.max_rows) }} rows at once. Your
+          file has {{ "{:,}".format(recipients|length) }} rows.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not count_of_recipients %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file is missing some rows
+        </h1>
+        <p>
+          It needs at least one row of data, and {{ recipients.missing_column_headers | sort() | formatted_list(
+            prefix='a column called',
+            prefix_plural='columns called'
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not recipients.has_recipient_columns %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          Your file needs {{ recipients.recipient_column_headers | formatted_list(
+            prefix='a column called',
+            prefix_plural='columns called'
+          ) }}
+        </h1>
+        <p>
+          Right now it has {{ recipients.column_headers | formatted_list(
+            prefix='one column, called ',
+            prefix_plural='columns called '
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif recipients.missing_column_headers %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        <h1 class='banner-title'>
+          The columns in your file need to match the double brackets in
+          your template
+        </h1>
+        <p>
+          Your file is missing {{ recipients.missing_column_headers | formatted_list(
+            conjunction='and',
+            prefix='a column called ',
+            prefix_plural='columns called '
+          ) }}.
+        </p>
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif row_errors %}
+
+    <div class="bottom-gutter">
+      {% call banner_wrapper(type='dangerous') %}
+        {% if row_errors|length == 1 %}
+          <h1 class='banner-title'>
+            There is a problem with your data
+          </h1>
+          <p>
+            You need to {{ row_errors[0] }}
+          </p>
+        {% else %}
+          <h1 class='banner-title'>
+            There are some problems with your data
+          </h1>
+          <p>
+            You need to:
+          </p>
+          <ul class="list-bullet">
+            {% for error in row_errors %}
+              <li>{{ error }}</li>
+            {% endfor %}
+          </ul>
+        {% endif %}
+        {{ skip_to_file_contents() }}
+      {% endcall %}
+    </div>
+
+  {% elif not recipients.allowed_to_send_to %}
+    {% with
+      count_of_recipients=count_of_recipients,
+      template_type_label=recipients.recipient_column_headers[0]
+    %}
+      {% include "partials/check/not-allowed-to-send-to.html" %}
+    {% endwith %}
+  {% elif recipients.more_rows_than_can_send %}
+    {% include "partials/check/too-many-messages.html" %}
+  {% else %}
+
+    <h1 class="heading-large">
+      Preview of {{ template.name }}
+    </h1>
+    {{ skip_to_file_contents() }}
+
+  {% endif %}
+
+  {% if not errors %}
+    {{ template|string }}
+  {% endif %}
+
+  <div class="bottom-gutter-3-2">
+  {% if errors %}
+    {% if request.args.from_test %}
+      <a href="{{ back_link }}" class="page-footer-back-link">Back</a>
+    {% else %}
+      {{file_upload(form.file, button_text='Re-upload your file')}}
+    {% endif %}
+  {% else %}
+    <form method="post" enctype="multipart/form-data" action="{{url_for('main.start_job', service_id=current_service.id, upload_id=upload_id)}}" class='page-footer'>
+      <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
+      <input type="hidden" name="help" value="{{ '3' if help else 0 }}" />
+      {% if choose_time_form and template.template_type != 'letter' %}
+        {{ radio_select(
+          choose_time_form.scheduled_for,
+          wrapping_class='bottom-gutter-2-3'
+        ) }}
+      {% endif %}
+      {% if template.template_type != 'letter' or not request.args.from_test %}
+      <input type="submit" class="button" value="Send {{ count_of_recipients }} {{ message_count_label(count_of_recipients, template.template_type, suffix='') }}" />
+      {% else %}
+        <a href="{{ url_for('main.check_messages_preview', service_id=current_service.id, template_type=template.template_type, upload_id=upload_id, filetype='pdf') }}" download="download" class="button">Download as a printable PDF</a>
+      {% endif %}
+      <a href="{{ back_link }}" class="page-footer-back-link">Back</a>
+    </form>
+  {% endif %}
+  </div>
+
+  {% if not request.args.from_test %}
+
+    <h2 class="heading-medium" id="{{ file_contents_header_id }}">{{ original_file_name }}</h2>
+
+    {% call(item, row_number) list_table(
+      recipients.initial_annotated_rows_with_errors if row_errors and not recipients.missing_column_headers else recipients.initial_annotated_rows,
+      caption=original_file_name,
+      caption_visible=False,
+      field_headings=[
+        '<span class="visually-hidden">Row in file</span><span aria-hidden="true" class="{}">1</span>'.format("table-field-invisible-error" if errors else "")|safe
+      ] + recipients.column_headers
+    ) %}
+      {% call index_field() %}
+        <span class="{% if item.index in recipients.rows_with_errors %}table-field-error{% endif %}">
+          {{ item.index + 2 }}
+        </span>
+      {% endcall %}
+      {% for column in recipients.column_headers %}
+        {% if item['columns'][column].error and not recipients.missing_column_headers %}
+          {% call field() %}
+            <span>
+              <span class="table-field-error-label">{{ item['columns'][column].error }}</span>
+              {{ item['columns'][column].data if item['columns'][column].data != None }}
+            </span>
+          {% endcall %}
+        {% elif item['columns'][column].ignore %}
+          {{ text_field(item['columns'][column].data or '', status='default') }}
+        {% else %}
+          {{ text_field(item['columns'][column].data or '') }}
+        {% endif %}
+      {% endfor %}
+      {% if item['columns'].get(None) %}
+        {% for column in item['columns'][None].data %}
+          {{ text_field(column, status='default') }}
+        {% endfor %}
+      {% endif %}
+    {% endcall %}
+
+  {% endif %}
+
+
+  {% if recipients.too_many_rows %}
+    <p class="table-show-more-link">
+      Can’t show the contents of this file
+    </p>
+  {% elif count_of_displayed_recipients < count_of_recipients %}
+    <p class="table-show-more-link">
+      {% if row_errors and not recipients.missing_column_headers %}
+        Only showing the first {{ count_of_displayed_recipients }} rows with errors
+      {% else %}
+        Only showing the first {{ count_of_displayed_recipients }} rows
+      {% endif %}
+    </p>
+  {% elif row_errors and not recipients.missing_column_headers %}
+    <p class="table-show-more-link">
+      Only showing rows with errors
+    </p>
+  {% endif %}
+
+  {% if errors %}
+    <h2 class="heading-medium">Preview of {{ template.name }}</h2>
+    {{ template|string }}
+  {% endif %}
+
+{% endblock %}