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

monopyly/CHANGELOG.md

@@ -237,4 +237,19 @@
 - Update JavaScript libraries (jQuery, Chartist)
 
 
+### 1.6.1
+
+- Allow pie chart labels to overflow the SVG container
+- Define JavaScript elements in header (deferring execution when logical)
+- Bump dependencies
+
+
+### 1.6.2
+
+- Fix bug in the transaction tag tree template preventing new subtags in the same subtag subtree
+- Refactor JavaScript used to manage the transaction tag tree
+- Add specificity to the reconciliation tool when parsing payment columns (when otherwise unidentified, payment transactions are determined by the presence of the isolated word "payment" in the description field)
+- Bump dependencies
+
+
 <a name="bottom" id="bottom"></a>

monopyly/_version.py

@@ -1,16 +1,34 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
 else:
     VERSION_TUPLE = object
+    COMMIT_ID = object
 
 version: str
 __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '1.6.2'
+__version_tuple__ = version_tuple = (1, 6, 2)
 
-__version__ = version = '1.6.0'
-__version_tuple__ = version_tuple = (1, 6, 0)
+__commit_id__ = commit_id = None

monopyly/banking/forms.py

@@ -115,6 +115,10 @@ class BankAccountForm(EntryForm):
             }
             return account_type_data
 
+        def gather_entry_data(self, entry):
+            """Gather data for the form from the given database entry."""
+            raise NotImplementedError
+
     # Fields to identify the bank/account type information for the account
     bank_info = FormField(BankSubform)
     account_type_info = FormField(AccountTypeSubform)

monopyly/common/forms/_forms.py

@@ -2,10 +2,10 @@
 General form constructions.
 """
 
-from abc import ABC, abstractmethod
+from abc import abstractmethod
 from datetime import date
 
-from flask_wtf import FlaskForm
+from dry_foundation.forms import AbstractFlaskForm, FlaskSubform
 from wtforms.fields import StringField, SubmitField
 from wtforms.validators import DataRequired
 
@@ -15,12 +15,7 @@ from .fields import CurrencyField, DateField
 form_err_msg = "There was an improper value in your form. Please try again."
 
 
-class AbstractEntryFormMixinMeta(type(FlaskForm), ABC):
-    # Defined to allow the forms to also to be abstract base classes
-    pass
-
-
-class EntryForm(FlaskForm, metaclass=AbstractEntryFormMixinMeta):
+class EntryForm(AbstractFlaskForm):
     """
     A form designed to accept database entry information.
 
@@ -85,11 +80,8 @@ class EntryForm(FlaskForm, metaclass=AbstractEntryFormMixinMeta):
         )
 
 
-class EntrySubform(EntryForm):
-    """Subform disabling CSRF (CSRF is REQUIRED in encapsulating form)."""
-
-    def __init__(self, *args, **kwargs):
-        super().__init__(meta={"csrf": False}, *args, **kwargs)
+class EntrySubform(FlaskSubform, EntryForm):
+    """A subform implementing ``EntryForm`` behavior."""
 
 
 class AcquisitionSubform(EntrySubform):
@@ -149,7 +141,6 @@ class TransactionForm(EntryForm):
             }
             return data
 
