django-ledger 0.6.2__py3-none-any.whl → 0.6.4__py3-none-any.whl

django_ledger/models/journal_entry.py

@@ -45,17 +45,28 @@ from django.utils.timezone import localtime
 from django.utils.translation import gettext_lazy as _
 
 from django_ledger.io.io_core import get_localtime
-from django_ledger.io.roles import (ASSET_CA_CASH, GROUP_CFS_FIN_DIVIDENDS, GROUP_CFS_FIN_ISSUING_EQUITY,
-                                    GROUP_CFS_FIN_LT_DEBT_PAYMENTS, GROUP_CFS_FIN_ST_DEBT_PAYMENTS,
-                                    GROUP_CFS_INVESTING_AND_FINANCING, GROUP_CFS_INVESTING_PPE,
-                                    GROUP_CFS_INVESTING_SECURITIES, validate_roles)
+from django_ledger.io.roles import (
+    ASSET_CA_CASH, GROUP_CFS_FIN_DIVIDENDS, GROUP_CFS_FIN_ISSUING_EQUITY,
+    GROUP_CFS_FIN_LT_DEBT_PAYMENTS, GROUP_CFS_FIN_ST_DEBT_PAYMENTS,
+    GROUP_CFS_INVESTING_AND_FINANCING, GROUP_CFS_INVESTING_PPE,
+    GROUP_CFS_INVESTING_SECURITIES, validate_roles
+)
 from django_ledger.models.accounts import CREDIT, DEBIT
 from django_ledger.models.entity import EntityStateModel, EntityModel
 from django_ledger.models.mixins import CreateUpdateMixIn
+from django_ledger.models.signals import (
+    journal_entry_unlocked,
+    journal_entry_locked,
+    journal_entry_posted,
+    journal_entry_unposted
+)
 from django_ledger.models.transactions import TransactionModelQuerySet, TransactionModel
 from django_ledger.models.utils import lazy_loader
-from django_ledger.settings import (DJANGO_LEDGER_JE_NUMBER_PREFIX, DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING,
-                                    DJANGO_LEDGER_JE_NUMBER_NO_UNIT_PREFIX)
+from django_ledger.settings import (
+    DJANGO_LEDGER_JE_NUMBER_PREFIX,
+    DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING,
+    DJANGO_LEDGER_JE_NUMBER_NO_UNIT_PREFIX
+)
 
 
 class JournalEntryValidationError(ValidationError):
@@ -588,31 +599,48 @@ class JournalEntryModelAbstract(CreateUpdateMixIn):
         """
         if verify and not self.is_verified():
             txs_qs, verified = self.verify()
-
             if not len(txs_qs):
-                raise JournalEntryValidationError(
-                    message=_('Cannot post an empty Journal Entry.')
-                )
+                if raise_exception:
+                    raise JournalEntryValidationError(
+                        message=_('Cannot post an empty Journal Entry.')
+                    )
+                return
 
         if force_lock and not self.is_locked():
-            self.mark_as_locked(commit=False, raise_exception=True)
+            try:
+                self.mark_as_locked(commit=False, raise_exception=True)
+            except JournalEntryValidationError as e:
+                if raise_exception:
+                    raise e
+                return
 
         if not self.can_post(ignore_verify=False):
             if raise_exception:
                 raise JournalEntryValidationError(f'Journal Entry {self.uuid} cannot post.'
                                                   f' Is verified: {self.is_verified()}')
-        else:
-            if not self.is_posted():
-                self.posted = True
-                if self.is_posted():
-                    if commit:
-                        self.save(verify=False,
-                                  update_fields=[
-                                      'posted',
-                                      'locked',
-                                      'activity',
-                                      'updated'
-                                  ])
+            return
+
+        if not self.is_posted():
+            self.posted = True
+            if self.is_posted():
+                if commit:
+                    self.save(verify=False,
+                              update_fields=[
+                                  'posted',
+                                  'locked',
+                                  'activity',
+                                  'updated'
+                              ])
+            journal_entry_posted.send_robust(sender=self.__class__,
+                                             instance=self,
+                                             commited=commit,
+                                             **kwargs)
+
+    def post(self, **kwargs):
+        """
+        Proxy function for `mark_as_posted` method.
+        """
+        return self.mark_as_posted(**kwargs)
 
     def mark_as_unposted(self, commit: bool = False, raise_exception: bool = False, **kwargs):
         """
