Added the sample data generation and database reset on the test site for live demonstration.

tests/make-sample.py

@@ -0,0 +1,306 @@
+#! env python3
+# The Mia! Accounting Project.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/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 sample data generation.
+
+"""
+from datetime import date, timedelta
+
+import click
+
+from testlib import Accounts, create_test_app, JournalEntryLineItemData, \
+    JournalEntryCurrencyData, JournalEntryData, \
+    BaseTestData
+
+
+@click.command()
+@click.argument("file")
+def main(file) -> None:
+    """Creates the sample data and output to a file."""
+    data: SampleData = SampleData(create_test_app(), "editor")
+    with open(file, "wt") as fp:
+        fp.write(data.json())
+
+
+class SampleData(BaseTestData):
+    """The sample data."""
+
+    def _init_data(self) -> None:
+        self.__add_recurring()
+        self.__add_offsets()
+        self.__add_meals()
+
+    def __add_recurring(self) -> None:
+        """Adds the recurring data.
+
+        :return: None.
+        """
+        self.__add_usd_recurring()
+        self.__add_twd_recurring()
+
+    def __add_usd_recurring(self) -> None:
+        """Adds the recurring data in USD.
+
+        :return: None.
+        """
+        today: date = date.today()
+        days: int
+        year: int
+        month: int
+
+        # Recurring in USD
+        j_date: date = date(today.year - 5, today.month, today.day)
+        j_date = j_date + timedelta(days=(4 - j_date.weekday()))
+        days = (today - j_date).days
+        while True:
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "USD", "2600",
+                Accounts.BANK, "Transfer", Accounts.SERVICE, "Payroll")
+
+            days = days - 1
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "USD", "1200",
+                Accounts.CASH, None, Accounts.BANK, "Withdraw")
+            days = days - 13
+
+        year = today.year - 5
+        month = today.month
+        while True:
+            month = month + 1
+            if month > 12:
+                year = year + 1
+                month = 1
+            days = (today - date(year, month, 1)).days
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "USD", "1800",
+                Accounts.RENT_EXPENSE, "Rent", Accounts.BANK, "Transfer")
+
+    def __add_twd_recurring(self) -> None:
+        """Adds the recurring data in TWD.
+
+        :return: None.
+        """
+        today: date = date.today()
+
+        year: int = today.year - 5
+        month: int = today.month
+        while True:
+            days: int = (today - date(year, month, 5)).days
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "TWD", "50000",
+                Accounts.BANK, "薪資轉帳", Accounts.SERVICE, "薪水")
+
+            days = days - 1
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "TWD", "25000",
+                Accounts.CASH, None, Accounts.BANK, "提款")
+
+            days = days - 4
+            if days < 0:
+                break
+            self.__add_journal_entry(
+                days, "TWD", "18000",
+                Accounts.RENT_EXPENSE, "房租", Accounts.BANK, "轉帳")
+
+            month = month + 1
+            if month > 12:
+                year = year + 1
+                month = 1
+
+    def __add_offsets(self) -> None:
+        """Adds the offset data.
+
+        :return: None.
+        """
+        days: int
+        year: int
+        month: int
+        description: str
+        line_item_or: JournalEntryLineItemData
+        line_item_of: JournalEntryLineItemData
+
+        # Full offset and unmatched in USD
+        description = "Speaking—Institute"
+        line_item_or = JournalEntryLineItemData(
+            Accounts.RECEIVABLE, description, "120")
+        self._add_journal_entry(JournalEntryData(
+            40, [JournalEntryCurrencyData(
+                "USD", [line_item_or], [JournalEntryLineItemData(
+                    Accounts.SERVICE, description, "120")])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.RECEIVABLE, description, "120",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            5, [JournalEntryCurrencyData(
+                "USD", [JournalEntryLineItemData(
+                    Accounts.BANK, description, "120")],
+                [line_item_of])]))
+        self.__add_journal_entry(
+            30, "USD", "120",
+            Accounts.BANK, description, Accounts.SERVICE, description)
+
+        # Partial offset in USD
+        line_item_or = JournalEntryLineItemData(
+            Accounts.PAYABLE, "Computer", "1600")
+        self._add_journal_entry(JournalEntryData(
+            60, [JournalEntryCurrencyData(
+                "USD", [JournalEntryLineItemData(
+                    Accounts.MACHINERY, "Computer", "1600")],
+                [line_item_or])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.PAYABLE, "Computer", "800",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            35, [JournalEntryCurrencyData(
+                "USD", [line_item_of], [JournalEntryLineItemData(
+                    Accounts.BANK, "Computer", "800")])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.PAYABLE, "Computer", "400",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            10, [JournalEntryCurrencyData(
+                "USD", [line_item_of], [JournalEntryLineItemData(
+                    Accounts.CASH, "Computer", "400")])]))
+
+        # Full offset and unmatched in TWD
+        description = "演講費—母校"
+        line_item_or = JournalEntryLineItemData(
+            Accounts.RECEIVABLE, description, "3000")
+        self._add_journal_entry(JournalEntryData(
+            45, [JournalEntryCurrencyData(
+                "TWD", [line_item_or], [JournalEntryLineItemData(
+                    Accounts.SERVICE, description, "3000")])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.RECEIVABLE, description, "3000",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            6, [JournalEntryCurrencyData(
+                "TWD", [JournalEntryLineItemData(
+                    Accounts.BANK, description, "3000")],
+                [line_item_of])]))
+        self.__add_journal_entry(
+            25, "TWD", "3000",
+            Accounts.BANK, description, Accounts.SERVICE, description)
+
+        # Partial offset in TWD
+        line_item_or = JournalEntryLineItemData(
+            Accounts.PAYABLE, "手機", "30000")
+        self._add_journal_entry(JournalEntryData(
+            55, [JournalEntryCurrencyData(
+                "TWD", [JournalEntryLineItemData(
+                    Accounts.MACHINERY, "手機", "30000")],
+                [line_item_or])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.PAYABLE, "手機", "16000",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            27, [JournalEntryCurrencyData(
+                "TWD", [line_item_of], [JournalEntryLineItemData(
+                    Accounts.BANK, "手機", "16000")])]))
+        line_item_of = JournalEntryLineItemData(
+            Accounts.PAYABLE, "手機", "6000",
+            original_line_item=line_item_or)
+        self._add_journal_entry(JournalEntryData(
+            8, [JournalEntryCurrencyData(
+                "TWD", [line_item_of], [JournalEntryLineItemData(
+                    Accounts.CASH, "手機", "6000")])]))
+
+    def __add_meals(self) -> None:
+        """Adds the meal data.
+
+        :return: None.
+        """
+        days = 60
+        while days >= 0:
+            # Meals in USD
+            if days % 4 == 2:
+                self.__add_journal_entry(
+                    days, "USD", "2.9",
+                    Accounts.MEAL, "Lunch—Coffee", Accounts.CASH, None)
+            else:
+                self.__add_journal_entry(
+                    days, "USD", "3.9",
+                    Accounts.MEAL, "Lunch—Coffee", Accounts.CASH, None)
+
+            if days % 15 == 3:
+                self.__add_journal_entry(
+                    days, "USD", "5.45",
+                    Accounts.MEAL, "Dinner—Pizza",
+                    Accounts.PAYABLE, "Dinner—Pizza")
+            else:
+                self.__add_journal_entry(
+                    days, "USD", "5.9",
+                    Accounts.MEAL, "Dinner—Pasta", Accounts.CASH, None)
+
+            # Meals in TWD
+            if days % 5 == 3:
+                self.__add_journal_entry(
+                    days, "TWD", "125",
+                    Accounts.MEAL, "午餐—鄰家咖啡", Accounts.CASH, None)
+            else:
+                self.__add_journal_entry(
+                    days, "TWD", "80",
+                    Accounts.MEAL, "午餐—便當", Accounts.CASH, None)
+
+            if days % 15 == 3:
+                self.__add_journal_entry(
+                    days, "TWD", "320",
+                    Accounts.MEAL, "晚餐—牛排", Accounts.PAYABLE, "晚餐—牛排")
+            else:
+                self.__add_journal_entry(
+                    days, "TWD", "100",
+                    Accounts.MEAL, "晚餐—自助餐", Accounts.CASH, None)
+
+            days = days - 1
+
+    def __add_journal_entry(
+            self, days: int, currency: str, amount: str,
+            debit_account: str, debit_description: str | None,
+            credit_account: str, credit_description: str | None) -> None:
+        """Adds a simple journal entry.
+
+        :param days: The number of days before today.
+        :param currency: The currency code.
+        :param amount: The amount.
+        :param debit_account: The debit account code.
+        :param debit_description: The debit description.
+        :param credit_account: The credit account code.
+        :param credit_description: The credit description.
+        :return: None.
+        """
+        self._add_journal_entry(JournalEntryData(
+            days,
+            [JournalEntryCurrencyData(
+                currency,
+                [JournalEntryLineItemData(
+                    debit_account, debit_description, amount)],
+                [JournalEntryLineItemData(
+                    credit_account, credit_description, amount)])]))
+
+
+if __name__ == "__main__":
+    main()

tests/test_site/__init__.py

@@ -71,6 +71,9 @@ def create_app(is_testing: bool = False) -> Flask:
     from . import auth
     auth.init_app(app)
 
+    from . import reset
+    reset.init_app(app)
+
     class UserUtilities(accounting.UserUtilityInterface[auth.User]):
 
         def can_view(self) -> bool:

tests/test_site/reset.py

@@ -0,0 +1,153 @@
+# The Mia! Accounting Demonstration Website.
+# Author: imacat@mail.imacat.idv.tw (imacat), 2023/4/12
+
+#  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 data reset for the Mia! Accounting demonstration website.
+
+"""
+import json
+import typing as t
+from datetime import date, timedelta
+from decimal import Decimal
+from pathlib import Path
+
+import sqlalchemy as sa
+from flask import Flask, Blueprint, url_for, flash, redirect, session, \
+    render_template
+from flask_babel import lazy_gettext
+
+from accounting.utils.cast import s
+from . import db
+from .auth import User, current_user
+
+bp: Blueprint = Blueprint("reset", __name__, url_prefix="/")
+
+
+@bp.get("reset", endpoint="reset-page")
+def reset() -> str:
+    """Resets the sample data.
+
+    :return: Redirection to the accounting application.
+    """
+    return render_template("reset.html")
+
+
+@bp.post("sample", endpoint="sample")
+def reset_sample() -> redirect:
+    """Resets the sample data.
+
+    :return: Redirection to the accounting application.
+    """
+    __reset_database()
+    __populate_sample_data()
+    flash(s(lazy_gettext(
+        "The sample data are emptied and reset successfully.")), "success")
+    return redirect(url_for("accounting-report.default"))
+
+
+@bp.post("reset", endpoint="clean-up")
+def clean_up() -> redirect:
+    """Clean-up the database data.
+
+    :return: Redirection to the accounting application.
+    """
+    __reset_database()
+    db.session.commit()
+    flash(s(lazy_gettext("The database is emptied successfully.")), "success")
+    return redirect(url_for("accounting-report.default"))
+
+
+def __populate_sample_data() -> None:
+    """Populates the sample data.
+
+    :return: None.
+    """
+    from accounting.models import Account, JournalEntry, JournalEntryLineItem
+    file: Path = Path(__file__).parent / "data" / "sample.json"
+    with open(file) as fp:
+        json_data = json.load(fp)
+    today: date = date.today()
+    user: User | None = current_user()
+    assert user is not None
+
+    def filter_journal_entry(data: list[t.Any]) -> dict[str, t.Any]:
+        """Filters the journal entry data from JSON.
+
+        :param data: The journal entry data.
+        :return: The journal entry data from JSON.
+        """
+        return {"id": data[0],
+                "date": today - timedelta(days=data[1]),
+                "no": data[2],
+                "note": data[3],
+                "created_by_id": user.id,
+                "updated_by_id": user.id}
+
+    def filter_line_item(data: list[t.Any]) -> dict[str, t.Any]:
+        """Filters the journal entry line item data from JSON.
+
+        :param data: The journal entry line item data.
+        :return: The journal entry line item data from JSON.
+        """
+        return {"id": data[0],
+                "journal_entry_id": data[1],
+                "original_line_item_id": data[2],
+                "is_debit": data[3],
+                "no": data[4],
+                "account_id": Account.find_by_code(data[5]).id,
+                "currency_code": data[6],
+                "description": data[7],
+                "amount": Decimal(data[8])}
+
+    db.session.execute(sa.insert(JournalEntry),
+                       [filter_journal_entry(x) for x in json_data[0]])
+    db.session.execute(sa.insert(JournalEntryLineItem),
+                       [filter_line_item(x) for x in json_data[1]])
+    db.session.commit()
+
+
+def __reset_database() -> None:
+    """Resets the database.
+
+    :return: None.
+    """
+    from accounting.models import Currency, CurrencyL10n, BaseAccount, \
+        BaseAccountL10n, Account, AccountL10n, JournalEntry, \
+        JournalEntryLineItem
+    from accounting.base_account import init_base_accounts_command
+    from accounting.account import init_accounts_command
+    from accounting.currency import init_currencies_command
+
+    JournalEntryLineItem.query.delete()
+    JournalEntry.query.delete()
+    CurrencyL10n.query.delete()
+    Currency.query.delete()
+    AccountL10n.query.delete()
+    Account.query.delete()
+    BaseAccountL10n.query.delete()
+    BaseAccount.query.delete()
+    init_base_accounts_command()
+    init_accounts_command(session["user"])
+    init_currencies_command(session["user"])
+
+
+def init_app(app: Flask) -> None:
+    """Initialize the localization.
+
+    :param app: The Flask application.
+    :return: None.
+    """
+    app.register_blueprint(bp)
+

