django-ledger 0.6.0.1__py3-none-any.whl → 0.6.1__py3-none-any.whl

django_ledger/models/accounts.py

@@ -87,6 +87,26 @@ class AccountModelQuerySet(MP_NodeQuerySet):
         """
         return self.filter(active=False)
 
+    def locked(self):
+        """
+        Filter locked elements.
+
+        This method filters the elements based on the `locked` attribute and returns a filtered queryset.
+
+        Returns:
+            A filtered queryset containing the locked elements.
+        """
+        return self.filter(locked=True)
+
+    def unlocked(self):
+        """
+        Returns a filtered version of an object, excluding any locked items.
+
+        Returns:
+            A filtered version of the object, excluding any locked items.
+        """
+        return self.filter(locked=False)
+
     def with_roles(self, roles: Union[List, str]):
         """
         This method is used to make query of accounts with a certain role. For instance, the fixed assets like
@@ -110,12 +130,25 @@ class AccountModelQuerySet(MP_NodeQuerySet):
         return self.filter(role__in=roles)
 
     def expenses(self):
+        """
+        Return the expenses filtered by the roles specified in GROUP_EXPENSES.
+
+        Returns:
+            QuerySet: A queryset containing the expenses filtered by the GROUP_EXPENSES roles..
+        """
         return self.filter(role__in=GROUP_EXPENSES)
 
     def is_coa_root(self):
+        """
+        Check if the account model instance is the Chart of Account Root.
+
+        Returns:
+            bool: True if the Account is the CoA Root, False otherwise.
+        """
         return self.filter(role__in=ROOT_GROUP)
 
     def not_coa_root(self):
+
         return self.exclude(role__in=ROOT_GROUP)
 
     def for_entity(self, entity_slug, user_model):
@@ -146,12 +179,16 @@ class AccountModelQuerySet(MP_NodeQuerySet):
     def is_role_default(self):
         return self.not_coa_root().filter(role_default=True)
 
+    def can_transact(self):
+        return self.filter(
+            Q(locked=False) & Q(active=True)
+        )
+
 
 class AccountModelManager(MP_NodeManager):
     """
-    This Model Manager will be used as interface through which the database query operations can be provided to the
-    Account Model. It uses the custom defined AccountModelQuerySet and hence overrides the normal get_queryset
-    function which return all rows of a model.
+    AccountModelManager class provides methods to manage and retrieve AccountModel objects.
+    It inherits from MP_NodeManager for tree-like model implementation.
     """
 
     def get_queryset(self) -> AccountModelQuerySet:
@@ -407,49 +444,41 @@ def account_code_validator(value: str):
 
 
 class AccountModelAbstract(MP_Node, CreateUpdateMixIn):
-    """
-    Django Ledger Base Account Model Abstract. This is the main abstract class which the Account Model database will
-    inherit, and it contains the fields/columns/attributes which the said ledger table will have. In addition to the
-    attributes mentioned below, it also has the fields/columns/attributes mentioned in the ParentChileMixin & the
-    CreateUpdateMixIn. Read about these mixin here.
+    """ AccountModelAbstract
 
-    Below are the fields specific to the accounts model.
+    Abstract class representing an Account Model.
 
     Attributes
     ----------
-    uuid: UUID
-        This is a unique primary key generated for the table. The default value of this field is uuid4().
-
-    code: str
-        Each account will have its own alphanumeric code.
-        For example:
-        * Cash Account -> Code 1010.
-        * Inventory -> 1200.
-        * Maximum Length allowed is 10.
-
-    name: str
-        This is the user defined name  of the Account. the maximum length for Name of the ledger allowed is 100
-
-    role: str
-        Each Account needs to be assigned a certain Role. The exhaustive list of ROLES is defined in io.roles.
-
-    balance_type: str
-        Each account will have a default Account type i.e. Either Debit or Credit.
-        For example:
-        * Assets like Cash, Inventory, Accounts Receivable or Expenses like Rent, Salary will have balance_type=DEBIT.
-        * Liabilities, Equities and Income like Payables, Loans, Income, Sales, Reserves will have balance_type=CREDIT.
-
-    locked: bool
-        This determines whether any transactions can be added in the account. Before making any update to the
-        account, the account needs to be unlocked. Default value is set to False i.e. Unlocked.
-
-    active: bool
-        Determines whether the concerned account is active. Any Account can be used only when it is unlocked and
-        Active. Default value is set to True.
-
-    coa_model: ChartOfAccountsModel
-        Each Accounts must be assigned a ChartOfAccountsModel. By default, one CoA will be created for each entity.
-        However, the creating of a new AccountModel must have an explicit assignment of a ChartOfAccountModel.
+    BALANCE_TYPE : list
+        List of choices for the balance type of the account.
+
+    uuid : UUIDField
+        UUID field representing the primary key of the account.
+
+    code : CharField
+        CharField representing the account code.
+
+    name : CharField
+        CharField representing the account name.
+
+    role : CharField
+        CharField representing the account role.
+
+    role_default : BooleanField
+        BooleanField representing whether the account is a default account for the role.
+
+    balance_type : CharField
+        CharField representing the balance type of the account. Must be 'debit' or 'credit'.
+
+    locked : BooleanField
+        BooleanField representing whether the account is locked.
+
+    active : BooleanField
+        BooleanField representing whether the account is active.
+
+    coa_model : ForeignKey
+        ForeignKey representing the associated ChartOfAccountModel.
     """
     BALANCE_TYPE = [
         (CREDIT, _('Credit')),
@@ -485,7 +514,8 @@ class AccountModelAbstract(MP_Node, CreateUpdateMixIn):
             models.Index(fields=['balance_type']),
             models.Index(fields=['active']),
             models.Index(fields=['locked']),
-            models.Index(fields=['coa_model'])
+            models.Index(fields=['coa_model', 'code']),
+            models.Index(fields=['code'])
         ]
 
     def __str__(self):

django_ledger/models/bill.py

@@ -486,6 +486,8 @@ class BillModelAbstract(
 
             if self.can_generate_bill_number():
                 self.generate_bill_number(commit=commit)
+                ledger_model.ledger_xid = f'bill-{self.bill_number.lower()}-{str(ledger_model.entity_id)[-5:]}'
+                ledger_model.save(update_fields=['ledger_xid'])
 
             self.clean()
 

django_ledger/models/coa.py

@@ -460,6 +460,8 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                 raise ChartOfAccountsModelValidationError(
                     message=f'Invalid Account Model {account_model} for CoA {self}'
                 )
+        else:
+            account_model.coa_model = self
 
         if not root_account_qs:
             root_account_qs = self.get_coa_root_accounts_qs()

django_ledger/models/entity.py

@@ -113,10 +113,10 @@ class EntityModelManager(MP_NodeManager):
 
     def get_queryset(self):
         """Sets the custom queryset as the default."""
-        qs = EntityModelQuerySet(self.model).order_by('path')
+        qs = EntityModelQuerySet(self.model, using=self._db).order_by('path')
         return qs.order_by('path').select_related('admin', 'default_coa')
 
-    def for_user(self, user_model):
+    def for_user(self, user_model, authorized_superuser: bool = False):
         """
         This QuerySet guarantees that Users do not access or operate on EntityModels that don't have access to.
         This is the recommended initial QuerySet.
@@ -125,6 +125,8 @@ class EntityModelManager(MP_NodeManager):
         ----------
         user_model
             The Django User Model making the request.
+        authorized_superuser
+            Allows any superuser to access the EntityModel. Default is False.
 
         Returns
         -------
