django-ledger 0.5.6.3__py3-none-any.whl → 0.5.6.5__py3-none-any.whl

django_ledger/models/coa.py

@@ -31,7 +31,7 @@ from django.contrib.auth import get_user_model
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.db.models import Q
-from django.db.models.signals import pre_save, post_save
+from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
 from django_ledger.io import (ROOT_COA, ROOT_GROUP_LEVEL_2, ROOT_GROUP_META, ROOT_ASSETS,
@@ -40,7 +40,6 @@ from django_ledger.io import (ROOT_COA, ROOT_GROUP_LEVEL_2, ROOT_GROUP_META, ROO
 from django_ledger.models import lazy_loader
 from django_ledger.models.accounts import AccountModel, AccountModelQuerySet
 from django_ledger.models.mixins import CreateUpdateMixIn, SlugNameMixIn
-from django_ledger.settings import logger
 
 UserModel = get_user_model()
 
@@ -52,7 +51,9 @@ class ChartOfAccountsModelValidationError(ValidationError):
 
 
 class ChartOfAccountModelQuerySet(models.QuerySet):
-    pass
+
+    def active(self):
+        return self.filter(active=True)
 
 
 class ChartOfAccountModelManager(models.Manager):
@@ -117,22 +118,10 @@ class ChartOfAccountModelManager(models.Manager):
         ChartOfAccountQuerySet
             Returns a ChartOfAccountQuerySet with applied filters.
         """
-        qs = self.get_queryset()
+        qs = self.for_user(user_model)
         if isinstance(entity_slug, lazy_loader.get_entity_model()):
-            return qs.filter(
-                Q(entity=entity_slug) &
-                (
-                        Q(entity__admin=user_model) |
-                        Q(entity__managers__in=[user_model])
-                )
-            )
-        return qs.filter(
-            Q(entity__slug__iexact=entity_slug) &
-            (
-                    Q(entity__admin=user_model) |
-                    Q(entity__managers__in=[user_model])
-            )
-        ).select_related('entity')
+            return qs.filter(entity=entity_slug).select_related('entity')
+        return qs.filter(entity__slug__iexact=entity_slug).select_related('entity')
 
 
 class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
@@ -150,10 +139,10 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
     entity: EntityModel
         The EntityModel associated with this Chart of Accounts.
 
-    locked: bool
+    active: bool
         This determines whether any changes can be done to the Chart of Accounts.
-        Before making any update to the ChartOf Account, the account needs to be unlocked.
-        Default value is set to False (unlocked).
+        Inactive Chart of Accounts will not be able to be used in new Transactions.
+        Default value is set to False (inactive).
 
     description: str
         A user generated description for this Chart of Accounts.
@@ -164,7 +153,7 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                                editable=False,
                                verbose_name=_('Entity'),
                                on_delete=models.CASCADE)
-    locked = models.BooleanField(default=False, verbose_name=_('Locked'))
+    active = models.BooleanField(default=True, verbose_name=_('Is Active'))
     description = models.TextField(verbose_name=_('CoA Description'), null=True, blank=True)
     objects = ChartOfAccountModelManager.from_queryset(queryset_class=ChartOfAccountModelQuerySet)()
 
@@ -194,7 +183,7 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                         root_account_qs: Optional[AccountModelQuerySet] = None,
                         as_queryset: bool = False) -> Union[AccountModelQuerySet, AccountModel]:
 
-        if not account_model.is_coa_root():
+        if not account_model.is_root_account():
 
             if not root_account_qs:
                 root_account_qs = self.get_coa_root_accounts_qs()
@@ -262,8 +251,9 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                 locked=True,
                 balance_type=role_meta['balance_type']
             )
-            coa_root_account_model = AccountModel.add_root(instance=root_account)
+            AccountModel.add_root(instance=root_account)
 
+            # must retrieve root model after added pero django-treebeard documentation...
             coa_root_account_model = AccountModel.objects.get(uuid__exact=account_pk)
 
             for root_role in ROOT_GROUP_LEVEL_2:
@@ -284,10 +274,15 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                         ))
 
     def is_default(self) -> bool:
-        if self.entity_id is None:
+        if not self.entity_id:
+            return False
+        if not self.entity.default_coa_id:
             return False
         return self.entity.default_coa_id == self.uuid
 
+    def is_active(self) -> bool:
+        return self.active is True
+
     def validate_account_model_qs(self, account_model_qs: AccountModelQuerySet):
         if not isinstance(account_model_qs, AccountModelQuerySet):
             raise ChartOfAccountsModelValidationError(
@@ -299,23 +294,72 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
                     message=f'Invalid root queryset for CoA {self.name}'
                 )
 
-    def create_account(self, account_model: AccountModel, root_account_qs: Optional[AccountModelQuerySet] = None):
-        if not account_model.coa_model_id:
+    def allocate_account(self,
+                         account_model: AccountModel,
+                         root_account_qs: Optional[AccountModelQuerySet] = None):
+        """
+        Allocates a given account model to the appropriate root account depending on the Account Model Role.
 
-            if not root_account_qs:
-                root_account_qs = self.get_coa_root_accounts_qs()
-            else:
-                self.validate_account_model_qs(root_account_qs)
+        Parameters
+        ----------
+        account_model: AccountModel
+            The Account Model to Allocate
+        root_account_qs:
+            The Root Account QuerySet of the Chart Of Accounts to use.
+            Will be validated against current CoA Model.
+
+        Returns
+        -------
+        AccountModel
+            The saved and allocated AccountModel.
+        """
 
-            l2_root_node: AccountModel = self.get_coa_l2_root(account_model, root_account_qs=root_account_qs)
+        if account_model.coa_model_id:
+            if account_model.coa_model_id != self.uuid:
+                raise ChartOfAccountsModelValidationError(
+                    message=f'Invalid Account Model {account_model} for CoA {self}'
+                )
 
-            account_model.coa_model = self
-            account_model = l2_root_node.add_child(instance=account_model)
+        if not root_account_qs:
+            root_account_qs = self.get_coa_root_accounts_qs()
+        else:
+            self.validate_account_model_qs(root_account_qs)
+
+        l2_root_node: AccountModel = self.get_coa_l2_root(
+            account_model=account_model,
+            root_account_qs=root_account_qs
+        )
+
+        account_model.coa_model = self
+        l2_root_node.add_child(instance=account_model)
+        coa_accounts_qs = self.get_non_root_coa_accounts_qs()
+        return coa_accounts_qs.get(uuid__exact=account_model.uuid)
+
+    def create_account(self,
+                       code: str,
+                       role: str,
+                       name: str,
+                       balance_type: str,
+                       active: bool,
+                       root_account_qs: Optional[AccountModelQuerySet] = None):
+
+        account_model = AccountModel(
+            code=code,
+            name=name,
+            role=role,
+            active=active,
+            balance_type=balance_type
+        )
+        account_model.clean()
+
+        account_model = self.allocate_account(
+            account_model=account_model,
+            root_account_qs=root_account_qs
+        )
         return account_model
 
     # ACTIONS -----
-
-    # todo: use these methods once multi CoA fetures are enabled...
+    # todo: use these methods once multi CoA features are enabled...
     def lock_all_accounts(self) -> AccountModelQuerySet:
         non_root_accounts_qs = self.get_non_root_coa_accounts_qs()
         non_root_accounts_qs.update(locked=True)
@@ -326,25 +370,192 @@ class ChartOfAccountModelAbstract(SlugNameMixIn, CreateUpdateMixIn):
         non_root_accounts_qs.update(locked=False)
         return non_root_accounts_qs
 
-    def clean(self):
-        self.generate_slug()
+    def mark_as_default(self, commit: bool = False, raise_exception: bool = False, **kwargs):
+        """
+        Marks the current Chart of Accounts instances as default for the EntityModel.
 
+        Parameters
+        ----------
+        commit: bool
+            Commit the action into the Database. Default is False.
+        raise_exception: bool
+            Raises exception if Chart of Account model instance is already marked as default.
+        """
+        if self.is_default():
+            if raise_exception:
+                raise ChartOfAccountsModelValidationError(
+                    message=_(f'The Chart of Accounts {self.slug} is already default')
+                )
+            return
+        self.entity.default_coa_id = self.uuid
+        self.clean()
+        if commit:
+            self.entity.save(
+                update_fields=[
+                    'default_coa_id',
+                    'updated'
+                ]
+            )
 
-class ChartOfAccountModel(ChartOfAccountModelAbstract):
-    """
-    Base ChartOfAccounts Model
-    """
+    def mark_as_default_url(self) -> str:
+        """
+        Returns the URL to mark the current Chart of Accounts instances as Default for the EntityModel.
+
+        Returns
+        -------
+        str
+            The URL as a String.
+        """
+        return reverse(
+            viewname='django_ledger:coa-action-mark-as-default',
+            kwargs={
+                'entity_slug': self.entity.slug,
+                'coa_slug': self.slug
+            }
+        )
+
+    def can_activate(self) -> bool:
+        return self.active is False
+
+    def can_deactivate(self) -> bool:
+        return all([
+            self.is_active(),
+            not self.is_default()
+        ])
+
+    def mark_as_active(self, commit: bool = False, raise_exception: bool = False, **kwargs):
+        """
+        Marks the current Chart of Accounts as Active.
+
+        Parameters
+        ----------
+        commit: bool
+            Commit the action into the Database. Default is False.
+        raise_exception: bool
+            Raises exception if Chart of Account model instance is already active. Default is False.
+        """
+        if self.is_active():
+            if raise_exception:
+                raise ChartOfAccountsModelValidationError(
+                    message=_('The Chart of Accounts is currently active.')
+                )
+            return
+
+        self.active = True
+        self.clean()
+        if commit:
+            self.save(
+                update_fields=[
+                    'active',
+                    'updated'
+                ])
+
+    def mark_as_active_url(self) -> str:
+        """
+        Returns the URL to mark the current Chart of Accounts instances as active.
+
+        Returns
+        -------
+        str
+            The URL as a String.
+        """
+        return reverse(
+            viewname='django_ledger:coa-action-mark-as-active',
+            kwargs={
+                'entity_slug': self.entity.slug,
+                'coa_slug': self.slug
+            }
+        )
+
+    def mark_as_inactive(self, commit: bool = False, raise_exception: bool = False, **kwargs):
+        """
+        Marks the current Chart of Accounts as Active.
 
+        Parameters
+        ----------
+        commit: bool
+            Commit the action into the Database. Default is False.
+        raise_exception: bool
+            Raises exception if Chart of Account model instance is already active. Default is False.
+        """
+        if not self.is_active():
+            if raise_exception:
+                raise ChartOfAccountsModelValidationError(
+                    message=_('The Chart of Accounts is currently not active.')
+                )
+            return
+
+        self.active = False
+        self.clean()
+        if commit:
+            self.save(
+                update_fields=[
+                    'active',
+                    'updated'
+                ])
+
+    def mark_as_inactive_url(self) -> str:
+        """
+        Returns the URL to mark the current Chart of Accounts instances as inactive.
 
-# def chartofaccountmodel_presave(instance: ChartOfAccountModel, **kwargs):
-#     if instance._state.adding:
-#         instance.configure(raise_exception=True)
+        Returns
+        -------
+        str
+            The URL as a String.
+        """
+        return reverse(
+            viewname='django_ledger:coa-action-mark-as-inactive',
+            kwargs={
+                'entity_slug': self.entity.slug,
+                'coa_slug': self.slug
+            }
+        )
+
+    def get_coa_list_url(self):
+        return reverse(
+            viewname='django_ledger:coa-list',
+            kwargs={
+                'entity_slug': self.entity.slug
+            }
+        )
+
+    def get_absolute_url(self) -> str:
+        return reverse(
+            viewname='django_ledger:coa-detail',
+            kwargs={
+                'coa_slug': self.slug,
+                'entity_slug': self.entity.slug
+            }
+        )
+
+    def get_account_list_url(self):
+        return reverse(
+            viewname='django_ledger:account-list-coa',
+            kwargs={
+                'entity_slug': self.entity.slug,
+                'coa_slug': self.slug
+            }
+        )
+
+    def get_create_coa_account_url(self):
+        return reverse(
+            viewname='django_ledger:account-create-coa',
+            kwargs={
+                'coa_slug': self.slug,
+                'entity_slug': self.entity.slug
+            }
+        )
 
+    def clean(self):
+        self.generate_slug()
 
-def chartofaccountmodel_postsave(instance: ChartOfAccountModel, **kwargs):
-    if instance._state.adding:
-        instance.configure(raise_exception=True)
+        if self.is_default() and not self.active:
+            raise ChartOfAccountsModelValidationError(
+                _('Default Chart of Accounts cannot be deactivated.')
+            )
 
 
-# pre_save.connect(receiver=chartofaccountmodel_presave, sender=ChartOfAccountModel)
-post_save.connect(receiver=chartofaccountmodel_postsave, sender=ChartOfAccountModel)
+class ChartOfAccountModel(ChartOfAccountModelAbstract):
+    """
+    Base ChartOfAccounts Model
+    """

django_ledger/models/entity.py

@@ -990,6 +990,21 @@ class EntityModelAbstract(MP_Node,
                 raise EntityModelValidationError(f'EntityModel {self.slug} does not have a default CoA')
         return self.default_coa
 
+    def set_default_coa(self, coa_model: Optional[Union[ChartOfAccountModel, str]], commit: bool = False):
+
+        # if str, will look up CoA Model by slug...
+        if isinstance(coa_model, str):
+            coa_model = self.chartofaccountmodel_set.get(slug=coa_model)
+        else:
+            self.validate_chart_of_accounts_for_entity(coa_model)
+
+        self.default_coa = coa_model
+        if commit:
+            self.save(update_fields=[
+                'default_coa',
+                'updated'
+            ])
+
     def create_chart_of_accounts(self,
                                  assign_as_default: bool = False,
                                  coa_name: Optional[str] = None,
@@ -1075,10 +1090,10 @@ class EntityModelAbstract(MP_Node,
         coa_has_accounts = coa_accounts_qs.not_coa_root().exists()
 
         if not coa_has_accounts or force:
-            root_accounts = coa_accounts_qs.is_coa_root()
+            root_account_qs = coa_accounts_qs.is_coa_root()
 
             root_maps = {
-                root_accounts.get(role__exact=k): [
+                root_account_qs.get(role__exact=k): [
                     AccountModel(
                         code=a['code'],
                         name=a['name'],
@@ -1100,12 +1115,14 @@ class EntityModelAbstract(MP_Node,
                         pass
 
                     account_model.clean()
-                    coa_model.create_account(account_model)
+                    coa_model.allocate_account(account_model, root_account_qs=root_account_qs)
 
         else:
             if not ignore_if_default_coa:
-                raise EntityModelValidationError(f'Entity {self.name} already has existing accounts. '
-                                                 'Use force=True to bypass this check')
+                raise EntityModelValidationError(
+                    f'Entity {self.name} already has existing accounts. '
+                    'Use force=True to bypass this check'
+                )
 
     # Model Validators....
     def validate_chart_of_accounts_for_entity(self,
@@ -1254,19 +1271,12 @@ class EntityModelAbstract(MP_Node,
         """
 
         if not coa_model:
-            account_model_qs = self.default_coa.accountmodel_set.all().select_related('coa_model', 'coa_model__entity')
+            account_model_qs = self.default_coa.accountmodel_set.all().select_related(
+                'coa_model', 'coa_model__entity').not_coa_root()
         else:
-            account_model_qs = AccountModel.objects.filter(
-                coa_model__entity__uuid__exact=self.uuid
-            ).select_related('coa_model', 'coa_model__entity')
-
-            if isinstance(coa_model, ChartOfAccountModel):
-                self.validate_chart_of_accounts_for_entity(coa_model=coa_model, raise_exception=True)
-                account_model_qs = coa_model.accountmodel_set.all()
-            if isinstance(coa_model, str):
-                account_model_qs = account_model_qs.filter(coa_model__slug__exact=coa_model)
-            elif isinstance(coa_model, UUID):
-                account_model_qs = account_model_qs.filter(coa_model__uuid__exact=coa_model)
+            self.validate_chart_of_accounts_for_entity(coa_model=coa_model)
+            account_model_qs = coa_model.accountmodel_set.select_related(
+                'coa_model', 'coa_model__entity').not_coa_root()
 
         if active:
             account_model_qs = account_model_qs.active()
@@ -1367,7 +1377,7 @@ class EntityModelAbstract(MP_Node,
                        role: str,
                        name: str,
                        balance_type: str,
-                       active: bool,
+                       active: bool = False,
                        coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None,
                        raise_exception: bool = True) -> AccountModel:
         """
@@ -1409,17 +1419,14 @@ class EntityModelAbstract(MP_Node,
         else:
             coa_model = self.default_coa
 
-        account_model = AccountModel(
+        return coa_model.create_account(
             code=code,
-            name=name,
             role=role,
-            active=active,
-            balance_type=balance_type
+            name=name,
+            balance_type=balance_type,
+            active=active
         )
 
-        account_model.clean()
-        return coa_model.create_account(account_model=account_model)
-
     def create_account_by_kwargs(self,
                                  account_model_kwargs: Dict,
                                  coa_model: Optional[Union[ChartOfAccountModel, UUID, str]] = None,
@@ -1457,9 +1464,9 @@ class EntityModelAbstract(MP_Node,
         else:
             coa_model = self.default_coa
 
-        account_model = AccountModel(**account_model_kwargs)
-        account_model.clean()
-        return coa_model, coa_model.create_account(account_model=account_model)
+        # account_model = AccountModel(**account_model_kwargs)
+        # account_model.clean()
+        return coa_model, coa_model.create_account(**account_model_kwargs)
 
     # ### LEDGER MANAGEMENT ####
     def get_ledgers(self, posted: bool = True):
@@ -2962,6 +2969,14 @@ class EntityModelAbstract(MP_Node,
                            'entity_slug': self.slug
                        })
 
+    def get_coa_list_url(self) -> str:
+        return reverse(
+            viewname='django_ledger:coa-list',
+            kwargs={
+                'entity_slug': self.slug
+            }
+        )
+
     def get_accounts_url(self) -> str:
         """
         The EntityModel Code of Accounts llist import URL.

django_ledger/templates/django_ledger/account/account_create.html

@@ -4,17 +4,23 @@
 {% load django_ledger %}
 
 {% block view_content %}
-    <div class="columns is-centered">
-        <div class="column is-8-tablet is-6-desktop">
-            <div class="box">
-                <form action="{% url 'django_ledger:account-create' entity_slug=view.kwargs.entity_slug %}"
-                      method="post">
-                    {% csrf_token %}
-                    {{ form.as_p }}
-                    <button type="submit" class="button is-primary is-fullwidth djetler_my_1">Submit</button>
-                    <a class="button is-dark is-small is-fullwidth"
-                       href="{% url 'django_ledger:account-list' entity_slug=view.kwargs.entity_slug %}">Back</a>
-                </form>
+    <div class="box">
+        <div class="columns is-centered is-multiline">
+            <div class="column is-12 has-text-centered">
+                <h1 class="is-size-2">{% trans 'Create Account' %}</h1>
+                <h2 class="is-size-3 has-text-info">{{ coa_model.name }}</h2>
+                <p class="is-size-4 has-text-danger is-italic">({{ coa_model.slug }})</p>
+            </div>
+            <div class="column is-8-tablet is-6-desktop">
+                <div class="box">
+                    <form method="post">
+                        {% csrf_token %}
+                        {{ form.as_p }}
+                        <button type="submit" class="button is-primary is-fullwidth djetler_my_1">Submit</button>
+                        <a class="button is-dark is-small is-fullwidth"
+                           href="{% url 'django_ledger:account-list' entity_slug=view.kwargs.entity_slug %}">Back</a>
+                    </form>
+                </div>
             </div>
         </div>
     </div>

django_ledger/templates/django_ledger/account/account_list.html

@@ -5,18 +5,21 @@
 
 {% block view_content %}
     <div class="box">
-        <div class="columns">
-            <div class="column">
-                <a href="{% url 'django_ledger:account-create' entity_slug=view.kwargs.entity_slug %}"
-                   class="button is-primary is-outlined">{% trans 'Create Account' %}</a>
-                <a href="{% url 'django_ledger:entity-dashboard' entity_slug=view.kwargs.entity_slug %}"
-                   class="button is-dark">{% trans 'Back' %}</a>
+        <div class="columns is-multiline">
+            <div class="column is-12 has-text-centered">
+                <h1 class="is-size-3">{% trans 'Accounts List' %}</h1>
+                <h2 class="is-size-1 has-text-info">{{ coa_model.name }}</h2>
+                <p class="is-italic has-text-danger">({{ coa_model.slug }})</p>
             </div>
-        </div>
-        <div class="columns">
-            <div class="column">
+            <div class="column is-12">
                 {% accounts_table accounts %}
             </div>
+            <div class="column is-12 has-text-centered">
+                <a href="{{ coa_model.get_create_coa_account_url }}"
+                   class="button is-success">{% trans 'Create Account' %}</a>
+                <a href="{{ coa_model.get_coa_list_url }}"
+                   class="button is-dark">{% trans 'Back to CoA List' %}</a>
+            </div>
         </div>
     </div>
 {% endblock %}

django_ledger/templates/django_ledger/account/account_update.html

@@ -4,22 +4,24 @@
 {% load django_ledger %}
 
 {% block view_content %}
-    <div class="columns is-centered">
-        <div class="column is-8-tablet is-6-desktop">
-            <div class="box">
-                <form action="{{ account.get_update_url }}" method="post">
-                    {% csrf_token %}
-                    {{ form.as_p }}
-                    <button class="button is-fullwidth is-primary my-3">{% trans 'Submit' %}</button>
-                    <a class="button is-fullwidth is-dark is-small my-3"
-                       href="{% url 'django_ledger:account-list' entity_slug=view.kwargs.entity_slug %}">
-                        {% trans 'Back' %}
-                    </a>
-                </form>
+    <div class="box">
+        <div class="columns is-centered is-multiline">
+            <div class="column is-12 has-text-centered">
+                <h2 class="is-size-3 has-text-info">{{ coa_model.name }}</h2>
+                <p class="is-size-4 has-text-danger is-italic">({{ coa_model.slug }})</p>
+                <h1 class="is-size-2">{{ account }}</h1>
+            </div>
+            <div class="column is-8-tablet is-6-desktop">
+                <div class="box">
+                    <form method="post">
+                        {% csrf_token %}
+                        {{ form.as_p }}
+                        <button type="submit" class="button is-primary is-fullwidth djetler_my_1">Submit</button>
+                        <a class="button is-dark is-small is-fullwidth"
+                           href="{% url 'django_ledger:account-list' entity_slug=view.kwargs.entity_slug %}">Back</a>
+                    </form>
+                </div>
             </div>
         </div>
     </div>
-{% endblock %}
-
-
-
+{% endblock %}