From 577cf8f60e3c7550002e0b682309e63f6db2eace Mon Sep 17 00:00:00 2001
From: Jonathan Niles <jonathanwniles@imaworldhealth.org>
Date: Thu, 9 Feb 2017 19:39:28 +0100
Subject: [PATCH] fix(cashbox): ensure is_auxiliary is updated

This commit should fix the issues in cashbox management where cashboxes
were not properly updated with the is_auxiliary field.  It also
generally improves the code by:
 1. Using the translate directive on the client.
 2. Using `db.one()` on the server.
 3. Using `FilterParser` on the server.

Closes #976.
---
 .../partials/cash/cashboxes/cashboxes.html    |  10 +-
 .../partials/cash/cashboxes/update/add.html   |  29 +++--
 .../partials/cash/cashboxes/update/edit.html  |  42 +++----
 server/controllers/finance/cashboxes/index.js | 114 +++++++-----------
 4 files changed, 81 insertions(+), 114 deletions(-)

diff --git a/client/src/partials/cash/cashboxes/cashboxes.html b/client/src/partials/cash/cashboxes/cashboxes.html
index 1afc2cca4b..4ae860eab4 100644
--- a/client/src/partials/cash/cashboxes/cashboxes.html
+++ b/client/src/partials/cash/cashboxes/cashboxes.html
@@ -2,23 +2,21 @@
   <div class="bhima-title">
 
     <ol class="headercrumb">
-      <li class="static">{{ "TREE.ADMIN" | translate }}</li>
-      <li class="title">{{ "CASHBOX.TITLE" | translate }}</li>
-      <!-- <span class="label label-warning">{{"BUTTON.CREATE" | translate}}</span> -->
+      <li class="static" translate>TREE.ADMIN</li>
+      <li class="title" translate>CASHBOX.TITLE</li>
     </ol>
 
     <div class="toolbar">
       <div class="toolbar-item">
         <button class="btn btn-default" ui-sref="cashboxes.create" data-method="create">
-          <i class="fa fa-plus"></i>
-          {{ "FORM.BUTTONS.ADD" | translate }}
+          <i class="fa fa-plus-square"></i>
+          <span translate>FORM.BUTTONS.ADD</span> <span translate>CASHBOX.CASHBOX</span>
         </button>
       </div>
     </div>
   </div>
 </div>
 
-<!-- Cashbox mangement content -->
 <div class="flex-content">
   <div ui-view autoscroll></div>
  </div>
diff --git a/client/src/partials/cash/cashboxes/update/add.html b/client/src/partials/cash/cashboxes/update/add.html
index a80cdd163c..f9d4634843 100644
--- a/client/src/partials/cash/cashboxes/update/add.html
+++ b/client/src/partials/cash/cashboxes/update/add.html
@@ -5,7 +5,7 @@
       <p>
         <a ui-sref="cashboxes.list">
           <span class="fa fa-arrow-circle-left"></span>
-          {{ "CASHBOX.BACK" | translate }}
+          <span translate>CASHBOX.BACK</span>
         </a>
       </p>
     </div>
@@ -22,8 +22,8 @@
        <div>
          <div>
             <div class="form-group" ng-class="{ 'has-error' : CreateForm.$submitted && CreateForm.label.$invalid }">
-              <label class="control-label">
-                {{ "FORM.LABELS.NAME" | translate }}
+              <label class="control-label" translate>
+                FORM.LABELS.NAME
               </label>
               <input class="form-control" name="label" ng-model="UpdateCtrl.box.label" ng-maxlength="CashCtrl.maxLength" required autocomplete="off">
               <div class="help-block" ng-messages="CreateForm.label.$error" ng-show="CreateForm.$submitted">
@@ -31,22 +31,21 @@
               </div>
             </div>
 
-            <label class="control-label">
-              {{ "FORM.LABELS.TYPE" | translate }}
-            </label>
-
             <div class="form-group" ng-class="{ 'has-error' : CreateForm.$submitted && CreateForm.type.$invalid }">
+              <label class="control-label" translate>
+                FORM.LABELS.TYPE
+              </label>
               <div class="radio">
                 <label>
-                  <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" value="0" required>
-                  {{ "FORM.LABELS.PRINCIPAL" | translate }}
+                  <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" ng-value="0" required>
+                  <span translate>FORM.LABELS.PRINCIPAL</span>
                 </label>
               </div>
 
               <div class="radio">
                 <label>
-                  <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" value="1" required>
-                  {{ "FORM.LABELS.AUXILIARY" | translate }}
+                  <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" ng-value="1" required>
+                  <span translate>FORM.LABELS.AUXILIARY</span>
                 </label>
               </div>
               <div class="help-block" ng-messages="CreateForm.type.$error" ng-show="CreateForm.$submitted">