@@ -134,7 +136,7 @@ class EntityModelManager(MP_NodeManager):
                 2. Is a manager.
         """
         qs = self.get_queryset()
-        if user_model.is_superuser:
+        if user_model.is_superuser and authorized_superuser:
             return qs
         return qs.filter(
             Q(admin=user_model) |

django_ledger/models/invoice.py

@@ -446,10 +446,11 @@ class InvoiceModelAbstract(
 
             if self.can_generate_invoice_number():
                 self.generate_invoice_number(commit=commit)
+                ledger_model.ledger_xid=f'invoice-{self.invoice_number.lower()}-{str(ledger_model.entity_id)[-5:]}'
+                ledger_model.save(update_fields=['ledger_xid'])
 
             self.clean()
 
-
             if commit:
                 self.save()
 

django_ledger/models/items.py

@@ -881,8 +881,6 @@ class ItemTransactionModelManager(models.Manager):
 
     def for_user(self, user_model):
         qs = self.get_queryset()
-        if user_model.is_superuser:
-            return qs
         return qs.filter(
             Q(item_model__entity__admin=user_model) |
             Q(item_model__entity__managers__in=[user_model])
@@ -890,6 +888,10 @@ class ItemTransactionModelManager(models.Manager):
 
     def for_entity(self, user_model, entity_slug):
         qs = self.for_user(user_model)
+        if isinstance(entity_slug, lazy_loader.get_entity_model()):
+            return qs.filter(
+                Q(item_model__entity=entity_slug)
+            )
         return qs.filter(
             Q(item_model__entity__slug__exact=entity_slug)
         )

django_ledger/models/ledger.py

@@ -184,13 +184,11 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
     _WRAPPED_MODEL_KEY = 'wrapped_model'
     uuid = models.UUIDField(default=uuid4, editable=False, primary_key=True)
     ledger_xid = models.SlugField(allow_unicode=True, max_length=150, null=True, blank=True,
-                                  verbose_name=_('Ledger Slug'),
+                                  verbose_name=_('Ledger External ID'),
                                   help_text=_('User Defined Ledger ID'))
     name = models.CharField(max_length=150, null=True, blank=True, verbose_name=_('Ledger Name'))
 
-    # todo: rename to entity_model...
     entity = models.ForeignKey('django_ledger.EntityModel',
-                               editable=False,
                                on_delete=models.CASCADE,
                                verbose_name=_('Ledger Entity'))
     posted = models.BooleanField(default=False, verbose_name=_('Posted Ledger'))
@@ -212,13 +210,21 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
             models.Index(fields=['entity']),
             models.Index(fields=['entity', 'posted']),
             models.Index(fields=['entity', 'locked']),
+            models.Index(fields=['entity', 'ledger_xid']),
+            models.Index(fields=['ledger_xid']),
         ]
         unique_together = [
             ('entity', 'ledger_xid')
         ]
 
     def __str__(self):
-        return self.name
+        if self.name is not None:
+            ledger_str = f'LedgerModel: {self.name}'
+        elif self.ledger_xid is not None:
+            ledger_str = f'LedgerModel: {self.ledger_xid}'
+        else:
+            ledger_str = f'LedgerModel: {self.uuid}'
+        return f'{ledger_str} | Posted: {self.posted} | Locked: {self.locked}'
 
     def has_wrapped_model_info(self):
         if self.additional_info is not None:
@@ -516,7 +522,7 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
             je_model_qs.bulk_update(objs=je_model_qs, fields=['locked', 'updated'])
         return je_model_qs
 
-    def unlock(self, commit: bool = False, **kwargs):
+    def unlock(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         """
         Un-locks the LedgerModel.
 
@@ -525,13 +531,19 @@ class LedgerModelAbstract(CreateUpdateMixIn, IOMixIn):
         commit: bool
             If True, saves the LedgerModel instance instantly. Defaults to False.
         """
-        if self.can_unlock():
-            self.locked = False
-            if commit:
-                self.save(update_fields=[
-                    'locked',
-                    'updated'
-                ])
+        if not self.can_unlock():
+            if raise_exception:
+                raise LedgerModelValidationError(
+                    message=_(f'Ledger {self.name} cannot be un-locked. UUID: {self.uuid}')
+                )
+            return
+
+        self.locked = False
+        if commit:
+            self.save(update_fields=[
+                'locked',
+                'updated'
+            ])
 
     def hide(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         if not self.can_hide():

django_ledger/models/mixins.py

@@ -487,7 +487,8 @@ class AccrualMixIn(models.Model):
         if ledger_model.locked:
             if raise_exception:
                 raise ValidationError(f'Bill ledger {ledger_model.name} is already locked...')
-        ledger_model.lock(commit)
+            return
+        ledger_model.lock(commit, raise_exception=raise_exception)
 
     def unlock_ledger(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         """
@@ -501,10 +502,11 @@ class AccrualMixIn(models.Model):
             If True, raises ValidationError if LedgerModel already locked.
         """
         ledger_model = self.ledger
-        if not ledger_model.locked:
+        if not ledger_model.is_locked():
             if raise_exception:
                 raise ValidationError(f'Bill ledger {ledger_model.name} is already unlocked...')
-        ledger_model.unlock(commit)
+            return
+        ledger_model.unlock(commit, raise_exception=raise_exception)
 
     # POST/UNPOST Ledger...
     def post_ledger(self, commit: bool = False, raise_exception: bool = True, **kwargs):
@@ -522,7 +524,8 @@ class AccrualMixIn(models.Model):
         if ledger_model.posted:
             if raise_exception:
                 raise ValidationError(f'Bill ledger {ledger_model.name} is already posted...')
-        ledger_model.post(commit)
+            return
+        ledger_model.post(commit, raise_exception=raise_exception)
 
     def unpost_ledger(self, commit: bool = False, raise_exception: bool = True, **kwargs):
         """
