Renamed "voucher" to "journal entry".
This commit is contained in:
19
src/accounting/journal_entry/utils/__init__.py
Normal file
19
src/accounting/journal_entry/utils/__init__.py
Normal file
@ -0,0 +1,19 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/10
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The utilities for the journal entry management.
|
||||
|
||||
"""
|
||||
49
src/accounting/journal_entry/utils/account_option.py
Normal file
49
src/accounting/journal_entry/utils/account_option.py
Normal file
@ -0,0 +1,49 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/10
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The account option for the journal entry management.
|
||||
|
||||
"""
|
||||
from accounting.models import Account
|
||||
|
||||
|
||||
class AccountOption:
|
||||
"""An account option."""
|
||||
|
||||
def __init__(self, account: Account):
|
||||
"""Constructs an account option.
|
||||
|
||||
:param account: The account.
|
||||
"""
|
||||
self.id: str = account.id
|
||||
"""The account ID."""
|
||||
self.code: str = account.code
|
||||
"""The account code."""
|
||||
self.query_values: list[str] = account.query_values
|
||||
"""The values to be queried."""
|
||||
self.__str: str = str(account)
|
||||
"""The string representation of the account option."""
|
||||
self.is_in_use: bool = False
|
||||
"""True if this account is in use, or False otherwise."""
|
||||
self.is_need_offset: bool = account.is_need_offset
|
||||
"""True if this account needs offset, or False otherwise."""
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""Returns the string representation of the account option.
|
||||
|
||||
:return: The string representation of the account option.
|
||||
"""
|
||||
return self.__str
|
||||
261
src/accounting/journal_entry/utils/description_editor.py
Normal file
261
src/accounting/journal_entry/utils/description_editor.py
Normal file
@ -0,0 +1,261 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/27
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The description editor.
|
||||
|
||||
"""
|
||||
import typing as t
|
||||
|
||||
import sqlalchemy as sa
|
||||
|
||||
from accounting import db
|
||||
from accounting.models import Account, JournalEntryLineItem
|
||||
|
||||
|
||||
class DescriptionAccount:
|
||||
"""An account for a description tag."""
|
||||
|
||||
def __init__(self, account: Account, freq: int):
|
||||
"""Constructs an account for a description tag.
|
||||
|
||||
:param account: The account.
|
||||
:param freq: The frequency of the tag with the account.
|
||||
"""
|
||||
self.account: Account = account
|
||||
"""The account."""
|
||||
self.id: int = account.id
|
||||
"""The account ID."""
|
||||
self.code: str = account.code
|
||||
"""The account code."""
|
||||
self.freq: int = freq
|
||||
"""The frequency of the tag with the account."""
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""Returns the string representation of the account.
|
||||
|
||||
:return: The string representation of the account.
|
||||
"""
|
||||
return str(self.account)
|
||||
|
||||
def add_freq(self, freq: int) -> None:
|
||||
"""Adds the frequency of an account.
|
||||
|
||||
:param freq: The frequency of the tag name with the account.
|
||||
:return: None.
|
||||
"""
|
||||
self.freq = self.freq + freq
|
||||
|
||||
|
||||
class DescriptionTag:
|
||||
"""A description tag."""
|
||||
|
||||
def __init__(self, name: str):
|
||||
"""Constructs a description tag.
|
||||
|
||||
:param name: The tag name.
|
||||
"""
|
||||
self.name: str = name
|
||||
"""The tag name."""
|
||||
self.__account_dict: dict[int, DescriptionAccount] = {}
|
||||
"""The accounts that come with the tag, in the order of their
|
||||
frequency."""
|
||||
self.freq: int = 0
|
||||
"""The frequency of the tag."""
|
||||
|
||||
def __str__(self) -> str:
|
||||
"""Returns the string representation of the tag.
|
||||
|
||||
:return: The string representation of the tag.
|
||||
"""
|
||||
return self.name
|
||||
|
||||
def add_account(self, account: Account, freq: int):
|
||||
"""Adds an account.
|
||||
|
||||
:param account: The associated account.
|
||||
:param freq: The frequency of the tag name with the account.
|
||||
:return: None.
|
||||
"""
|
||||
self.__account_dict[account.id] = DescriptionAccount(account, freq)
|
||||
self.freq = self.freq + freq
|
||||
|
||||
@property
|
||||
def accounts(self) -> list[DescriptionAccount]:
|
||||
"""Returns the accounts by the order of their frequencies.
|
||||
|
||||
:return: The accounts by the order of their frequencies.
|
||||
"""
|
||||
return sorted(self.__account_dict.values(), key=lambda x: -x.freq)
|
||||
|
||||
@property
|
||||
def account_codes(self) -> list[str]:
|
||||
"""Returns the account codes by the order of their frequencies.
|
||||
|
||||
:return: The account codes by the order of their frequencies.
|
||||
"""
|
||||
return [x.code for x in self.accounts]
|
||||
|
||||
|
||||
class DescriptionType:
|
||||
"""A description type"""
|
||||
|
||||
def __init__(self, type_id: t.Literal["general", "travel", "bus"]):
|
||||
"""Constructs a description type.
|
||||
|
||||
:param type_id: The type ID, either "general", "travel", or "bus".
|
||||
"""
|
||||
self.id: t.Literal["general", "travel", "bus"] = type_id
|
||||
"""The type ID."""
|
||||
self.__tag_dict: dict[str, DescriptionTag] = {}
|
||||
"""A dictionary from the tag name to their corresponding tag."""
|
||||
|
||||
def add_tag(self, name: str, account: Account, freq: int) -> None:
|
||||
"""Adds a tag.
|
||||
|
||||
:param name: The tag name.
|
||||
:param account: The associated account.
|
||||
:param freq: The frequency of the tag name with the account.
|
||||
:return: None.
|
||||
"""
|
||||
if name not in self.__tag_dict:
|
||||
self.__tag_dict[name] = DescriptionTag(name)
|
||||
self.__tag_dict[name].add_account(account, freq)
|
||||
|
||||
@property
|
||||
def tags(self) -> list[DescriptionTag]:
|
||||
"""Returns the tags by the order of their frequencies.
|
||||
|
||||
:return: The tags by the order of their frequencies.
|
||||
"""
|
||||
return sorted(self.__tag_dict.values(), key=lambda x: -x.freq)
|
||||
|
||||
|
||||
class DescriptionDebitCredit:
|
||||
"""The description on debit or credit."""
|
||||
|
||||
def __init__(self, debit_credit: t.Literal["debit", "credit"]):
|
||||
"""Constructs the description on debit or credit.
|
||||
|
||||
:param debit_credit: Either "debit" or "credit".
|
||||
"""
|
||||
self.debit_credit: t.Literal["debit", "credit"] = debit_credit
|
||||
"""Either debit or credit."""
|
||||
self.general: DescriptionType = DescriptionType("general")
|
||||
"""The general tags."""
|
||||
self.travel: DescriptionType = DescriptionType("travel")
|
||||
"""The travel tags."""
|
||||
self.bus: DescriptionType = DescriptionType("bus")
|
||||
"""The bus tags."""
|
||||
self.__type_dict: dict[t.Literal["general", "travel", "bus"],
|
||||
DescriptionType] \
|
||||
= {x.id: x for x in {self.general, self.travel, self.bus}}
|
||||
"""A dictionary from the type ID to the corresponding tags."""
|
||||
|
||||
def add_tag(self, tag_type: t.Literal["general", "travel", "bus"],
|
||||
name: str, account: Account, freq: int) -> None:
|
||||
"""Adds a tag.
|
||||
|
||||
:param tag_type: The tag type, either "general", "travel", or "bus".
|
||||
:param name: The name.
|
||||
:param account: The associated account.
|
||||
:param freq: The frequency of the tag name with the account.
|
||||
:return: None.
|
||||
"""
|
||||
self.__type_dict[tag_type].add_tag(name, account, freq)
|
||||
|
||||
@property
|
||||
def accounts(self) -> list[DescriptionAccount]:
|
||||
"""Returns the suggested accounts of all tags in the description editor
|
||||
in debit or credit, in their frequency order.
|
||||
|
||||
:return: The suggested accounts of all tags, in their frequency order.
|
||||
"""
|
||||
accounts: dict[int, DescriptionAccount] = {}
|
||||
freq: dict[int, int] = {}
|
||||
for tag_type in self.__type_dict.values():
|
||||
for tag in tag_type.tags:
|
||||
for account in tag.accounts:
|
||||
accounts[account.id] = account
|
||||
if account.id not in freq:
|
||||
freq[account.id] = 0
|
||||
freq[account.id] \
|
||||
= freq[account.id] + account.freq
|
||||
return [accounts[y] for y in sorted(freq.keys(),
|
||||
key=lambda x: -freq[x])]
|
||||
|
||||
|
||||
class DescriptionEditor:
|
||||
"""The description editor."""
|
||||
|
||||
def __init__(self):
|
||||
"""Constructs the description editor."""
|
||||
self.debit: DescriptionDebitCredit = DescriptionDebitCredit("debit")
|
||||
"""The debit tags."""
|
||||
self.credit: DescriptionDebitCredit = DescriptionDebitCredit("credit")
|
||||
"""The credit tags."""
|
||||
debit_credit: sa.Label = sa.case(
|
||||
(JournalEntryLineItem.is_debit, "debit"),
|
||||
else_="credit").label("debit_credit")
|
||||
tag_type: sa.Label = sa.case(
|
||||
(JournalEntryLineItem.description.like("_%—_%—_%→_%"), "bus"),
|
||||
(sa.or_(JournalEntryLineItem.description.like("_%—_%→_%"),
|
||||
JournalEntryLineItem.description.like("_%—_%↔_%")),
|
||||
"travel"),
|
||||
else_="general").label("tag_type")
|
||||
tag: sa.Label = get_prefix(JournalEntryLineItem.description, "—")\
|
||||
.label("tag")
|
||||
select: sa.Select = sa.Select(debit_credit, tag_type, tag,
|
||||
JournalEntryLineItem.account_id,
|
||||
sa.func.count().label("freq"))\
|
||||
.filter(JournalEntryLineItem.description.is_not(None),
|
||||
JournalEntryLineItem.description.like("_%—_%"),
|
||||
JournalEntryLineItem.original_line_item_id.is_(None))\
|
||||
.group_by(debit_credit, tag_type, tag,
|
||||
JournalEntryLineItem.account_id)
|
||||
result: list[sa.Row] = db.session.execute(select).all()
|
||||
accounts: dict[int, Account] \
|
||||
= {x.id: x for x in Account.query
|
||||
.filter(Account.id.in_({x.account_id for x in result})).all()}
|
||||
debit_credit_dict: dict[t.Literal["debit", "credit"],
|
||||
DescriptionDebitCredit] \
|
||||
= {x.debit_credit: x for x in {self.debit, self.credit}}
|
||||
for row in result:
|
||||
debit_credit_dict[row.debit_credit].add_tag(
|
||||
row.tag_type, row.tag, accounts[row.account_id], row.freq)
|
||||
|
||||
|
||||
def get_prefix(string: str | sa.Column, separator: str | sa.Column) \
|
||||
-> sa.Function:
|
||||
"""Returns the SQL function to find the prefix of a string.
|
||||
|
||||
:param string: The string.
|
||||
:param separator: The separator.
|
||||
:return: The position of the substring, starting from 1.
|
||||
"""
|
||||
return sa.func.substr(string, 0, get_position(string, separator))
|
||||
|
||||
|
||||
def get_position(string: str | sa.Column, substring: str | sa.Column) \
|
||||
-> sa.Function:
|
||||
"""Returns the SQL function to find the position of a substring.
|
||||
|
||||
:param string: The string.
|
||||
:param substring: The substring.
|
||||
:return: The position of the substring, starting from 1.
|
||||
"""
|
||||
if db.engine.name == "postgresql":
|
||||
return sa.func.strpos(string, substring)
|
||||
return sa.func.instr(string, substring)
|
||||
39
src/accounting/journal_entry/utils/offset_alias.py
Normal file
39
src/accounting/journal_entry/utils/offset_alias.py
Normal file
@ -0,0 +1,39 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/15
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The SQLAlchemy alias for the offset items.
|
||||
|
||||
"""
|
||||
import typing as t
|
||||
|
||||
import sqlalchemy as sa
|
||||
|
||||
from accounting.models import JournalEntryLineItem
|
||||
|
||||
|
||||
def offset_alias() -> sa.Alias:
|
||||
"""Returns the SQLAlchemy alias for the offset items.
|
||||
|
||||
:return: The SQLAlchemy alias for the offset items.
|
||||
"""
|
||||
|
||||
def as_from(model_cls: t.Any) -> sa.FromClause:
|
||||
return model_cls
|
||||
|
||||
def as_alias(alias: t.Any) -> sa.Alias:
|
||||
return alias
|
||||
|
||||
return as_alias(sa.alias(as_from(JournalEntryLineItem), name="offset"))
|
||||
336
src/accounting/journal_entry/utils/operators.py
Normal file
336
src/accounting/journal_entry/utils/operators.py
Normal file
@ -0,0 +1,336 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/2/19
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The operators for different journal entry types.
|
||||
|
||||
"""
|
||||
import typing as t
|
||||
from abc import ABC, abstractmethod
|
||||
|
||||
from flask import render_template, request, abort
|
||||
from flask_wtf import FlaskForm
|
||||
|
||||
from accounting.models import JournalEntry
|
||||
from accounting.template_globals import default_currency_code
|
||||
from accounting.utils.journal_entry_types import JournalEntryType
|
||||
from accounting.journal_entry.forms import JournalEntryForm, \
|
||||
CashReceiptJournalEntryForm, CashDisbursementJournalEntryForm, \
|
||||
TransferJournalEntryForm
|
||||
from accounting.journal_entry.forms.line_item import LineItemForm
|
||||
|
||||
|
||||
class JournalEntryOperator(ABC):
|
||||
"""The base journal entry operator."""
|
||||
CHECK_ORDER: int = -1
|
||||
"""The order when checking the journal entry operator."""
|
||||
|
||||
@property
|
||||
@abstractmethod
|
||||
def form(self) -> t.Type[JournalEntryForm]:
|
||||
"""Returns the form class.
|
||||
|
||||
:return: The form class.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def render_create_template(self, form: FlaskForm) -> str:
|
||||
"""Renders the template for the form to create a journal entry.
|
||||
|
||||
:param form: The journal entry form.
|
||||
:return: the form to create a journal entry.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def render_detail_template(self, journal_entry: JournalEntry) -> str:
|
||||
"""Renders the template for the detail page.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: the detail page.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def render_edit_template(self, journal_entry: JournalEntry,
|
||||
form: FlaskForm) -> str:
|
||||
"""Renders the template for the form to edit a journal entry.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:param form: The form.
|
||||
:return: the form to edit a journal entry.
|
||||
"""
|
||||
|
||||
@abstractmethod
|
||||
def is_my_type(self, journal_entry: JournalEntry) -> bool:
|
||||
"""Checks and returns whether the journal entry belongs to the type.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: True if the journal entry belongs to the type, or False
|
||||
otherwise.
|
||||
"""
|
||||
|
||||
@property
|
||||
def _line_item_template(self) -> str:
|
||||
"""Renders and returns the template for the line item sub-form.
|
||||
|
||||
:return: The template for the line item sub-form.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/include/form-line-item.html",
|
||||
currency_index="CURRENCY_INDEX",
|
||||
debit_credit="DEBIT_CREDIT",
|
||||
line_item_index="LINE_ITEM_INDEX",
|
||||
form=LineItemForm())
|
||||
|
||||
|
||||
class CashReceiptJournalEntry(JournalEntryOperator):
|
||||
"""A cash receipt journal entry."""
|
||||
CHECK_ORDER: int = 2
|
||||
"""The order when checking the journal entry operator."""
|
||||
|
||||
@property
|
||||
def form(self) -> t.Type[JournalEntryForm]:
|
||||
"""Returns the form class.
|
||||
|
||||
:return: The form class.
|
||||
"""
|
||||
return CashReceiptJournalEntryForm
|
||||
|
||||
def render_create_template(self, form: CashReceiptJournalEntryForm) -> str:
|
||||
"""Renders the template for the form to create a journal entry.
|
||||
|
||||
:param form: The journal entry form.
|
||||
:return: the form to create a journal entry.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/receipt/create.html",
|
||||
form=form,
|
||||
journal_entry_type=JournalEntryType.CASH_RECEIPT,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def render_detail_template(self, journal_entry: JournalEntry) -> str:
|
||||
"""Renders the template for the detail page.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: the detail page.
|
||||
"""
|
||||
return render_template("accounting/journal-entry/receipt/detail.html",
|
||||
obj=journal_entry)
|
||||
|
||||
def render_edit_template(self, journal_entry: JournalEntry,
|
||||
form: CashReceiptJournalEntryForm) -> str:
|
||||
"""Renders the template for the form to edit a journal entry.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:param form: The form.
|
||||
:return: the form to edit a journal entry.
|
||||
"""
|
||||
return render_template("accounting/journal-entry/receipt/edit.html",
|
||||
journal_entry=journal_entry, form=form,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def is_my_type(self, journal_entry: JournalEntry) -> bool:
|
||||
"""Checks and returns whether the journal entry belongs to the type.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: True if the journal entry belongs to the type, or False
|
||||
otherwise.
|
||||
"""
|
||||
return journal_entry.is_cash_receipt
|
||||
|
||||
@property
|
||||
def __currency_template(self) -> str:
|
||||
"""Renders and returns the template for the currency sub-form.
|
||||
|
||||
:return: The template for the currency sub-form.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/receipt/include/form-currency.html",
|
||||
currency_index="CURRENCY_INDEX",
|
||||
currency_code_data=default_currency_code(),
|
||||
credit_total="-")
|
||||
|
||||
|
||||
class CashDisbursementJournalEntry(JournalEntryOperator):
|
||||
"""A cash disbursement journal entry."""
|
||||
CHECK_ORDER: int = 1
|
||||
"""The order when checking the journal entry operator."""
|
||||
|
||||
@property
|
||||
def form(self) -> t.Type[JournalEntryForm]:
|
||||
"""Returns the form class.
|
||||
|
||||
:return: The form class.
|
||||
"""
|
||||
return CashDisbursementJournalEntryForm
|
||||
|
||||
def render_create_template(self, form: CashDisbursementJournalEntryForm) \
|
||||
-> str:
|
||||
"""Renders the template for the form to create a journal entry.
|
||||
|
||||
:param form: The journal entry form.
|
||||
:return: the form to create a journal entry.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/disbursement/create.html",
|
||||
form=form,
|
||||
journal_entry_type=JournalEntryType.CASH_DISBURSEMENT,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def render_detail_template(self, journal_entry: JournalEntry) -> str:
|
||||
"""Renders the template for the detail page.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: the detail page.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/disbursement/detail.html",
|
||||
obj=journal_entry)
|
||||
|
||||
def render_edit_template(self, journal_entry: JournalEntry,
|
||||
form: CashDisbursementJournalEntryForm) -> str:
|
||||
"""Renders the template for the form to edit a journal entry.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:param form: The form.
|
||||
:return: the form to edit a journal entry.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/disbursement/edit.html",
|
||||
journal_entry=journal_entry, form=form,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def is_my_type(self, journal_entry: JournalEntry) -> bool:
|
||||
"""Checks and returns whether the journal entry belongs to the type.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: True if the journal entry belongs to the type, or False
|
||||
otherwise.
|
||||
"""
|
||||
return journal_entry.is_cash_disbursement
|
||||
|
||||
@property
|
||||
def __currency_template(self) -> str:
|
||||
"""Renders and returns the template for the currency sub-form.
|
||||
|
||||
:return: The template for the currency sub-form.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/disbursement/include/form-currency.html",
|
||||
currency_index="CURRENCY_INDEX",
|
||||
currency_code_data=default_currency_code(),
|
||||
debit_total="-")
|
||||
|
||||
|
||||
class TransferJournalEntry(JournalEntryOperator):
|
||||
"""A transfer journal entry."""
|
||||
CHECK_ORDER: int = 3
|
||||
"""The order when checking the journal entry operator."""
|
||||
|
||||
@property
|
||||
def form(self) -> t.Type[JournalEntryForm]:
|
||||
"""Returns the form class.
|
||||
|
||||
:return: The form class.
|
||||
"""
|
||||
return TransferJournalEntryForm
|
||||
|
||||
def render_create_template(self, form: TransferJournalEntryForm) -> str:
|
||||
"""Renders the template for the form to create a journal entry.
|
||||
|
||||
:param form: The journal entry form.
|
||||
:return: the form to create a journal entry.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/transfer/create.html",
|
||||
form=form,
|
||||
journal_entry_type=JournalEntryType.TRANSFER,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def render_detail_template(self, journal_entry: JournalEntry) -> str:
|
||||
"""Renders the template for the detail page.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: the detail page.
|
||||
"""
|
||||
return render_template("accounting/journal-entry/transfer/detail.html",
|
||||
obj=journal_entry)
|
||||
|
||||
def render_edit_template(self, journal_entry: JournalEntry,
|
||||
form: TransferJournalEntryForm) -> str:
|
||||
"""Renders the template for the form to edit a journal entry.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:param form: The form.
|
||||
:return: the form to edit a journal entry.
|
||||
"""
|
||||
return render_template("accounting/journal-entry/transfer/edit.html",
|
||||
journal_entry=journal_entry, form=form,
|
||||
currency_template=self.__currency_template,
|
||||
line_item_template=self._line_item_template)
|
||||
|
||||
def is_my_type(self, journal_entry: JournalEntry) -> bool:
|
||||
"""Checks and returns whether the journal entry belongs to the type.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:return: True if the journal entry belongs to the type, or False
|
||||
otherwise.
|
||||
"""
|
||||
return True
|
||||
|
||||
@property
|
||||
def __currency_template(self) -> str:
|
||||
"""Renders and returns the template for the currency sub-form.
|
||||
|
||||
:return: The template for the currency sub-form.
|
||||
"""
|
||||
return render_template(
|
||||
"accounting/journal-entry/transfer/include/form-currency.html",
|
||||
currency_index="CURRENCY_INDEX",
|
||||
currency_code_data=default_currency_code(),
|
||||
debit_total="-", credit_total="-")
|
||||
|
||||
|
||||
JOURNAL_ENTRY_TYPE_TO_OP: dict[JournalEntryType, JournalEntryOperator] \
|
||||
= {JournalEntryType.CASH_RECEIPT: CashReceiptJournalEntry(),
|
||||
JournalEntryType.CASH_DISBURSEMENT: CashDisbursementJournalEntry(),
|
||||
JournalEntryType.TRANSFER: TransferJournalEntry()}
|
||||
"""The map from the journal entry types to their operators."""
|
||||
|
||||
|
||||
def get_journal_entry_op(journal_entry: JournalEntry,
|
||||
is_check_as: bool = False) -> JournalEntryOperator:
|
||||
"""Returns the journal entry operator that may be specified in the "as"
|
||||
query parameter. If it is not specified, check the journal entry type from
|
||||
the journal entry.
|
||||
|
||||
:param journal_entry: The journal entry.
|
||||
:param is_check_as: True to check the "as" parameter, or False otherwise.
|
||||
:return: None.
|
||||
"""
|
||||
if is_check_as and "as" in request.args:
|
||||
type_dict: dict[str, JournalEntryType] \
|
||||
= {x.value: x for x in JournalEntryType}
|
||||
if request.args["as"] not in type_dict:
|
||||
abort(404)
|
||||
return JOURNAL_ENTRY_TYPE_TO_OP[type_dict[request.args["as"]]]
|
||||
for journal_entry_type in sorted(JOURNAL_ENTRY_TYPE_TO_OP.values(),
|
||||
key=lambda x: x.CHECK_ORDER):
|
||||
if journal_entry_type.is_my_type(journal_entry):
|
||||
return journal_entry_type
|
||||
84
src/accounting/journal_entry/utils/original_line_items.py
Normal file
84
src/accounting/journal_entry/utils/original_line_items.py
Normal file
@ -0,0 +1,84 @@
|
||||
# The Mia! Accounting Flask Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/10
|
||||
|
||||
# Copyright (c) 2023 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
"""The selectable original line items.
|
||||
|
||||
"""
|
||||
from decimal import Decimal
|
||||
|
||||
import sqlalchemy as sa
|
||||
from sqlalchemy.orm import selectinload
|
||||
|
||||
from accounting import db
|
||||
from accounting.models import Account, JournalEntry, JournalEntryLineItem
|
||||
from accounting.utils.cast import be
|
||||
from .offset_alias import offset_alias
|
||||
|
||||
|
||||
def get_selectable_original_line_items(
|
||||
line_item_id_on_form: set[int], is_payable: bool,
|
||||
is_receivable: bool) -> list[JournalEntryLineItem]:
|
||||
"""Queries and returns the selectable original line items, with their net
|
||||
balances. The offset amounts of the form is excluded.
|
||||
|
||||
:param line_item_id_on_form: The ID of the line items on the form.
|
||||
:param is_payable: True to check the payable original line items, or False
|
||||
otherwise.
|
||||
:param is_receivable: True to check the receivable original line items, or
|
||||
False otherwise.
|
||||
:return: The selectable original line items, with their net balances.
|
||||
"""
|
||||
assert is_payable or is_receivable
|
||||
offset: sa.Alias = offset_alias()
|
||||
net_balance: sa.Label = (JournalEntryLineItem.amount + sa.func.sum(sa.case(
|
||||
(offset.c.id.in_(line_item_id_on_form), 0),
|
||||
(be(offset.c.is_debit == JournalEntryLineItem.is_debit),
|
||||
offset.c.amount),
|
||||
else_=-offset.c.amount))).label("net_balance")
|
||||
conditions: list[sa.BinaryExpression] = [Account.is_need_offset]
|
||||
sub_conditions: list[sa.BinaryExpression] = []
|
||||
if is_payable:
|
||||
sub_conditions.append(sa.and_(Account.base_code.startswith("2"),
|
||||
sa.not_(JournalEntryLineItem.is_debit)))
|
||||
if is_receivable:
|
||||
sub_conditions.append(sa.and_(Account.base_code.startswith("1"),
|
||||
JournalEntryLineItem.is_debit))
|
||||
conditions.append(sa.or_(*sub_conditions))
|
||||
select_net_balances: sa.Select \
|
||||
= sa.select(JournalEntryLineItem.id, net_balance)\
|
||||
.join(Account)\
|
||||
.join(offset, be(JournalEntryLineItem.id
|
||||
== offset.c.original_line_item_id),
|
||||
isouter=True)\
|
||||
.filter(*conditions)\
|
||||
.group_by(JournalEntryLineItem.id)\
|
||||
.having(sa.or_(sa.func.count(offset.c.id) == 0, net_balance != 0))
|
||||
net_balances: dict[int, Decimal] \
|
||||
= {x.id: x.net_balance
|
||||
for x in db.session.execute(select_net_balances).all()}
|
||||
line_items: list[JournalEntryLineItem] = JournalEntryLineItem.query\
|
||||
.filter(JournalEntryLineItem.id.in_({x for x in net_balances}))\
|
||||
.join(JournalEntry)\
|
||||
.order_by(JournalEntry.date, JournalEntryLineItem.is_debit,
|
||||
JournalEntryLineItem.no)\
|
||||
.options(selectinload(JournalEntryLineItem.currency),
|
||||
selectinload(JournalEntryLineItem.account),
|
||||
selectinload(JournalEntryLineItem.journal_entry)).all()
|
||||
for line_item in line_items:
|
||||
line_item.net_balance = line_item.amount \
|
||||
if net_balances[line_item.id] is None \
|
||||
else net_balances[line_item.id]
|
||||
return line_items
|
||||
Reference in New Issue
Block a user