Moved the "accounting.report.reports.utils" module to "accounting.report.utils". It does not make sense to have a wierd and long module name just to make the import pretty.

src/accounting/report/utils/__init__.py

@@ -0,0 +1,19 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/7
+
+#  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 reports.
+
+"""

src/accounting/report/utils/base_page_params.py

@@ -0,0 +1,88 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/6
+
+#  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 page parameters of a report.
+
+"""
+import typing as t
+from abc import ABC, abstractmethod
+from urllib.parse import urlparse, ParseResult, parse_qsl, urlencode, \
+    urlunparse
+
+import sqlalchemy as sa
+from flask import request
+
+from accounting import db
+from accounting.models import Currency, JournalEntry
+from accounting.utils.txn_types import TransactionType
+from .option_link import OptionLink
+from .report_chooser import ReportChooser
+
+
+class BasePageParams(ABC):
+    """The base HTML page parameters class."""
+
+    @property
+    @abstractmethod
+    def has_data(self) -> bool:
+        """Returns whether there is any data on the page.
+
+        :return: True if there is any data, or False otherwise.
+        """
+
+    @property
+    @abstractmethod
+    def report_chooser(self) -> ReportChooser:
+        """Returns the report chooser.
+
+        :return: The report chooser.
+        """
+
+    @property
+    def txn_types(self) -> t.Type[TransactionType]:
+        """Returns the transaction types.
+
+        :return: The transaction types.
+        """
+        return TransactionType
+
+    @property
+    def csv_uri(self) -> str:
+        uri: str = request.full_path if request.query_string \
+            else request.path
+        uri_p: ParseResult = urlparse(uri)
+        params: list[tuple[str, str]] = parse_qsl(uri_p.query)
+        params = [x for x in params if x[0] != "as"]
+        params.append(("as", "csv"))
+        parts: list[str] = list(uri_p)
+        parts[4] = urlencode(params)
+        return urlunparse(parts)
+
+    @staticmethod
+    def _get_currency_options(get_url: t.Callable[[Currency], str],
+                              active_currency: Currency) -> list[OptionLink]:
+        """Returns the currency options.
+
+        :param get_url: The callback to return the URL of a currency.
+        :param active_currency: The active currency.
+        :return: The currency options.
+        """
+        in_use: set[str] = set(db.session.scalars(
+            sa.select(JournalEntry.currency_code)
+            .group_by(JournalEntry.currency_code)).all())
+        return [OptionLink(str(x), get_url(x), x.code == active_currency.code)
+                for x in Currency.query.filter(Currency.code.in_(in_use))
+                .order_by(Currency.code).all()]

src/accounting/report/utils/base_report.py