@@ -55,8 +54,8 @@
             </div>
 
             <div class="form-group" ng-class="{ 'has-error' : CreateForm.$submitted && CreateForm.project.$invalid }">
-              <label class="control-label">
-                {{ "FORM.LABELS.PROJECT" | translate }}
+              <label class="control-label" translate>
+                FORM.LABELS.PROJECT
               </label>
               <select
                 class="form-control"
@@ -64,7 +63,7 @@
                 ng-model="UpdateCtrl.box.project_id"
                 ng-options="project.id as project.name for project in CashCtrl.projects track by project.id"
                 required>
-                <option value="" disabled>{{ "FORM.SELECT.PROJECT" | translate }}</option>
+                <option value="" disabled translate>FORM.SELECT.PROJECT</option>
               </select>
               <div class="help-block" ng-messages="CreateForm.project.$error" ng-show="CreateForm.$submitted">
                 <div ng-messages-include="partials/templates/messages.tmpl.html"></div>
@@ -76,7 +75,7 @@
         <div class="clearfix" style="margin-bottom : 5px">
           <div class="pull-right" style="text-align : right">
             <bh-loading-button loading-state="CreateForm.$loading">
-              {{ "FORM.BUTTONS.SUBMIT" | translate }}
+              <span translate>FORM.BUTTONS.SUBMIT</span>
             </bh-loading-button>
           </div>
         </div>
diff --git a/client/src/partials/cash/cashboxes/update/edit.html b/client/src/partials/cash/cashboxes/update/edit.html
index ed0c7ca3e7..63a0364467 100644
--- a/client/src/partials/cash/cashboxes/update/edit.html
+++ b/client/src/partials/cash/cashboxes/update/edit.html
@@ -5,7 +5,7 @@
       <p>
         <a ui-sref="cashboxes.list">
           <span class="fa fa-arrow-circle-left"></span>
-          {{ "CASHBOX.BACK" | translate }}
+          <span translate>CASHBOX.BACK</span>
         </a>
       </p>
     </div>
@@ -23,8 +23,8 @@
          <div>
            <div>
               <div class="form-group" ng-class="{ 'has-error' : UpdateForm.$submitted && UpdateForm.label.$invalid }">
-                <label class="control-label">
-                  {{ "FORM.LABELS.NAME" | translate }}
+                <label class="control-label" translate>
+                  FORM.LABELS.NAME
                 </label>
                 <input class="form-control" name="label" ng-model="UpdateCtrl.box.label" ng-maxlength="CashCtrl.maxLength" required>
                 <div class="help-block" ng-messages="UpdateForm.label.$error" ng-show="UpdateForm.$submitted">
@@ -33,20 +33,20 @@
               </div>
 
               <div class="form-group" ng-class="{ 'has-error' : UpdateForm.$submitted && UpdateForm.type.$invalid }">
-                <label class="control-label">
-                  {{ "FORM.LABELS.TYPE" | translate }}
+                <label class="control-label" translate>
+                  FORM.LABELS.TYPE
                 </label>
                 <div class="radio">
                   <label>
-                    <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" value="0" required>
-                    {{ "FORM.LABELS.PRINCIPAL" | translate }}
+                    <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" ng-value="0" required>
+                    <span translate>FORM.LABELS.PRINCIPAL</span>
                   </label>
                 </div>
 
                 <div class="radio">
                   <label>
-                    <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" value="1" required>
-                    {{ "FORM.LABELS.AUXILIARY" | translate }}
+                    <input type="radio" name="type" ng-model="UpdateCtrl.box.is_auxiliary" ng-value="1" required>
+                    <span translate>FORM.LABELS.AUXILIARY</span>
                   </label>
                 </div>
                 <div class="help-block" ng-messages="UpdateForm.type.$error" ng-show="UpdateForm.$submitted">
@@ -55,23 +55,23 @@
               </div>
 
               <div class="form-group">
-                <label>{{ "FORM.LABELS.CURRENCIES" | translate }}</label>
+                <label translate>FORM.LABELS.CURRENCIES</label>
                 <div ng-repeat="currency in UpdateCtrl.currencies | orderBy:currency.name track by currency.id">
                   <p ng-class="{ 'text-danger' : !currency.configured }">
                     <i class="fa fa-alert" ng-if="!currency.configured"></i> {{ currency.name }} ({{ currency.symbol}})
