From d5b5a281ac5f2d11ee964827fa7a7fba3e495f3d Mon Sep 17 00:00:00 2001
From: Jonathan Niles <jonathanwniles@gmail.com>
Date: Tue, 31 Oct 2017 12:49:44 +0100
Subject: [PATCH] feat(Aged Creditors): implement monthly grouping

This commit implements "Group by Month" on the Aged Creditors page.  It
transforms the date range from being a simply 30/60/90 range to being
this month, last month, and the previous month(s).  This allows a much
more intuitive grouping for users who are not used to thinking in ranges
of 30 days.

Closes #1367.
---
 client/src/i18n/en/form.json                  |  1 +
 client/src/i18n/fr/form.json                  |  1 +
 .../aged_creditors/aged_creditors.html        | 10 ++++-
 .../generate/aged_debtors/aged_debtors.html   |  1 +
 .../finance/reports/creditors/aged.handlebars | 33 +++++++++++++---
 .../finance/reports/creditors/index.js        | 39 ++++++++++++++-----
 .../finance/reports/debtors/aged.handlebars   | 12 +++---
 7 files changed, 75 insertions(+), 22 deletions(-)

diff --git a/client/src/i18n/en/form.json b/client/src/i18n/en/form.json
index cab01ea7cf..4a0aab12ba 100644
--- a/client/src/i18n/en/form.json
+++ b/client/src/i18n/en/form.json
@@ -493,6 +493,7 @@
             "UPDATE_GROUP_DEBTOR": "Update Debtor Group",
             "UPDATE_PATIENT_GROUP": "Update Patient Group Subscription",
             "USE": "Use",
+            "USE_MONTH_GROUPING": "Group By Months",
             "USE_POS_RECEIPT": "POS Receipts",
             "USE_SIMPLIFIED_CARD": "Use simple patient identity",
             "USER": "User",
diff --git a/client/src/i18n/fr/form.json b/client/src/i18n/fr/form.json
index 71afae287d..f9faeb9460 100644
--- a/client/src/i18n/fr/form.json
+++ b/client/src/i18n/fr/form.json
@@ -496,6 +496,7 @@
             "UPDATE_GROUP_DEBTOR": "Mettre à jour le Groupe débiteur",
             "UPDATE_PATIENT_GROUP": "Mettre à jour les groupes de patients",
             "USE": "Utilisation",
+            "USE_MONTH_GROUPING": "Grouper par Mois",
             "USERNAME": "Nom de l'utilisateur",
             "USE_POS_RECEIPT": "Impression POS",
             "USE_SIMPLIFIED_CARD": "Utiliser une identité de patient simple",
diff --git a/client/src/modules/reports/generate/aged_creditors/aged_creditors.html b/client/src/modules/reports/generate/aged_creditors/aged_creditors.html
index c26daf7ac0..d02b03e364 100644
--- a/client/src/modules/reports/generate/aged_creditors/aged_creditors.html
+++ b/client/src/modules/reports/generate/aged_creditors/aged_creditors.html
@@ -28,6 +28,14 @@ <h3 class="text-capitalize" translate>REPORT.AGED_CREDITORS.TITLE</h3>
               on-select-callback = "ReportConfigCtrl.onSelectPeriod(period)">
             </bh-report-period-select>
 
+            <!-- toggle to grouping by months -->
+            <div class="checkbox">
+              <label>
+                <input type="checkbox" ng-model="ReportConfigCtrl.reportDetails.useMonthGrouping" ng-true-value="1" ng-false-value="0">
+                <span translate>FORM.LABELS.USE_MONTH_GROUPING</span>
+              </label>
+            </div>
+
             <!-- included Total Zeros  -->
             <div class="checkbox">
               <label>
@@ -44,4 +52,4 @@ <h3 class="text-capitalize" translate>REPORT.AGED_CREDITORS.TITLE</h3>
       </div>
     </div>
   </div>
-</div>
\ No newline at end of file
+</div>
diff --git a/client/src/modules/reports/generate/aged_debtors/aged_debtors.html b/client/src/modules/reports/generate/aged_debtors/aged_debtors.html
index ecc8f58c94..82fb3637eb 100644
--- a/client/src/modules/reports/generate/aged_debtors/aged_debtors.html
+++ b/client/src/modules/reports/generate/aged_debtors/aged_debtors.html
@@ -29,6 +29,7 @@ <h3 class="text-capitalize" translate>REPORT.AGED_DEBTORS.TITLE</h3>
               validation-trigger="ConfigForm.$submitted">
             </bh-report-period-select>
 