@@ -0,0 +1,40 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/8
+
+#  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 base report.
+
+"""
+from abc import ABC, abstractmethod
+
+from flask import Response
+
+
+class BaseReport(ABC):
+    """The base report class."""
+
+    @abstractmethod
+    def csv(self) -> Response:
+        """Returns the report as CSV for download.
+
+        :return: The response of the report for download.
+        """
+
+    @abstractmethod
+    def html(self) -> str:
+        """Composes and returns the report as HTML.
+
+        :return: The report as HTML.
+        """

src/accounting/report/utils/csv_export.py

@@ -0,0 +1,108 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/7
+
+#  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 to export the report as CSV for download.
+
+"""
+import csv
+from abc import ABC, abstractmethod
+from datetime import timedelta, date
+from decimal import Decimal
+from io import StringIO
+
+from flask import Response
+
+from accounting.report.period import Period
+
+
+class BaseCSVRow(ABC):
+    """The base CSV row."""
+
+    @property
+    @abstractmethod
+    def values(self) -> list[str | Decimal | None]:
+        """Returns the values of the row.
+
+        :return: The values of the row.
+        """
+
+
+def csv_download(filename: str, rows: list[BaseCSVRow]) -> Response:
+    """Exports the data rows as a CSV file for download.
+
+    :param filename: The download file name.
+    :param rows: The data rows.
+    :return: The response for download the CSV file.
+    """
+    with StringIO() as fp:
+        writer = csv.writer(fp)
+        writer.writerows([x.values for x in rows])
+        fp.seek(0)
+        response: Response = Response(fp.read(), mimetype="text/csv")
+        response.headers["Content-Disposition"] \
+            = f"attachment; filename={filename}"
+        return response
+
+
+def period_spec(period: Period) -> str:
+    """Constructs the period specification to be used in the filename.
+
+    :param period: The period.
+    :return: The period specification to be used in the filename.
+    """
+    start: str | None = __get_start_str(period.start)
+    end: str | None = __get_end_str(period.end)
+    if period.start is None and period.end is None:
+        return "all-time"
+    if start == end:
+        return start
+    if period.start is None:
+        return f"until-{end}"
+    if period.end is None:
+        return f"since-{start}"
+    return f"{start}-{end}"
+
+
+def __get_start_str(start: date | None) -> str | None:
+    """Returns the string representation of the start date.
+
+    :param start: The start date.
+    :return: The string representation of the start date, or None if the start
+        date is None.
+    """
+    if start is None:
+        return None
+    if start.month == 1 and start.day == 1:
+        return str(start.year)
+    if start.day == 1:
+        return start.strftime("%Y%m")
+    return start.strftime("%Y%m%d")
+
+
+def __get_end_str(end: date | None) -> str | None:
+    """Returns the string representation of the end date.
+
+    :param end: The end date.
+    :return: The string representation of the end date, or None if the end
+        date is None.
+    """
+    if end is None:
+        return None
+    if end.month == 12 and end.day == 31:
+        return str(end.year)
+    if (end + timedelta(days=1)).day == 1:
+        return end.strftime("%Y%m")
+    return end.strftime("%Y%m%d")

src/accounting/report/utils/option_link.py