@@ -632,18 +660,30 @@ class JournalEntryModelAbstract(CreateUpdateMixIn):
         if not self.can_unpost():
             if raise_exception:
                 raise JournalEntryValidationError(f'Journal Entry {self.uuid} cannot unpost.')
-        else:
-            if self.is_posted():
-                self.posted = False
-                self.activity = None
-                if not self.is_posted():
-                    if commit:
-                        self.save(verify=False,
-                                  update_fields=[
-                                      'posted',
-                                      'activity',
-                                      'updated'
-                                  ])
+            return
+        if self.is_posted():
+            self.posted = False
+            self.activity = None
+            if not self.is_posted():
+                if commit:
+                    self.save(
+                        verify=False,
+                        update_fields=[
+                            'posted',
+                            'activity',
+                            'updated'
+                        ]
+                    )
+            journal_entry_unposted.send_robust(sender=self.__class__,
+                                               instance=self,
+                                               commited=commit,
+                                               **kwargs)
+
+    def unpost(self, **kwargs):
+        """
+        Proxy function for `mark_as_unposted` method.
+        """
+        return self.mark_as_unposted(**kwargs)
 
     def mark_as_locked(self, commit: bool = False, raise_exception: bool = False, **kwargs):
         """
@@ -662,14 +702,26 @@ class JournalEntryModelAbstract(CreateUpdateMixIn):
         """
         if not self.can_lock():
             if raise_exception:
-                raise JournalEntryValidationError(f'Journal Entry {self.uuid} is already locked.')
-        else:
-            if not self.is_locked():
-                self.generate_activity(force_update=True)
-                self.locked = True
-                if self.is_locked():
-                    if commit:
-                        self.save(verify=False)
+                if raise_exception:
+                    raise JournalEntryValidationError(f'Journal Entry {self.uuid} is already locked.')
+                return
+
+        if not self.is_locked():
+            self.generate_activity(force_update=True)
+            self.locked = True
+            if self.is_locked():
+                if commit:
+                    self.save(verify=False)
+                journal_entry_locked.send_robust(sender=self.__class__,
+                                                 instance=self,
+                                                 commited=commit,
+                                                 **kwargs)
+
+    def lock(self, **kwargs):
+        """
+        Proxy function for `mark_as_locked` method.
+        """
+        return self.mark_as_locked(**kwargs)
 
     def mark_as_unlocked(self, commit: bool = False, raise_exception: bool = False, **kwargs):
         """
@@ -687,12 +739,23 @@ class JournalEntryModelAbstract(CreateUpdateMixIn):
         if not self.can_unlock():
             if raise_exception:
                 raise JournalEntryValidationError(f'Journal Entry {self.uuid} is already unlocked.')
-        else:
-            if self.is_locked():
-                self.locked = False
-                if not self.is_locked():
-                    if commit:
-                        self.save(verify=False)
+            return
+
+        if self.is_locked():
+            self.locked = False
+            if not self.is_locked():
+                if commit:
+                    self.save(verify=False)
+                journal_entry_unlocked.send_robust(sender=self.__class__,
+                                                   instance=self,
+                                                   commited=commit,
+                                                   **kwargs)
+
+    def unlock(self, **kwargs):
+        """
+        Proxy function for `mark_as_unlocked` method.
+        """
+        return self.mark_as_unlocked(**kwargs)
 
     def get_transaction_queryset(self, select_accounts: bool = True) -> TransactionModelQuerySet:
         """

django_ledger/models/ledger.py

@@ -37,6 +37,14 @@ from django.db import models
 from django.db.models import Q, Min, F, Count
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
+from django_ledger.models.signals import (
+    ledger_posted,
+    ledger_unposted,
+    ledger_locked,
+    ledger_unlocked,
+    ledger_hidden,
+    ledger_unhidden
+)
 
 from django_ledger.io.io_core import IOMixIn
 from django_ledger.models import lazy_loader
@@ -456,6 +464,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'posted',
                 'updated'
             ])