+            <!-- toggle to grouping by months -->
             <div class="checkbox">
               <label>
                 <input type="checkbox" ng-model="ReportConfigCtrl.reportDetails.useMonthGrouping" ng-true-value="1" ng-false-value="0">
diff --git a/server/controllers/finance/reports/creditors/aged.handlebars b/server/controllers/finance/reports/creditors/aged.handlebars
index c57e0ea2de..65bcebd6a0 100644
--- a/server/controllers/finance/reports/creditors/aged.handlebars
+++ b/server/controllers/finance/reports/creditors/aged.handlebars
@@ -19,11 +19,34 @@
           <tr class="text-capitalize" style="background-color: #ddd;">
             <th class="text-center">{{translate "TABLE.COLUMNS.NAME"}}</th>
             <th class="text-center" style="width:15%">{{translate "FORM.LABELS.ACCOUNT_NUMBER"}}</th>
-            <th class="text-center">{{translate "REPORT.ZERO_TO_THIRTY_DAYS"}}</th>
-            <th class="text-center">{{translate "REPORT.THIRTY_TO_SIXTY_DAYS"}}</th>
-            <th class="text-center">{{translate "REPORT.SIXTY_TO_NINETY_DAYS"}}</th>
-            <th class="text-center">{{translate "REPORT.OVER_NINETY_DAYS"}}</th>
-            <th class="text-center">{{translate "TABLE.COLUMNS.TOTAL"}}</th>
+            <th class="text-center">
+              {{#if useMonthGrouping}}
+                {{month firstMonth}}
+              {{else}}
+                {{translate "REPORT.ZERO_TO_THIRTY_DAYS"}}
+              {{/if}}
+            </th>
+            <th class="text-center">
+              {{#if useMonthGrouping}}
+                {{month secondMonth}}
+              {{else}}
+                {{translate "REPORT.THIRTY_TO_SIXTY_DAYS"}}
+              {{/if}}
+            </th>
+            <th class="text-center">
+              {{#if useMonthGrouping}}
+                {{month thirdMonth}}
+              {{else}}
+                {{translate "REPORT.SIXTY_TO_NINETY_DAYS"}}
+              {{/if}}
+            </th>
+            <th class="text-center">
+              {{#if useMonthGrouping}}
+                {{translate "REPORT.PREVIOUS_MONTHS"}}
+              {{else}}
+                {{translate "REPORT.OVER_NINETY_DAYS"}}
+              {{/if}}
+            </th>
           </tr>
         </thead>
         <tbody>
diff --git a/server/controllers/finance/reports/creditors/index.js b/server/controllers/finance/reports/creditors/index.js
index 0031102d7a..8e2e9cd586 100644
--- a/server/controllers/finance/reports/creditors/index.js
+++ b/server/controllers/finance/reports/creditors/index.js
@@ -11,6 +11,7 @@
 
 
 const _ = require('lodash');
+const moment = require('moment');
 const ReportManager = require('../../../../lib/ReportManager');
 const db = require('../../../../lib/db');
 
@@ -58,6 +59,7 @@ function queryContext(queryParams) {
   const params = queryParams || {};
   const havingNonZeroValues = ' HAVING total > 0 ';
   const includeZeroes = Boolean(Number(params.zeroes));
+  const useMonthGrouping = Boolean(Number(params.useMonthGrouping));
 
   // format the dates for MySQL escape
   const dates = _.fill(Array(5), new Date(params.date));
@@ -65,13 +67,26 @@ function queryContext(queryParams) {
   const data = {};
   const source = 'general_ledger';
 
+  const groupByMonthColumns = `
+    SUM(IF(MONTH(?) - MONTH(gl.trans_date) = 0, gl.debit_equiv - gl.credit_equiv, 0)) AS thirty,
+    SUM(IF(MONTH(?) - MONTH(gl.trans_date) = 1, gl.debit_equiv - gl.credit_equiv, 0)) AS sixty,
+    SUM(IF(MONTH(?) - MONTH(gl.trans_date) = 2, gl.debit_equiv - gl.credit_equiv, 0)) AS ninety,
+    SUM(IF(MONTH(?) - MONTH(gl.trans_date) > 2, gl.debit_equiv - gl.credit_equiv, 0)) AS excess,
+  `;
+
+  const groupByRangeColumns = `
+    SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 0 AND 29, gl.debit_equiv - gl.credit_equiv, 0)) AS thirty,
+    SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 30 AND 59, gl.debit_equiv - gl.credit_equiv, 0)) AS sixty,
+    SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 60 AND 89, gl.debit_equiv - gl.credit_equiv, 0)) AS ninety,
+    SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) > 90, gl.debit_equiv - gl.credit_equiv, 0)) AS excess,
+  `;
+
+  const columns = useMonthGrouping ? groupByMonthColumns : groupByRangeColumns;
+
   // selects into columns of 30, 60, 90, and >90
   const creditorSql = `
     SELECT BUID(cg.uuid) AS id, cg.name, a.number,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 0 AND 29, gl.credit_equiv - gl.debit_equiv, 0)) AS thirty,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 30 AND 59, gl.credit_equiv - gl.debit_equiv, 0)) AS sixty,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 60 AND 89, gl.credit_equiv - gl.debit_equiv, 0)) AS ninety,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) > 90, gl.credit_equiv - gl.debit_equiv, 0)) AS excess,
+      ${columns}
       SUM(gl.credit_equiv - gl.debit_equiv) AS total
     FROM creditor_group AS cg
       JOIN ${source} AS gl ON gl.account_id = cg.account_id
@@ -85,12 +100,9 @@ function queryContext(queryParams) {
   // aggregates the data above as totals into columns of 30, 60, 90, and >90
   const aggregateSql = `
     SELECT
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 0 AND 29, gl.credit_equiv - gl.debit_equiv, 0)) AS thirty,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 30 AND 59, gl.credit_equiv - gl.debit_equiv, 0)) AS sixty,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) BETWEEN 60 AND 89, gl.credit_equiv - gl.debit_equiv, 0)) AS ninety,
-      SUM(IF(DATEDIFF(DATE(?), DATE(gl.trans_date)) > 90, gl.credit_equiv - gl.debit_equiv, 0)) AS excess,
+      ${columns}
       SUM(gl.credit_equiv - gl.debit_equiv) AS total
-    FROM creditor_group AS cg 
+    FROM creditor_group AS cg
       JOIN ${source} AS gl ON gl.account_id = cg.account_id
     WHERE DATE(gl.trans_date) <= DATE(?)
     ${includeZeroes ? '' : havingNonZeroValues}
@@ -100,10 +112,17 @@ function queryContext(queryParams) {
     .then(creditors => {
       data.creditors = creditors;
       data.dateUntil = params.date;
+
+      // this is specific to grouping by months
+      data.firstMonth = params.date;
+      data.secondMonth = moment(params.date).subtract(1, 'month');
+      data.thirdMonth = moment(params.date).subtract(2, 'month');
+
+      data.useMonthGrouping = useMonthGrouping;
       return db.exec(aggregateSql, dates);
     })
     .then(aggregates => {
-      data.aggregates = aggregates[0];
+      [data.aggregates] = aggregates;
       return data;
     });
 }
diff --git a/server/controllers/finance/reports/debtors/aged.handlebars b/server/controllers/finance/reports/debtors/aged.handlebars
index d595a6c787..79f5202bbe 100644
--- a/server/controllers/finance/reports/debtors/aged.handlebars
+++ b/server/controllers/finance/reports/debtors/aged.handlebars
@@ -19,36 +19,36 @@
         <thead>
           <tr class="text-capitalize text-center" style="background-color: #ddd;">
             <th>{{translate "TABLE.COLUMNS.NAME"}}</th>
-            <th style="width:15%">{{translate "FORM.LABELS.ACCOUNT_NUMBER"}}</th>
-            <th>
+            <th style="width:15%" class="text-center">{{translate "FORM.LABELS.ACCOUNT_NUMBER"}}</th>
+            <th class="text-center">
               {{#if useMonthGrouping}}
                 {{month firstMonth}}
               {{else}}
                 {{translate "REPORT.ZERO_TO_THIRTY_DAYS"}}
               {{/if}}
             </th>
-            <th>
+            <th class="text-center">
               {{#if useMonthGrouping}}
                 {{month secondMonth}}
               {{else}}
                 {{translate "REPORT.THIRTY_TO_SIXTY_DAYS"}}
               {{/if}}
             </th>
-            <th>
+            <th class="text-center">
               {{#if useMonthGrouping}}
                 {{month thirdMonth}}
               {{else}}
                 {{translate "REPORT.SIXTY_TO_NINETY_DAYS"}}
               {{/if}}
             </th>
-            <th>
+            <th class="text-center">
               {{#if useMonthGrouping}}
                 {{translate "REPORT.PREVIOUS_MONTHS"}}
               {{else}}
                 {{translate "REPORT.OVER_NINETY_DAYS"}}
               {{/if}}
             </th>
-            <th>{{translate "TABLE.COLUMNS.TOTAL"}}</th>
+            <th class="text-center">{{translate "TABLE.COLUMNS.TOTAL"}}</th>
           </tr>
         </thead>
         <tbody>