monopyly 1.5.1__py3-none-any.whl → 1.6.0__py3-none-any.whl

monopyly/common/transactions.py

@@ -2,10 +2,8 @@
 Tools for building a common transaction interface.
 """
 
-from abc import abstractmethod
-
-from authanor.database.handler import DatabaseHandler, DatabaseViewHandler
-from flask import current_app
+from dry_foundation.database.handler import DatabaseHandler, DatabaseViewHandler
+from flask import abort, current_app
 
 from ..database.models import (
     BankAccountTypeView,
@@ -31,17 +29,27 @@ class TransactionHandler(DatabaseViewHandler):
     """
 
     @classmethod
-    def _customize_entries_query(cls, query, criteria, column_orders):
+    def _customize_entries_query(
+        cls, query, criteria, column_orders, offset=None, limit=None
+    ):
         # Group transactions and order by transaction date
         query = query.group_by(cls.model.id)
-        return super()._customize_entries_query(query, criteria, column_orders)
+        return super()._customize_entries_query(
+            query, criteria, column_orders, offset=offset, limit=limit
+        )
 
     @classmethod
-    def _get_transactions(cls, criteria=None, sort_order="DESC"):
+    def _get_transactions(
+        cls, criteria=None, sort_order="DESC", offset=None, limit=None
+    ):
         # Specify transaction order
         column_orders = {cls.model.transaction_date: sort_order}
         entries = cls.get_entries(
-            entry_ids=None, criteria=criteria, column_orders=column_orders
+            entry_ids=None,
+            criteria=criteria,
+            column_orders=column_orders,
+            offset=offset,
+            limit=limit,
         )
         return entries
 
@@ -76,7 +84,26 @@ class TransactionHandler(DatabaseViewHandler):
 
     @classmethod
     def update_entry(cls, entry_id, **field_values):
-        """Update a transaction in the database."""
+        """
+        Update a transaction in the database.
+
+        Accept a mapping relating given inputs to database fields. This
+        mapping is used to update an existing transaction in the
+        database. All fields are sanitized prior to updating, and any
+        subtransactions are identified for individual processing.
+
+        Parameters
+        ----------
+        entry_id : int
+            The ID of the transaction to be updated.
+        **field_values :
+            Values for the fields to update in the transaction.
+
+        Returns
+        -------
+        transaction : database.models.BankTransaction
+            The saved transaction.
+        """
         # Extend the default method to account for subtransactions
         subtransactions_data = field_values.pop("subtransactions", None)
         transaction = super().update_entry(entry_id, **field_values)
@@ -100,6 +127,30 @@ class TransactionHandler(DatabaseViewHandler):
         # Flush to the database after all subtransactions have been added
         cls._db.session.flush()
 
+    @classmethod
+    def delete_entry(cls, entry_id):
+        """
+        Delete a transaction in the database given its ID.
+
+        Parameters
+        ----------
+        entry_id : int
+            The ID of the transaction to be deleted.
+
+        Notes
+        -----
+        This will also delete any internal transactions associated with
+        this transaction, since the internal transaction link no longer
+        exists.
+        """
+        internal_transaction = cls.get_entry(entry_id).internal_transaction
+        super().delete_entry(entry_id)
+        if internal_transaction:
+            cls._db.session.refresh(internal_transaction)
+            if len(internal_transaction.transaction_views) <= 1:
+                cls._db.session.delete(internal_transaction)
+                cls._db.session.flush()
+
 
 def get_linked_transaction(transaction):
     """
@@ -232,10 +283,10 @@ class TransactionTagHandler(DatabaseHandler, model=TransactionTag):
         return tags
 
     @classmethod
-    def _filter_entries(cls, query, criteria):
+    def _filter_entries(cls, query, criteria, offset, limit):
         # Only get distinct tag entries
         query = query.distinct()
-        return super()._filter_entries(query, criteria)
+        return super()._filter_entries(query, criteria, offset, limit)
 
     @classmethod
     def get_subtags(cls, tag):
@@ -359,6 +410,25 @@ class TransactionTagHandler(DatabaseHandler, model=TransactionTag):
         tag = cls._db.session.execute(query).scalar_one_or_none()
         return tag
 
+    @classmethod
+    def delete_entry(cls, entry_id):
+        """
+        Delete the tag in the database given its ID.
+
+        Parameters
+        ----------
+        entry_id : int
+            The ID of the tag to be deleted.
+        """
+        super().delete_entry(entry_id)
+
+    @classmethod
+    def _retrieve_authorized_manipulable_entry(cls, entry_id):
+        tag = super()._retrieve_authorized_manipulable_entry(entry_id)
+        if tag.user_id != cls.user_id:
+            abort(403, "The current user is not authorized to manipulate this tag.")
+        return tag
+
 
 def categorize(transactions):
     """