+        ledger_posted.send_robust(sender=self.__class__,
+                                  instance=self,
+                                  commited=commit,
+                                  **kwargs)
 
     def post_journal_entries(self, commit: bool = True, **kwargs):
         je_model_qs = self.journal_entries.unposted()
@@ -488,6 +500,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'posted',
                 'updated'
             ])
+        ledger_unposted.send_robust(sender=self.__class__,
+                                    instance=self,
+                                    commited=commit,
+                                    **kwargs)
 
     def lock(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         """
@@ -513,6 +529,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'locked',
                 'updated'
             ])
+        ledger_locked.send_robust(sender=self.__class__,
+                                  instance=self,
+                                  commited=commit,
+                                  **kwargs)
 
     def lock_journal_entries(self, commit: bool = True, **kwargs):
         je_model_qs = self.journal_entries.unlocked()
@@ -544,6 +564,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'locked',
                 'updated'
             ])
+        ledger_unlocked.send_robust(sender=self.__class__,
+                                    instance=self,
+                                    commited=commit,
+                                    **kwargs)
 
     def hide(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         if not self.can_hide():
@@ -558,6 +582,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'hidden',
                 'updated'
             ])
+        ledger_hidden.send_robust(sender=self.__class__,
+                                  instance=self,
+                                  commited=commit,
+                                  **kwargs)
 
     def unhide(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         if not self.can_unhide():
@@ -572,6 +600,10 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
                 'hidden',
                 'updated'
             ])
+        ledger_unhidden.send_robust(sender=self.__class__,
+                                    instance=self,
+                                    commited=commit,
+                                    **kwargs)
 
     def delete(self, **kwargs):
         if not self.can_delete():

django_ledger/models/purchase_order.py

@@ -39,6 +39,14 @@ from django_ledger.models.items import ItemTransactionModel, ItemTransactionMode
 from django_ledger.models.mixins import CreateUpdateMixIn, MarkdownNotesMixIn, ItemizeMixIn
 from django_ledger.models.utils import lazy_loader
 from django_ledger.settings import DJANGO_LEDGER_DOCUMENT_NUMBER_PADDING, DJANGO_LEDGER_PO_NUMBER_PREFIX
+from django_ledger.models.signals import (
+    po_status_draft,
+    po_status_void,
+    po_status_fulfilled,
+    po_status_approved,
+    po_status_canceled,
+    po_status_in_review
+)
 
 PO_NUMBER_CHARS = ascii_uppercase + digits
 
@@ -403,9 +411,8 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
         } if not lazy_agg else None
 
     # ### ItemizeMixIn implementation END...
-    def update_state(self,
-                     itemtxs_qs: Optional[Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None
-                     ) -> Tuple:
+    def update_state(self, itemtxs_qs: Optional[
+        Union[ItemTransactionModelQuerySet, List[ItemTransactionModel]]] = None) -> Tuple:
 
         """
         Updates the state of the PurchaseOrderModel.
@@ -696,6 +703,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'po_status',
                 'updated'
             ])
+        po_status_draft.send_robust(sender=self.__class__,
+                                    instance=self,
+                                    commited=commit,
+                                    **kwargs)
 
     def get_mark_as_draft_html_id(self):
         """
@@ -765,6 +776,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'date_in_review',
                 'updated'
             ])
+        po_status_in_review.send_robust(sender=self.__class__,
+                                        instance=self,
+                                        commited=commit,
+                                        **kwargs)
 
     def get_mark_as_review_html_id(self):
         """
@@ -828,6 +843,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'po_status',
                 'updated'
             ])
+        po_status_approved.send_robust(sender=self.__class__,
+                                       instance=self,
+                                       commited=commit,
+                                       **kwargs)
 
     def get_mark_as_approved_html_id(self):
         """
@@ -890,6 +909,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'date_canceled',
                 'updated'
             ])
+        po_status_canceled.send_robust(sender=self.__class__,
+                                       instance=self,
+                                       commited=commit,
+                                       **kwargs)
 
     def get_mark_as_canceled_html_id(self):
         """
@@ -983,6 +1006,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'po_status',
                 'updated'
             ])
+        po_status_fulfilled.send_robust(sender=self.__class__,
+                                        instance=self,
+                                        commited=commit,
+                                        **kwargs)
 
     def get_mark_as_fulfilled_html_id(self):
         """
@@ -1057,6 +1084,10 @@ class PurchaseOrderModelAbstract(CreateUpdateMixIn,
                 'po_status',
                 'updated'
             ])
+        po_status_void.send_robust(sender=self.__class__,
+                                   instance=self,
+                                   commited=commit,
+                                   **kwargs)
 
     def get_mark_as_void_html_id(self):
         """

django_ledger/models/signals.py

@@ -0,0 +1,58 @@
+"""
+Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
+Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
+
+Contributions to this module:
+    * Miguel Sanda <msanda@arrobalytics.com>
+
+The signals module provide the means to notify listeners about important events or states in the models,
+such as a ledger model being posted or a bill status changing.
+"""
+
+from django.dispatch import Signal
+
+# Ledger Model Signals...
+ledger_posted = Signal()
+ledger_unposted = Signal()
+ledger_locked = Signal()
+ledger_unlocked = Signal()
+ledger_hidden = Signal()
+ledger_unhidden = Signal()
+
+# Journal Entry Model Signals...
+journal_entry_posted = Signal()
+journal_entry_unposted = Signal()
+journal_entry_locked = Signal()
+journal_entry_unlocked = Signal()
+
+# Bill Model Signals...
+bill_status_draft = Signal()
+bill_status_in_review = Signal()
+bill_status_approved = Signal()
+bill_status_paid = Signal()
+bill_status_canceled = Signal()
+bill_status_void = Signal()
+
+# Invoice Model Signals...
+invoice_status_draft = Signal()
+invoice_status_in_review = Signal()
+invoice_status_approved = Signal()
+invoice_status_paid = Signal()
+invoice_status_canceled = Signal()
+invoice_status_void = Signal()
+
+# PO Model Signals...
+po_status_draft = Signal()
+po_status_in_review = Signal()
+po_status_approved = Signal()
+po_status_fulfilled = Signal()
+po_status_canceled = Signal()
+po_status_void = Signal()
+
+# Estimate Model Signals...
+estimate_status_draft = Signal()
+estimate_status_in_review = Signal()
+estimate_status_approved = Signal()
+estimate_status_completed = Signal()
+estimate_status_canceled = Signal()
+estimate_status_void = Signal()

django_ledger/report/cash_flow_statement.py

@@ -1,7 +1,7 @@
 from datetime import datetime, date
 from typing import Optional, Dict, Union
 
-from django_ledger.io.io_digest import IODigestContextManager
+from django_ledger.io.io_context import IODigestContextManager
 from django_ledger.report.core import BaseReportSupport, PDFReportValidationError
 from django_ledger.settings import DJANGO_LEDGER_CURRENCY_SYMBOL
 from django_ledger.templatetags.django_ledger import currency_format

django_ledger/report/core.py

@@ -3,7 +3,7 @@ from typing import Optional, Dict
 from django.contrib.staticfiles import finders
 from django.core.exceptions import ValidationError
 
-from django_ledger.io.io_digest import IODigestContextManager
+from django_ledger.io.io_context import IODigestContextManager
 from django_ledger.models.ledger import LedgerModel
 from django_ledger.models.unit import EntityUnitModel
 from django_ledger.settings import DJANGO_LEDGER_PDF_SUPPORT_ENABLED

django_ledger/templates/django_ledger/financial_statements/balance_sheet.html

@@ -44,10 +44,10 @@
             {% balance_sheet_statement io_model=object %}
             {% if entity %}
                 <a class="button is-fullwidth is-dark mb-1"
-                   href="{% url 'django_ledger:ledger-list' entity_slug=view.kwargs.entity_slug %}">{% trans 'Go Back' %}</a>
+                   href="{% url 'django_ledger:entity-dashboard' entity_slug=view.kwargs.entity_slug %}">{% trans 'Go Back' %}</a>
             {% elif ledger %}
                 <a class="button is-fullwidth is-dark my-2"