@@ -0,0 +1,36 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/5
+
+#  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 option link.
+
+"""
+
+
+class OptionLink:
+    """An option link."""
+
+    def __init__(self, title: str, url: str, is_active: bool,
+                 fa_icon: str | None = None):
+        """Constructs an option link.
+
+        :param title: The title.
+        :param url: The URI.
+        :param is_active: True if active, or False otherwise
+        """
+        self.title: str = title
+        self.url: str = url
+        self.is_active: bool = is_active
+        self.fa_icon: str | None = fa_icon

src/accounting/report/utils/period_choosers.py

@@ -0,0 +1,97 @@
+# 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 period choosers.
+
+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 datetime import date
+
+from accounting.models import Transaction
+from accounting.report.period import Period, ThisMonth, LastMonth, \
+    SinceLastMonth, ThisYear, LastYear, Today, Yesterday, AllTime, \
+    TemplatePeriod, YearPeriod
+
+
+class PeriodChooser:
+    """The period chooser."""
+
+    def __init__(self, get_url: t.Callable[[Period], str]):
+        """Constructs a period chooser.
+
+        :param get_url: The callback to return the URL of the current report in
+            a period.
+        """
+        self.__get_url: t.Callable[[Period], str] = get_url
+        """The callback to return the URL of the current report in a period."""
+
+        # Shortcut periods
+        self.this_month_url: str = get_url(ThisMonth())
+        """The URL for this month."""
+        self.last_month_url: str = get_url(LastMonth())
+        """The URL for last month."""
+        self.since_last_month_url: str = get_url(SinceLastMonth())
+        """The URL since last mint."""
+        self.this_year_url: str = get_url(ThisYear())
+        """The URL for this year."""
+        self.last_year_url: str = get_url(LastYear())
+        """The URL for last year."""
+        self.today_url: str = get_url(Today())
+        """The URL for today."""
+        self.yesterday_url: str = get_url(Yesterday())
+        """The URL for yesterday."""
+        self.all_url: str = get_url(AllTime())
+        """The URL for all period."""
+        self.url_template: str = get_url(TemplatePeriod())
+        """The URL template."""
+
+        first: Transaction | None \
+            = Transaction.query.order_by(Transaction.date).first()
+        start: date | None = None if first is None else first.date
+
+        # Attributes
+        self.data_start: date | None = start
+        """The start of the data."""
+        self.has_data: bool = start is not None
+        """Whether there is any data."""
+        self.has_last_month: bool = False
+        """Where there is data in last month."""
+        self.has_last_year: bool = False
+        """Whether there is data in last year."""
+        self.has_yesterday: bool = False
+        """Whether there is data in yesterday."""
+        self.available_years: list[int] = []
+        """The available years."""
+
+        if self.has_data is not None:
+            today: date = date.today()
+            self.has_last_month = start < date(today.year, today.month, 1)
+            self.has_last_year = start.year < today.year
+            self.has_yesterday = start < today
+            if start.year < today.year - 1:
+                self.available_years \
+                    = reversed(range(start.year, today.year - 1))
+
+    def year_url(self, year: int) -> str:
+        """Returns the period URL of a year.
+
+        :param year: The year
+        :return: The period URL of the year.
+        """
+        return self.__get_url(YearPeriod(year))

src/accounting/report/utils/report_chooser.py

@@ -0,0 +1,160 @@
+# 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 re
+import typing as t
+
+from flask_babel import LazyString
+
+from accounting import db
+from accounting.locale import gettext
+from accounting.models import Currency, Account
+from accounting.report.income_expense_account import IncomeExpensesAccount
+from accounting.report.period import Period
+from accounting.template_globals import default_currency_code
+from .option_link import OptionLink
+from .report_type import ReportType
+from .urls import journal_url, ledger_url, income_expenses_url, \
+    trial_balance_url, income_statement_url, balance_sheet_url
+
+
+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.cash() 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.is_search: bool = active_report == ReportType.SEARCH
+        """Whether the current report is the search page."""
+        self.__reports.append(self.__journal)
+        self.__reports.append(self.__ledger)
+        self.__reports.append(self.__income_expenses)
+        self.__reports.append(self.__trial_balance)
+        self.__reports.append(self.__income_statement)
+        self.__reports.append(self.__balance_sheet)
+        for report in self.__reports:
+            if report.is_active:
+                self.current_report = report.title
+        if self.is_search:
+            self.current_report = gettext("Search")
+
+    @property
+    def __journal(self) -> OptionLink:
+        """Returns the journal.
+
+        :return: The journal.
+        """
+        return OptionLink(gettext("Journal"), journal_url(self.__period),
+                          self.__active_report == ReportType.JOURNAL,
+                          fa_icon="fa-solid fa-book")
+
+    @property
+    def __ledger(self) -> OptionLink:
+        """Returns the ledger.
+
+        :return: The ledger.
+        """
+        return OptionLink(gettext("Ledger"),
+                          ledger_url(self.__currency, self.__account,
+                                     self.__period),
+                          self.__active_report == ReportType.LEDGER,
+                          fa_icon="fa-solid fa-clipboard")
+
+    @property
+    def __income_expenses(self) -> OptionLink:
+        """Returns the income and expenses log.
+
+        :return: The income and expenses log.
+        """
+        account: Account = self.__account
+        if not re.match(r"[12][12]", account.base_code):
+            account: Account = Account.cash()
+        return OptionLink(gettext("Income and Expenses Log"),
+                          income_expenses_url(self.__currency,
+                                              IncomeExpensesAccount(account),
+                                              self.__period),
+                          self.__active_report == ReportType.INCOME_EXPENSES,
+                          fa_icon="fa-solid fa-money-bill-wave")
+
+    @property
+    def __trial_balance(self) -> OptionLink:
+        """Returns the trial balance.
+
+        :return: The trial balance.
+        """
+        return OptionLink(gettext("Trial Balance"),
+                          trial_balance_url(self.__currency, self.__period),
+                          self.__active_report == ReportType.TRIAL_BALANCE,
+                          fa_icon="fa-solid fa-scale-unbalanced")
+
+    @property
+    def __income_statement(self) -> OptionLink:
+        """Returns the income statement.
+
+        :return: The income statement.
+        """
+        return OptionLink(gettext("Income Statement"),
+                          income_statement_url(self.__currency, self.__period),
+                          self.__active_report == ReportType.INCOME_STATEMENT,
+                          fa_icon="fa-solid fa-file-invoice-dollar")
+
+    @property
+    def __balance_sheet(self) -> OptionLink:
+        """Returns the balance sheet.
+
+        :return: The balance sheet.
+        """
+        return OptionLink(gettext("Balance Sheet"),
+                          balance_sheet_url(self.__currency, self.__period),
+                          self.__active_report == ReportType.BALANCE_SHEET,
+                          fa_icon="fa-solid fa-scale-balanced")
+
+    def __iter__(self) -> t.Iterator[OptionLink]:
+        """Returns the iteration of the reports.
+
+        :return: The iteration of the reports.
+        """
+        return iter(self.__reports)

src/accounting/report/utils/report_type.py

@@ -0,0 +1,38 @@
+# 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 types.
+
+"""
+from enum import Enum
+
+
+class ReportType(Enum):
+    """The report types."""
+    JOURNAL: str = "journal"
+    """The journal."""
+    LEDGER: str = "ledger"
+    """The ledger."""
+    INCOME_EXPENSES: str = "income-expenses"
+    """The income and expenses log."""
+    TRIAL_BALANCE: str = "trial-balance"
+    """The trial balance."""
+    INCOME_STATEMENT: str = "income-statement"
+    """The income statement."""
+    BALANCE_SHEET: str = "balance-sheet"
+    """The balance sheet."""
+    SEARCH: str = "search"
+    """The search."""