@@ -402,6 +472,11 @@ class CategoryTree:
     """
     Store a tree of categories.
 
+    The category tree is a tree of categorized subtransactions. Each
+    leaf of the tree represents a transaction tag and the
+    subtransactions that have been categorized according to that tag
+    (the category).
+
     Parameters
     ----------
     category : database.models.TransactionTag, str
@@ -470,9 +545,9 @@ class RootCategoryTree(CategoryTree):
         Given a subtransaction, add that subtransaction to the category
         tree according to its tags. If multiple tags exist at the same
         level of the tree (i.e., a subtransaction with tags in diverging
-        branches), the tag is determined to be "uncategorizable" and the
-        tag is listed only as a member of the root tree and not as a
-        member of any other subcategory tree.
+        branches), the subtransaction is determined to be "uncategorizable"
+        and the tag is listed only as a member of the root tree and not
+        as a member of any other subcategory tree.
 
         Parameters
         ----------

monopyly/core/actions.py

@@ -1,16 +1,10 @@
 """Module describing logical core actions (to be used in routes)."""
 
-from datetime import datetime
-
 import markdown
 
 
-def get_timestamp():
-    """Get a timestamp for backup filenames."""
-    return datetime.now().strftime("%Y%m%d_%H%M%S")
-
-
 class MarkdownConverter:
+    """An object to convert Markdown to HTML."""
 
     replacements = {
         "src": [
@@ -78,7 +72,7 @@ def convert_readme_to_html_template(readme_path):
             '<div class="resource-links">'
             "  <h2>Links</h2>"
             '  <p><a href="{{ url_for("core.story") }}">Story</a></p>'
-            '  <p><a href="{{ url_for("core.credits") }}">Credits</a></p>'
+            '  <p><a href="{{ url_for("core.application_credits") }}">Credits</a></p>'
             "</div>"
         ),
     )

monopyly/core/blueprint.py

@@ -9,3 +9,5 @@ bp = Blueprint("core", __name__)
 
 # Import routes after defining blueprint to avoid circular imports
 from . import context_processors, errors, filters, routes
+
+__all__ = ["context_processors", "errors", "filters", "routes"]

monopyly/core/filters.py

@@ -2,8 +2,6 @@
 Filters defined for the application.
 """
 
-from math import floor, log10
-
 from .blueprint import bp
 
 

monopyly/core/routes.py

@@ -74,7 +74,7 @@ def story():
 
 
 @bp.route("/credits")
-def credits():
+def application_credits():
     return render_template("core/credits.html")
 
 

monopyly/credit/accounts.py