-                   href="{% url 'django_ledger:entity-dashboard' entity_slug=view.kwargs.entity_slug %}">{% trans 'Go Back' %}</a>
+                   href="{% url 'django_ledger:ledger-list' entity_slug=view.kwargs.entity_slug %}">{% trans 'Go Back' %}</a>
             {% endif %}
             <a class="button is-fullwidth is-light my-2"
                href="?by_unit=1">{% trans 'By Unit' %}</a>

django_ledger/tests/test_io_ofx/tests.py

@@ -0,0 +1,52 @@
+import os
+from decimal import Decimal
+
+from django_ledger.io.ofx import OFXFileManager
+from django_ledger.tests.base import DjangoLedgerBaseTest
+
+
+class SimpleOFXTest(DjangoLedgerBaseTest):
+    BASE_PATH = "django_ledger/tests/test_io_ofx/samples/"
+
+    def get_sample_ofx(self, ofx_sample_name: str):
+        ofx = OFXFileManager(ofx_file_or_path=os.path.join(self.BASE_PATH, ofx_sample_name))
+
+        return ofx
+
+    def test_ofx_v1_with_intu_bid_field(self):
+        """
+        OFX v1 with <INTU.BID> field. These are ofx files that are exported for Quickbooks.
+        This field can be used to identify the bank in the absence of the <FI.ORG> fields.
+        """
+        ofx = self.get_sample_ofx("v1_with_intu_bid.ofx")
+        accounts = ofx.get_accounts()
+
+        # The bank and fid fields are not provided in this ofx file.
+        self.assertIsNone(accounts[0]["fid"])
+        self.assertIsNone(accounts[0]["bank"])
+        # balance observed from the ofx file
+        self.assertEqual(ofx.ofx_data.statements[0].balance.balamt, Decimal("123456.49"))
+
+    def test_ofx_v1_with_open_tags(self):
+        """
+        OFX v1 with open tags like `<DTSERVER>20211015063225[-5:EST]` instead of `<DTSERVER>20230510120000</DTSERVER>`
+        """
+        ofx = self.get_sample_ofx("v1_with_open_tags.ofx")
+        accounts = ofx.get_accounts()
+        account = accounts[0]
+
+        self.assertIsNone(account["fid"])
+        self.assertIsNone(account["bank"])
+        self.assertEqual(ofx.ofx_data.statements[0].balance.balamt, Decimal("1868.27"))
+
+    def test_ofx_v2_good(self):
+        """
+        ofx v2 uses XML rather than SGML. This is a good ofx v2 file.
+        """
+        ofx = self.get_sample_ofx("v2_good.ofx")
+        accounts = ofx.get_accounts()
+        account = accounts[0]
+
+        self.assertEqual(account["fid"], "123456789")
+        self.assertEqual(account["bank"], "BANK NAME")
+        self.assertEqual(ofx.ofx_data.statements[0].balance.balamt, Decimal("5000.00"))

django_ledger/views/account.py

@@ -210,7 +210,7 @@ class AccountModelYearDetailView(DjangoLedgerSecurityMixIn,
         context['header_title'] = f'Account {account.code} - {account.name}'
         context['page_title'] = f'Account {account.code} - {account.name}'
         account_model: AccountModel = self.object
-        txs_qs = account_model.transactionmodel_set.posted().order_by(
+        txs_qs = account_model.transactionmodel_set.all().posted().order_by(
             'journal_entry__timestamp').select_related(
             'journal_entry', 'journal_entry__entity_unit')
         txs_qs = txs_qs.from_date(self.get_from_date())

django_ledger/views/bill.py

@@ -3,7 +3,7 @@ Django Ledger created by Miguel Sanda <msanda@arrobalytics.com>.
 Copyright© EDMA Group Inc licensed under the GPLv3 Agreement.
 
 Contributions to this module:
-Miguel Sanda <msanda@arrobalytics.com>
+    * Miguel Sanda <msanda@arrobalytics.com>
 """
 
 from django.contrib import messages

{django_ledger-0.6.2.dist-info → django_ledger-0.6.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-ledger
-Version: 0.6.2
+Version: 0.6.4
 Summary: Double entry accounting system built on the Django Web Framework.
 Author-email: Miguel Sanda <msanda@arrobalytics.com>
 Maintainer-email: Miguel Sanda <msanda@arrobalytics.com>