From 73ce3b9e781cb99c3ef9361e6a0c26c6ba132518 Mon Sep 17 00:00:00 2001
From: Michael Wood <michael.wood@opendataservices.coop>
Date: Tue, 14 Dec 2021 12:17:49 +0000
Subject: [PATCH] templates: progress-bars: Improve readability of result
 charts

* Create better visual distinction between a progress bar and a chart to
avoid confusion
* Show the failed portion of the chart in matching colour with reduced
opacity rather than black
* Add tooltip texts on overview graphs
* Add explanation text in overview of what is being shown

Fixes: https://github.com/pwyf/data-quality-tester/issues/40
---
 DataQualityTester/templates/overview.html            | 12 +++++++-----
 DataQualityTester/templates/partials/_totaliser.html |  5 +++--
 .../templates/quality_by_component.html              |  5 +++--
 3 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/DataQualityTester/templates/overview.html b/DataQualityTester/templates/overview.html
index 2450e98..2c002cf 100644
--- a/DataQualityTester/templates/overview.html
+++ b/DataQualityTester/templates/overview.html
@@ -5,7 +5,7 @@
 
 <div class="row quality-panels-list">
 {% for component in components %}
-  <div class="col-sm-6 quality-panel" id="{{ component.id }}" data-status-url="{{ url_for('task_status', task_id=task_ids[component.id]) }}" data-more-url="{{ url_for('package_quality_by_component', uuid=uuid, component_id=component.id) }}">
+  <div class="col-sm-6 quality-panel" id="{{ component.id }}" data-title="{{component.name}}" data-status-url="{{ url_for('task_status', task_id=task_ids[component.id]) }}" data-more-url="{{ url_for('package_quality_by_component', uuid=uuid, component_id=component.id) }}">
     <div class="panel panel-primary">
       <div class="panel-heading">
         <h3 class="panel-title">{{ component.name }}</h3>
@@ -17,7 +17,6 @@ <h3 class="panel-title">{{ component.name }}</h3>
             <i class="fa fa-circle-o-notch fa-spin fa-fw"></i>
           </div>
         </div>
-
         <div class="progress" style="visibility: collapse;"></div>
         <a class="btn btn-default pull-right" disabled="disabled" href="#">More…</a>
       </div>
@@ -35,14 +34,15 @@ <h3 class="panel-title">{{ component.name }}</h3>
 <script id="panel-tmpl" type="text/x-handlebars-template">
 {% raw %}
   <div class="progress">
-    <div class="progress-bar progress-bar-striped" style="width: {{ pass }}%; background-color: {{ colour }}">
+    <div class="progress-bar" style="width: {{ pass }}%; background-color: {{ colour }};" title="{{int_pass}}% Passed" data-toggle="tooltip">
       <span class="sr-only">{{ int_pass }}% Pass</span>
       {{ int_pass }}%
     </div>
-    <div class="progress-bar" style="width: {{ fail }}%; background-color: #222">
+    <div class="progress-bar" style="width: {{ fail }}%; background-color: {{ colour }}; opacity: 0.2;">
       <span class="sr-only">{{ int_fail }}% Fail</span>
     </div>
   </div>
+  <p><strong>{{int_pass}}%</strong> of the '{{title}}' tests passed.</p>
   <a class="btn btn-default pull-right" href="{{ more_url }}">More…</a>
 {% endraw %}
 </script>
@@ -74,10 +74,12 @@ <h3 class="panel-title">{{ component.name }}</h3>
             int_fail: parseInt(100 - data.score),
             colour: data.colour,
             component: data.name,
-            more_url: $el.data('more-url')
+            more_url: $el.data('more-url'),
+            title: $el.data('title'),
           };
           $el.find('.panel-body .loading').fadeOut(function() {
             $el.find('.panel-body').html(tmpl(ctx));
+            $('[data-toggle="tooltip"]').tooltip();
           });
         } else {
           $el.find('.panel-body .loading').fadeOut(function() {
diff --git a/DataQualityTester/templates/partials/_totaliser.html b/DataQualityTester/templates/partials/_totaliser.html
index 704616f..2a471cc 100644
--- a/DataQualityTester/templates/partials/_totaliser.html
+++ b/DataQualityTester/templates/partials/_totaliser.html
@@ -1,10 +1,11 @@
 {% macro totaliser(results) %}
+{% set bg_color=results|colorify %}
 <div class="progress">
-  <div id="num-pass" class="progress-bar progress-bar-striped" style="width: {{ 100 * results }}%; background-color: {{ results|colorify }}">
+  <div id="num-pass" class="progress-bar" style="width: {{ 100 * results }}%; background-color: {{ bg_color }}">
     <span class="sr-only">{{ (100 * results)|int }}% Pass</span>
     {{ (100 * results)|int }}%
   </div>
-  <div id="num-fail" class="progress-bar" style="width: {{ 100 * (1 - results) }}%; background-color: #222">
+  <div id="num-fail" class="progress-bar" style="width: {{ 100 * (1 - results) }}%; background-color: {{ bg_color }}; opacity: 0.2;">
     <span class="sr-only">{{ (100 * (1 - results))|ceil|int }}% Fail</span>
   </div>
 </div>
diff --git a/DataQualityTester/templates/quality_by_component.html b/DataQualityTester/templates/quality_by_component.html
index a1aea8f..1121f93 100644
--- a/DataQualityTester/templates/quality_by_component.html
+++ b/DataQualityTester/templates/quality_by_component.html
@@ -16,12 +16,13 @@ <h3 class="panel-title">{{ test_name }}</h3>
             </div>
             <div class="panel-body">
               {% if result_dict|percent is not none %}
+              {% set bg_color=result_dict|percent|colorify %}
               <div class="progress">
-                <div class="progress-bar progress-bar-striped" style="width: {{ result_dict|percent }}%; background-color: {{ result_dict|percent|colorify }}">
+                <div class="progress-bar" style="width: {{ result_dict|percent }}%; background-color: {{ bg_color }}">
                   <span class="sr-only">{{ result_dict|percent|int }}% Pass</span>
                   {{ result_dict|percent|int }}%
                 </div>
-                <div class="progress-bar" style="width: {{ 100 - result_dict|percent }}%; background-color: #222">
+                <div class="progress-bar" style="width: {{ 100 - result_dict|percent }}%; background-color: {{ bg_color }}; opacity: 0.2;">
                   <span class="sr-only">{{ 100 - result_dict|percent|int }}% Fail</span>
                 </div>
               </div>