-        @abstractmethod
         def gather_entry_data(self, entry):
             if self.subtransaction_model is None:
                 raise RuntimeError(

monopyly/common/forms/fields.py

@@ -24,15 +24,6 @@ class DateField(wtforms_fields.DateField):
         super().__init__(*args, filters=filters, **kwargs)
 
 
-class OptionalDateField(DateField):
-    """A date field where the field value is optional."""
-
-    def process_formdata(self, valuelist):
-        """Process data from the form, ignoring an ommitted value."""
-        if valuelist != [""]:
-            super().process_formdata(valuelist)
-
-
 class CurrencyField(wtforms_fields.DecimalField):
     """A decimal field with currency-specific customizations."""
 

monopyly/common/forms/utils.py

@@ -113,9 +113,9 @@ def extend_field_list_for_ajax(form_class, field_list_name, field_list_count):
 
     Parameters
     ----------
-    form_class : flask_wtf.FlaskForm
-        The class (not class instance) containing the field list to be
-        extended.
+    form_class : type
+        The form class (not class instance) containing the field list to
+        be extended.
     field_list_name : str
         The name of the field list to be extended.
     field_list_count : int

monopyly/core/context_processors.py

@@ -2,8 +2,7 @@
 Filters defined for the application.
 """
 
-from datetime import date
-from importlib import import_module
+from dry_foundation.utils import define_basic_template_global_variables
 
 from .actions import determine_summary_balance_svg_viewbox_width
 from .blueprint import bp
@@ -11,13 +10,8 @@ from .blueprint import bp
 
 @bp.app_context_processor
 def inject_global_template_variables():
-    """Inject template variablees globally into the template context."""
-    template_globals = {
-        "app_version": _display_version(),
-        "copyright_statement": f"© {date.today().year}",
-        "date_today": date.today(),
-    }
-    return template_globals
+    """Inject template variables globally into the template context."""
+    return define_basic_template_global_variables("monopyly._version")
 
 
 @bp.app_context_processor
@@ -27,15 +21,3 @@ def inject_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:
-        version = import_module("monopyly._version").version
-    except ModuleNotFoundError:
-        # Fallback action in case Hatch VCS fails
-        display_version = ""
-    else:
-        display_version = version.split("+")[0]
-    return display_version

monopyly/credit/cards.py

@@ -137,7 +137,7 @@ def save_card(form, card_id=None):
 
     Parameters
     ----------
-    form : flask_wtf.FlaskForm
+    form : CreditCardForm
         The form beign used to provide the data being saved.
     card_id : int
         The ID of hte card to be saved. If provided, the named card will

monopyly/credit/forms.py

@@ -5,6 +5,7 @@ Generate credit card forms for the user to complete.
 from flask import abort
 from wtforms.fields import (
     BooleanField,
+    DateField,
     FieldList,
     FormField,
     IntegerField,
@@ -18,7 +19,6 @@ from ..common.forms import AcquisitionSubform, EntryForm, EntrySubform, Transact
 from ..common.forms.fields import (
     CustomChoiceSelectField,
     LastFourDigitsField,
-    OptionalDateField,
     StringField,
 )
 from ..common.forms.utils import Autocompleter
@@ -152,6 +152,10 @@ class CardStatementTransferForm(EntryForm):
     transfer = RadioField("transfer", choices=[("yes", "Yes"), ("no", "No")])
     submit = SubmitField("Continue")
 
+    def gather_entry_data(self, entry):
+        """Gather data for the form from the given database entry."""
+        raise NotImplementedError
+
 
 class CreditTransactionForm(TransactionForm):
     """Form to input/edit credit card transactions."""
@@ -193,7 +197,7 @@ class CreditTransactionForm(TransactionForm):
         # Fields to identify the card/bank information for the statement
         card_info = FormField(CardSubform)
         # Fields pertaining to the statement
-        issue_date = OptionalDateField("Statement Date")
+        issue_date = DateField("Statement Date", [Optional()])
 
         def get_statement(self, transaction_date):
             """Get the credit card statement described by the form data."""

monopyly/credit/transactions/activity/parser.py

@@ -213,7 +213,7 @@ class _TransactionActivityParser:
         def _infer_payment_row(row):
             # Infer whether the row constitutes a payment transaction
             contextual_info = [row[i].lower() for i in contextual_column_indices]
-            return any("payment" in element for element in contextual_info)
+            return any("payment" in element.split() for element in contextual_info)
 
         payment_rows = list(filter(_infer_payment_row, raw_data))
         return self._extrapolate_payments_positive(payment_rows, raw_data)

monopyly/static/css/style.css

@@ -3481,6 +3481,10 @@ form#pay #make-payment[type="submit"] #prompt {
   min-height: 400px;
 }
 
+#category-chart.ct-chart svg {
+  overflow: visible;
+}
+
 #category-chart text.ct-label {
   transition: fill 0.1s ease;
 }

monopyly/static/js/bind-tag-actions.js

@@ -13,111 +13,199 @@ import { executeAjaxRequest } from './modules/ajax.js';
 
 
 (function() {
-
-  const endpointAddTag = ADD_TAG_ENDPOINT;
-  const endpointRemoveTag = REMOVE_TAG_ENDPOINT;
-  // Set animation parameters
-  const slideTime = 300;
   // Identify the buttons
-  const $buttonsAddTag = $('#transaction-tags .new-tag.button');
-  const $buttonsDelete = $('#transaction-tags .action.button.delete');
-
-  bindTagCreator($buttonsAddTag, $buttonsDelete);
-
-  function bindTagCreator($buttonsAddTag, $buttonsDelete) {
-    // Bind add tag buttons
-    $buttonsAddTag.on('click', function() {
-      const $container = $(this).closest('.tag-container');
-      const $tags = $container.children('ul.tags');
-      const $input = $tags.children('input.new-tag');
-      // Reveal the input
-      showInput($input);
-      // Perform actions when focus is lost
-      $input.on('blur', function() {
-        if ($input.val()) {
-          addNewTag($input, $container);
-        } else {
-          hideEmptyInput($input);
-        }
-        clearInput($input);
-      });
-      $input.on('keydown', function() {
-        if (event.which == 27) {
-          clearInput($input);
-          hideEmptyInput($input);
-        }
-      });
+  const $createTagButtons = $('#transaction-tags .new-tag.button');
+  const $deleteTagButtons = $('#transaction-tags .action.button.delete');
+  bindTagButtonBehavior($createTagButtons, $deleteTagButtons);
+
+})();
+
+
+/**
+ * Create the tag manager.
+ *
+ * @param {JQuery} $createTagButtons - Buttons for adding subtags to one or
+ *     more tags.
+ * @param {JQuery} $deleteTagButtons - Buttons for removing tags.
+ */
+function bindTagButtonBehavior($createTagButtons, $deleteTagButtons) {
+  console.log('bind create buttons', $createTagButtons);
+  console.log('bind delete buttons', $deleteTagButtons);
+  $createTagButtons.on('click', function() {
+    const $button = $(this);
+    const behavior = new TagCreation($button);
+    behavior.perform();
+  });
+  $deleteTagButtons.on('click', function() {
+    const $button = $(this);
+    const behavior = new TagDeletion($button);
+    behavior.perform();
+  });
+}
+
+
+/**
+ * A class for managing transaction tags and the behavior of their buttons.
+ */
+class TagButtonBehavior {
+
+  /**
+   * Create the tag manager.
+   *
+   * @param {JQuery} $button - A button belonging to a tag.
+   */
+  constructor($button) {
+    this.$container = $button.closest('.tag-container');
+    this.$tag = this.$container.children('.tag-area').find('.tag');
+    this.$tags = this.$container.children('ul.tags');
+    this.$input = this.$tags.children('input.new-tag');
+    // Set animation parameters
+    this.slideTime = 300;
+  }
+
+}
+
+/**
+ * A class for managing transaction tags creation behavior.
+ */
+class TagCreation extends TagButtonBehavior {
+
+  #endpoint = ADD_TAG_ENDPOINT;
+
+  /**
+   * Create the tag creator.
+   *
+   * @param {JQuery} $button - A button belonging to a tag.
+   */
+  constructor($button) {
+    super($button);
+    self = this;
+    this.$input.on('blur', function() {
+      self.#dropInputFocus();
     });
-    // Bind remove tag buttons
-    $buttonsDelete.on('click', function() {
-      if (confirmDelete()) {
-        const $container = $(this).closest('.tag-container');
-        const $tag = $container.find('.tag').first();
-        // Remove the tag from the database
-        removeTag($tag);
-        // Remove the tag from the display
-        const $tagContainer = $tag.closest('.tag-area');
-        $tagContainer.slideUp(300, function() {
-          $(this).remove()
-        });
+    this.$input.on('keydown', function() {
+      if (event.key == 'Escape') {
+        self.#clearInput();
+        this.blur();
+      } else if (event.key == 'Enter') {
+        this.blur();
       }
     });
   }
 
-  function addNewTag($input, $container) {
-    // Add the input value to the database as a tag
-    const parentTag = $container.children('.tag-area').find('.tag').text()
+  /**
+   * Perform the behavior.
+   */
+  perform() {
+    this.#showInput();
+  }
+
+  /**
+   * Show the input box to collect new tag information.
+   */
+  #showInput() {
+    console.log('showing input', this.$input);
+    self = this;
+    this.$input.slideDown(this.slideTime, function() {
+      self.$input.addClass('visible');
+      self.$input.focus();
+      console.log('focus', self.$input);
+    });
+  }
+
+  /**
+   * Perform a specific action when the input loses focus.
+   */
+  #dropInputFocus() {
+    if (this.$input.val()) {
+      this.#createTag();
+      this.#hideFilledInput();
+    } else {
+      this.#hideEmptyInput();
+    }
+  }
+
+  /**
+   * Create the new tag in the database.
+   */
+  #createTag() {
     const rawData = {
-      'tag_name': $input.val(),
-      'parent': parentTag
+      'tag_name': this.$input.val(),
+      'parent': this.$tag.text()
     };
-    // Execute the AJAX request and display update
-    function addTag(response) {
-      // Add the AJAX request response to the DOM before the input
-      $input.before(response);
-      hideFilledInput($input);
-      // Bind the buttons for the newly added tag
-      const $buttonAddTag = $input.prev().find('.new-tag.button');
-      const $buttonRemoveTag = $input.prev().find('.action.button.delete');
-      bindTagCreator($buttonAddTag, $buttonRemoveTag);
-    }
-    executeAjaxRequest(endpointAddTag, rawData, addTag);
+    // Execute the AJAX request and place the new tag
+    executeAjaxRequest(this.#endpoint, rawData, this.#placeNewTag.bind(this));
   }
 
-  function showInput($input) {
-    $input.slideDown(slideTime, function() {
-      $input.addClass('visible');
-      $input.focus();
-    });
+  /**
+   * Add the new tag to the DOM before the input.
+   */
+  #placeNewTag(newTagHTML) {
+    const $newTag = $(newTagHTML);
+    this.$input.before($newTag);
+    // Bind behavior functionality to the newly created/placed tag buttons
+    bindTagButtonBehavior(
+      $newTag.find('.new-tag.button'), $newTag.find('.action.button.delete')
+    );
   }
 
-  function hideFilledInput($input) {
-    // Hide the input immediately
-    $input.hide();
-    $input.removeClass('visible');
+  /**
+   * Hide the input immediately.
+   */
+  #hideFilledInput() {
+    this.$input.hide();
+    this.$input.removeClass('visible');
+    this.#clearInput();
   }
 
-  function hideEmptyInput($input) {
-    // Hide the input gracefully
-    $input.removeClass('visible');
-    $input.slideUp(slideTime);
+  /**
+   * Hide the (empty) input gracefully.
+   */
+  #hideEmptyInput() {
+    this.$input.removeClass('visible');
+    this.$input.slideUp(this.slideTime);
+    console.log('hiding empty input', this.$input);
   }
 
-  function clearInput($input) {
-    // Clear the input
-    $input.val('');
+  /**
+   * Clear the input.
+   */
+  #clearInput() {
+    this.$input.val('');
   }
 
-  function confirmDelete() {
-    return confirm('Are you sure you want to delete this tag?');
+}
+
+
+/**
+ * A class for managing transaction tags deletion behavior.
+ */
+class TagDeletion extends TagButtonBehavior {
+
+  #endpoint = REMOVE_TAG_ENDPOINT;
+
+  /**
+   * Perform the behavior.
+   */
+  perform() {
+    if (this.#confirmDelete()) {
+      this.#removeTag();
+    }
   }
 
-  function removeTag($tag) {
-    // Get the name of the tag
-    const tagName = $tag.html();
-    const rawData = {'tag_name': tagName};
-    // Execute the AJAX request
-    executeAjaxRequest(endpointRemoveTag, rawData);
+  /**
+   * Remove the tag from the database.
+   */
+  #removeTag() {
+    const rawData = {'tag_name': this.$tag.html()};
+    // Execute the AJAX request to delete the tag
+    executeAjaxRequest(this.#endpoint, rawData);
+    // Remove the tag from the display
+    this.$container.slideUp(this.slideTime, function() {this.remove()});
   }
 
-})();
+  #confirmDelete() {
+    return confirm('Are you sure you want to delete this tag?');
+  }
+
+}

monopyly/static/js/highlight-discrepant-transactions.js

@@ -114,6 +114,7 @@ class DiscrepancyHighlighter {
       this.removeHighlight($(activity), $matchingTransactionRow);
     }
   }
+
 }
 
 

monopyly/templates/banking/account_form/account_form_page_new.html

@@ -1,6 +1,16 @@
 {% extends "common/form_page.html" %}
 
 
+{% block javascript %}
+
+  <script type="module" src="{{ url_for('static', filename='js/display-new-bank-inputs.js') }}">
+  </script>
+  <script type="module" src="{{ url_for('static', filename='js/display-new-account-type-inputs.js') }}">
+  </script>
+
+{% endblock %}
+
+
 {% block title %}
   New Bank Account
 {% endblock %}
@@ -13,11 +23,3 @@
   {% endwith %}
 
 {% endblock %}
-
-
-{% block javascript %}
-  <script type="module" src="{{ url_for('static', filename='js/display-new-bank-inputs.js') }}">
-  </script>
-  <script type="module" src="{{ url_for('static', filename='js/display-new-account-type-inputs.js') }}">
-  </script>
-{% endblock %}

monopyly/templates/banking/account_page.html

@@ -1,6 +1,30 @@
 {% extends 'layout.html' %}
 
 
+{% block javascript %}
+
+  <script>
+    const EXPAND_TRANSACTION_ENDPOINT = "{{ url_for('banking.expand_transaction') }}";
+    const LINKED_TRANSACTION_ENDPOINT = "{{ url_for('banking.show_linked_transaction') }}";
+    const LOAD_TRANSACTIONS_ENDPOINT = "{{ url_for('banking.load_more_transactions') }}";
+    const LOAD_TRANSACTIONS_SELECTORS = {
+      "account_id": {{ account.id }},
+      "block_count": 1
+    };
+    const BALANCE_CHART_DATA = {{ chart_data|tojson }};
+  </script>
+  <script type="module" src="{{ url_for('static', filename='js/load-more-transactions.js') }}">
+  </script>
+  <script type="module" src="{{ url_for('static', filename='js/expand-transaction.js') }}">
+  </script>
+  <script type="module" src="{{ url_for('static', filename='js/show-linked-transaction.js') }}">
+  </script>
+  <script type="module" src="{{ url_for('static', filename='js/create-balance-chart.js') }}">
+  </script>
+
+{% endblock %}
+
+
 {% block header %}
 
   <h1>
@@ -57,27 +81,3 @@
     </div>
 
 {% endblock %}
-
-
-{% block javascript %}
-
-  <script>
-    const EXPAND_TRANSACTION_ENDPOINT = "{{ url_for('banking.expand_transaction') }}";
-    const LINKED_TRANSACTION_ENDPOINT = "{{ url_for('banking.show_linked_transaction') }}";
-    const LOAD_TRANSACTIONS_ENDPOINT = "{{ url_for('banking.load_more_transactions') }}";
-    const LOAD_TRANSACTIONS_SELECTORS = {
-      "account_id": {{ account.id }},
-      "block_count": 1
-    };
-    const BALANCE_CHART_DATA = {{ chart_data|tojson }};
-  </script>
-  <script type="module" src="{{ url_for('static', filename='js/load-more-transactions.js') }}">
-  </script>
-  <script type="module" src="{{ url_for('static', filename='js/expand-transaction.js') }}">
-  </script>
-  <script type="module" src="{{ url_for('static', filename='js/show-linked-transaction.js') }}">
-  </script>
-  <script type="module" src="{{ url_for('static', filename='js/create-balance-chart.js') }}">
-  </script>
-
-{% endblock %}

monopyly/templates/banking/accounts_page.html

@@ -1,6 +1,14 @@
 {% extends 'layout.html' %}
 
 
+{% block javascript %}
+
+  <script type="module" src="{{ url_for('static', filename='js/expand-bank-account.js') }}">
+  </script>
+
+{% endblock %}
+
+
 {% block header %}
 
   <h1>
@@ -83,9 +91,3 @@
     </div>
 
 {% endblock %}
-
-
-{% block javascript %}
-  <script type="module" src="{{ url_for('static', filename='js/expand-bank-account.js') }}">
-  </script>
-{% endblock %}