FinanceBuddy: carry money across recurrence/duplicate, advance installments (v1.0.1)

Asset/css/finance.css

@@ -13,6 +13,11 @@
     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;
 }
@@ -38,6 +43,7 @@
     color: #fff;
     font-weight: bold;
     font-size: 1.1em;
+    white-space: nowrap;
 }
 
 .fb-badge-debit {

Model/FinancePersistence.php

@@ -48,6 +48,28 @@ 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']);
         }
     }
 
@@ -114,6 +136,46 @@ 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,
+        ));
+    }
+
     private function intOrBlank($raw)
     {
         $raw = trim((string) $raw);

Plugin.php

@@ -29,6 +29,11 @@ class Plugin extends Base
         $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'));
+
         // 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');
@@ -36,6 +41,11 @@ class Plugin extends Base
 
         // 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()
@@ -62,7 +72,7 @@ class Plugin extends Base
 
     public function getPluginVersion()
     {
-        return '0.4.0';
+        return '1.0.1';
     }
 
     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,59 @@ 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`.
+
 ## 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,7 +72,8 @@ 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
 

Template/board/column_total.php

@@ -20,5 +20,5 @@ if ($net > 0) {
 }
 ?>
 <div class="<?= $class ?>">
-    <?= t('total') ?> <?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money(abs($net)) ?>
+    <?= t('Total') ?>: <span class="fb-amount"><?= $sign ?>R$<?= \Kanboard\Plugin\FinanceBuddy\Helper\FinanceHelper::money(abs($net)) ?></span>
 </div>

VERSION

@@ -1 +1 @@
-FinanceBuddy v0.4
+FinanceBuddy v1.0.1