src/accounting/report/utils/urls.py

@@ -0,0 +1,112 @@
+# The Mia! Accounting Flask Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/3/9
+
+#  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 to get the ledger URL.
+
+"""
+from flask import url_for
+
+from accounting.models import Currency, Account
+from accounting.report.income_expense_account import IncomeExpensesAccount
+from accounting.report.period import Period
+
+
+def journal_url(period: Period) \
+        -> str:
+    """Returns the URL of a journal.
+
+    :param period: The period.
+    :return: The URL of the journal.
+    """
+    if period.is_default:
+        return url_for("accounting.report.journal-default")
+    return url_for("accounting.report.journal", period=period)
+
+
+def ledger_url(currency: Currency, account: Account, period: Period) \
+        -> str:
+    """Returns the URL of a ledger.
+
+    :param currency: The currency.
+    :param account: The account.
+    :param period: The period.
+    :return: The URL of the ledger.
+    """
+    if period.is_default:
+        return url_for("accounting.report.ledger-default",
+                       currency=currency, account=account)
+    return url_for("accounting.report.ledger",
+                   currency=currency, account=account,
+                   period=period)
+
+
+def income_expenses_url(currency: Currency, account: IncomeExpensesAccount,
+                        period: Period) -> str:
+    """Returns the URL of an income and expenses log.
+
+    :param currency: The currency.
+    :param account: The account.
+    :param period: The period.
+    :return: The URL of the income and expenses log.
+    """
+    if period.is_default:
+        return url_for("accounting.report.income-expenses-default",
+                       currency=currency, account=account)
+    return url_for("accounting.report.income-expenses",
+                   currency=currency, account=account,
+                   period=period)
+
+
+def trial_balance_url(currency: Currency, period: Period) -> str:
+    """Returns the URL of a trial balance.
+
+    :param currency: The currency.
+    :param period: The period.
+    :return: The URL of the trial balance.
+    """
+    if period.is_default:
+        return url_for("accounting.report.trial-balance-default",
+                       currency=currency)
+    return url_for("accounting.report.trial-balance",
+                   currency=currency, period=period)
+
+
+def income_statement_url(currency: Currency, period: Period) -> str:
+    """Returns the URL of an income statement.
+
+    :param currency: The currency.
+    :param period: The period.
+    :return: The URL of the income statement.
+    """
+    if period.is_default:
+        return url_for("accounting.report.income-statement-default",
+                       currency=currency)
+    return url_for("accounting.report.income-statement",
+                   currency=currency, period=period)
+
+
+def balance_sheet_url(currency: Currency, period: Period) -> str:
+    """Returns the URL of a balance sheet.
+
+    :param currency: The currency.
+    :param period: The period.
+    :return: The URL of the balance sheet.
+    """
+    if period.is_default:
+        return url_for("accounting.report.balance-sheet-default",
+                       currency=currency)
+    return url_for("accounting.report.balance-sheet",
+                   currency=currency, period=period)