v0.7.6 (#257)

* Closing Entry Model and workflow optimization.

* Development pre-migration new laptop

* v0.7.6
Refactor mixin usage for base views in `django_ledger`.

Replaces multiple redundant mixins with unified base view classes (`EntityUnitModelModelBaseView` and `VendorModelModelBaseView`) to streamline inheritance and improve code maintainability. Updated version to `0.7.6` to reflect these changes.

* Enhance filtering and account data handling in ledger.

Added support for cleared and reconciled transaction filtering in `io_core` based on kwargs with proper validation. Updated `io_context` to include a method for retrieving account data with an optional key function. Also improved form handling for datetime inputs in journal entries.

* Refactor transaction queries and add account balance utility

Updated transaction filtering methods to validate input types and support AccountModel, UUID, and string formats. Added new utility methods for cleared and reconciled transaction queries. Introduced an account balance retrieval method in the entity model for better account insights.

* Add extensibility hooks and method for entity instance name

Introduce new template blocks for custom JS/CSS in the header and footer to enhance layout flexibility. Add a method to retrieve the authorized entity instance's name, improving clarity and usability in views.

* Add alt_str method and enhance docstrings for properties

Introduced the `alt_str` method to provide a concise string representation of accounts. Additionally, improved and detailed the docstrings for `coa_slug` and `entity_slug` properties, ensuring clarity and consistency in code documentation.

* Refactor closing entry behavior and enhance ledger locking.

Updated ledger locking/unlocking logic to ensure data consistency during posting, unposting, and deletion of closing entries. Adjusted form input attributes and enhanced `mark_as_posted` and `mark_as_unposted` methods for better handling of entity metadata.

* Removed experimental swappable model functionality.

Author: elarroba

dev_env/settings.py

@@ -154,47 +154,3 @@
 #         }
 #     }
 # }
-
-# DJANGO_LEDGER_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.AccountModel')
-# DJANGO_LEDGER_CHART_OF_ACCOUNTS_MODEL = getattr(settings, 'DJANGO_LEDGER_ACCOUNT_MODEL', 'django_ledger.ChartOfAccountModel')
-# DJANGO_LEDGER_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_TRANSACTION_MODEL', 'django_ledger.TransactionModel')
-# DJANGO_LEDGER_JOURNAL_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_JOURNAL_ENTRY_MODEL', 'django_ledger.JournalEntryModel')
-# DJANGO_LEDGER_LEDGER_MODEL = getattr(settings, 'DJANGO_LEDGER_LEDGER_MODEL', 'django_ledger.LedgerModel')
-# DJANGO_LEDGER_ENTITY_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_MODEL', 'django_ledger.EntityModel')
-# DJANGO_LEDGER_ENTITY_STATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_STATE_MODEL', 'django_ledger.EntityStateModel')
-# DJANGO_LEDGER_ENTITY_UNIT_MODEL = getattr(settings, 'DJANGO_LEDGER_ENTITY_UNIT_MODEL', 'django_ledger.EntityUnitModel')
-# DJANGO_LEDGER_ESTIMATE_MODEL = getattr(settings, 'DJANGO_LEDGER_ESTIMATE_MODEL', 'django_ledger.EstimateModel')
-# DJANGO_LEDGER_BILL_MODEL = getattr(settings, 'DJANGO_LEDGER_BILL_MODEL', 'django_ledger.BillModel')
-# DJANGO_LEDGER_INVOICE_MODEL = getattr(settings, 'DJANGO_LEDGER_INVOICE_MODEL', 'django_ledger.InvoiceModel')
-# DJANGO_LEDGER_PURCHASE_ORDER_MODEL = getattr(settings, 'DJANGO_LEDGER_PURCHASE_ORDER_MODEL', 'django_ledger.PurchaseOrderModel')
-# DJANGO_LEDGER_CUSTOMER_MODEL = getattr(settings, 'DJANGO_LEDGER_CUSTOMER_MODEL', 'django_ledger.CustomerModel')
-# DJANGO_LEDGER_VENDOR_MODEL = getattr(settings, 'DJANGO_LEDGER_VENDOR_MODEL', 'django_ledger.VendorModel')
-# DJANGO_LEDGER_BANK_ACCOUNT_MODEL = getattr(settings, 'DJANGO_LEDGER_BANK_ACCOUNT_MODEL', 'django_ledger.BankAccountModel')
-# DJANGO_LEDGER_CLOSING_ENTRY_MODEL = getattr(settings, 'DJANGO_LEDGER_CLOSING_ENTRY_MODEL', 'django_ledger.ClosingEntryModel')
-# DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL = getattr(settings, 'DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL', 'django_ledger.UnitOfMeasureModel')
-# DJANGO_LEDGER_ITEM_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_TRANSACTION_MODEL', 'django_ledger.ItemTransactionModel')
-# DJANGO_LEDGER_ITEM_MODEL = getattr(settings, 'DJANGO_LEDGER_ITEM_MODEL', 'django_ledger.ItemModel')
-# DJANGO_LEDGER_STAGED_TRANSACTION_MODEL = getattr(settings, 'DJANGO_LEDGER_STAGED_TRANSACTION_MODEL', 'django_ledger.StagedTransactionModel')
-# DJANGO_LEDGER_IMPORT_JOB_MODEL = getattr(settings, 'DJANGO_LEDGER_IMPORT_JOB_MODEL', 'django_ledger.ImportJobModel')
-
-DJANGO_LEDGER_ACCOUNT_MODEL = 'django_ledger.AccountModel'
-DJANGO_LEDGER_CHART_OF_ACCOUNTS_MODEL = 'django_ledger.ChartOfAccountModel'
-DJANGO_LEDGER_TRANSACTION_MODEL = 'django_ledger.TransactionModel'
-DJANGO_LEDGER_JOURNAL_ENTRY_MODEL = 'django_ledger.JournalEntryModel'
-DJANGO_LEDGER_LEDGER_MODEL = 'django_ledger.LedgerModel'
-DJANGO_LEDGER_ENTITY_MODEL = 'django_ledger.EntityModel'
-DJANGO_LEDGER_ENTITY_STATE_MODEL = 'django_ledger.EntityStateModel'
-DJANGO_LEDGER_ENTITY_UNIT_MODEL = 'django_ledger.EntityUnitModel'
-DJANGO_LEDGER_ESTIMATE_MODEL = 'django_ledger.EstimateModel'
-DJANGO_LEDGER_BILL_MODEL = 'django_ledger.BillModel'
-DJANGO_LEDGER_INVOICE_MODEL = 'django_ledger.InvoiceModel'
-DJANGO_LEDGER_PURCHASE_ORDER_MODEL = 'django_ledger.PurchaseOrderModel'
-DJANGO_LEDGER_CUSTOMER_MODEL = 'django_ledger.CustomerModel'
-DJANGO_LEDGER_VENDOR_MODEL = 'django_ledger.VendorModel'
-DJANGO_LEDGER_BANK_ACCOUNT_MODEL = 'django_ledger.BankAccountModel'
-DJANGO_LEDGER_CLOSING_ENTRY_MODEL = 'django_ledger.ClosingEntryModel'
-DJANGO_LEDGER_UNIT_OF_MEASURE_MODEL = 'django_ledger.UnitOfMeasureModel'
-DJANGO_LEDGER_ITEM_TRANSACTION_MODEL = 'django_ledger.ItemTransactionModel'
-DJANGO_LEDGER_ITEM_MODEL = 'django_ledger.ItemModel'
-DJANGO_LEDGER_STAGED_TRANSACTION_MODEL = 'django_ledger.StagedTransactionModel'
-DJANGO_LEDGER_IMPORT_JOB_MODEL = 'django_ledger.ImportJobModel'

django_ledger/__init__.py

@@ -6,7 +6,7 @@
 default_app_config = 'django_ledger.apps.DjangoLedgerConfig'
 
 """Django Ledger"""
-__version__ = '0.7.5.2'
+__version__ = '0.7.6'
 __license__ = 'GPLv3 License'
 
 __author__ = 'Miguel Sanda'

django_ledger/forms/closing_entry.py

@@ -26,7 +26,8 @@ class Meta:
             'closing_date': DateInput(attrs={
                 'class': DJANGO_LEDGER_FORM_INPUT_CLASSES + ' is-large',
                 'placeholder': _('Closing Date (YYYY-MM-DD)...'),
-                'id': 'djl-datepicker'
+                'id': 'djl-datepicker',
+                'type': 'date'
             })
         }
         labels = {

django_ledger/forms/journal_entry.py

@@ -53,6 +53,7 @@ class Meta:
                 'class': DJANGO_LEDGER_FORM_INPUT_CLASSES
             }),
             'timestamp': DateTimeInput(attrs={
+                'type': 'datetime-local',
                 'class': DJANGO_LEDGER_FORM_INPUT_CLASSES
             }),
             'description': Textarea(attrs={

django_ledger/io/io_context.py

@@ -89,6 +89,16 @@ def is_by_period(self) -> bool:
     def is_by_activity(self) -> bool:
         return self.IO_DATA['by_activity']
 
+    # Account Information
+    def get_account_data(self, key_func=None) -> Dict:
+        if key_func:
+            return {
+                key_func(acc): acc for acc in self.IO_DATA['accounts']
+            }
+        return {
+            acc['account_uuid']: acc for acc in self.IO_DATA['accounts']
+        }
+
     # Balance Sheet Data...
     def has_balance_sheet(self) -> bool:
         return 'balance_sheet' in self.IO_DATA

django_ledger/io/io_core.py

@@ -847,6 +847,28 @@ def database_digest(self,
         if role:
             txs_queryset = txs_queryset.for_roles(role_list=role)
 
+        # Cleared transaction filter via KWARGS....
+        cleared_filter = kwargs.get('cleared')
+        if cleared_filter is not None:
+            if cleared_filter in [True, False]:
+                txs_queryset = txs_queryset.is_cleared() if cleared_filter else txs_queryset.not_cleared()
+            else:
+                raise IOValidationError(
+                    message=f'Invalid value for cleared filter: {cleared_filter}. '
+                            f'Valid values are True, False'
+                )
+
+        # Reconciled transaction filter via KWARGS....
+        reconciled_filter = kwargs.get('reconciled')
+        if reconciled_filter is not None:
+            if reconciled_filter in [True, False]:
+                txs_queryset = txs_queryset.is_reconciled() if reconciled_filter else txs_queryset.not_reconciled()
+            else:
+                raise IOValidationError(
+                    message=f'Invalid value for reconciled filter: {reconciled_filter}. '
+                            f'Valid values are True, False'
+                )
+
         if io_result.is_bounded:
             txs_queryset = txs_queryset.annotate(
                 amount_io=Case(

django_ledger/models/accounts.py

@@ -472,15 +472,55 @@ def __str__(self):
             x5=self.code
         )
 
+    def alt_str(self):
+        """
+        Returns a formatted string representation of the object.
+
+        The formatted string includes the code, name, role, and balance type
+        of the object. The role is converted to uppercase for consistency,
+        and the balance type is displayed as is. This method provides a
+        concise textual representation for quick identification or display.
+
+        Returns:
+            str: A formatted string in the format 'code: name (ROLE/BALANCE_TYPE)'.
+        """
+        return f'{self.code}: {self.name} ({self.role.upper()}/{self.balance_type})'
+
     @property
     def coa_slug(self):
+        """
+        Property that retrieves the `coa_slug` attribute from the object. If the attribute
+        is not found, it fetches the `slug` attribute from the `coa_model`.
+
+        Attributes:
+            _coa_slug (str): Cached value of the `coa_slug` if it exists.
+            coa_model (Any): Object containing the `slug` attribute that serves
+                as a fallback when `_coa_slug` is not present.
+
+        Returns:
+            str: The value of `_coa_slug` if defined, or the `slug` attribute from
+            `coa_model` if `_coa_slug` is not available.
+        """
         try:
             return getattr(self, '_coa_slug')
         except AttributeError:
             return self.coa_model.slug
 
     @property
     def entity_slug(self):
+        """
+            Retrieve the slug value associated with the entity.
+
+            This property method returns the value of the private attribute
+            '_entity_slug' for the current instance. The purpose of the
+            slug is typically to provide a URL-friendly string representing
+            the entity.
+
+            Returns
+            -------
+            Any
+                The value of the '_entity_slug' attribute.
+        """
         return getattr(self, '_entity_slug')
 
     @classmethod
@@ -1059,7 +1099,6 @@ class AccountModel(AccountModelAbstract):
     """
 
     class Meta(AccountModelAbstract.Meta):
-        swappable = 'DJANGO_LEDGER_ACCOUNT_MODEL'
         abstract = False
 
 

django_ledger/models/bank_account.py

@@ -213,5 +213,4 @@ class BankAccountModel(BankAccountModelAbstract):
     """
 
     class Meta(BankAccountModelAbstract.Meta):
-        swappable = 'DJANGO_LEDGER_BANK_ACCOUNT_MODEL'
         abstract = False

django_ledger/models/bill.py

@@ -1920,7 +1920,6 @@ class BillModel(BillModelAbstract):
     """
 
     class Meta(BillModelAbstract.Meta):
-        swappable = 'DJANGO_LEDGER_BILL_MODEL'
         abstract = False
 
 

django_ledger/models/chart_of_accounts.py

@@ -840,7 +840,6 @@ class ChartOfAccountModel(ChartOfAccountModelAbstract):
     Base ChartOfAccounts Model
     """
     class Meta(ChartOfAccountModelAbstract.Meta):
-        swappable = 'DJANGO_LEDGER_CHART_OF_ACCOUNTS_MODEL'
         abstract = False