122 lines
4.4 KiB
Python
122 lines
4.4 KiB
Python
# The Mia! Accounting Flask Project.
|
|
# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/4
|
|
|
|
# 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 report chooser.
|
|
|
|
This file is largely taken from the NanoParma ERP project, first written in
|
|
2021/9/16 by imacat (imacat@nanoparma.com).
|
|
|
|
"""
|
|
import typing as t
|
|
|
|
from flask import url_for
|
|
from flask_babel import LazyString
|
|
|
|
from accounting import db
|
|
from accounting.locale import gettext
|
|
from accounting.models import Currency, Account
|
|
from accounting.template_globals import default_currency_code
|
|
from .option_link import OptionLink
|
|
from .period import Period
|
|
from .report_type import ReportType
|
|
|
|
|
|
class ReportChooser:
|
|
"""The report chooser."""
|
|
|
|
def __init__(self, active_report: ReportType,
|
|
period: Period | None = None,
|
|
currency: Currency | None = None,
|
|
account: Account | None = None):
|
|
"""Constructs the report chooser.
|
|
|
|
:param active_report: The active report.
|
|
:param period: The period.
|
|
:param currency: The currency.
|
|
:param account: The account.
|
|
"""
|
|
self.__active_report: ReportType = active_report
|
|
"""The currently active report."""
|
|
self.__period: Period = Period.get_instance() if period is None \
|
|
else period
|
|
"""The period."""
|
|
self.__currency: Currency = db.session.get(
|
|
Currency, default_currency_code()) \
|
|
if currency is None else currency
|
|
"""The currency."""
|
|
self.__account: Account = Account.find_by_code("1111-001") \
|
|
if account is None else account
|
|
"""The currency."""
|
|
self.__reports: list[OptionLink] = []
|
|
"""The links to the reports."""
|
|
self.current_report: str | LazyString = ""
|
|
"""The title of the current report."""
|
|
self.__reports.append(self.__journal)
|
|
self.__reports.append(self.__ledger)
|
|
self.__reports.append(self.__income_expenses)
|
|
for report in self.__reports:
|
|
if report.is_active:
|
|
self.current_report = report.title
|
|
|
|
@property
|
|
def __journal(self) -> OptionLink:
|
|
"""Returns the journal.
|
|
|
|
:return: The journal.
|
|
"""
|
|
url: str = url_for("accounting.report.journal-default") \
|
|
if self.__period.is_default \
|
|
else url_for("accounting.report.journal", period=self.__period)
|
|
return OptionLink(gettext("Journal"), url,
|
|
self.__active_report == ReportType.JOURNAL)
|
|
|
|
@property
|
|
def __ledger(self) -> OptionLink:
|
|
"""Returns the ledger.
|
|
|
|
:return: The ledger.
|
|
"""
|
|
url: str = url_for("accounting.report.ledger-default",
|
|
currency=self.__currency, account=self.__account) \
|
|
if self.__period.is_default \
|
|
else url_for("accounting.report.ledger",
|
|
currency=self.__currency, account=self.__account,
|
|
period=self.__period)
|
|
return OptionLink(gettext("Ledger"), url,
|
|
self.__active_report == ReportType.LEDGER)
|
|
|
|
@property
|
|
def __income_expenses(self) -> OptionLink:
|
|
"""Returns the income and expenses.
|
|
|
|
:return: The income and expenses.
|
|
"""
|
|
url: str = url_for("accounting.report.income-expenses-default",
|
|
currency=self.__currency, account=self.__account) \
|
|
if self.__period.is_default \
|
|
else url_for("accounting.report.income-expenses",
|
|
currency=self.__currency, account=self.__account,
|
|
period=self.__period)
|
|
return OptionLink(gettext("Income and Expenses"), url,
|
|
self.__active_report == ReportType.INCOME_EXPENSES)
|
|
|
|
def __iter__(self) -> t.Iterator[OptionLink]:
|
|
"""Returns the iteration of the reports.
|
|
|
|
:return: The iteration of the reports.
|
|
"""
|
|
return iter(self.__reports)
|