From d18c787a0207f19101b9e174c2233566aa9af8c1 Mon Sep 17 00:00:00 2001
From: David McDonald <david.mcdonald@digital.cabinet-office.gov.uk>
Date: Mon, 25 Apr 2022 11:27:03 +0100
Subject: [PATCH] Give better names to usage page variables

`free` becomes `sms_free_count`
`paid` becomes `sms_paid_count`

This small change is just to help with readability for this
complex area of code
---
 app/main/views/dashboard.py            |  6 +++---
 app/templates/views/usage.html         | 12 ++++++------
 tests/app/main/views/test_dashboard.py | 24 ++++++++++++------------
 3 files changed, 21 insertions(+), 21 deletions(-)

diff --git a/app/main/views/dashboard.py b/app/main/views/dashboard.py
index ac4ff69db..6c8fe6af5 100644
--- a/app/main/views/dashboard.py
+++ b/app/main/views/dashboard.py
@@ -426,9 +426,9 @@ def get_free_paid_breakdown_for_billable_units(year, free_sms_fragment_limit, bi
         yield {
             'name': month,
             'letter_total': letter_total,
-            'paid': breakdown['paid'],
-            'free': breakdown['free'],
-            'letters': letter_billing
+            'letters': letter_billing,
+            'sms_paid_count': breakdown['paid'],
+            'sms_free_count': breakdown['free'],
         }
 
 
diff --git a/app/templates/views/usage.html b/app/templates/views/usage.html
index 43f7ce51a..26b63e559 100644
--- a/app/templates/views/usage.html
+++ b/app/templates/views/usage.html
@@ -97,16 +97,16 @@
             {% endcall %}
             {% call field(align='left') %}
               {{ big_number(
-                (sms_rate * month.paid) + month.letter_total,
+                (sms_rate * month.sms_paid_count) + month.letter_total,
                 currency="£",
                 smallest=True
               ) }}
               <ul>
-              {% if month.free %}
-                <li class="tabular-numbers">{{ month.free|format_thousands }} free {{ month.free|message_count_label('sms', suffix='') }}</li>
+              {% if month.sms_free_count %}
+                <li class="tabular-numbers">{{ month.sms_free_count|format_thousands }} free {{ month.sms_free_count|message_count_label('sms', suffix='') }}</li>
               {% endif %}
-              {% if month.paid %}
-                <li class="tabular-numbers">{{ month.paid|message_count('sms') }} at
+              {% if month.sms_paid_count %}
+                <li class="tabular-numbers">{{ month.sms_paid_count|message_count('sms') }} at
                 {{- ' {:.2f}p'.format(sms_rate * 100) }}</li>
               {% endif %}
               {% for letter in month.letters%}
@@ -115,7 +115,7 @@
                   {{ letter.rate | format_number_in_pounds_as_currency }}</li>
                 {% endif %}
               {% endfor %}
-              {% if not (month.free or month.paid or month.letters) %}
+              {% if not (month.sms_free_count or month.sms_paid_count or month.letters) %}
                 <li aria-hidden="true">–</li>
               {% endif %}
               </ul>
diff --git a/tests/app/main/views/test_dashboard.py b/tests/app/main/views/test_dashboard.py
index d61101f96..dfafc6b29 100644
--- a/tests/app/main/views/test_dashboard.py
+++ b/tests/app/main/views/test_dashboard.py
@@ -1595,18 +1595,18 @@ def test_get_free_paid_breakdown_for_billable_units(now, expected_number_of_mont
             ]
         )
         assert list(billing_units) == [
-            {'free': 100000, 'name': 'April', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 100000, 'name': 'May', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 50000, 'name': 'June', 'paid': 50000, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'July', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'August', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'September', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'October', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'November', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'December', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'January', 'paid': 0, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'February', 'paid': 2000, 'letter_total': 0, 'letters': []},
-            {'free': 0, 'name': 'March', 'paid': 0, 'letter_total': 0, 'letters': []}
+            {'sms_free_count': 100000, 'name': 'April', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 100000, 'name': 'May', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 50000, 'name': 'June', 'sms_paid_count': 50000, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'July', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'August', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'September', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'October', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'November', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'December', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'January', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'February', 'sms_paid_count': 2000, 'letter_total': 0, 'letters': []},
+            {'sms_free_count': 0, 'name': 'March', 'sms_paid_count': 0, 'letter_total': 0, 'letters': []}
         ][:expected_number_of_months]