@@ -2,7 +2,7 @@
 Tools for interacting with credit accounts in the database.
 """
 
-from authanor.database.handler import DatabaseHandler
+from dry_foundation.database.handler import DatabaseHandler
 
 from ..database.models import CreditAccount
 

monopyly/credit/actions.py

@@ -94,9 +94,8 @@ def get_potential_preceding_card(card):
                 card_ids=(other_card.id,),
             )
             latest_statement = statements.first()
-            if latest_statement:
-                if latest_statement.balance > 0:
-                    return other_card
+            if latest_statement and latest_statement.balance > 0:
+                return other_card
     # Card does not meet all of these conditions
     return None
 
@@ -110,8 +109,8 @@ def transfer_credit_card_statement(form, card_id, prior_card_id):
         statements = CreditStatementHandler.get_statements(card_ids=(prior_card_id,))
         latest_statement = statements.first()
         CreditStatementHandler.update_entry(latest_statement.id, card_id=card_id)
-        # Deactivate the old card
-        prior_card = CreditCardHandler.get_entry(prior_card_id)
+        # Deactivate the old card (after ensuring it exists and is accessible)
+        CreditCardHandler.get_entry(prior_card_id)
         CreditCardHandler.update_entry(prior_card_id, active=0)
 
 

monopyly/credit/blueprint.py

@@ -9,3 +9,5 @@ bp = Blueprint("credit", __name__, url_prefix="/credit")
 
 # Import routes after defining blueprint to avoid circular imports
 from . import routes
+
+__all__ = ["routes"]

monopyly/credit/cards.py

@@ -2,7 +2,7 @@
 Tools for interacting with credit cards in the database.
 """
 
-from authanor.database.handler import DatabaseHandler
+from dry_foundation.database.handler import DatabaseHandler
 
 from ..common.forms.utils import execute_on_form_validation
 from ..database.models import Bank, CreditAccount, CreditCard
@@ -99,8 +99,12 @@ class CreditCardHandler(DatabaseHandler, model=CreditCard):
         return card
 
     @classmethod
-    def _customize_entries_query(cls, query, filters, sort_order):
-        query = super()._customize_entries_query(query, filters, sort_order)
+    def _customize_entries_query(
+        cls, query, filters, sort_order, offset=None, limit=None
+    ):
+        query = super()._customize_entries_query(
+            query, filters, sort_order, offset=offset, limit=limit
+        )
         # Order cards by active status (active cards first)
         query = query.order_by(cls.model.active.desc())
         return query

monopyly/credit/forms.py

@@ -2,20 +2,18 @@
 Generate credit card forms for the user to complete.
 """
 
-from werkzeug.exceptions import abort
+from flask import abort
 from wtforms.fields import (
     BooleanField,
     FieldList,
     FormField,
     IntegerField,
     RadioField,
-    StringField,
     SubmitField,
 )
 from wtforms.validators import DataRequired, Optional
 
-from ..banking.banks import BankHandler
-from ..banking.forms import BankSelectField, BankSubform
+from ..banking.forms import BankSubform
 from ..common.forms import AcquisitionSubform, EntryForm, EntrySubform, TransactionForm
 from ..common.forms.fields import (
     CustomChoiceSelectField,
@@ -335,7 +333,7 @@ class CreditTransactionForm(TransactionForm):
         """Gather data for the form from the given database entry."""
         if isinstance(entry, CreditTransactionView):
             data = self._gather_transaction_data(entry)
-            statement_info = entry.statement
+            statement_info = entry.statement_view
         elif isinstance(entry, (CreditCard, CreditStatementView)):
             data = {}
             statement_info = entry

monopyly/credit/routes.py

@@ -2,11 +2,10 @@
 Routes for credit card financials.
 """
 