tests/test_site/templates/base.html

@@ -72,6 +72,14 @@ First written: 2023/1/27
                   </button>
                 </form>
               </li>
+              {% if current_user().username == "admin" %}
+                <li>
+                  <a class="dropdown-item {% if request.endpoint and request.endpoint.startswith("reset.") %} active {% endif %}" href="{{ url_for("reset.reset-page") }}">
+                    <i class="fa-solid fa-rotate-right"></i>
+                    {{ _("Reset") }}
+                  </a>
+                </li>
+              {% endif %}
             </ul>
           </li>
         {% else %}

tests/test_site/templates/reset.html

@@ -0,0 +1,48 @@
+{#
+The Mia! Accounting Demonstration Website
+reset.html: The reset page.
+
+ 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.
+
+Author: imacat@mail.imacat.idv.tw (imacat)
+First written: 2023/4/12
+#}
+{% extends "base.html" %}
+
+{% block header %}{% block title %}{{ _("Reset Database") }}{% endblock %}{% endblock %}
+
+{% block content %}
+
+<p>{{ _("Warning: All the current accounting data will be deleted.  This cannot be undone.  Please backup your database first.") }}</p>
+
+<p>{{ _("Database reset is provided by the live demonstration.  This is not part of the Mia! Accounting project.") }}</p>
+
+<form class="mb-2" action="{{ url_for("reset.clean-up") }}" method="post">
+  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
+  {% if request.args.next %}
+    <input type="hidden" name="next" value="{{ request.args.next }}">
+  {% endif %}
+  <button class="btn btn-primary" type="submit">{{ _("Empty the Database") }}</button>
+</form>
+
+<form class="mb-2" action="{{ url_for("reset.sample") }}" method="post">
+  <input type="hidden" name="csrf_token" value="{{ csrf_token() }}">
+  {% if request.args.next %}
+    <input type="hidden" name="next" value="{{ request.args.next }}">
+  {% endif %}
+  <button class="btn btn-primary" type="submit">{{ _("Empty and reset the Sample Data") }}</button>
+</form>
+
+{% endblock %}

tests/testlib.py

@@ -19,6 +19,7 @@
 """
 from __future__ import annotations
 
+import json
 import re
 import typing as t
 from abc import ABC, abstractmethod
@@ -47,6 +48,7 @@ class Accounts:
     BANK: str = "1113-001"
     NOTES_RECEIVABLE: str = "1131-001"
     RECEIVABLE: str = "1141-001"
+    MACHINERY: str = "1441-001"
     PREPAID: str = "1258-001"
     NOTES_PAYABLE: str = "2131-001"
     PAYABLE: str = "2141-001"
@@ -166,7 +168,7 @@ def match_journal_entry_detail(location: str) -> int:
 class JournalEntryLineItemData:
     """The journal entry line item data."""
 
-    def __init__(self, account: str, description: str, amount: str,
+    def __init__(self, account: str, description: str | None, amount: str,
                  original_line_item: JournalEntryLineItemData | None = None):
         """Constructs the journal entry line item data.
 
@@ -181,7 +183,7 @@ class JournalEntryLineItemData:
         self.original_line_item: JournalEntryLineItemData | None \
             = original_line_item
         self.account: str = account
-        self.description: str = description
+        self.description: str | None = description
         self.amount: Decimal = Decimal(amount)
 
     def form(self, prefix: str, debit_credit: str, index: int,
@@ -332,6 +334,49 @@ class BaseTestData(ABC):
                                self.__line_items)
             db.session.commit()
 
+    def json(self) -> str:
+        """Returns the data as JSON.
+
+        :return: The JSON string.
+        """
+        from accounting.models import Account
+        today: date = date.today()
+
+        def filter_journal_entry(data: dict[str, t.Any]) -> list[t.Any]:
+            """Filters the journal entry data for JSON encoding.
+
+            :param data: The journal entry data.
+            :return: The journal entry data for JSON encoding.
+            """
+            data = data.copy()
+            data["date"] = (today - data["date"]).days
+            del data["created_by_id"]
+            del data["updated_by_id"]
+            return [data[x] for x in ["id", "date", "no", "note"]]
+
+        def filter_line_item(data: dict[str, t.Any]) -> list[t.Any]:
+            """Filters the journal entry line item data for JSON encoding.
+
+            :param data: The journal entry line item data.
+            :return: The journal entry line item data for JSON encoding.
+            """
+            data = data.copy()
+            with self.__app.app_context():
+                data["account_id"] \
+                    = db.session.get(Account, data["account_id"]).code
+            data["amount"] = str(data["amount"])
+            if "original_line_item_id" not in data:
+                data["original_line_item_id"] = None
+            return [data[x] for x in ["id", "journal_entry_id",
+                                      "original_line_item_id", "is_debit",
+                                      "no", "account_id", "currency_code",
+                                      "description", "amount"]]
+
+        return json.dumps(
+            [[filter_journal_entry(x) for x in self.__journal_entries],
+             [filter_line_item(x) for x in self.__line_items]],
+            ensure_ascii=False, separators=(",", ":"))
+
     @staticmethod
     def _couple(description: str, amount: str, debit: str, credit: str) \
             -> tuple[JournalEntryLineItemData, JournalEntryLineItemData]: