FinanceBuddy: separate the Integrations section with a trailing rule (v1.1.2)

Asset/css/finance.css

@@ -1,10 +1,79 @@
 /*
  * 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.
  */
 
+/* The column header (.board-column-expanded-header) is a flex row, so the total is a flex item. To
+   drop it onto its own line under the title, let that header wrap (scoped with :has to headers that
+   actually contain the total -- i.e. enabled boards only) and give the total full width. No
+   background (dropped per request); "Total:" stays black, only the amount span is colored by sign. */
+.board-column-expanded-header:has(.fb-column-total) {
+    flex-wrap: wrap;
+}
+
+.fb-column-total {
+    flex-basis: 100%;
+    margin-top: 2px;
+    text-align: right;
+}
+
+/* The visible pill hugs the text (not the full width) and is right-justified on its line. */
+.fb-total-pill {
+    display: inline-block;
+    padding: 0 5px;
+    font-weight: bold;
+    font-size: 0.95em;
+    color: #000;
+    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, ',', '');
+    }
 }

Model/FinancePersistence.php

@@ -48,6 +48,41 @@ class FinancePersistence extends Base
         if ($this->pending !== null) {
             $this->persist((int) $task_id, $this->pending['project_id'], $this->pending['fields']);
             $this->pending = null;
+            return;
+        }
+
+        // Not a form submission. Native recurrence builds the next occurrence with a plain task
+        // create (which copies no metadata) after setting recurrence_parent to the source task, so
+        // carry the finance metadata across -- otherwise the recurring card loses its money.
+        $task = $this->taskFinderModel->getById((int) $task_id);
+
+        if (! empty($task['recurrence_parent'])) {
+            // A recurrence is the NEXT occurrence, so advance the installment (p2/30 -> p3/30).
+            $this->copyMetadata((int) $task['recurrence_parent'], (int) $task_id, true);
+        }
+    }
+
+    /**
+     * model:task:duplication:aftersave -- the manual "Duplicate" action. TaskDuplicationModel does
+     * not copy metadata, so carry the finance fields to the new task.
+     */
+    public function onDuplication(array &$hook_values)
+    {
+        if (! empty($hook_values['source_task_id']) && ! empty($hook_values['destination_task_id'])) {
+            $this->copyMetadata((int) $hook_values['source_task_id'], (int) $hook_values['destination_task_id']);
+        }
+    }
+
+    /**
+     * recoreco:task:spawned -- RecoReco (calendar recurrence) just spawned a copy. Its ongoing card
+     * is the TEMPLATE that stays (unlike native recurrence, whose ongoing card is the new child), so
+     * advance the SOURCE template's installment. The clone already copied the current installment
+     * verbatim via onDuplication during RecoReco's duplicate() call.
+     */
+    public function onRecoRecoSpawn(array &$payload)
+    {
+        if (! empty($payload['source_task_id'])) {
+            $this->advanceInstallment((int) $payload['source_task_id']);
         }
     }
 
@@ -114,6 +149,74 @@ class FinancePersistence extends Base
         ));
     }
 
+    /**
+     * Copy the finance metadata from one task to another (recurrence next occurrence, or a manual
+     * duplicate). When $advance is true, bump the current installment by one -- clamped at the
+     * total so a finite plan stops at its last installment (e.g. p30/30 stays p30/30).
+     */
+    private function copyMetadata($source_id, $dest_id, $advance = false)
+    {
+        if ($source_id <= 0 || $dest_id <= 0) {
+            return;
+        }
+
+        $amount = $this->taskMetadataModel->get($source_id, FinanceHelper::AMOUNT_KEY, '');
+
+        // Nothing to carry over if the source has no money set.
+        if ($amount === '' || (float) $amount <= 0) {
+            return;
+        }
+
+        $direction = $this->taskMetadataModel->get($source_id, FinanceHelper::DIRECTION_KEY, 'debit');
+        $current = $this->taskMetadataModel->get($source_id, FinanceHelper::INSTALLMENT_CURRENT_KEY, '');
+        $total = $this->taskMetadataModel->get($source_id, FinanceHelper::INSTALLMENT_TOTAL_KEY, '');
+
+        if ($advance && $current !== '' && ctype_digit((string) $current)) {
+            $next = (int) $current + 1;
+
+            if ($total !== '' && ctype_digit((string) $total) && $next > (int) $total) {
+                $next = (int) $total;
+            }
+
+            $current = (string) $next;
+        }
+
+        $this->taskMetadataModel->save($dest_id, array(
+            FinanceHelper::AMOUNT_KEY => $amount,
+            FinanceHelper::DIRECTION_KEY => $direction === 'credit' ? 'credit' : 'debit',
+            FinanceHelper::INSTALLMENT_CURRENT_KEY => $current,
+            FinanceHelper::INSTALLMENT_TOTAL_KEY => $total,
+        ));
+    }
+
+    /**
+     * Advance a task's current installment by one, in place. A finite plan clamps at total+1, one
+     * past the last installment: that overflow is the "plan complete" tombstone (p4/3) that RecoReco
+     * reads to stop a following recurrence, and it caps runaway when nothing follows. Clones still
+     * read p1/total .. pTotal/total because a clone snapshots current BEFORE this advance. An
+     * open-ended plan (no total) increments unbounded (p2 -> p3); cards with no numeric current
+     * installment are left alone.
+     */
+    private function advanceInstallment($task_id)
+    {
+        $current = $this->taskMetadataModel->get($task_id, FinanceHelper::INSTALLMENT_CURRENT_KEY, '');
+
+        if ($current === '' || ! ctype_digit((string) $current)) {
+            return;
+        }
+
+        $total = $this->taskMetadataModel->get($task_id, FinanceHelper::INSTALLMENT_TOTAL_KEY, '');
+        $next = (int) $current + 1;
+
+        if ($total !== '' && ctype_digit((string) $total) && $next > (int) $total + 1) {
+            $next = (int) $total + 1;
+        }
+
+        $this->taskMetadataModel->save($task_id, array(
+            FinanceHelper::INSTALLMENT_CURRENT_KEY => (string) $next,
+        ));
+    }
+
     private function intOrBlank($raw)
     {
         $raw = trim((string) $raw);

Plugin.php

@@ -28,6 +28,29 @@ 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'));
+
+        // Carry the finance metadata onto copies (which Kanboard does not copy): native recurrence
+        // advances the installment for the next occurrence (creation:aftersave via recurrence_parent),
+        // and a manual Duplicate copies it verbatim.
+        $this->hook->on('model:task:duplication:aftersave', array($persistence, 'onDuplication'));
+
+        // RecoReco (calendar recurrence) spawns a copy and emits this signal. The clone already got
+        // the finance verbatim (via onDuplication above); here we advance the SOURCE template's
+        // installment, since RecoReco's ongoing card is the template that stays.
+        $this->hook->on('recoreco:task:spawned', array($persistence, 'onRecoRecoSpawn'));
+
+        // 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');
+
+        // The same money badge at the top of the opened card (task view), under the title, so a
+        // card shows its money whether you are on the board or reading the card. Reuses the board
+        // badge template (both hooks pass $task).
+        $this->template->hook->attach('template:task:details:top', 'financeBuddy:board/task_money');
     }
 
     public function getHelpers()
@@ -54,7 +77,7 @@ class Plugin extends Base
 
     public function getPluginVersion()
     {
-        return '0.3.0';
+        return '1.1.2';
     }
 
     public function getPluginHomepage()

README.md

@@ -1,8 +1,8 @@
 # FinanceBuddy -- money on your Kanboard cards
 