@@ -536,13 +539,14 @@ class AccrualMixIn(models.Model):
             If True, raises ValidationError if LedgerModel already locked.
         """
         ledger_model = self.ledger
-        if not ledger_model.posted:
+        if not ledger_model.is_posted():
             if raise_exception:
                 raise ValidationError(f'Bill ledger {ledger_model.name} is not posted...')
-        ledger_model.post(commit)
+            return
+        ledger_model.post(commit, raise_exception=raise_exception)
 
     def migrate_state(self,
-                      # todo: remove usermodel param...
+                      # todo: remove usermodel param...?
                       user_model,
                       entity_slug: str,
                       itemtxs_qs: Optional[QuerySet] = None,

django_ledger/models/transactions.py

@@ -24,7 +24,7 @@ from django.contrib.auth import get_user_model
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator
 from django.db import models
-from django.db.models import Q, QuerySet
+from django.db.models import Q, QuerySet, F
 from django.db.models.signals import pre_save
 from django.utils.translation import gettext_lazy as _
 
@@ -49,35 +49,6 @@ class TransactionModelQuerySet(QuerySet):
     """
     A custom QuerySet class for TransactionModels implementing methods to effectively and safely read
     TransactionModels from the database.
-
-    Methods
-    -------
-    posted() -> TransactionModelQuerySet:
-        Fetches a QuerySet of posted transactions only.
-
-    for_accounts(account_list: List[str or AccountModel]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels which AccountModel has a specific role.
-
-    for_roles(role_list: Union[str, List[str]]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels which AccountModel has a specific role.
-
-    for_unit(unit_slug: Union[str, EntityUnitModel]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels associated with a specific EntityUnitModel.
-
-    for_activity(activity_list: Union[str, List[str]]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels associated with a specific activity or list of activities.
-
-    to_date(to_date: Union[str, date, datetime]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels associated with a maximum date or timestamp filter.
-
-    from_date(from_date: Union[str, date, datetime]) -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels associated with a minimum date or timestamp filter.
-
-    not_closing_entry() -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels that are not part of a closing entry.
-
-    is_closing_entry() -> TransactionModelQuerySet:
-        Fetches a QuerySet of TransactionModels that are part of a closing entry.
     """
 
     def posted(self) -> QuerySet:
@@ -111,7 +82,7 @@ class TransactionModelQuerySet(QuerySet):
         TransactionModelQuerySet
             Returns a TransactionModelQuerySet with applied filters.
         """
-        if len(account_list) > 0 and isinstance(account_list[0], str):
+        if isinstance(account_list, list) > 0 and isinstance(account_list[0], str):
             return self.filter(account__code__in=account_list)
         return self.filter(account__in=account_list)
 
@@ -238,7 +209,7 @@ class TransactionModelQuerySet(QuerySet):
         return self.filter(journal_entry__is_closing_entry=True)
 
 
-class TransactionModelAdmin(models.Manager):
+class TransactionModelManager(models.Manager):
     """
     A manager class for the TransactionModel.
     """
@@ -276,8 +247,6 @@ class TransactionModelAdmin(models.Manager):
         ledger or the user is one of the managers of the entity associated with the transaction's ledger.
         """
         qs = self.get_queryset()
-        if user_model.is_superuser:
-            return qs
         return qs.filter(
             Q(journal_entry__ledger__entity__admin=user_model) |
             Q(journal_entry__ledger__entity__managers__in=[user_model])
@@ -531,7 +500,7 @@ class TransactionModelAbstract(CreateUpdateMixIn):
                                    verbose_name=_('Tx Description'),
                                    help_text=_('A description to be included with this individual transaction'))
 
-    objects = TransactionModelAdmin()
+    objects = TransactionModelManager()
 
     class Meta:
         abstract = True

django_ledger/settings.py

@@ -34,6 +34,7 @@ logger.info(f'Django Ledger GraphQL Enabled: {DJANGO_LEDGER_GRAPHQL_SUPPORT_ENAB
 DJANGO_LEDGER_USE_CLOSING_ENTRIES = getattr(settings, 'DJANGO_LEDGER_USE_CLOSING_ENTRIES', True)
 DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT = getattr(settings,
                                                             'DJANGO_LEDGER_DEFAULT_CLOSING_ENTRY_CACHE_TIMEOUT', 3600)
+DJANGO_LEDGER_AUTHORIZED_SUPERUSER = getattr(settings, 'DJANGO_LEDGER_AUTHORIZED_SUPERUSER', False)
 DJANGO_LEDGER_LOGIN_URL = getattr(settings, 'DJANGO_LEDGER_LOGIN_URL', settings.LOGIN_URL)
 DJANGO_LEDGER_BILL_NUMBER_LENGTH = getattr(settings, 'DJANGO_LEDGER_BILL_NUMBER_LENGTH', 10)
 DJANGO_LEDGER_INVOICE_NUMBER_LENGTH = getattr(settings, 'DJANGO_LEDGER_INVOICE_NUMBER_LENGTH', 10)

django_ledger/urls/entity.py

@@ -9,7 +9,7 @@ urlpatterns = [
 
     # DASHBOARD Views...
     path('<slug:entity_slug>/dashboard/',
-         views.EntityModelDetailView.as_view(),
+         views.EntityModelDetailHandlerView.as_view(),
          name='entity-dashboard'),
     path('<slug:entity_slug>/dashboard/year/<int:year>/',
          views.FiscalYearEntityModelDashboardView.as_view(),

django_ledger/urls/unit.py

@@ -19,7 +19,7 @@ urlpatterns = [
 
     # DASHBOARD Views ...
     path('<slug:entity_slug>/dashboard/<slug:unit_slug>/',
-         views.EntityModelDetailView.as_view(),
+         views.EntityModelDetailHandlerView.as_view(),
          name='unit-dashboard'),
     path('<slug:entity_slug>/dashboard/<slug:unit_slug>/year/<int:year>/',
          views.FiscalYearEntityModelDashboardView.as_view(),

django_ledger/views/entity.py

@@ -159,9 +159,9 @@ class EntityDeleteView(DjangoLedgerSecurityMixIn, EntityModelModelViewQuerySetMi
 
 
 # DASHBOARD VIEWS START ----
-class EntityModelDetailView(DjangoLedgerSecurityMixIn,
-                            EntityUnitMixIn,
-                            RedirectView):
+class EntityModelDetailHandlerView(DjangoLedgerSecurityMixIn,
+                                   EntityUnitMixIn,
+                                   RedirectView):
 
     def get_redirect_url(self, *args, **kwargs):
         loc_date = get_localdate()
@@ -182,14 +182,14 @@ class EntityModelDetailView(DjangoLedgerSecurityMixIn,
                        })
 
 
-class FiscalYearEntityModelDashboardView(DjangoLedgerSecurityMixIn,
-                                         EntityModelModelViewQuerySetMixIn,
-                                         BaseDateNavigationUrlMixIn,
-                                         UnpaidElementsMixIn,
-                                         EntityUnitMixIn,
-                                         DigestContextMixIn,
-                                         YearlyReportMixIn,
-                                         DetailView):
+class EntityModelDetailBaseView(DjangoLedgerSecurityMixIn,
+                                EntityModelModelViewQuerySetMixIn,
+                                BaseDateNavigationUrlMixIn,
+                                UnpaidElementsMixIn,
+                                EntityUnitMixIn,
+                                DigestContextMixIn,
+                                YearlyReportMixIn,
+                                DetailView):
     context_object_name = 'entity'
     slug_url_kwarg = 'entity_slug'
     template_name = 'django_ledger/entity/entity_dashboard.html'
@@ -203,7 +203,7 @@ class FiscalYearEntityModelDashboardView(DjangoLedgerSecurityMixIn,
     IO_DIGEST_EQUITY = True
 
     def get_context_data(self, **kwargs):
-        context = super(FiscalYearEntityModelDashboardView, self).get_context_data(**kwargs)
+        context = super().get_context_data(**kwargs)
         entity_model: EntityModel = self.object
         context['page_title'] = entity_model.name
         context['header_title'] = entity_model.name
@@ -228,6 +228,12 @@ class FiscalYearEntityModelDashboardView(DjangoLedgerSecurityMixIn,
         return context
 
 
+class FiscalYearEntityModelDashboardView(EntityModelDetailBaseView):
+    """
+    Entity Fiscal Year Dashboard View.
+    """
+
+
 class QuarterlyEntityDashboardView(FiscalYearEntityModelDashboardView, QuarterlyReportMixIn):
     """
     Entity Quarterly Dashboard View.

django_ledger/views/ledger.py

@@ -107,7 +107,6 @@ class LedgerModelCreateView(DjangoLedgerSecurityMixIn, LedgerModelModelViewQuery
     def form_valid(self, form):
         instance = form.save(commit=False)
         instance.entity = self.AUTHORIZED_ENTITY_MODEL
-        self.object = form.save()
         return super().form_valid(form)
 
     def get_success_url(self):