-from itertools import islice
-
+from dry_foundation.database import db_transaction
 from flask import (
+    abort,
     flash,
-    g,
     jsonify,
     redirect,
     render_template,
@@ -14,23 +13,18 @@ from flask import (
     session,
     url_for,
 )
-from fuisce.database import db_transaction
 from sqlalchemy.exc import MultipleResultsFound
-from werkzeug.exceptions import abort
-from wtforms.validators import ValidationError
 
 from ..auth.tools import login_required
 from ..banking.accounts import BankAccountHandler
 from ..banking.banks import BankHandler
-from ..banking.transactions import BankTransactionHandler
-from ..common.forms import form_err_msg
 from ..common.forms.utils import extend_field_list_for_ajax
 from ..common.transactions import (
     categorize,
     get_linked_transaction,
     highlight_unmatched_transactions,
 )
-from ..common.utils import dedelimit_float, parse_date, sort_by_frequency
+from ..common.utils import dedelimit_float, parse_date
 from .accounts import CreditAccountHandler
 from .actions import (
     get_card_statement_grouping,
@@ -44,13 +38,16 @@ from .blueprint import bp
 from .cards import CreditCardHandler, save_card
 from .forms import CardStatementTransferForm, CreditCardForm, CreditTransactionForm
 from .statements import CreditStatementHandler
-from .transactions import CreditTagHandler, CreditTransactionHandler, save_transaction
+from .transactions import CreditTransactionHandler, save_transaction
 from .transactions.activity import (
     ActivityMatchmaker,
     TransactionActivities,
     parse_transaction_activity_file,
 )
 
+# Set a limit on the number of transactions loaded at one time for certain routes
+TRANSACTION_LIMIT = 100
+
 
 @bp.route("/cards")
 @login_required
@@ -206,7 +203,7 @@ def load_statement_details(statement_id):
     return render_template(
         "credit/statement_page.html",
         statement=statement,
-        statement_transactions=transactions,
+        transactions=transactions,
         bank_accounts=bank_accounts,
         chart_data=categories.assemble_chart_data(exclude=["Credit payments"]),
     )
@@ -261,7 +258,7 @@ def pay_credit_card(card_id, statement_id):
         bank_accounts=bank_accounts,
     )
     transactions_table_template = render_template(
-        "credit/transactions_table/transactions.html",
+        "credit/transactions_table/table.html",
         transactions=transactions,
     )
     return jsonify((summary_template, transactions_table_template))
@@ -299,7 +296,7 @@ def load_statement_reconciliation_details(statement_id):
         return render_template(
             "credit/statement_reconciliation/statement_reconciliation_page.html",
             statement=statement,
-            statement_transactions=transactions,
+            transactions=transactions,
             discrepant_records=matchmaker.match_discrepancies,
             discrepant_amount=abs(statement_transaction_balance - activities.total),
             unrecorded_activities=matchmaker.unmatched_activities,
@@ -321,6 +318,7 @@ def clear_reconciliation_info():
         "credit.update_transaction",
         "credit.infer_statement",
         "credit.suggest_transaction_autocomplete",
+        "credit.add_subtransaction_fields",
         "credit.delete_transaction",
         "static",
         None,
@@ -344,15 +342,57 @@ def load_transactions(card_id):
     # Get all of the user's transactions for the selected cards
     sort_order = "DESC"
     transactions = CreditTransactionHandler.get_transactions(
-        card_ids=selected_card_ids,
-        sort_order=sort_order,
-    )
+        card_ids=selected_card_ids, sort_order=sort_order
+    ).all()
     return render_template(
         "credit/transactions_page.html",
         filter_cards=cards,
         selected_card_ids=selected_card_ids,
         sort_order=sort_order,
-        transactions=islice(transactions, 100),
+        transactions=transactions[:TRANSACTION_LIMIT],
+        total_transactions=len(transactions),
+    )
+
+
+@bp.route("/_extra_transactions", methods=("POST",))
+@login_required
+def load_more_transactions():
+    # Get info about the transactions being displayed from the AJAX request
+    post_args = request.get_json()
+    selected_card_ids = map(int, post_args["selected_card_ids"])
+    sort_order = "ASC" if post_args["sort_order"] == "asc" else "DESC"
+    block_index = post_args["block_count"] - 1
+    full_view = post_args["full_view"]
+    # Get a subset of the remaining transactions to load
+    more_transactions = CreditTransactionHandler.get_transactions(
+        card_ids=selected_card_ids,
+        sort_order=sort_order,
+        offset=block_index * TRANSACTION_LIMIT,
+        limit=TRANSACTION_LIMIT,
+    )
+    return render_template(
+        "credit/transactions_table/transactions.html",
+        transactions=more_transactions,
+        full_view=full_view,
+    )
+
+
+@bp.route("/_update_transactions_display", methods=("POST",))
+@login_required
+def update_transactions_display():
+    # Separate the arguments of the POST method
+    post_args = request.get_json()
+    card_ids = map(int, post_args["card_ids"])
+    sort_order = "ASC" if post_args["sort_order"] == "asc" else "DESC"
+    # Filter selected transactions from the database
+    transactions = CreditTransactionHandler.get_transactions(
+        card_ids=card_ids, sort_order=sort_order, limit=100
+    )
+    return render_template(
+        "credit/transactions_table/table.html",
+        sort_order=sort_order,
+        transactions=transactions,
+        full_view=True,
     )
 
 
@@ -385,26 +425,6 @@ def show_linked_transaction():
     )
 
 
