FinanceBuddy: keep signed amounts on one line, relabel column total (v0.4.1)

Asset/css/finance.css

@@ -1,10 +1,65 @@
 /*
  * FinanceBuddy styles.
- *
- * The money badge (.fb-badge / .fb-installments) and the per-column total (.fb-column-total)
- * styling are added as those features land in later versions.
  */
 
+/* Per-column net total in the column header (its own line, subtle pill). */
+.fb-column-total {
+    display: inline-block;
+    margin-top: 3px;
+    padding: 0 5px;
+    font-weight: bold;
+    font-size: 0.95em;
+    background: rgba(0, 0, 0, 0.05);
+    border-radius: 3px;
+}
+
+/* Keep the signed amount together ("-R$450,00"); a break before it (after "Total:") is fine. */
+.fb-amount {
+    white-space: nowrap;
+}
+
+.fb-total-debit {
+    color: #b94a48;
+}
+
+.fb-total-credit {
+    color: #468847;
+}
+
+.fb-total-zero {
+    color: #777;
+}
+
+/* Line-3 money badge on board cards. Its own background guarantees contrast on any card color. */
+.fb-line {
+    margin: 2px 0 4px;
+    line-height: 1.4;
+}
+
+.fb-badge {
+    display: inline-block;
+    padding: 1px 6px;
+    border-radius: 3px;
+    color: #fff;
+    font-weight: bold;
+    font-size: 1.1em;
+    white-space: nowrap;
+}
+
+.fb-badge-debit {
+    background: #b94a48;
+}
+
+.fb-badge-credit {
+    background: #468847;
+}
+
+.fb-installments {
+    margin-left: 6px;
+    color: #000;
+    font-size: 1.05em;
+}
+
 /* Task-form finance fieldset (middle column). */
 .fb-form-directions {
     margin-bottom: 8px;

Helper/FinanceHelper.php

@@ -23,6 +23,9 @@ class FinanceHelper extends Base
     // non-finance task updates (moves, API calls) are ignored by the persistence hooks.
     const FORM_MARKER = 'financebuddy_form';
 
+    // Memoized per project_id: the board hooks below call isEnabled() once per card.
+    private static $enabledCache = array();
+
     /**
      * Is FinanceBuddy enabled for this board?
      *
@@ -31,25 +34,82 @@ class FinanceHelper extends Base
      */
     public function isEnabled($project_id)
     {
-        return (int) $this->projectMetadataModel->get($project_id, self::ENABLED_KEY, 0) === 1;
+        $project_id = (int) $project_id;
+
+        if (! isset(self::$enabledCache[$project_id])) {
+            self::$enabledCache[$project_id] = (int) $this->projectMetadataModel->get($project_id, self::ENABLED_KEY, 0) === 1;
+        }
+
+        return self::$enabledCache[$project_id];
     }
 
     /**
-     * Stored finance values for a task, with defaults.
+     * Stored finance values for a task, with defaults. One query (getAll) since the board renders
+     * this per card.
      *
      * @param  integer $task_id
      * @return array
      */
     public function get($task_id)
     {
+        $all = $this->taskMetadataModel->getAll($task_id);
+
         return array(
-            'amount' => $this->taskMetadataModel->get($task_id, self::AMOUNT_KEY, ''),
+            'amount' => isset($all[self::AMOUNT_KEY]) ? $all[self::AMOUNT_KEY] : '',
-            'direction' => $this->taskMetadataModel->get($task_id, self::DIRECTION_KEY, 'debit') ?: 'debit',
+            'direction' => (isset($all[self::DIRECTION_KEY]) && $all[self::DIRECTION_KEY] === 'credit') ? 'credit' : 'debit',
-            'installment_current' => $this->taskMetadataModel->get($task_id, self::INSTALLMENT_CURRENT_KEY, ''),
+            'installment_current' => isset($all[self::INSTALLMENT_CURRENT_KEY]) ? $all[self::INSTALLMENT_CURRENT_KEY] : '',
-            'installment_total' => $this->taskMetadataModel->get($task_id, self::INSTALLMENT_TOTAL_KEY, ''),
+            'installment_total' => isset($all[self::INSTALLMENT_TOTAL_KEY]) ? $all[self::INSTALLMENT_TOTAL_KEY] : '',
         );
     }
 
+    /**
+     * Net money for a board column: credits positive, debits negative, summed over the cards in
+     * the column. One grouped query over the column's task ids (the task rows carry no metadata).
+     *
+     * @param  array $column  A board column as passed to template:board:column:header ('tasks').
+     * @return float
+     */
+    public function columnNet(array $column)
+    {
+        if (empty($column['tasks'])) {
+            return 0.0;
+        }
+
+        $task_ids = array();
+        foreach ($column['tasks'] as $task) {
+            $task_ids[] = (int) $task['id'];
+        }
+
+        $rows = $this->db->table('task_has_metadata')
+            ->columns('task_id', 'name', 'value')
+            ->in('task_id', $task_ids)
+            ->in('name', array(self::AMOUNT_KEY, self::DIRECTION_KEY))
+            ->findAll();
+
+        $amounts = array();
+        $directions = array();
+
+        foreach ($rows as $row) {
+            if ($row['name'] === self::AMOUNT_KEY) {
+                $amounts[$row['task_id']] = (float) $row['value'];
+            } else {
+                $directions[$row['task_id']] = $row['value'];
+            }
+        }
+
+        $net = 0.0;
+        foreach ($amounts as $task_id => $amount) {
+            if ($amount <= 0) {
+                continue;
+            }
+
+            $is_credit = isset($directions[$task_id]) && $directions[$task_id] === 'credit';
+            $net += $is_credit ? $amount : -$amount;
+        }
+
+        return $net;
+    }
+
     /**
      * Values to prefill the task-form fields: a re-post (after a validation error) wins, then the
      * stored metadata for an existing task, otherwise blanks for a new task.
@@ -95,4 +155,16 @@ class FinanceHelper extends Base
 
         return $value > 0 ? $value : 0.0;
     }
+
+    /**
+     * Format a money value for display: two decimals, comma decimal separator, no thousand
+     * separator (e.g. 20.9 -> "20,90"). Accepts a float or a canonical dot-string.
+     *
+     * @param  float|string $amount
+     * @return string
+     */
+    public static function money($amount)
+    {
+        return number_format((float) $amount, 2, ',', '');
+    }
 }