-Attach a money value to a board card, see it on the card, and total it per column -- so a
+Attach a money value to each board card, see it on the card, and total it per column, so a
-Kanboard project can double as a simple, visual finance board (bills, installments, income
+Kanboard project can double as a simple, visual finance board -- bills, installments, income
-vs expenses).
+vs expenses.
 
 FinanceBuddy is **opt-in per board**: installing it changes nothing until a project manager
 enables it for a specific board under Settings -> Integrations. Boards that are not enabled
@@ -10,30 +10,68 @@ look exactly as before.
 
 ## The idea: a bill-lifecycle board
 
-Kanboard imposes no structure, so FinanceBuddy is built to fit one rather than dictate it. The
+Kanboard imposes no structure, so FinanceBuddy fits one rather than dictating it. A layout that
-suggested organization:
+works well:
 
-- **Columns = a bill's status:** `Templates -> Due this month -> Paid`. Cards flow left to
+- **Columns = a bill's status:** `Templates -> Due this month -> Paid`. Cards flow left to right
-  right as they are paid.
+  as they are paid.
 - **Tags = category:** housing, utilities, comms, food...
 - **Due date = the bill's due date;** color/priority = urgency.
-- Each card carries a **money value** (debit or credit) and, optionally, an **installment**
+- Each card carries a **money value** and, optionally, an **installment** count.
-  count (`p2/10` = 2nd of 10 payments; leave the total blank for an open-ended recurring bill).
 
 Recurring monthly bills can live as template cards spawned each month by the companion RecoReco
 plugin; FinanceBuddy only owns the money.
 
+## What it does
+
+Once a board is enabled:
+
+### Set the money on a card
+
+The task edit/create form gains a **Finance** section in the middle column:
+
+- **Amount** in R$.
+- **Debit** or **Credit** (money out vs money in).
+- **Installment** current / total (for example `2` of `10`). Leave the total blank for an
+  open-ended recurring bill.
+
+### See it on the card
+
+A badge appears just under the card title -- both on the board and at the top of the opened
+card, so the money is visible whether you glance at the board or read the card (no need to open
+the edit form):
+
+- **red** with a `-` for a debit, **green** with a `+` for a credit (both the color and the sign
+  carry the meaning, and the badge's own background stays readable on any card color);
+- followed by `pN/M` when a total is set (for example `p2/10`), hidden for open-ended bills.
+
+### Total per column
+
+Each column header shows a **`Total:`** of its cards -- credits positive, debits negative (the
+net): red when negative (what you owe), green when positive, gray at zero. It is shown for every
+column, including `Total: R$0,00`.
+
+### Installments and recurrence
+
+FinanceBuddy carries the money across copies. Kanboard's built-in recurrence and RecoReco's
+calendar recurrence advance the installment on the next occurrence (`p2/10 -> p3/10`); a manual
+duplicate copies it as-is. When a RecoReco-followed plan finishes, the parked template is left one
+past the last installment (`p3/3 -> p4/3`) as a "plan complete" marker that RecoReco reads to stop
+recurring; the copies themselves still read `p1/3 .. p3/3`. Open-ended plans (blank total) keep
+counting.
+
 ## Money format
 
-Amounts are shown in R$ with a comma decimal and no thousand separator (for example
+Amounts show in R$ with a comma decimal and no thousand separator (for example `R$1234,56`).
-`R$1234,56`). Input accepts either a dot or a comma as the decimal separator, so `1234.56` and
+Input accepts either a dot or a comma as the decimal separator, so `1234.56` and `1234,56` are
-`1234,56` are the same value.
+the same value.
 
-## Status
+## How it stores data
 
-Early development. This version registers the plugin and loads its stylesheet; the per-board
+No database migration. The per-board enable flag is stored in project metadata; each card's
-toggle, the in-form editing, the card badge, and the per-column totals arrive in the following
+money is stored in task metadata. The finance fields live in the normal task form but are saved
-versions.
+separately (they are not task columns), so ordinary task saving is untouched. Uninstalling the
+plugin leaves that metadata harmlessly in place and changes nothing else.
 
 ## Requirements
 
@@ -43,8 +81,26 @@ versions.
 
 Copy this folder into your Kanboard installation as `plugins/FinanceBuddy/`. The directory name
 must be exactly `FinanceBuddy` (Kanboard derives the plugin namespace from the folder name). No
-build step and no database migration.
+build step and no database migration. Then, on each board you want to track, go to
+Settings -> Integrations and tick "Enable FinanceBuddy on this board".
 
 ## License
 
 AGPL-3.0. See LICENSE.
+
+## More Kanboard plugins by Ruben (drbeco)
+
+All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
+
+- **[RecoReco](https://code.beco.cc/beco/RecoReco)** -- calendar-scheduled recurring cards (yearly,
+  monthly, weekly, daily), driven by the card due date. Pairs directly with FinanceBuddy: recurring
+  bills spawn on schedule and their installments count down until the plan is paid off.
+- **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small
+  quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due
+  dates, extra search keywords and shared board filters, and more.
+- **[BulkMoveTasks](https://code.beco.cc/beco/BulkMoveTasks)** -- move every task from one board
+  column to another in a single action.
+- **[ShrinkVertically](https://code.beco.cc/beco/ShrinkVertically)** -- shrink vertically-collapsed
+  board columns so the horizontal scrollbar stays within reach.
+- **[TweakDrag](https://code.beco.cc/beco/TweakDrag)** -- board drag and touch niceties:
+  drag-to-scroll, a wider column gap, and smoother card dragging.

Template/board/column_total.php

@@ -0,0 +1,25 @@
+<?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. Rendered on its own full-width line under the title; "Total:" stays the
+// default (black) and only the amount is colored by sign.
+if (empty($column['project_id']) || ! $this->FinanceHelper->isEnabled($column['project_id'])) {
+    return;
+}
+
+$net = $this->FinanceHelper->columnNet($column);
+
+if ($net > 0) {
+    $amount_class = 'fb-total-credit';
+    $sign = '+';
+} elseif ($net < 0) {
+    $amount_class = 'fb-total-debit';
+    $sign = '-';
+} else {
+    $amount_class = 'fb-total-zero';
+    $sign = '';
+}
+?>
+<div class="fb-column-total">
+    <span class="fb-total-pill"><?= t('Total') ?>: <span class="fb-amount <?= $amount_class ?>"><?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money(abs($net)) ?></span></span>
+</div>

Template/board/task_money.php

@@ -0,0 +1,32 @@
+<?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'];
+
+// Installments: "p2/10" when a total is set; "p2" (open-ended) when only the current is set;
+// nothing when neither is set. Default the current to 1 if only a total was entered.
+$show_installments = $current !== '' || $total !== '';
+$current_display = $current !== '' ? $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 ($show_installments): ?>
+        <span class="fb-installments">p<?= $this->text->e($current_display) ?><?= $total !== '' ? '/'.$this->text->e($total) : '' ?></span>
+    <?php endif ?>
+</div>

Template/project/integration.php

@@ -18,3 +18,4 @@
 <div class="form-actions">
     <button type="submit" class="btn btn-blue"><?= t('Save') ?></button>
 </div>
+<hr>

Template/task/form_fields.php

@@ -24,6 +24,6 @@
         <span><?= t('of') ?></span>
         <input type="number" min="1" name="financebuddy_installment_total" value="<?= $this->text->e($fb['installment_total']) ?>" class="fb-form-num">
     </div>
-    <p class="form-help"><?= t('Leave the total blank for an open-ended recurring bill.') ?></p>
+    <p class="form-help"><?= t('Set a total for a finite plan (shows p2/10); leave it blank for an open-ended count (shows p2).') ?></p>
 </div>
 <?php endif ?>

VERSION

@@ -1 +1 @@
-FinanceBuddy v0.3
+FinanceBuddy v1.1.2