monopyly 1.4.6__py3-none-any.whl → 1.4.8__py3-none-any.whl

monopyly/core/actions.py

@@ -10,25 +10,112 @@ def get_timestamp():
     return datetime.now().strftime("%Y%m%d_%H%M%S")
 
 
-def format_readme_as_html_template(readme_text):
-    """Given the README text in Markdown, convert it to a renderable HTML template."""
-    # Convert Markdown to HTML
-    raw_html_readme = markdown.markdown(readme_text, extensions=["fenced_code"])
-    # Replace README relative links with app relevant links
-    html_readme = raw_html_readme.replace('src="monopyly/static', 'src="/static')
-    # Format the HTML as a valid Jinja template
-    html_readme_template = (
-        '{% extends "layout.html" %}'
-        "{% block title %}About{% endblock %}"
-        "{% block content %}"
-        '  <div id="readme" class="about">'
-        f"    {html_readme}"
-        '    <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>'
-        "    </div>"
-        "  </div>"
-        "{% endblock %}"
+class MarkdownConverter:
+
+    replacements = {
+        "src": [
+            ["monopyly/static", "/static"],
+        ],
+        "href": [
+            ["README.md", '{{ url_for("core.about") }}'],
+            ["CHANGELOG.md", '{{ url_for("core.changelog") }}'],
+        ],
+    }
+
+    @classmethod
+    def convert(cls, markdown_path, title, id_="", class_="", extra_content=""):
+        """Given a Markdown file, convert it to a renderable HTML template."""
+        raw_markdown = cls._read_markdown(markdown_path)
+        html_content = cls._convert_markdown_to_html(raw_markdown)
+        return cls._generate_html_template(
+            html_content, title, id_=id_, class_=class_, extra_content=extra_content
+        )
+
+    @staticmethod
+    def _read_markdown(markdown_path):
+        with markdown_path.open(encoding="utf-8") as markdown_file:
+            raw_markdown = markdown_file.read()
+        return raw_markdown
+
+    @classmethod
+    def _convert_markdown_to_html(cls, raw_markdown):
+        raw_html = markdown.markdown(raw_markdown, extensions=["fenced_code"])
+        return cls._replace_links(raw_html)
+
+    @classmethod
+    def _replace_links(cls, raw_html):
+        html = raw_html
+        for tag, pairs in cls.replacements.items():
+            for original, replacement in pairs:
+                html = html.replace(f'{tag}="{original}', f'{tag}="{replacement}')
+        return html
+
+    @staticmethod
+    def _generate_html_template(content, title, id_="", class_="", extra_content=""):
+        # Format the HTML as a valid Jinja template
+        html_template = (
+            '{% extends "layout.html" %}'
+            "{% block title %}"
+            f"  {title}"
+            "{% endblock %}"
+            "{% block content %}"
+            f'  <div id="{id_}" class="{class_}">'
+            f"    {content}"
+            f"    {extra_content}"
+            "{% endblock %}"
+        )
+        return html_template
+
+
+def convert_readme_to_html_template(readme_path):
+    """Given a README file in Markdown, convert it to a renderable HTML template."""
+    return MarkdownConverter.convert(
+        readme_path,
+        title="About",
+        id_="readme",
+        class_="about",
+        extra_content=(
+            '<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>'
+            "</div>"
+        ),
+    )
+
+
+def convert_changelog_to_html_template(changelog_path):
+    """Given a CHANGELOG file in Markdown, convert it to a renderable HTML template."""
+    return MarkdownConverter.convert(
+        changelog_path,
+        title="Changes",
+        id_="changelog",
     )
-    return html_readme_template
+
+
+def determine_summary_balance_svg_viewbox_width(currency_value):
+    """
+    Determine the width of the SVG viewBox attribute displayed in summary boxes.
+
+    Parameters
+    ----------
+    currency_value : str
+        A currency value, displayed in the format output by the
+        `core.filters.make_currency` filter function.
+    """
+    # Set the per-character width contributions
+    digit_width = 55
+    punctuation_width = 25
+    spacing_width = 25
+    # Count the number of commas and non-comma characters in the non-decimal portion
+    nondecimal_value = currency_value.rsplit(".", maxsplit=1)[0]
+    comma_count = nondecimal_value.count(",")
+    digit_count = len(nondecimal_value) - comma_count
+    # Width is the total of the following subcomponents
+    svg_currency_width_subcomponents = [
+        digit_width * digit_count,  # ------------- total width of digits/sign
+        punctuation_width * comma_count,  # ------- total width of commas
+        punctuation_width + (2 * digit_width),  # - width of the decimal section
+        digit_width + spacing_width,  # ----------- width of the dollar sign and spacing
+    ]
+    return max(400, sum(svg_currency_width_subcomponents))

monopyly/core/blueprint.py

@@ -8,4 +8,4 @@ from flask import Blueprint
 bp = Blueprint("core", __name__)
 
 # Import routes after defining blueprint to avoid circular imports
-from . import context_processors, filters, routes
+from . import context_processors, errors, filters, routes

monopyly/core/context_processors.py

@@ -5,6 +5,7 @@ Filters defined for the application.
 from datetime import date
 from importlib import import_module
 
+from .actions import determine_summary_balance_svg_viewbox_width
 from .blueprint import bp
 
 
@@ -19,6 +20,15 @@ def inject_global_template_variables():
     return template_globals
 
 
+@bp.app_context_processor
+def inject_utility_functions():
+    """Inject utility functions globally into the template context."""
+    utility_functions = {
+        "calculate_summary_balance_width": determine_summary_balance_svg_viewbox_width,
+    }
+    return utility_functions
+
+
 def _display_version():
     """Show the version (without commit information)."""
     try:

monopyly/core/errors.py

@@ -0,0 +1,9 @@
+"""
+Tools for handling app errors.
+"""
+
+from flask import render_template
+
+
+def render_error_template(exception):
+    return render_template(f"core/errors/{exception.code}.html", exception=exception)

monopyly/core/filters.py

@@ -2,6 +2,8 @@
 Filters defined for the application.
 """
 
+from math import floor, log10
+
 from .blueprint import bp
 
 
@@ -32,8 +34,8 @@ def make_ordinal(integer):
 
     Notes
     -----
-    This function is an adaptation of the one proposed by Stack Overflow user
-    Florian Brucker (https://stackoverflow.com/a/50992575/8754471).
+    This function is an adaptation of the one proposed by Stack Overflow
+    user Florian Brucker (https://stackoverflow.com/a/50992575/8754471).
 
     Parameters
     ----------

monopyly/core/routes.py

@@ -5,15 +5,18 @@ Routes for core functionality.
 from pathlib import Path
 
 from flask import g, render_template, render_template_string, session
+from werkzeug.exceptions import abort
 
 from ..auth.tools import login_required
 from ..banking.accounts import BankAccountHandler
 from ..banking.banks import BankHandler
 from ..credit.cards import CreditCardHandler
 from ..credit.statements import CreditStatementHandler
-from .actions import format_readme_as_html_template
+from .actions import convert_changelog_to_html_template, convert_readme_to_html_template
 from .blueprint import bp
 
+APP_ROOT_DIR = Path(__file__).parents[1]
+
 
 @bp.route("/")
 def index():
@@ -40,7 +43,7 @@ def index():
         session["show_homepage_block"] = True
         bank_accounts, active_cards = None, None
     return render_template(
-        "index.html", bank_accounts=bank_accounts, cards=active_cards
+        "core/index.html", bank_accounts=bank_accounts, cards=active_cards
     )
 
 
@@ -53,22 +56,27 @@ def hide_homepage_block():
 
 @bp.route("/about")
 def about():
-    readme_path = Path(__file__).parents[1] / "README.md"
-    with readme_path.open(encoding="utf-8") as readme_file:
-        raw_readme_text = readme_file.read()
-    about_page_template = format_readme_as_html_template(raw_readme_text)
+    readme_path = APP_ROOT_DIR / "README.md"
+    about_page_template = convert_readme_to_html_template(readme_path)
     return render_template_string(about_page_template)
 
 
+@bp.route("/changelog")
+def changelog():
+    changelog_path = APP_ROOT_DIR / "CHANGELOG.md"
+    changelog_page_template = convert_changelog_to_html_template(changelog_path)
+    return render_template_string(changelog_page_template)
+
+
 @bp.route("/story")
 @login_required
 def story():
-    return render_template("story.html")
+    return render_template("core/story.html")
 
 
 @bp.route("/credits")
 def credits():
-    return render_template("credits.html")
+    return render_template("core/credits.html")
 
 
 @bp.route("/profile")
@@ -76,4 +84,9 @@ def credits():
 def load_profile():
     banks = BankHandler.get_banks()
     # Return banks as a list to allow multiple reuse
-    return render_template("profile.html", banks=list(banks))
+    return render_template("core/profile.html", banks=list(banks))
+
+
+@bp.route("/change_password")
+def change_password():
+    abort(418)

monopyly/credit/routes.py

@@ -216,12 +216,20 @@ def pay_credit_card(card_id, statement_id):
     make_payment(card_id, payment_account_id, payment_date, payment_amount)
     # Get the current statement information from the database
     statement = CreditStatementHandler.get_entry(statement_id)
+    transactions = CreditTransactionHandler.get_transactions(
+        statement_ids=(statement_id,)
+    )
     bank_accounts = BankAccountHandler.get_accounts()
-    return render_template(
+    summary_template = render_template(
         "credit/statement_summary.html",
         statement=statement,
         bank_accounts=bank_accounts,
     )
+    transactions_table_template = render_template(
+        "credit/transactions_table/transactions.html",
+        transactions=transactions,
+    )
+    return jsonify((summary_template, transactions_table_template))
 
 
 @bp.route("/transactions", defaults={"card_id": None})

monopyly/credit/transactions/_transactions.py

@@ -52,7 +52,7 @@ class CreditTransactionHandler(
 
         Parameters
         ----------
-        statement_ids : tuple of str, optional
+        statement_ids : tuple of int, optional
             A sequence of statement IDs with which to filter
             transactions (if `None`, all statement IDs will be shown).
         card_ids : tuple of int, optional