v0.5.4.2

Make Payments Method
IODatabaseMixIn Optimization

Author: elarroba

.gitignore

@@ -113,3 +113,4 @@ data/
 oauth_codes.json
 http-client.private.env.json
 docs/source/README.md
+assets/.yarn

django_ledger/__init__.py

@@ -9,7 +9,7 @@
 default_app_config = 'django_ledger.apps.DjangoLedgerConfig'
 
 """Django Ledger"""
-__version__ = '0.5.4.1'
+__version__ = '0.5.4.2'
 __license__ = 'GPLv3 License'
 
 __author__ = 'Miguel Sanda'

django_ledger/io/data_generator.py

@@ -730,15 +730,14 @@ def fund_entity(self):
         capital_acc = choice(self.accounts_by_role[EQUITY_CAPITAL])
         cash_acc = choice(self.bank_account_models).cash_account
 
-        ledger_model: LedgerModel = self.entity_model.add_equity(
-            user_model=self.user_model,
-            amount=self.capital_contribution,
+        self.entity_model.deposit_capital(
             cash_account=cash_acc,
-            equity_account=capital_acc,
-            txs_date=self.start_date,
-            ledger_name='Entity Funding for Sample Data',
+            capital_account=capital_acc,
+            amount=self.capital_contribution,
+            je_timestamp=self.start_date,
+            je_posted=True,
             ledger_posted=True,
-            je_posted=True
+            description='Entity Funding for Sample Data',
         )
 
     def recount_inventory(self):

django_ledger/io/io_mixin.py

@@ -19,7 +19,7 @@
 from django.db.models.functions import TruncMonth
 from django.http import Http404
 from django.utils.dateparse import parse_date, parse_datetime
-from django.utils.timezone import localdate, make_aware, is_naive
+from django.utils.timezone import make_aware, is_naive, localtime
 
 from django_ledger.exceptions import InvalidDateInputError, TransactionNotInBalanceError
 from django_ledger.io import roles as roles_module
@@ -96,19 +96,21 @@ def balance_tx_data(tx_data: list, perform_correction: bool = True) -> bool:
     return True
 
 
-def validate_io_date(dt: Union[str, date, datetime], no_parse_localdate: bool = True) -> Union[datetime]:
+def validate_io_date(dt: Union[str, date, datetime], no_parse_localdate: bool = True) -> Optional[datetime]:
+    if not dt:
+        return
+
     if isinstance(dt, date):
-        dt = make_aware(datetime.combine(
-            dt,
-            datetime.min.time()
-        ))
+        dt = make_aware(
+            value=datetime.combine(
+                dt,
+                datetime.min.time()
+            ))
         return dt
-
     elif isinstance(dt, datetime):
         if is_naive(dt):
             return make_aware(dt)
         return dt
-
     elif isinstance(dt, str):
         # try to parse a date object from string...
         fdt = parse_date(dt)
@@ -124,7 +126,7 @@ def validate_io_date(dt: Union[str, date, datetime], no_parse_localdate: bool =
         return fdt
 
     if no_parse_localdate:
-        return localdate()
+        return localtime()
 
 
 def validate_dates(
@@ -611,11 +613,6 @@ def digest(self,
                cash_flow_statement: bool = False,
                ) -> Union[Tuple, IODigest]:
 
-        io_data = defaultdict(lambda: dict())
-        io_data['io_model'] = self
-        io_data['from_date'] = from_date
-        io_data['to_date'] = to_date
-
         if balance_sheet_statement:
             from_date = None
 
@@ -629,6 +626,11 @@ def digest(self,
 
         from_date, to_date = validate_dates(from_date, to_date)
 
+        io_data = defaultdict(lambda: dict())
+        io_data['io_model'] = self
+        io_data['from_date'] = from_date
+        io_data['to_date'] = to_date
+
         txs_qs, accounts_digest = self.python_digest(
             txs_queryset=txs_queryset,
             user_model=user_model,
@@ -714,10 +716,10 @@ def digest(self,
         return txs_qs, digest_results
 
     def commit_txs(self,
-                   je_date: Union[str, datetime, date],
-                   je_txs: list,
+                   je_timestamp: Union[str, datetime, date],
+                   je_txs: List[Dict],
                    je_posted: bool = False,
-                   je_ledger=None,
+                   je_ledger_model=None,
                    je_desc=None,
                    je_origin=None):
         """
@@ -731,36 +733,39 @@ def commit_txs(self,
             'staged_tx_model': StagedTransactionModel or None
         }]
 
-        :param je_date:
+        :param je_timestamp:
         :param je_txs:
         :param je_activity:
         :param je_posted:
-        :param je_ledger:
+        :param je_ledger_model:
         :param je_desc:
         :param je_origin:
         :param je_parent:
         :return:
         """
+
+        # if isinstance(self, lazy_loader.get_entity_model()):
+
         # Validates that credits/debits balance.
         balance_tx_data(je_txs)
 
         if all([
             isinstance(self, lazy_loader.get_entity_model()),
-            not je_ledger
+            not je_ledger_model
         ]):
             raise ValidationError('Must pass an instance of LedgerModel')
 
-        if not je_ledger:
-            je_ledger = self
+        if not je_ledger_model:
+            je_ledger_model = self
 
         JournalEntryModel = lazy_loader.get_journal_entry_model()
 
-        je_date = validate_io_date(dt=je_date)
+        je_timestamp = validate_io_date(dt=je_timestamp)
 
         je_model = JournalEntryModel(
-            ledger=je_ledger,
+            ledger=je_ledger_model,
             description=je_desc,
-            timestamp=je_date,
+            timestamp=je_timestamp,
             origin=je_origin,
         )
 
@@ -770,13 +775,10 @@ def commit_txs(self,
         TransactionModel = lazy_loader.get_txs_model()
         txs_models = [
             TransactionModel(
-                account_id=tx['account_id'],
-                tx_type=tx['tx_type'],
-                amount=tx['amount'],
-                description=tx['description'],
+                **txm_kwargs,
                 journal_entry=je_model,
-                stagedtransactionmodel=tx.get('staged_tx_model')
-            ) for tx in je_txs
+                stagedtransactionmodel=txm_kwargs.get('staged_tx_model')
+            ) for txm_kwargs in je_txs
         ]
         txs_models = TransactionModel.objects.bulk_create(txs_models)
 

django_ledger/models/bill.py

@@ -19,7 +19,7 @@
 >>> bill_model.save()
 """
 
-from datetime import date
+from datetime import date, datetime
 from decimal import Decimal
 from typing import Union, Optional, Tuple, Dict, List
 from uuid import uuid4
@@ -31,7 +31,7 @@
 from django.db.models.signals import post_delete, pre_save
 from django.shortcuts import get_object_or_404
 from django.urls import reverse
-from django.utils.timezone import localdate
+from django.utils.timezone import localdate, localtime
 from django.utils.translation import gettext_lazy as _
 
 from django_ledger.models.entity import EntityModel
@@ -906,16 +906,88 @@ def can_generate_bill_number(self) -> bool:
             self.is_configured()
         ])
 
-    # --> URLs <---
-    def get_absolute_url(self):
-        return reverse('django_ledger:bill-detail',
-                       kwargs={
-                           'entity_slug': self.ledger.entity.slug,
-                           'bill_pk': self.uuid
-                       })
+    # ACTIONS ---
+
+    def can_make_payment(self) -> bool:
+        """
+        Checks if the BillModel can accept a payment.
+
+
+        Returns
+        _______
+
+        bool
+            True if can bind provided PurchaseOderModel, else False.
+        """
+        return self.is_approved()
 
-    # --> ACTIONS <---
-    def action_bind_estimate(self, estimate_model, commit: bool = False, raise_exception: bool = True):
+    def make_payment(self,
+                     payment_amount: Union[Decimal, float, int],
+                     payment_date: Optional[Union[datetime, date]] = None,
+                     commit: bool = False,
+                     raise_exception: bool = True):
+        """
+        Makes a payment to the BillModel.
+
+
+        Parameters
+        __________
+
+        payment_amount: Decimal ot float
+            The payment amount to process.
+
+        payment_date: datetime or date.
+            Date or timestamp of the payment being applied.
+
+        commit: bool
+            If True, commits the transaction into the DB. Defaults to False.
+
+        raise_exception: bool
+            If True, raises BillModelValidationError if payment exceeds amount due, else False.
+
+        Returns
+        _______
+
+        bool
+            True if can make payment, else False.
+        """
+
+        if isinstance(payment_amount, float):
+            payment_amount = Decimal.from_float(payment_amount)
+        elif isinstance(payment_amount, int):
+            payment_amount = Decimal.from_float(float(payment_amount))
+        self.amount_paid += payment_amount
+
+        if self.amount_paid > self.amount_due:
+            if raise_exception:
+                raise BillModelValidationError(
+                    f'Amount paid: {self.amount_paid} exceed amount due: {self.amount_due}.'
+                )
+            return
+
+        self.get_state(commit=True)
+        self.clean()
+
+        if not payment_date:
+            payment_date = localtime()
+
+        if commit:
+            self.migrate_state(
+                user_model=None,
+                entity_slug=self.ledger.entity.slug,
+                je_timestamp=payment_date,
+                raise_exception=True
+            )
+            self.save(
+                update_fields=[
+                    'amount_paid',
+                    'amount_earned',
+                    'amount_unearned',
+                    'amount_receivable',
+                    'updated'
+                ])
+
+    def bind_estimate(self, estimate_model, commit: bool = False, raise_exception: bool = True):
         """
         Binds BillModel to a given EstimateModel. Raises ValueError if EstimateModel cannot be bound.
 
@@ -1168,7 +1240,7 @@ def mark_as_approved(self,
                 self.migrate_state(
                     entity_slug=entity_slug,
                     user_model=user_model,
-                    je_date=date_approved,
+                    je_timestamp=date_approved,
                     force_migrate=self.accrue
                 )
             self.ledger.post(commit=commit)
@@ -1226,6 +1298,7 @@ def mark_as_paid(self,
                      itemtxs_qs: Optional[ItemTransactionModelQuerySet] = None,
                      commit: bool = False,
                      **kwargs):
+
         """
         Marks BillModel as Paid.
 
@@ -1290,7 +1363,7 @@ def mark_as_paid(self,
                 user_model=user_model,
                 entity_slug=entity_slug,
                 itemtxs_qs=itemtxs_qs,
-                je_date=date_paid,
+                je_timestamp=date_paid,
                 force_migrate=True
             )
             self.lock_ledger(commit=True)
@@ -1725,6 +1798,14 @@ def generate_bill_number(self, commit: bool = False) -> str:
     def generate_descriptive_title(self) -> str:
         return f'Bill {self.bill_number} | {self.get_bill_status_display()} {self.get_status_action_date()} | {self.vendor.vendor_name}'
 
+    # --> URLs <---
+    def get_absolute_url(self):
+        return reverse('django_ledger:bill-detail',
+                       kwargs={
+                           'entity_slug': self.ledger.entity.slug,
+                           'bill_pk': self.uuid
+                       })
+
     def clean(self, commit: bool = True):
         """
         Clean method for BillModel. Results in a DB query if bill number has not been generated and the BillModel is