Plugin.php

@@ -28,6 +28,14 @@ class Plugin extends Base
         $this->hook->on('model:task:creation:prepare', array($persistence, 'onCreationPrepare'));
         $this->hook->on('model:task:creation:aftersave', array($persistence, 'onCreationAfterSave'));
         $this->hook->on('model:task:modification:prepare', array($persistence, 'onModificationPrepare'));
+
+        // The line-3 money badge on each board card, rendered directly under the title. Two hooks:
+        // "private" is the normal board, "public" is the read-only board shared by token.
+        $this->template->hook->attach('template:board:private:task:after-title', 'financeBuddy:board/task_money');
+        $this->template->hook->attach('template:board:public:task:after-title', 'financeBuddy:board/task_money');
+
+        // Per-column net total (credits - debits) in the column header.
+        $this->template->hook->attach('template:board:column:header', 'financeBuddy:board/column_total');
     }
 
     public function getHelpers()
@@ -54,7 +62,7 @@ class Plugin extends Base
 
     public function getPluginVersion()
     {
-        return '0.3.0';
+        return '0.4.1';
     }
 
     public function getPluginHomepage()

Template/board/column_total.php

@@ -0,0 +1,24 @@
+<?php
+// Per-column net total in the column header (credits - debits). Shown in every column of an
+// enabled board, including "total R$0,00" -- never hidden on zero. Server-side, re-renders on
+// every board refresh.
+if (empty($column['project_id']) || ! $this->FinanceHelper->isEnabled($column['project_id'])) {
+    return;
+}
+
+$net = $this->FinanceHelper->columnNet($column);
+
+if ($net > 0) {
+    $class = 'fb-column-total fb-total-credit';
+    $sign = '+';
+} elseif ($net < 0) {
+    $class = 'fb-column-total fb-total-debit';
+    $sign = '-';
+} else {
+    $class = 'fb-column-total fb-total-zero';
+    $sign = '';
+}
+?>
+<div class="<?= $class ?>">
+    <?= t('Total') ?>: <span class="fb-amount"><?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money(abs($net)) ?></span>
+</div>

Template/board/task_money.php

@@ -0,0 +1,27 @@
+<?php
+// Line-3 money badge, rendered under the card title via the after-title hooks. Server-side, so
+// it re-renders correctly on every board refresh. Nothing shows unless the board is enabled and
+// the card has a positive amount.
+if (empty($task['project_id']) || ! $this->FinanceHelper->isEnabled($task['project_id'])) {
+    return;
+}
+
+$fb = $this->FinanceHelper->get($task['id']);
+
+if ($fb['amount'] === '' || (float) $fb['amount'] <= 0) {
+    return;
+}
+
+$credit = $fb['direction'] === 'credit';
+$sign = $credit ? '+' : '-';
+$total = $fb['installment_total'];
+$current = $fb['installment_current'] !== '' ? $fb['installment_current'] : '1';
+?>
+<div class="fb-line">
+    <span class="fb-badge <?= $credit ? 'fb-badge-credit' : 'fb-badge-debit' ?>">
+        <?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money($fb['amount']) ?>
+    </span>
+    <?php if ($total !== ''): ?>
+        <span class="fb-installments">p<?= $this->text->e($current) ?>/<?= $this->text->e($total) ?></span>
+    <?php endif ?>
+</div>

VERSION

@@ -1 +1 @@
-FinanceBuddy v0.3
+FinanceBuddy v0.4.1