-                    <a class="btn btn-xs btn-default" href="" ng-click="UpdateCtrl.configureCurrency(currency)" data-currency-id="{{ currency.id }}">
-                      <i class="fa fa-pencil-square-o"></i> {{ "FORM.BUTTONS.CONFIGURE" | translate }}
+                    <a class="btn btn-xs btn-default" href ng-click="UpdateCtrl.configureCurrency(currency)" data-currency-id="{{ ::currency.id }}">
+                      <i class="fa fa-pencil-square-o"></i> <span translate>FORM.BUTTONS.CONFIGURE</span>
                     </a>
                   </p>
-                  <p ng-if="!currency.configured" class="help-block">
-                    {{ "FORM.INFO.NOT_CONFIGURED" | translate }}
+                  <p ng-if="!currency.configured" class="help-block" translate>
+                    FORM.INFO.NOT_CONFIGURED
                   </p>
                 </div>
               </div>
 
               <div class="form-group" ng-class="{ 'has-error' : UpdateForm.$submitted && UpdateForm.project.$invalid }">
-                <label class="control-label">
-                  {{ "FORM.LABELS.PROJECT" | translate }}
+                <label class="control-label" translate>
+                  FORM.LABELS.PROJECT
                 </label>
                 <select
                   class="form-control"
@@ -79,7 +79,7 @@
                   ng-model="UpdateCtrl.box.project_id"
                   ng-options="project.id as project.name for project in CashCtrl.projects"
                   required>
-                  <option value="" disabled>{{ "FORM.SELECT.PROJECT" | translate }}</option>
+                  <option value="" disabled translate>FORM.SELECT.PROJECT</option>
                 </select>
                 <div class="help-block" ng-messages="UpdateForm.project.$error" ng-show="UpdateForm.$submitted">
                   <div ng-messages-include="partials/templates/messages.tmpl.html"></div>
@@ -91,7 +91,7 @@
           <div class="clearfix" style="margin-bottom : 5px">
             <div class="pull-right" style="text-align : right">
               <bh-loading-button loading-state="UpdateForm.$loading">
-                {{ "FORM.BUTTONS.SUBMIT" | translate }}
+                <span translate>FORM.BUTTONS.SUBMIT</span>
               </bh-loading-button>
             </div>
           </div>
@@ -100,12 +100,12 @@
 
       <div class="col-md-7">
         <div class="panel panel-default">
-          <div class="panel-heading">
-            <i class="fa fa-ellipsis-h"></i> {{ "CASHBOX.ACTIONS" | translate }}
+          <div class="panel-heading" translate>
+            CASHBOX.ACTIONS
           </div>
           <div class="panel-body">
             <button class="btn btn-danger" type="button" ng-click="UpdateCtrl.remove(UpdateCtrl.box)" data-method="delete">
-              <i class="fa fa-trash-o"></i> {{ "FORM.BUTTONS.DELETE" | translate }} {{ "CASHBOX.CASHBOX" | translate }}
+              <i class="fa fa-trash-o"></i> <span translate>FORM.BUTTONS.DELETE</span> <span translate>CASHBOX.CASHBOX</span>
             </button>
           </div>
         </div>
diff --git a/server/controllers/finance/cashboxes/index.js b/server/controllers/finance/cashboxes/index.js
index 85ada271eb..2f4c855a67 100644
--- a/server/controllers/finance/cashboxes/index.js
+++ b/server/controllers/finance/cashboxes/index.js
@@ -10,12 +10,14 @@
  * @requires NotFound
  * @requires Topic
  * @requires Cashboxes/Currencies
+ * @requires FilterParser
  */
 
 'use strict';
 
 const db = require('../../../lib/db');
 const NotFound = require('../../../lib/errors/NotFound');
+const FilterParser = require('../../../lib/filter');
 const Topic = require('../../../lib/topic');
 const currencies = require('./currencies');
 
@@ -33,22 +35,16 @@ exports.currencies = currencies;
  * GET /cashboxes
  * Lists available cashboxes, defaulting to all in the database.  Pass in the
  * optional parameters:
- *  1) ?project_id={id}
- *  2) ?is_auxiliary={1|0}
- *  3) ?detailed={1|0}
- * to filter results appropriately.
  */
 function list(req, res, next) {
-  const possibleConditions = ['project_id', 'is_auxiliary'];
-  const providedConditions = Object.keys(req.query);
-  const conditions = [];
+  const filters = new FilterParser(req.query);
 
   let sql =
-    'SELECT id, label FROM cash_box ';
+    'SELECT id, label, is_auxiliary FROM cash_box ';
 
   if (req.query.detailed === '1') {
     sql = `
-      SELECT cash_box.id, label, account_id, transfer_account_id, symbol,
+      SELECT cash_box.id, label, account_id, is_auxiliary, transfer_account_id, symbol,
       cash_box_account_currency.currency_id
       FROM cash_box JOIN cash_box_account_currency ON
       cash_box.id = cash_box_account_currency.cash_box_id JOIN currency ON
@@ -56,33 +52,16 @@ function list(req, res, next) {
     `;
   }
 
-  delete req.query.detailed;
+  filters.equals('project_id');
+  filters.equals('is_auxiliary');
 
-  // loop through conditions if they exist, escaping them and adding them
-  // to the query string.
-  /** @todo -- use the queryConditions() function already written */
-  if (providedConditions.length > 0) {
-    possibleConditions.forEach(function (k) {
-      let key = req.query[k];
+  filters.setOrder('ORDER BY label');
 
-      // if the key exists, add it to a list of growing conditions
-      if (key) {
-        conditions.push(k + ' = ' + db.escape(key));
-      }
-    });
-  }
-
-  // if we have actual matches, concatenate them into a WHERE condition
-  if (conditions.length > 0) {
-    sql += 'WHERE ' + conditions.join(' AND ');
-  }
-
-  sql += ';';
+  const query = filters.applyQuery(sql);
+  const parameters = filters.parameters();
 
-  db.exec(sql)
-    .then(function (rows) {
-      res.status(200).json(rows);
-    })
+  db.exec(query, parameters)
+    .then(rows => res.status(200).json(rows))
     .catch(next)
     .done();
 }
@@ -104,14 +83,10 @@ function helperGetCashbox(id) {
     WHERE id = ?;
   `;
 
-  return db.exec(sql, [id])
-    .then(function (rows) {
-
-      if (!rows.length) {
-        throw new NotFound(`Could not find a cashbox with id ${id}.`);
-      }
+  return db.one(sql, [id], id, 'Cashbox')
+    .then(box => {
 
-      cashbox = rows[0];
+      cashbox = box;
 
       // query the currencies supported by this cashbox
       sql = `
@@ -122,8 +97,7 @@ function helperGetCashbox(id) {
 
       return db.exec(sql, [cashbox.id]);
     })
-    .then(function (rows) {
-
+    .then(rows => {
       // assign the currencies to the cashbox
       cashbox.currencies = rows;
       return cashbox;
@@ -141,11 +115,9 @@ function helperGetCashbox(id) {
  */
 function detail(req, res, next) {
   helperGetCashbox(req.params.id)
-  .then(function (cashbox) {
-    res.status(200).json(cashbox);
-  })
-  .catch(next)
-  .done();
+    .then(cashbox => res.status(200).json(cashbox))
+    .catch(next)
+    .done();
 }
 
 
@@ -163,19 +135,19 @@ function create(req, res, next) {
     'INSERT INTO cash_box SET ?;';
 
   db.exec(sql, [ box ])
-  .then(function (row) {
+    .then(function (row) {
 
-    Topic.publish(Topic.channels.FINANCE, {
-      event: Topic.events.CREATE,
-      entity: Topic.entities.CASHBOX,
-      user_id: req.session.user.id,
-      id: row.insertId
-    });
+      Topic.publish(Topic.channels.FINANCE, {
+        event: Topic.events.CREATE,
+        entity: Topic.entities.CASHBOX,
+        user_id: req.session.user.id,
+        id: row.insertId
+      });
 
-    res.status(201).json({ id : row.insertId });
-  })
-  .catch(next)
-  .done();
+      res.status(201).json({ id : row.insertId });
+    })
+    .catch(next)
+    .done();
 }
 
 /**
@@ -191,22 +163,20 @@ function update(req, res, next) {
   let sql = 'UPDATE cash_box SET ? WHERE id = ?;';
 
   db.exec(sql, [req.body, req.params.id])
-  .then(function (rows) {
-    return helperGetCashbox(req.params.id);
-  })
-  .then(function (cashbox) {
+    .then(() => helperGetCashbox(req.params.id))
+    .then(cashbox => {
 
-    Topic.publish(Topic.channels.FINANCE, {
-      event: Topic.events.UPDATE,
-      entity: Topic.entities.CASHBOX,
-      user_id: req.session.user.id,
-      id: req.params.id
-    });
+      Topic.publish(Topic.channels.FINANCE, {
+        event: Topic.events.UPDATE,
+        entity: Topic.entities.CASHBOX,
+        user_id: req.session.user.id,
+        id: req.params.id
+      });
 
-    res.status(200).json(cashbox);
-  })
-  .catch(next)
-  .done();
+      res.status(200).json(cashbox);
+    })
+    .catch(next)
+    .done();
 }