Closing Entry Model and workflow optimization.

Author: elarroba

django_ledger/models/closing_entry.py

@@ -13,7 +13,7 @@
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db import models
-from django.db.models import Q
+from django.db.models import Q, Count
 from django.db.models.signals import pre_save
 from django.urls import reverse
 from django.utils.timezone import make_aware
@@ -42,6 +42,12 @@ def not_posted(self):
 
 class ClosingEntryModelManager(models.Manager):
 
+    def get_queryset(self):
+        qs = ClosingEntryModelQuerySet(self.model, using=self._db)
+        return qs.annotate(
+            ce_txs_count=Count('closingentrytransactionmodel')
+        )
+
     def for_user(self, user_model):
         qs = self.get_queryset()
         if user_model.is_superuser:
@@ -102,6 +108,7 @@ def get_closing_date_as_timestamp(self):
         return make_aware(datetime.combine(self.closing_date, time.max))
 
     def migrate(self):
+
         ce_txs = self.closingentrytransactionmodel_set.all().select_related(
             'account_model',
             'unit_model'
@@ -118,7 +125,6 @@ def migrate(self):
         ce_txs_gb = groupby(ce_txs, key=lambda k: k.tx_type)
 
         # adding DEBITS and CREDITS...
-        # ce_txs_gb = {k: list(l) for k, l in ce_txs_gb}
         ce_txs_sum = {k: sum(v.balance for v in l) for k, l in ce_txs_gb}
 
         if len(ce_txs_sum) and ce_txs_sum[TransactionModel.DEBIT] != ce_txs_sum[TransactionModel.CREDIT]:
@@ -131,7 +137,9 @@ def migrate(self):
 
         ce_txs.sort(key=key_func)
         ce_txs_gb = groupby(ce_txs, key=key_func)
-        ce_txs_gb = {unit_model_id: list(je_txs) for unit_model_id, je_txs in ce_txs_gb}
+        ce_txs_gb = {
+            unit_model_id: list(je_txs) for unit_model_id, je_txs in ce_txs_gb
+        }
 
         ce_txs_journal_entries = {
             (unit_model_id, activity): JournalEntryModel(
@@ -347,8 +355,6 @@ class Meta(ClosingEntryModelAbstract.Meta):
         abstract = False
 
 
-# todo: Remove this model!
-
 class ClosingEntryTransactionModelQuerySet(models.QuerySet):
     pass
 

django_ledger/models/journal_entry.py

@@ -1243,7 +1243,10 @@ def generate_activity(self,
                         self.activity = None
                     else:
                         role_list = self.get_txs_roles(txs_qs, exclude_cash_role=True)
-                        self.activity = self.get_activity_from_roles(role_set=role_list)
+                        self.activity = self.get_activity_from_roles(
+                            role_set=role_list,
+                            raise_exception=raise_exception
+                        )
         return self.activity
 
     # todo: add entity_model as parameter on all functions...
@@ -1534,7 +1537,7 @@ def save(
 
             if verify:
                 txs_qs, is_verified = self.clean(verify=True)
-                if self.is_verified() and post_on_verify:
+                if is_verified and post_on_verify:
                     # Mark as posted if verification succeeds and posting is requested
                     self.mark_as_posted(commit=False, verify=False, force_lock=True, raise_exception=True)
 

django_ledger/views/closing_entry.py

@@ -8,13 +8,15 @@
 
 from django.contrib import messages
 from django.core.exceptions import ValidationError, ImproperlyConfigured
-from django.db.models import Count
 from django.http import HttpResponseRedirect
-from django.shortcuts import get_object_or_404
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
-from django.views.generic import ArchiveIndexView, YearArchiveView, MonthArchiveView, DetailView, \
-    RedirectView, CreateView, DeleteView, UpdateView
+from django.views.generic import (
+    ArchiveIndexView, YearArchiveView,
+    MonthArchiveView, DetailView,
+    RedirectView, CreateView,
+    DeleteView, UpdateView
+)
 from django.views.generic.detail import SingleObjectMixin
 
 from django_ledger.forms.closing_entry import ClosingEntryCreateForm, ClosingEntryUpdateForm
@@ -24,25 +26,21 @@
 from django_ledger.views import DjangoLedgerSecurityMixIn
 
 
-class ClosingEntryModelViewQuerySetMixIn:
+class ClosingEntryModelBaseView(DjangoLedgerSecurityMixIn):
     queryset = None
-    queryset_annotate_txs_count = False
 
     def get_queryset(self):
         if self.queryset is None:
-            qs = ClosingEntryModel.objects.for_entity(
-                entity_slug=self.kwargs['entity_slug'],
-                user_model=self.request.user
-            ).select_related('entity_model', 'ledger_model')
-            if self.queryset_annotate_txs_count:
-                qs = qs.annotate(ce_txs_count=Count('closingentrytransactionmodel'))
-            self.queryset = qs
-        return super().get_queryset()
-
-
-class ClosingEntryModelListView(DjangoLedgerSecurityMixIn,
-                                ClosingEntryModelViewQuerySetMixIn,
-                                ArchiveIndexView):
+            entity_model: EntityModel = self.get_authorized_entity_instance()
+            closing_entry_model_qs = entity_model.closingentrymodel_set.all().select_related(
+                'entity_model',
+                'ledger_model'
+            ).order_by('-closing_date')
+            self.queryset = closing_entry_model_qs
+        return self.queryset
+
+
+class ClosingEntryModelListView(ClosingEntryModelBaseView, ArchiveIndexView):
     template_name = 'django_ledger/closing_entry/closing_entry_list.html'
     date_field = 'closing_date'
     allow_future = False
@@ -56,23 +54,21 @@ class ClosingEntryModelListView(DjangoLedgerSecurityMixIn,
         'header_title': PAGE_TITLE,
         'header_subtitle_icon': 'file-icons:finaldraft'
     }
-    queryset_annotate_txs_count = True
 
 
-class ClosingEntryModelYearListView(YearArchiveView, ClosingEntryModelListView):
+class ClosingEntryModelYearListView(ClosingEntryModelListView, YearArchiveView):
     paginate_by = 10
     make_object_list = True
 
 
-class ClosingEntryModelMonthListView(MonthArchiveView, ClosingEntryModelListView):
+class ClosingEntryModelMonthListView(ClosingEntryModelListView, MonthArchiveView):
     paginate_by = 10
     month_format = '%m'
     date_list_period = 'year'
 
 
-class ClosingEntryModelCreateView(DjangoLedgerSecurityMixIn, ClosingEntryModelViewQuerySetMixIn, CreateView):
+class ClosingEntryModelCreateView(ClosingEntryModelBaseView, CreateView):
     template_name = 'django_ledger/closing_entry/closing_entry_create.html'
-    form_class = ClosingEntryCreateForm
     PAGE_TITLE = _('Create Closing Entry')
     extra_context = {
         'page_title': PAGE_TITLE,
@@ -85,23 +81,25 @@ def get_initial(self):
             'closing_date': get_localdate()
         }
 
-    def get_object(self, queryset=None):
-        if not getattr(self, 'object'):
-            entity_model_qs = EntityModel.objects.for_user(user_model=self.request.user)
-            entity_model = get_object_or_404(entity_model_qs, slug__exact=self.kwargs['entity_slug'])
-            self.object = entity_model
-        return self.object
+    def get_form(self, form_class=None, **kwargs):
+        return ClosingEntryCreateForm(
+            **self.get_form_kwargs()
+        )
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
-        entity_model = self.get_object()
+        entity_model: EntityModel = self.get_authorized_entity_instance()
         ctx['header_subtitle'] = entity_model.name
         return ctx
 
     def form_valid(self, form):
         closing_date = form.cleaned_data['closing_date']
-        entity_model: EntityModel = self.get_object()
-        ce_model, _ = entity_model.close_entity_books(closing_date=closing_date, force_update=True)
+        entity_model: EntityModel = self.get_authorized_entity_instance()
+        ce_model, _ = entity_model.close_entity_books(
+            closing_date=closing_date,
+            force_update=True,
+            post_closing_entry=False
+        )
         self.ce_model = ce_model
         return HttpResponseRedirect(self.get_success_url())
 
@@ -115,15 +113,14 @@ def get_success_url(self):
         )
 
 
-class ClosingEntryModelDetailView(DjangoLedgerSecurityMixIn, ClosingEntryModelViewQuerySetMixIn, DetailView):
+class ClosingEntryModelDetailView(ClosingEntryModelBaseView, DetailView):
     template_name = 'django_ledger/closing_entry/closing_entry_detail.html'
     pk_url_kwarg = 'closing_entry_pk'
     context_object_name = 'closing_entry_model'
     extra_context = {
         'header_title': 'Closing Entry Detail',
         'header_subtitle_icon': 'file-icons:finaldraft'
     }
-    queryset_annotate_txs_count = True
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
@@ -135,12 +132,11 @@ def get_context_data(self, **kwargs):
         return ctx
 
 
-class ClosingEntryModelUpdateView(DjangoLedgerSecurityMixIn, ClosingEntryModelViewQuerySetMixIn, UpdateView):
+class ClosingEntryModelUpdateView(ClosingEntryModelBaseView, UpdateView):
     template_name = 'django_ledger/closing_entry/closing_entry_update.html'
     pk_url_kwarg = 'closing_entry_pk'
     form_class = ClosingEntryUpdateForm
     context_object_name = 'closing_entry_model'
-    queryset_annotate_txs_count = True
     extra_context = {
         'header_title': 'Closing Entry Detail',
         'header_subtitle_icon': 'file-icons:finaldraft'
@@ -165,10 +161,22 @@ def get_success_url(self):
         )
 
 
-class ClosingEntryDeleteView(DjangoLedgerSecurityMixIn, ClosingEntryModelViewQuerySetMixIn, DeleteView):
+class ClosingEntryDeleteView(ClosingEntryModelBaseView, DeleteView):
     template_name = 'django_ledger/closing_entry/closing_entry_delete.html'
     pk_url_kwarg = 'closing_entry_pk'
     context_object_name = 'closing_entry'
+    extra_context = {
+        'header_title': _('Delete Closing Entry'),
+        'header_subtitle_icon': 'file-icons:finaldraft'
+    }
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        closing_entry_model: ClosingEntryModel = self.object
+        entity_model: EntityModel = self.get_authorized_entity_instance()
+        context['page_title'] = 'Delete Closing Entry {}'.format(closing_entry_model.closing_date)
+        context['header_subtitle'] = entity_model.name
+        return context
 
     def get_success_url(self):
         return reverse(viewname='django_ledger:closing-entry-list',
@@ -177,9 +185,8 @@ def get_success_url(self):
                        })
 
 
-class ClosingEntryModelActionView(DjangoLedgerSecurityMixIn,
+class ClosingEntryModelActionView(ClosingEntryModelBaseView,
                                   RedirectView,
-                                  ClosingEntryModelViewQuerySetMixIn,
                                   SingleObjectMixin):
     http_method_names = ['get']
     pk_url_kwarg = 'closing_entry_pk'