Moving Account.amount to Account.credit & Account.debit

.github/workflows/main.yml

@@ -83,11 +83,20 @@ jobs:
 
       - name: Check All Migrations Exist
         run: |
-          pip install "py-moneyed<3" --upgrade
-          PYTHONPATH=`pwd` ./manage.py makemigrations --check hordak
-          pip install "py-moneyed>=3" --upgrade  # Different version of py-moneyed should not create different migrations
           PYTHONPATH=`pwd` ./manage.py makemigrations --check hordak
 
+      - name: Create missing migrations
+        if: ${{ failure() }}
+        run: |
+          PYTHONPATH=`pwd` ./manage.py makemigrations hordak
+
+      - name: Archive created migrations for debugging
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v1
+        with:
+          name: created-migrations
+          path: hordak/migrations
+
       - name: Testing (PostgreSQL)
         run: |
           PYTHONPATH=`pwd` python -Wall -W error::DeprecationWarning -m coverage run ./manage.py test hordak

CHANGES.txt

@@ -1,9 +1,19 @@
 Version 2.0.0 (unreleased)
 ==========================
 
-* **Breaking**: New account currencies now default to ``DEFAULT_CURRENCY`` rather than all available currencies (trading accounts should be the only accounts with multiple currencies).
+**Important:** It is strongly recommended that you
+**upgrade to Hordak 1.16 before upgrading to Hordak 2.0**. Update your code
+to address any depreciation warnings in 1.16 before upgrading to Hordak 2.0.
+
+* **Breaking**: ``to_account()`` was deprecated in 1.16. This old implementation has now been removed
+  and the newer ``to_account_accounting()`` has been renamed to take its place.
+  Existing uses of ``to_account_accounting()`` should be updated to
+  point to ``to_account()``. This change standardises the behaviour of this method on industry norms.
+* **Breaking**: New account currencies now default to ``DEFAULT_CURRENCY`` rather than all available currencies
+  (trading accounts should be the only accounts with multiple currencies).
 * **Breaking**: Removed ``django-smalluuid``. UUIDs in URLs will now be rendered in the regular UUID format.
-* **Breaking**: Removed use of ``django-model-utils``. Model choices have the same values, but the data structures have changed to use the Django-native ``models.TextChoices``:
+* **Breaking**: Removed use of ``django-model-utils``. Model choices have the same values, but the data
+  structures have changed to use the Django-native ``models.TextChoices``. The old syntax will continue to work until Hordak 3.0:
 
   * ``Account.TYPES`` is now ``AccountType``
   * ``TransactionCsvImportColumn.TO_FIELDS`` is now ``ToField``

hordak/admin.py

@@ -1,5 +1,6 @@
 from django.contrib import admin
-from django.db.models import Q, Sum
+from django.db.models import DecimalField, Q, Sum
+from django.db.models.functions import Coalesce
 from django.utils.html import escape
 from django.utils.safestring import mark_safe
 from mptt.admin import MPTTModelAdmin
@@ -51,8 +52,12 @@ def get_queryset(self, *args, **kwargs):
             super()
             .get_queryset(*args, **kwargs)
             .annotate(
-                balance_sum=Sum("legs__amount"),
-                income=Sum("legs__amount", filter=Q(legs__amount__gt=0)),
+                # TODO: I think this needs some sign-changing work
+                balance_sum=Sum(
+                    Coalesce("legs__credit", 0, output_field=DecimalField())
+                    - Coalesce("legs__debit", 0, output_field=DecimalField())
+                ),
+                income=Sum("legs__credit", filter=Q(legs__credit__isnull=False)),
             )
         )
 
@@ -186,6 +191,8 @@ def debit_(self, obj: models.LegView):
 
 
 def _fmt_admin_decimal(v):
+    if hasattr(v, "amount"):
+        v = v.amount
     if v is None:
         v = "-"
     else:

hordak/exceptions.py