-@bp.route("/_update_transactions_display", methods=("POST",))
-@login_required
-def update_transactions_display():
-    # Separate the arguments of the POST method
-    post_args = request.get_json()
-    card_ids = map(int, post_args["card_ids"])
-    sort_order = "ASC" if post_args["sort_order"] == "asc" else "DESC"
-    # Filter selected transactions from the database
-    transactions = CreditTransactionHandler.get_transactions(
-        card_ids=card_ids,
-        sort_order=sort_order,
-    )
-    return render_template(
-        "credit/transactions_table/transactions.html",
-        sort_order=sort_order,
-        transactions=islice(transactions, 100),
-        full_view=True,
-    )
-
-
 @bp.route(
     "/add_transaction",
     defaults={"card_id": None, "statement_id": None},
@@ -497,59 +517,17 @@ def add_subtransaction_fields():
 @db_transaction
 def delete_transaction(transaction_id):
     CreditTransactionHandler.delete_entry(transaction_id)
-    if statement_id := session.pop("statement_focus", None):
-        return redirect(
-            url_for("credit.load_statement_details", statement_id=statement_id)
-        )
+    if (statement_id := session.pop("statement_focus", None)) is not None:
+        statement = CreditStatementHandler.get_entry(statement_id)
+        # Delete the statement if it has no more transactions
+        if statement.balance is not None:
+            return redirect(
+                url_for("credit.load_statement_details", statement_id=statement.id)
+            )
+        CreditStatementHandler.delete_entry(statement.id)
     return redirect(url_for("credit.load_transactions"))
 
 
-@bp.route("/tags")
-@login_required
-def load_tags():
-    # Get the tag hierarchy from the database
-    hierarchy = CreditTagHandler.get_hierarchy()
-    return render_template("credit/tags_page.html", tags_hierarchy=hierarchy)
-
-
-@bp.route("/_add_tag", methods=("POST",))
-@login_required
-@db_transaction
-def add_tag():
-    # Get the new tag (and potentially parent category) from the AJAX request
-    post_args = request.get_json()
-    tag_name = post_args["tag_name"]
-    parent_name = post_args.get("parent")
-    # Check that the tag name does not already exist
-    if CreditTagHandler.get_tags(tag_names=(tag_name,)):
-        raise ValueError("The given tag name already exists. Tag names must be unique.")
-    if parent_name:
-        parent_id = CreditTagHandler.find_tag(parent_name).id
-    else:
-        parent_id = None
-    tag = CreditTagHandler.add_entry(
-        parent_id=parent_id,
-        user_id=g.user.id,
-        tag_name=tag_name,
-    )
-    return render_template(
-        "credit/tag_tree/subtag_tree.html", tag=tag, tags_hierarchy={}
-    )
-
-
-@bp.route("/_delete_tag", methods=("POST",))
-@login_required
-@db_transaction
-def delete_tag():
-    # Get the tag to be deleted from the AJAX request
-    post_args = request.get_json()
-    tag_name = post_args["tag_name"]
-    tag = CreditTagHandler.find_tag(tag_name)
-    # Remove the tag from the database
-    CreditTagHandler.delete_entry(tag.id)
-    return ""
-
-
 @bp.route("/_suggest_transaction_autocomplete", methods=("POST",))
 @login_required
 def suggest_transaction_autocomplete():

monopyly/credit/statements.py

@@ -2,8 +2,8 @@
 Tools for interacting with the credit statements in the database.
 """
 
-from authanor.database.handler import DatabaseViewHandler
 from dateutil.relativedelta import relativedelta
+from dry_foundation.database.handler import DatabaseViewHandler
 
 from ..common.utils import get_next_occurrence_of_day
 from ..database.models import (

monopyly/credit/transactions/__init__.py

@@ -3,3 +3,5 @@ Tools for interacting with the credit transactions in the database.
 """
 
 from ._transactions import CreditTagHandler, CreditTransactionHandler, save_transaction
+
+__all__ = ["CreditTagHandler", "CreditTransactionHandler", "save_transaction"]

monopyly/credit/transactions/_transactions.py

@@ -2,15 +2,12 @@
 Tools for interacting with the credit transactions in the database.
 """
 
-from authanor.database.handler import DatabaseHandler, DatabaseViewHandler
+from dry_foundation.database.handler import DatabaseViewHandler
 
 from ...common.forms.utils import execute_on_form_validation
 from ...common.transactions import TransactionHandler, TransactionTagHandler
 from ...database.models import (
-    Bank,
-    CreditAccount,
     CreditCard,
-    CreditStatementView,
     CreditSubtransaction,
     CreditTransaction,
     CreditTransactionView,
@@ -38,7 +35,13 @@ class CreditTransactionHandler(
     @classmethod
     @DatabaseViewHandler.view_query
     def get_transactions(
-        cls, statement_ids=None, card_ids=None, active=None, sort_order="DESC"
+        cls,
+        statement_ids=None,
+        card_ids=None,
+        active=None,
+        sort_order="DESC",
+        offset=None,
+        limit=None,
     ):
         """
         Get credit card transactions from the database.
@@ -66,6 +69,13 @@ class CreditTransactionHandler(
             An indicator of whether the transactions should be ordered
             in ascending (oldest at top) or descending (newest at top)
             order.
+        offset : int, optional
+            The number of transactions by which to offset the results
+            returned by this query. The default is `None`, in which case
+            no offset will be added.
+        limit : int, optional
+            A limit on the number of transactions retrieved from the
+            database.
 
         Returns
         -------
@@ -77,7 +87,7 @@ class CreditTransactionHandler(
         criteria.add_match_filter(CreditCard, "id", card_ids)
         criteria.add_match_filter(CreditCard, "active", active)
         transactions = super()._get_transactions(
-            criteria=criteria, sort_order=sort_order
+            criteria=criteria, sort_order=sort_order, offset=offset, limit=limit
         )
         return transactions
 
@@ -196,7 +206,7 @@ class CreditTagHandler(TransactionTagHandler, model=TransactionTagHandler.model)
         return tags
 
     @classmethod
-    def _filter_entries(cls, query, criteria):
+    def _filter_entries(cls, query, criteria, offset, limit):
         # Add a join to enable filtering by transaction ID or subtransaction ID
         join_transaction = CreditTransactionView in criteria.discriminators
         join_subtransaction = (
@@ -206,7 +216,7 @@ class CreditTagHandler(TransactionTagHandler, model=TransactionTagHandler.model)
             query = query.join(credit_tag_link_table).join(CreditSubtransaction)
             if join_transaction:
                 query = query.join(CreditTransactionView)
-        return super()._filter_entries(query, criteria)
+        return super()._filter_entries(query, criteria, offset, limit)
 
 
 @execute_on_form_validation

monopyly/credit/transactions/activity/__init__.py

@@ -1,3 +1,9 @@
 from .data import TransactionActivities
 from .parser import parse_transaction_activity_file
 from .reconciliation import ActivityMatchmaker
+
+__all__ = [
+    "TransactionActivities",
+    "parse_transaction_activity_file",
+    "ActivityMatchmaker",
+]

monopyly/credit/transactions/activity/parser.py

@@ -5,7 +5,6 @@ from abc import ABC, abstractmethod
 from pathlib import Path
 
 from flask import abort, current_app
-from werkzeug.utils import secure_filename
 
 from ....common.utils import parse_date
 from .data import ActivityLoadingError, TransactionActivities, TransactionActivityLoader