@@ -85,3 +85,27 @@ class NoMoreAccountCodesAvailableInSequence(HordakError):
     """
 
     pass
+
+
+class InvalidOrMissingAccountTypeError(Exception):
+    """When an unexpected account type is encountered"""
+
+    pass
+
+
+class NeitherCreditNorDebitPresentError(Exception):
+    """When neither credit nor debit present for a Leg"""
+
+    pass
+
+
+class BothCreditAndDebitPresentError(Exception):
+    """When both credit and debit present for a Leg"""
+
+    pass
+
+
+class CreditOrDebitIsNegativeError(Exception):
+    """When either the credit and debit field of a Leg is negative"""
+
+    pass

hordak/forms/transactions.py

@@ -133,6 +133,16 @@ def clean_amount(self):
 
         return amount
 
+    def save(self, commit=True):
+        inst: Leg = super().save(commit=False)
+        if self.cleaned_data["amount"].amount > 0:
+            inst.credit = self.cleaned_data["amount"]
+        else:
+            inst.debit = abs(self.cleaned_data["amount"])
+
+        if commit:
+            inst.save()
+
 
 class BaseLegFormSet(BaseInlineFormSet):
     def __init__(self, **kwargs):
@@ -240,17 +250,17 @@ def save(self):
             description=self.cleaned_data.get("description")
         )
         Leg.objects.create(
-            transaction=transaction, account=source_account, amount=source_amount
+            transaction=transaction, account=source_account, credit=source_amount
         )
         Leg.objects.create(
-            transaction=transaction, account=trading_account, amount=-source_amount
+            transaction=transaction, account=trading_account, debit=source_amount
         )
         Leg.objects.create(
-            transaction=transaction, account=trading_account, amount=destination_amount
+            transaction=transaction, account=trading_account, credit=destination_amount
         )
         Leg.objects.create(
             transaction=transaction,
             account=destination_account,
-            amount=-destination_amount,
+            debit=destination_amount,
         )
         return transaction

hordak/management/commands/create_benchmark_transactions.py

@@ -101,6 +101,6 @@ def _transfer_no_commit(
 
     transaction = Transaction()
     legs = []
-    legs.append(Leg(transaction=transaction, account=debit, amount=-amount))
-    legs.append(Leg(transaction=transaction, account=credit, amount=amount))
+    legs.append(Leg(transaction=transaction, account=debit, debit=amount))
+    legs.append(Leg(transaction=transaction, account=credit, credit=amount))
     return transaction, legs

hordak/migrations/0044_legview.py

@@ -3,6 +3,8 @@
 import djmoney.models.fields
 from django.db import migrations, models
 
+from hordak.defaults import DECIMAL_PLACES
+
 
 class Migration(migrations.Migration):
     dependencies = [
@@ -350,7 +352,7 @@ class Migration(migrations.Migration):
                 (
                     "amount",
                     djmoney.models.fields.MoneyField(
-                        decimal_places=6,
+                        decimal_places=DECIMAL_PLACES,
                         default_currency="EUR",
                         max_digits=20,
                         verbose_name="amount",
@@ -368,7 +370,7 @@ class Migration(migrations.Migration):
                 (
                     "credit",
                     models.DecimalField(
-                        decimal_places=6,
+                        decimal_places=DECIMAL_PLACES,
                         help_text="Amount of this credit, or NULL if not a credit",
                         max_digits=20,
                         verbose_name="credit amount",
@@ -377,7 +379,7 @@ class Migration(migrations.Migration):
                 (
                     "debit",
                     models.DecimalField(
-                        decimal_places=6,
+                        decimal_places=DECIMAL_PLACES,
                         help_text="Amount of this debit, or NULL if not a debit",
                         max_digits=20,
                         verbose_name="debit amount",
@@ -386,7 +388,7 @@ class Migration(migrations.Migration):
                 (
                     "account_balance",
                     models.DecimalField(
-                        decimal_places=6,
+                        decimal_places=DECIMAL_PLACES,
                         help_text="Account balance following this transaction. For multiple-currency accounts this will be the balance of the same currency as the leg amount.",
                         max_digits=20,
                         verbose_name="account balance",

hordak/migrations/0048_hordak_transaction_view.pg.sql

@@ -43,4 +43,5 @@ INNER JOIN LATERAL (
 GROUP BY T.id, T.uuid, T.timestamp, T.date, T.description
 ORDER BY T.id DESC);
 --- reverse:
-drop view hordak_transaction_view;
+-- can be implicitly dropped by migration 0050
+drop view if exists hordak_transaction_view;