From d8c8a858c4d7ebc0695ddee1c20fb33ac62b248e Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:09:34 +0100 Subject: [PATCH 01/16] =?UTF-8?q?feat:=20=F0=9F=86=95=20enhance=20user=20a?= =?UTF-8?q?nd=20category=20management=20with=20new=20routes=20and=20templa?= =?UTF-8?q?tes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/data_handler.py | 101 ++++++++++++++++++---------- src/front/home.py | 117 +++++++++++++++++++++++++++++---- src/front/templates/home.html | 56 +++++++++++++--- src/tests/test_data_handler.py | 49 ++++++++++++++ 4 files changed, 267 insertions(+), 56 deletions(-) diff --git a/src/data_handler.py b/src/data_handler.py index 1e2448c..573c540 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -42,23 +42,6 @@ def execute_sql(self, sql_statement: str, return_id: bool = False) -> (bool, int else: return is_success - def read_database(self, sql_statement: str): - "reads the database query and returns the results" - logging.debug(f"received request to read {sql_statement}") - results = 0 - try: - connection = sqlite3.connect(self.database) - logging.debug("opened connection to database") - cursor = connection.cursor() - results = cursor.execute(sql_statement, {}) - results = results.fetchall() - logging.debug(f"query returned: {results}") - except Exception as e: - logging.error(f"Read error occured: {e}") - finally: - connection.close() - return results - @staticmethod def _build_column(column: dict) -> str: logging.debug( @@ -147,28 +130,21 @@ def print_table_schema(self, table_name): logger.error(e) def add_user_name(self, user_name: str) -> int: - "takes user name string, returns user id" - logger.debug( - f"attempting to insert values into user table {user_name}" - ) + logger.debug(f"attempting to insert values into user table {user_name}") try: connection = sqlite3.connect(self.database) - logger.debug("connection to db open") cursor = connection.cursor() - logger.debug("cursor activated") cursor.execute( - """INSERT INTO user ( - name - ) - VALUES (?) - """, + """ + INSERT INTO user ( + name + ) + VALUES (?) + """, (user_name,), ) - logger.debug("cursor executed") connection.commit() user_id = cursor.lastrowid - logger.debug(f"insert attempt seems successful, user id is {user_id}") - if user_id is None: user_id = 0 except Exception as e: @@ -184,6 +160,63 @@ def add_user_name(self, user_name: str) -> int: return 0 def get_users(self) -> list: - get_user_sql = "SELECT name FROM user" - users = self.read_database(get_user_sql) - return users + get_user_sql = "SELECT id, name FROM user" + return self.read_database(get_user_sql) + + def add_category(self, user_id: int, category_name: str, budget_value=None, parent_id=None) -> int: + """Inserts a new category. Returns the category id.""" + logger.debug(f"attempting to insert category '{category_name}' for user {user_id}") + try: + connection = sqlite3.connect(self.database) + cursor = connection.cursor() + cursor.execute( + """ + INSERT INTO category (user_id, name, budget_value, parent_id) + VALUES (?, ?, ?, ?) + """, + (user_id, category_name, budget_value, parent_id), + ) + connection.commit() + category_id = cursor.lastrowid or 0 + except Exception as e: + logger.error(f"Failed to insert category name, error: {e}") + category_id = 0 + finally: + try: + connection.close() + except Exception as e: + logger.error(f"failed to close connection: {e}") + return category_id + + def get_categories(self, user_id: int) -> list: + """Returns all categories for a given user.""" + try: + connection = sqlite3.connect(self.database) + cursor = connection.cursor() + sql = "SELECT id, name, budget_value, parent_id FROM category WHERE user_id = ?" + cursor.execute(sql, (user_id,)) + categories = cursor.fetchall() + except Exception as e: + logger.error(f"Failed to fetch categories: {e}") + categories = [] + finally: + try: + connection.close() + except Exception as e: + logger.error(f"failed to close connection: {e}") + return categories + + def read_database(self, sql_statement: str, params=()) -> list: + logging.debug(f"received request to read {sql_statement}") + results = [] + try: + connection = sqlite3.connect(self.database) + cursor = connection.cursor() + results = cursor.execute(sql_statement, params) + results = results.fetchall() + logging.debug(f"query returned: {results}") + except Exception as e: + logging.error(f"Read error occurred: {e}") + finally: + connection.close() + return results \ No newline at end of file diff --git a/src/front/home.py b/src/front/home.py index f452074..8022e2c 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -16,25 +16,116 @@ def home_page(): logger.info("home page hit") db_call = data_handler.database(verity_config) users = db_call.get_users() - return render_template("home.html", users=users) - + # Get user info directly from session - we store both ID and name there + user_id = session.get("user_id") + selected_user_name = session.get("user_name") + + # Debug log to see what's being passed to the template + logger.debug(f"User ID from session: {user_id}, User Name from session: {selected_user_name}") + + categories = db_call.get_categories(user_id) if user_id else [] + return render_template( + "home.html", + users=users, + categories=categories, + selected_user_id=user_id, + selected_user_name=selected_user_name + ) @home_bp.route("/submit", methods=["POST"]) def submit_user_name(): user_name = request.form.get("userName") logger.debug(f"Request Received: {request.form}") - if user_name: - logger.info(f"User submitted new user name: {user_name}") - session["user_name"] = user_name - db_call = data_handler.database(verity_config) - user_id = db_call.add_user_name(user_name) - if user_id == 0: - # db entry failed, throw error message - flash("User Name not saved, please check the logs", "error") + if not user_name: + flash("Please enter a user name.", "error") + return redirect(url_for("home.home_page")) + + db_call = data_handler.database(verity_config) + # Check if user already exists + users = db_call.get_users() + for user in users: + # users is [(id, name)] or [(name,)] + if (len(user) > 1 and user[1] == user_name) or (user[0] == user_name): + flash("A user with that name already exists.", "error") return redirect(url_for("home.home_page")) - session["user_id"] = user_id - flash("user name saved!", "success") + + logger.info(f"User submitted new user name: {user_name}") + user_id = db_call.add_user_name(user_name) + if user_id == 0: + flash("User Name not saved, please check the logs", "error") + return redirect(url_for("home.home_page")) + flash("user name saved! Now select the user from the dropdown to continue.", "success") + return redirect(url_for("home.home_page")) + +@home_bp.route("/select_user", methods=["POST"]) +def select_user(): + selected_user_id = request.form.get("selectedUserId") + if not selected_user_id: + flash("No user selected", "error") + session.pop("user_id", None) + session.pop("user_name", None) return redirect(url_for("home.home_page")) + + # Get the user details directly from the database using the ID + db_call = data_handler.database(verity_config) + result = db_call.read_database("SELECT id, name FROM user WHERE id = ?", (selected_user_id,)) + + if result and len(result) > 0: + user_id = result[0][0] + selected_user_name = result[0][1] + logger.debug(f"Found user with ID {user_id} and name {selected_user_name}") + + # Store both ID and name in the session + session["user_id"] = int(user_id) + session["user_name"] = selected_user_name + logger.debug(f"User selected - ID: {user_id}, Name: {selected_user_name}") + flash("User selected!", "success") else: - flash("Please enter a user name.", "error") + session.pop("user_id", None) + session.pop("user_name", None) + flash("User not found!", "error") + + return redirect(url_for("home.home_page")) + +@home_bp.route("/submit_category", methods=["POST"]) +def submit_category(): + user_id = session.get("user_id") + if not user_id: + flash("No user selected!", "error") + return redirect(url_for("home.home_page")) + + # Get and validate category name (required) + category_name = request.form.get("categoryName") + if not category_name: + flash("Category name is required", "error") return redirect(url_for("home.home_page")) + + # Convert budget_value to float if provided, otherwise None + budget_value_str = request.form.get("budgetValue") + budget_value = None + if budget_value_str and budget_value_str.strip(): + try: + budget_value = float(budget_value_str) + except ValueError: + logger.error(f"Invalid budget value: {budget_value_str}") + flash("Invalid budget value - please enter a valid number", "error") + return redirect(url_for("home.home_page")) + + # Convert parent_id to int if provided, otherwise None + parent_id_str = request.form.get("parentId") + parent_id = None + if parent_id_str and parent_id_str.strip(): + try: + parent_id = int(parent_id_str) + except ValueError: + logger.error(f"Invalid parent ID: {parent_id_str}") + flash("Invalid parent category ID", "error") + return redirect(url_for("home.home_page")) + + db_call = data_handler.database(verity_config) + category_id = db_call.add_category(user_id, category_name, budget_value, parent_id) + if category_id == 0: + flash("Category not saved, please check the logs", "error") + else: + flash("Category saved!", "success") + return redirect(url_for("home.home_page")) \ No newline at end of file diff --git a/src/front/templates/home.html b/src/front/templates/home.html index 5f5d5ed..c7bbe2d 100644 --- a/src/front/templates/home.html +++ b/src/front/templates/home.html @@ -1,25 +1,63 @@ -{% extends "base.html" %} {% block title %} Home {% endblock %} {% block content -%} +{% extends "base.html" %} +{% block title %} Home {% endblock %} +{% block content %}

Home of Verity

-

New User:

+

Create New User:

- + +
+
+ +
+
+

Select User:

+ +
+
+ +
+
+

New Category:

+ + + +

- {% for user in users %} -- {{ user[0] }}
+ Your Categories:
+ {% for category in categories %} + - {{ category[1] }}{% if category[3] %} (Sub of ID {{ category[3] }}){% endif %}{% if category[2] %} [Budget: {{ category[2] }}]{% endif %}
{% endfor %}

-{% endblock %} +{% else %} + +{% endif %} +{% endblock %} \ No newline at end of file diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index 85f8f01..087fc4b 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -57,3 +57,52 @@ def test_get_users(test_db_call): # Check the contents of the list # self.assertIsNotNone(users) # self.assertIsInstance(users[0], str) + + +def test_add_category_success(test_db_call): + # Add a user first, since category requires a user_id + user_id = test_db_call.add_user_name("CategoryTestUser") + assert user_id != 0 + # Add a category with all fields + category_id = test_db_call.add_category(user_id, "Groceries", 200.0, None) + assert category_id != 0 + # Add a category with only required fields + category_id2 = test_db_call.add_category(user_id, "Utilities") + assert category_id2 != 0 + + +def test_add_category_null_budget_and_parent(test_db_call): + user_id = test_db_call.add_user_name("NullBudgetParentUser") + assert user_id != 0 + # Add a category with None for budget_value and parent_id + category_id = test_db_call.add_category(user_id, "NoBudgetOrParent", None, None) + assert category_id != 0 + + +def test_add_category_and_get_categories(test_db_call): + # Add a user + user_name = "CategoryTestUser" + user_id = test_db_call.add_user_name(user_name) + assert user_id != 0 + # Add a category for this user + category_name = "Groceries" + budget_value = 100.0 + parent_id = None + category_id = test_db_call.add_category(user_id, category_name, budget_value, parent_id) + assert category_id != 0 + # Add a subcategory + subcategory_name = "Supermarket" + subcategory_id = test_db_call.add_category(user_id, subcategory_name, 50.0, category_id) + assert subcategory_id != 0 + # Retrieve categories for this user + categories = test_db_call.get_categories(user_id) + assert isinstance(categories, list) + names = [cat[1] for cat in categories] + assert category_name in names + assert subcategory_name in names + + +def test_add_category_invalid_user(test_db_call): + # Try to add a category with a non-existent user_id (should still succeed in SQLite unless foreign keys are enforced) + category_id = test_db_call.add_category(99999, "InvalidUserCategory") + assert isinstance(category_id, int) From a3ebc8bd1fc0aa6aa9f3f8cd91b6bed33702409c Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:23:01 +0100 Subject: [PATCH 02/16] =?UTF-8?q?feat:=20=F0=9F=86=95=20enhance=20test=20c?= =?UTF-8?q?overage=20for=20database=20operations=20with=20new=20test=20cas?= =?UTF-8?q?es=20and=20cleanup?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/tests/test_data_handler.py | 110 ++++++++++++++++++++++++++++----- 1 file changed, 93 insertions(+), 17 deletions(-) diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index 087fc4b..64bb86c 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -1,4 +1,5 @@ import pytest +import os from src import data_handler from src.config import VerityConfig @@ -6,57 +7,132 @@ @pytest.fixture def test_db_call(): + """Create a test database instance with a unique test database file""" config = VerityConfig() + # Use a test-specific database file + test_db_file = "test_verity.db" + # Remove the test DB if it already exists + if os.path.exists(test_db_file): + os.remove(test_db_file) + + # Create a config with the test DB + config.DATABASE = test_db_file db_call = data_handler.database(config) db_call.build_database() yield db_call + # Cleanup after tests + if os.path.exists(test_db_file): + os.remove(test_db_file) def test_execute_sql_success(test_db_call): + """Test executing valid SQL statements""" sql_statement = """INSERT INTO user ( name ) VALUES ('a_user_name') """ result = test_db_call.execute_sql(sql_statement) - assert result + assert result is True def test_execute_sql_error(test_db_call): + """Test executing invalid SQL statements""" sql_statement = "SELECT * FROM non_existent_table" result = test_db_call.execute_sql(sql_statement) - assert not result - # Check if an error message is logged - # You might need to add a logging assertion here + assert result is False + + +def test_execute_sql_with_return_id(test_db_call): + """Test executing SQL with return_id flag""" + sql_statement = """INSERT INTO user ( + name + ) + VALUES ('return_id_test') + """ + result, new_id = test_db_call.execute_sql(sql_statement, return_id=True) + assert result is True + assert new_id > 0 def test_read_database(test_db_call): - # Test reading database data - sql_statement = "SELECT name FROM user" + """Test reading database data""" + # First insert a user + test_db_call.add_user_name("read_test_user") + # Then read it back + sql_statement = "SELECT id, name FROM user WHERE name = 'read_test_user'" results = test_db_call.read_database(sql_statement) assert isinstance(results, list) - # Check the contents of the list - # self.assertIsNotNone(results) - # self.assertIsInstance(results[0], str) + assert len(results) > 0 + assert results[0][1] == "read_test_user" + + +def test_read_database_with_params(test_db_call): + """Test reading database with parameterized query""" + # First insert a user + test_db_call.add_user_name("param_test_user") + # Then read it back with params + sql_statement = "SELECT id, name FROM user WHERE name = ?" + params = ("param_test_user",) + results = test_db_call.read_database(sql_statement, params) + assert isinstance(results, list) + assert len(results) > 0 + assert results[0][1] == "param_test_user" + + +def test_build_database(test_db_call): + """Test that the database builds correctly with all required tables""" + # Check if all tables have been created + tables_to_check = ["user", "account", "account_type", "party", "transaction_type", + "category", "transaction_log"] + for table in tables_to_check: + sql = f"SELECT name FROM sqlite_master WHERE type='table' AND name='{table}';" + results = test_db_call.read_database(sql) + assert len(results) == 1, f"Table '{table}' should exist" def test_add_user_name(test_db_call): - # Test adding a new user name + """Test adding a new user name""" user_name = "Test user" user_id = test_db_call.add_user_name(user_name) - assert user_id is not None + assert user_id > 0 + # Check if the user name was actually added - # You might need to query the database to verify - # self.assertEqual(user_id, 1) + sql = "SELECT id, name FROM user WHERE name = ?" + results = test_db_call.read_database(sql, (user_name,)) + assert len(results) == 1 + assert results[0][1] == user_name + + +def test_add_duplicate_user_name(test_db_call): + """Test adding a duplicate user name (should succeed at DB level without constraints)""" + user_name = "Duplicate User" + # Add first user + user_id1 = test_db_call.add_user_name(user_name) + assert user_id1 > 0 + + # Add second user with same name + user_id2 = test_db_call.add_user_name(user_name) + assert user_id2 > 0 + assert user_id2 != user_id1 # They should have different IDs def test_get_users(test_db_call): - # Test getting users + """Test getting all users""" + # Add some test users first + test_db_call.add_user_name("User One") + test_db_call.add_user_name("User Two") + + # Get users users = test_db_call.get_users() assert isinstance(users, list) - # Check the contents of the list - # self.assertIsNotNone(users) - # self.assertIsInstance(users[0], str) + assert len(users) >= 2 + + # Check that users are returned as (id, name) tuples + for user in users: + assert len(user) == 2 + assert isinstance(user[0], int) # ID + assert isinstance(user[1], str) # Name def test_add_category_success(test_db_call): From e767f5ceec479f3b41a3ffac1cf7a1ff74e69189 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:37:44 +0100 Subject: [PATCH 03/16] =?UTF-8?q?feat:=20=F0=9F=86=95=20add=20docstring=20?= =?UTF-8?q?to=20read=5Fdatabase=20method=20for=20clarity=20on=20functional?= =?UTF-8?q?ity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/data_handler.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/data_handler.py b/src/data_handler.py index 573c540..38e71fd 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -207,6 +207,7 @@ def get_categories(self, user_id: int) -> list: return categories def read_database(self, sql_statement: str, params=()) -> list: + "reads the database query and returns the results" logging.debug(f"received request to read {sql_statement}") results = [] try: From d58a68e9143b51b165a8cfa4c0331b7dd88daaf6 Mon Sep 17 00:00:00 2001 From: Alex Dimmock <50240483+AtomicAlexD@users.noreply.github.com> Date: Wed, 28 May 2025 16:40:58 +0100 Subject: [PATCH 04/16] Update src/front/home.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/front/home.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/front/home.py b/src/front/home.py index 8022e2c..d9fd6a1 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -45,7 +45,7 @@ def submit_user_name(): users = db_call.get_users() for user in users: # users is [(id, name)] or [(name,)] - if (len(user) > 1 and user[1] == user_name) or (user[0] == user_name): + if len(user) > 1 and user[1] == user_name: flash("A user with that name already exists.", "error") return redirect(url_for("home.home_page")) From 1f0aa8d0b94eebcc654b793760044f8170e745ff Mon Sep 17 00:00:00 2001 From: Alex Dimmock <50240483+AtomicAlexD@users.noreply.github.com> Date: Wed, 28 May 2025 16:41:43 +0100 Subject: [PATCH 05/16] Update src/front/home.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/front/home.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/front/home.py b/src/front/home.py index d9fd6a1..3944958 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -65,7 +65,15 @@ def select_user(): session.pop("user_id", None) session.pop("user_name", None) return redirect(url_for("home.home_page")) - + + # Convert selected_user_id to int and handle invalid input + try: + selected_user_id = int(selected_user_id) + except ValueError: + logger.error(f"Invalid user ID: {selected_user_id}") + flash("Invalid user ID", "error") + return redirect(url_for("home.home_page")) + # Get the user details directly from the database using the ID db_call = data_handler.database(verity_config) result = db_call.read_database("SELECT id, name FROM user WHERE id = ?", (selected_user_id,)) From 4cc647b018060cd74a5365d99faea3ee48ad7f63 Mon Sep 17 00:00:00 2001 From: Alex Dimmock <50240483+AtomicAlexD@users.noreply.github.com> Date: Wed, 28 May 2025 16:45:50 +0100 Subject: [PATCH 06/16] Update src/tests/test_data_handler.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- src/tests/test_data_handler.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index 64bb86c..772fba9 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -10,10 +10,8 @@ def test_db_call(): """Create a test database instance with a unique test database file""" config = VerityConfig() # Use a test-specific database file - test_db_file = "test_verity.db" - # Remove the test DB if it already exists - if os.path.exists(test_db_file): - os.remove(test_db_file) + with tempfile.NamedTemporaryFile(suffix=".db", delete=False) as temp_db: + test_db_file = temp_db.name # Create a config with the test DB config.DATABASE = test_db_file From f12371b7b919da221a96160d9ce1357e98f2fba1 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:46:30 +0100 Subject: [PATCH 07/16] =?UTF-8?q?feat:=20=F0=9F=86=95=20add=20tempfile=20i?= =?UTF-8?q?mport=20for=20handling=20temporary=20files=20in=20tests?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/tests/test_data_handler.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index 772fba9..9a40d62 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -1,5 +1,6 @@ import pytest import os +import tempfile from src import data_handler from src.config import VerityConfig From 747d28175e608b1d2a373120691e955e9fc8a649 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:55:31 +0100 Subject: [PATCH 08/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20add=20conditional?= =?UTF-8?q?=20check=20for=20selected=5Fuser=5Fid=20before=20displaying=20c?= =?UTF-8?q?ategory=20form?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/front/templates/home.html | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/front/templates/home.html b/src/front/templates/home.html index c7bbe2d..667cec8 100644 --- a/src/front/templates/home.html +++ b/src/front/templates/home.html @@ -32,6 +32,8 @@

Home of Verity

+ +{% if selected_user_id %}
From 566d4162bdea595cc117702f946fddff66d9848c Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:56:30 +0100 Subject: [PATCH 09/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20reorder=20import=20?= =?UTF-8?q?statements=20for=20consistency=20in=20home.py?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/front/home.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/front/home.py b/src/front/home.py index 3944958..23703ac 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -1,5 +1,4 @@ -from flask import Blueprint, render_template -from flask import flash, redirect, url_for, session, request +from flask import flash, redirect, url_for, session, request, Blueprint, render_template import logging import data_handler From 5341640a748689698f01a26ee69dde4105a0bd87 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 16:59:43 +0100 Subject: [PATCH 10/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20update=20route=20na?= =?UTF-8?q?me=20for=20user=20submission=20to=20be=20more=20descriptive?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/front/home.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/front/home.py b/src/front/home.py index 23703ac..d9c8c7e 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -31,7 +31,7 @@ def home_page(): selected_user_name=selected_user_name ) -@home_bp.route("/submit", methods=["POST"]) +@home_bp.route("/submit_user", methods=["POST"]) def submit_user_name(): user_name = request.form.get("userName") logger.debug(f"Request Received: {request.form}") From 9544a6975d6b2a0f37c195f1aadcc5a801defd56 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 17:11:06 +0100 Subject: [PATCH 11/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20streamline=20user?= =?UTF-8?q?=20existence=20check=20and=20improve=20session=20handling=20in?= =?UTF-8?q?=20home.py?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/front/home.py | 41 ++++++++++++++++++----------------------- 1 file changed, 18 insertions(+), 23 deletions(-) diff --git a/src/front/home.py b/src/front/home.py index d9c8c7e..85bde40 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -15,7 +15,7 @@ def home_page(): logger.info("home page hit") db_call = data_handler.database(verity_config) users = db_call.get_users() - # Get user info directly from session - we store both ID and name there + # Get user info directly from session user_id = session.get("user_id") selected_user_name = session.get("user_name") @@ -40,19 +40,18 @@ def submit_user_name(): return redirect(url_for("home.home_page")) db_call = data_handler.database(verity_config) - # Check if user already exists - users = db_call.get_users() - for user in users: - # users is [(id, name)] or [(name,)] - if len(user) > 1 and user[1] == user_name: - flash("A user with that name already exists.", "error") - return redirect(url_for("home.home_page")) + # More efficient check for existing user + exists = db_call.read_database("SELECT 1 FROM user WHERE name = ?", (user_name,)) + if exists: + flash("A user with that name already exists.", "error") + return redirect(url_for("home.home_page")) logger.info(f"User submitted new user name: {user_name}") user_id = db_call.add_user_name(user_name) if user_id == 0: flash("User Name not saved, please check the logs", "error") return redirect(url_for("home.home_page")) + flash("user name saved! Now select the user from the dropdown to continue.", "success") return redirect(url_for("home.home_page")) @@ -75,17 +74,12 @@ def select_user(): # Get the user details directly from the database using the ID db_call = data_handler.database(verity_config) - result = db_call.read_database("SELECT id, name FROM user WHERE id = ?", (selected_user_id,)) + result = db_call.read_database("SELECT name FROM user WHERE id = ?", (selected_user_id,)) - if result and len(result) > 0: - user_id = result[0][0] - selected_user_name = result[0][1] - logger.debug(f"Found user with ID {user_id} and name {selected_user_name}") - + if result and result[0]: # Store both ID and name in the session - session["user_id"] = int(user_id) - session["user_name"] = selected_user_name - logger.debug(f"User selected - ID: {user_id}, Name: {selected_user_name}") + session["user_id"] = selected_user_id + session["user_name"] = result[0][0] flash("User selected!", "success") else: session.pop("user_id", None) @@ -107,10 +101,11 @@ def submit_category(): flash("Category name is required", "error") return redirect(url_for("home.home_page")) - # Convert budget_value to float if provided, otherwise None - budget_value_str = request.form.get("budgetValue") + # Handle form values more concisely + # Convert budget_value to float if provided budget_value = None - if budget_value_str and budget_value_str.strip(): + budget_value_str = request.form.get("budgetValue", "").strip() + if budget_value_str: try: budget_value = float(budget_value_str) except ValueError: @@ -118,10 +113,10 @@ def submit_category(): flash("Invalid budget value - please enter a valid number", "error") return redirect(url_for("home.home_page")) - # Convert parent_id to int if provided, otherwise None - parent_id_str = request.form.get("parentId") + # Convert parent_id to int if provided parent_id = None - if parent_id_str and parent_id_str.strip(): + parent_id_str = request.form.get("parentId", "").strip() + if parent_id_str: try: parent_id = int(parent_id_str) except ValueError: From 1fc7afcb7e1f8789b279efd7fe95073f68bb6e9c Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 17:18:04 +0100 Subject: [PATCH 12/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20put=20the=20read=5F?= =?UTF-8?q?database=20back=20where=20it=20belongs.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/data_handler.py | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/src/data_handler.py b/src/data_handler.py index 38e71fd..85aad98 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -41,7 +41,23 @@ def execute_sql(self, sql_statement: str, return_id: bool = False) -> (bool, int return (is_success, new_id) else: return is_success - + + def read_database(self, sql_statement: str, params=()) -> list: + "reads the database query and returns the results" + logging.debug(f"received request to read {sql_statement}") + results = [] + try: + connection = sqlite3.connect(self.database) + cursor = connection.cursor() + results = cursor.execute(sql_statement, params) + results = results.fetchall() + logging.debug(f"query returned: {results}") + except Exception as e: + logging.error(f"Read error occurred: {e}") + finally: + connection.close() + return results + @staticmethod def _build_column(column: dict) -> str: logging.debug( @@ -204,20 +220,4 @@ def get_categories(self, user_id: int) -> list: connection.close() except Exception as e: logger.error(f"failed to close connection: {e}") - return categories - - def read_database(self, sql_statement: str, params=()) -> list: - "reads the database query and returns the results" - logging.debug(f"received request to read {sql_statement}") - results = [] - try: - connection = sqlite3.connect(self.database) - cursor = connection.cursor() - results = cursor.execute(sql_statement, params) - results = results.fetchall() - logging.debug(f"query returned: {results}") - except Exception as e: - logging.error(f"Read error occurred: {e}") - finally: - connection.close() - return results \ No newline at end of file + return categories \ No newline at end of file From 1527857777d3be9e3e9811224b6f9096904efd5f Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Wed, 28 May 2025 17:27:32 +0100 Subject: [PATCH 13/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20add=20docstrings=20?= =?UTF-8?q?for=20add=5Fuser=5Fname=20and=20get=5Fusers=20methods=20in=20da?= =?UTF-8?q?tabase=20class?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/data_handler.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/data_handler.py b/src/data_handler.py index 85aad98..0e169b7 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -146,6 +146,7 @@ def print_table_schema(self, table_name): logger.error(e) def add_user_name(self, user_name: str) -> int: + "takes user name string, returns user id" logger.debug(f"attempting to insert values into user table {user_name}") try: connection = sqlite3.connect(self.database) @@ -176,6 +177,7 @@ def add_user_name(self, user_name: str) -> int: return 0 def get_users(self) -> list: + """Returns all users in the database.""" get_user_sql = "SELECT id, name FROM user" return self.read_database(get_user_sql) From 0007c26de1a44a029eaf7cc80b8278c6cf52a662 Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Sat, 31 May 2025 17:30:20 +0100 Subject: [PATCH 14/16] feat: add new task for fixing code with Ruff and update tasks.json; improve database methods and tests --- .vscode/tasks.json | 19 +++++++++++++++++-- pyproject.toml | 1 + src/data_handler.py | 13 +++++++------ src/front/home.py | 28 ++++++++++++++-------------- src/tests/test_data_handler.py | 18 ++++++++++-------- 5 files changed, 49 insertions(+), 30 deletions(-) diff --git a/.vscode/tasks.json b/.vscode/tasks.json index d4db1b4..2d57213 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -61,8 +61,7 @@ "clear": true, "focus": true }, "problemMatcher": [] - }, - { + }, { "label": "UV Sync ", "type": "shell", "command": "uv sync", @@ -77,6 +76,22 @@ "focus": true }, "problemMatcher": [] + }, + { + "label": "Fix Code with Ruff", + "type": "shell", + "command": "ruff check --fix .", + "options": { + "cwd": "${workspaceFolder}/src" + }, + "group": "none", + "presentation": { + "reveal": "always", + "panel": "dedicated", + "clear": true, + "focus": true + }, + "problemMatcher": [] } ] } diff --git a/pyproject.toml b/pyproject.toml index 4804f36..d178565 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,6 +31,7 @@ plugins.jedi_definition.enabled = true [tool.ruff] line-length = 100 target-version = "py313" +fix = true [tool.ruff.lint] select = ["E", "F", "I", "W"] # Error, F: PyFlakes, I: isort, W: pycodestyle warnings diff --git a/src/data_handler.py b/src/data_handler.py index ef6e14d..f3d9677 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -41,7 +41,7 @@ def execute_sql(self, sql_statement: str, return_id: bool = False) -> (bool, int return (is_success, new_id) else: return is_success - + def read_database(self, sql_statement: str, params=()) -> list: "reads the database query and returns the results" logging.debug(f"received request to read {sql_statement}") @@ -57,7 +57,7 @@ def read_database(self, sql_statement: str, params=()) -> list: finally: connection.close() return results - + @staticmethod def _build_column(column: dict) -> str: logging.debug( @@ -179,9 +179,10 @@ def add_user_name(self, user_name: str) -> int: def get_users(self) -> list: """Returns all users in the database.""" get_user_sql = "SELECT id, name FROM user" - return self.read_database(get_user_sql) - - def add_category(self, user_id: int, category_name: str, budget_value=None, parent_id=None) -> int: + return self.read_database(get_user_sql) + + def add_category(self, user_id: int, category_name: str,budget_value: int = 0, + parent_id = None) -> int: """Inserts a new category. Returns the category id.""" logger.debug(f"attempting to insert category '{category_name}' for user {user_id}") try: @@ -222,4 +223,4 @@ def get_categories(self, user_id: int) -> list: connection.close() except Exception as e: logger.error(f"failed to close connection: {e}") - return categories \ No newline at end of file + return categories diff --git a/src/front/home.py b/src/front/home.py index ce6d45d..9d75d1f 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -17,12 +17,12 @@ def home_page(): db_call = data_handler.database(verity_config) users = db_call.get_users() # Get user info directly from session - user_id = session.get("user_id") + user_id = session.get("user_id") selected_user_name = session.get("user_name") - + # Debug log to see what's being passed to the template logger.debug(f"User ID from session: {user_id}, User Name from session: {selected_user_name}") - + categories = db_call.get_categories(user_id) if user_id else [] return render_template( "home.html", @@ -52,10 +52,10 @@ def submit_user_name(): if user_id == 0: flash("User Name not saved, please check the logs", "error") return redirect(url_for("home.home_page")) - + flash("user name saved! Now select the user from the dropdown to continue.", "success") return redirect(url_for("home.home_page")) - + @home_bp.route("/select_user", methods=["POST"]) def select_user(): selected_user_id = request.form.get("selectedUserId") @@ -64,7 +64,7 @@ def select_user(): session.pop("user_id", None) session.pop("user_name", None) return redirect(url_for("home.home_page")) - + # Convert selected_user_id to int and handle invalid input try: selected_user_id = int(selected_user_id) @@ -72,11 +72,11 @@ def select_user(): logger.error(f"Invalid user ID: {selected_user_id}") flash("Invalid user ID", "error") return redirect(url_for("home.home_page")) - + # Get the user details directly from the database using the ID db_call = data_handler.database(verity_config) result = db_call.read_database("SELECT name FROM user WHERE id = ?", (selected_user_id,)) - + if result and result[0]: # Store both ID and name in the session session["user_id"] = selected_user_id @@ -86,7 +86,7 @@ def select_user(): session.pop("user_id", None) session.pop("user_name", None) flash("User not found!", "error") - + return redirect(url_for("home.home_page")) @home_bp.route("/submit_category", methods=["POST"]) @@ -95,13 +95,13 @@ def submit_category(): if not user_id: flash("No user selected!", "error") return redirect(url_for("home.home_page")) - + # Get and validate category name (required) category_name = request.form.get("categoryName") if not category_name: flash("Category name is required", "error") return redirect(url_for("home.home_page")) - + # Handle form values more concisely # Convert budget_value to float if provided budget_value = None @@ -113,7 +113,7 @@ def submit_category(): logger.error(f"Invalid budget value: {budget_value_str}") flash("Invalid budget value - please enter a valid number", "error") return redirect(url_for("home.home_page")) - + # Convert parent_id to int if provided parent_id = None parent_id_str = request.form.get("parentId", "").strip() @@ -124,11 +124,11 @@ def submit_category(): logger.error(f"Invalid parent ID: {parent_id_str}") flash("Invalid parent category ID", "error") return redirect(url_for("home.home_page")) - + db_call = data_handler.database(verity_config) category_id = db_call.add_category(user_id, category_name, budget_value, parent_id) if category_id == 0: flash("Category not saved, please check the logs", "error") else: flash("Category saved!", "success") - return redirect(url_for("home.home_page")) \ No newline at end of file + return redirect(url_for("home.home_page")) diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index 9a40d62..becf155 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -1,7 +1,8 @@ -import pytest import os import tempfile +import pytest + from src import data_handler from src.config import VerityConfig @@ -13,7 +14,7 @@ def test_db_call(): # Use a test-specific database file with tempfile.NamedTemporaryFile(suffix=".db", delete=False) as temp_db: test_db_file = temp_db.name - + # Create a config with the test DB config.DATABASE = test_db_file db_call = data_handler.database(config) @@ -82,7 +83,7 @@ def test_read_database_with_params(test_db_call): def test_build_database(test_db_call): """Test that the database builds correctly with all required tables""" # Check if all tables have been created - tables_to_check = ["user", "account", "account_type", "party", "transaction_type", + tables_to_check = ["user", "account", "account_type", "party", "transaction_type", "category", "transaction_log"] for table in tables_to_check: sql = f"SELECT name FROM sqlite_master WHERE type='table' AND name='{table}';" @@ -95,7 +96,7 @@ def test_add_user_name(test_db_call): user_name = "Test user" user_id = test_db_call.add_user_name(user_name) assert user_id > 0 - + # Check if the user name was actually added sql = "SELECT id, name FROM user WHERE name = ?" results = test_db_call.read_database(sql, (user_name,)) @@ -109,7 +110,7 @@ def test_add_duplicate_user_name(test_db_call): # Add first user user_id1 = test_db_call.add_user_name(user_name) assert user_id1 > 0 - + # Add second user with same name user_id2 = test_db_call.add_user_name(user_name) assert user_id2 > 0 @@ -121,12 +122,12 @@ def test_get_users(test_db_call): # Add some test users first test_db_call.add_user_name("User One") test_db_call.add_user_name("User Two") - + # Get users users = test_db_call.get_users() assert isinstance(users, list) assert len(users) >= 2 - + # Check that users are returned as (id, name) tuples for user in users: assert len(user) == 2 @@ -178,6 +179,7 @@ def test_add_category_and_get_categories(test_db_call): def test_add_category_invalid_user(test_db_call): - # Try to add a category with a non-existent user_id (should still succeed in SQLite unless foreign keys are enforced) + # Try to add a category with a non-existent user_id + # (should still succeed in SQLite unless foreign keys are enforced) category_id = test_db_call.add_category(99999, "InvalidUserCategory") assert isinstance(category_id, int) From 26e156c0a89b2f3a293b140afd3f66760f21755d Mon Sep 17 00:00:00 2001 From: Alex Dimmock Date: Sat, 31 May 2025 17:31:13 +0100 Subject: [PATCH 15/16] =?UTF-8?q?fix:=20=F0=9F=90=9B=20add=20setting=20to?= =?UTF-8?q?=20render=20whitespace=20in=20editor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .vscode/settings.json | 1 + 1 file changed, 1 insertion(+) diff --git a/.vscode/settings.json b/.vscode/settings.json index 9a329fa..084a4a9 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -17,4 +17,5 @@ "editor.defaultFormatter": "charliermarsh.ruff", "ruff.enable": true, "ruff.organizeImports": true, + "editor.renderWhitespace": "all", } From 4d9426e6d954310888ba0bd208e50cf46ca58e93 Mon Sep 17 00:00:00 2001 From: Jake-Pullen <88822333+Jake-Pullen@users.noreply.github.com> Date: Sat, 28 Jun 2025 07:58:52 +0100 Subject: [PATCH 16/16] Category support additions (#19) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Some initial changes based on feedback * More additions * Resolved most comments from Pull Request 8 * Moved convert to universal currency to its own module. * Working towards adding default rows, need to add system user? * feat: ✨We now add an internal master category per user that is hidden Will be useful for various key restraints. * fix: 🩹 Fixed a test failure --------- Co-authored-by: Jake Pullen --- src/config.py | 1 + src/config_files/default_data.yaml | 4 + src/currency_handler.py | 23 +++++ src/data_handler.py | 139 ++++++++++++----------------- src/front/home.py | 71 +++++++-------- src/tests/test_currency_handler.py | 21 +++++ src/tests/test_data_handler.py | 9 +- src/verity.py | 1 + 8 files changed, 149 insertions(+), 120 deletions(-) create mode 100644 src/config_files/default_data.yaml create mode 100644 src/currency_handler.py create mode 100644 src/tests/test_currency_handler.py diff --git a/src/config.py b/src/config.py index 975c89e..851119d 100644 --- a/src/config.py +++ b/src/config.py @@ -10,6 +10,7 @@ def __init__(self): self.CONFIG_FILE_DIRECTORY = "config_files" self.LOGGING_CONFIG = self.load_config_file("logging_config.yaml") self.DATABASE_SCHEMA = self.load_config_file("verity_schema.yaml") + self.DEFAULT_DATA = self.load_config_file("default_data.yaml") def load_config_file(self, file): config = "" diff --git a/src/config_files/default_data.yaml b/src/config_files/default_data.yaml new file mode 100644 index 0000000..fb9cac2 --- /dev/null +++ b/src/config_files/default_data.yaml @@ -0,0 +1,4 @@ +category: + - name: 'internal_master_category' + - name: 'tesing more categories' + budget_value: '100' diff --git a/src/currency_handler.py b/src/currency_handler.py new file mode 100644 index 0000000..cb92036 --- /dev/null +++ b/src/currency_handler.py @@ -0,0 +1,23 @@ +import logging + +logger = logging.getLogger(__name__) + +# TODO: Make this into a proper class so we can scale currrency handling + + +def convert_to_universal_currency(input_value: float) -> int: + """ + Converts the the input value to remove all decimal places and return an int. + This will be the starting point for our universal currency, + (see docs/data_dictionary). + for now, we will just focus on making this an int. + it will need change later once we have the basics done + """ + logger.info(f"received {input_value} to convert to universal currency") + input_value = float(input_value) + while input_value % 1 != 0: + logger.debug(f"input value is not a whole number {input_value}") + input_value = input_value * 10 + logger.info(f"returning {int(input_value)}") + return int(input_value) + diff --git a/src/data_handler.py b/src/data_handler.py index f3d9677..c1d970d 100644 --- a/src/data_handler.py +++ b/src/data_handler.py @@ -14,10 +14,13 @@ def __init__(self, config) -> None: self.verity_config = config self.schema = self.verity_config.DATABASE_SCHEMA self.database = self.verity_config.DATABASE + self.default_data = self.verity_config.DEFAULT_DATA - def execute_sql(self, sql_statement: str, return_id: bool = False) -> (bool, int): + def execute_sql( + self, sql_statement: str, params: tuple = (), return_id: bool = False, seed: bool = False + ) -> (bool, int): "send the query here, returns true if successful, false if fail" - logging.debug(f"received request to execute {sql_statement}") + logger.debug(f"received request to execute {sql_statement} with params {params}") new_id: int = 0 is_success: bool = False try: @@ -25,44 +28,50 @@ def execute_sql(self, sql_statement: str, return_id: bool = False) -> (bool, int database=self.database, timeout=10, # seconds i hope ) - logging.debug("opened connection to database") + logger.info("opened connection to database") cursor = connection.cursor() - cursor.execute(sql_statement, {}) + cursor.execute("PRAGMA foreign_keys = ON;") + if seed: + cursor.execute("PRAGMA foreign_keys = OFF;") + cursor.execute(sql_statement, params) connection.commit() + logger.debug(f"executed {sql_statement} with params: {params}") + logger.info("executed sql command") if return_id: new_id = cursor.lastrowid + logger.debug(f"New id created {new_id}") is_success = True except Exception as e: # TODO: better Exception handling - logging.error(e) + logger.error(e) is_success = False finally: + cursor.execute("PRAGMA foreign_keys = ON;") connection.close() + logger.info("closed connection to database") if return_id: return (is_success, new_id) else: return is_success - def read_database(self, sql_statement: str, params=()) -> list: + def read_database(self, sql_statement: str, params: tuple = ()) -> list: "reads the database query and returns the results" - logging.debug(f"received request to read {sql_statement}") + logger.debug(f"received request to read {sql_statement} with params {params}") results = [] try: connection = sqlite3.connect(self.database) cursor = connection.cursor() results = cursor.execute(sql_statement, params) results = results.fetchall() - logging.debug(f"query returned: {results}") + logger.debug(f"query returned: {results}") except Exception as e: - logging.error(f"Read error occurred: {e}") + logger.error(f"Read error occurred: {e}") finally: connection.close() return results @staticmethod def _build_column(column: dict) -> str: - logging.debug( - f"building column {column}" - ) + logging.debug(f"building column {column}") name = column["column_name"] is_pk = column["is_pk"] is_fk = column.get("is_fk") @@ -77,7 +86,6 @@ def _build_column(column: dict) -> str: column_string += " NOT NULL" return column_string - def _add_table_to_db(self, table: dict) -> bool: "Creates the table in the verity database, based on the schema yaml" sql = f"""CREATE TABLE IF NOT EXISTS {table["table_name"]} ( @@ -132,9 +140,7 @@ def print_table_schema(self, table_name): # Print the schema logger.debug(f"Schema for table: {table_name}") for row in cursor.fetchall(): - logger.debug( - f"Column Name: {row[1]}, Data Type: {row[2]}, Not Null: {row[3]}" - ) + logger.debug(f"Column Name: {row[1]}, Data Type: {row[2]}, Not Null: {row[3]}") except Exception as e: logger.error(f"An error occurred: {e}") @@ -148,79 +154,50 @@ def print_table_schema(self, table_name): def add_user_name(self, user_name: str) -> int: "takes user name string, returns user id" logger.debug(f"attempting to insert values into user table {user_name}") - try: - connection = sqlite3.connect(self.database) - cursor = connection.cursor() - cursor.execute( - """ - INSERT INTO user ( - name - ) - VALUES (?) - """, - (user_name,), - ) - connection.commit() - user_id = cursor.lastrowid - if user_id is None: - user_id = 0 - except Exception as e: - logger.error(f"Failed to insert user name, error: {e}") - user_id = 0 - finally: - try: - connection.close() - logger.debug("connection to db closed") - return user_id - except Exception as e: - logger.error(f"failed to close connection message: {e}") - return 0 + sql_statement = """ + INSERT INTO user (name) + VALUES (?) + """ + params = (user_name,) + success, user_id = self.execute_sql(sql_statement, params, True) + if not success: + logger.error("Failed to execute sql, check the logs") + self.add_category(user_id, "internal_master_category", seed=True) + return user_id def get_users(self) -> list: """Returns all users in the database.""" get_user_sql = "SELECT id, name FROM user" return self.read_database(get_user_sql) - def add_category(self, user_id: int, category_name: str,budget_value: int = 0, - parent_id = None) -> int: + def add_category( + self, user_id: int, category_name: str, budget_value: int = 0, parent_id=None, seed=False + ) -> int: """Inserts a new category. Returns the category id.""" logger.debug(f"attempting to insert category '{category_name}' for user {user_id}") - try: - connection = sqlite3.connect(self.database) - cursor = connection.cursor() - cursor.execute( - """ - INSERT INTO category (user_id, name, budget_value, parent_id) - VALUES (?, ?, ?, ?) - """, - (user_id, category_name, budget_value, parent_id), - ) - connection.commit() - category_id = cursor.lastrowid or 0 - except Exception as e: - logger.error(f"Failed to insert category name, error: {e}") - category_id = 0 - finally: - try: - connection.close() - except Exception as e: - logger.error(f"failed to close connection: {e}") - return category_id + sql_statement = """ + INSERT INTO category (user_id, name, budget_value, parent_id) + VALUES (?, ?, ?, ?)""" + if not seed: + if not parent_id: + parent_id = self.read_database( + "SELECT id FROM category WHERE user_id = ? AND name = ?", + (user_id, "internal_master_category"), + ) + try: + parent_id = parent_id[0][0] + except IndexError: + parent_id = None + params = (user_id, category_name, budget_value, parent_id) + + success, category_id = self.execute_sql(sql_statement, params, True, seed) + if not success: + logger.error("Failed to execute sql, check the logs") + return category_id def get_categories(self, user_id: int) -> list: """Returns all categories for a given user.""" - try: - connection = sqlite3.connect(self.database) - cursor = connection.cursor() - sql = "SELECT id, name, budget_value, parent_id FROM category WHERE user_id = ?" - cursor.execute(sql, (user_id,)) - categories = cursor.fetchall() - except Exception as e: - logger.error(f"Failed to fetch categories: {e}") - categories = [] - finally: - try: - connection.close() - except Exception as e: - logger.error(f"failed to close connection: {e}") - return categories + sql = ( + "SELECT id, name, budget_value, parent_id FROM category WHERE user_id = ? and name != ?" + ) + return self.read_database(sql_statement=sql, params=(user_id, "internal_master_category")) diff --git a/src/front/home.py b/src/front/home.py index 9d75d1f..0bf3eb0 100644 --- a/src/front/home.py +++ b/src/front/home.py @@ -2,6 +2,7 @@ from flask import Blueprint, flash, redirect, render_template, request, session, url_for +import currency_handler import data_handler from config import VerityConfig @@ -22,6 +23,7 @@ def home_page(): # Debug log to see what's being passed to the template logger.debug(f"User ID from session: {user_id}, User Name from session: {selected_user_name}") + logger.info(f"{selected_user_name} is logged in") categories = db_call.get_categories(user_id) if user_id else [] return render_template( @@ -29,33 +31,36 @@ def home_page(): users=users, categories=categories, selected_user_id=user_id, - selected_user_name=selected_user_name + selected_user_name=selected_user_name, ) + @home_bp.route("/submit_user", methods=["POST"]) def submit_user_name(): user_name = request.form.get("userName") logger.debug(f"Request Received: {request.form}") if not user_name: - flash("Please enter a user name.", "error") + flash("Please enter a user name.", "danger") return redirect(url_for("home.home_page")) db_call = data_handler.database(verity_config) # More efficient check for existing user exists = db_call.read_database("SELECT 1 FROM user WHERE name = ?", (user_name,)) if exists: - flash("A user with that name already exists.", "error") + logger.warning(f"username already exists in the database: {user_name}") + flash("A user with that name already exists.", "danger") return redirect(url_for("home.home_page")) - logger.info(f"User submitted new user name: {user_name}") user_id = db_call.add_user_name(user_name) if user_id == 0: - flash("User Name not saved, please check the logs", "error") + flash("User Name not saved, please check the logs", "danger") return redirect(url_for("home.home_page")) - - flash("user name saved! Now select the user from the dropdown to continue.", "success") + session["user_id"] = int(user_id) + session["user_name"] = user_name + flash("user name saved! Start adding categories.", "success") return redirect(url_for("home.home_page")) + @home_bp.route("/select_user", methods=["POST"]) def select_user(): selected_user_id = request.form.get("selectedUserId") @@ -85,50 +90,46 @@ def select_user(): else: session.pop("user_id", None) session.pop("user_name", None) - flash("User not found!", "error") + flash("User not found!", "danger") return redirect(url_for("home.home_page")) + @home_bp.route("/submit_category", methods=["POST"]) def submit_category(): user_id = session.get("user_id") if not user_id: - flash("No user selected!", "error") + logger.warning("No user selected and trying to add a category... how?") + flash("No user selected!", "danger") return redirect(url_for("home.home_page")) # Get and validate category name (required) category_name = request.form.get("categoryName") - if not category_name: - flash("Category name is required", "error") - return redirect(url_for("home.home_page")) - - # Handle form values more concisely - # Convert budget_value to float if provided - budget_value = None - budget_value_str = request.form.get("budgetValue", "").strip() - if budget_value_str: - try: - budget_value = float(budget_value_str) - except ValueError: - logger.error(f"Invalid budget value: {budget_value_str}") - flash("Invalid budget value - please enter a valid number", "error") - return redirect(url_for("home.home_page")) + # Convert budget_value to our universal currency + budget_value: int = 0 + budget_value_input = request.form.get("budgetValue", "0") + logger.debug(f"budget value input: {budget_value_input}") + if not budget_value_input: + logger.info("no budget value assigned to category") + else: + logger.info(f"Category:{category_name}, Assigned amount: {budget_value_input}") + # User might either add a whole currency or a decimal of. we need to handle both + if float(budget_value_input) < 0: + logger.info("user is stupid and tried to assign a negative amount to the category") + flash("Negative amounts don`t really make sense here, removed budget amount", "danger") + budget_value_input = 0 + budget_value = currency_handler.convert_to_universal_currency(budget_value_input) # Convert parent_id to int if provided - parent_id = None - parent_id_str = request.form.get("parentId", "").strip() - if parent_id_str: - try: - parent_id = int(parent_id_str) - except ValueError: - logger.error(f"Invalid parent ID: {parent_id_str}") - flash("Invalid parent category ID", "error") - return redirect(url_for("home.home_page")) + parent_id = request.form.get("parentId", "0").strip() db_call = data_handler.database(verity_config) - category_id = db_call.add_category(user_id, category_name, budget_value, parent_id) + if parent_id == 0: + category_id = db_call.add_category(user_id, category_name, budget_value) + else: + category_id = db_call.add_category(user_id, category_name, budget_value, parent_id) if category_id == 0: - flash("Category not saved, please check the logs", "error") + flash("Category not saved, please check the logs", "danger") else: flash("Category saved!", "success") return redirect(url_for("home.home_page")) diff --git a/src/tests/test_currency_handler.py b/src/tests/test_currency_handler.py new file mode 100644 index 0000000..8111018 --- /dev/null +++ b/src/tests/test_currency_handler.py @@ -0,0 +1,21 @@ + +from src import currency_handler + + +def test_convert_to_universal_currency(): + input = 87.82 + result = currency_handler.convert_to_universal_currency(input) + assert result == 8782 + + +def test_whole_number(): + input = 123 + result = currency_handler.convert_to_universal_currency(input) + assert result == input + + +def test_negative_number(): + input = -123.45 + result = currency_handler.convert_to_universal_currency(input) + print(result) + assert result == -12345 diff --git a/src/tests/test_data_handler.py b/src/tests/test_data_handler.py index becf155..283ae80 100644 --- a/src/tests/test_data_handler.py +++ b/src/tests/test_data_handler.py @@ -83,10 +83,10 @@ def test_read_database_with_params(test_db_call): def test_build_database(test_db_call): """Test that the database builds correctly with all required tables""" # Check if all tables have been created - tables_to_check = ["user", "account", "account_type", "party", "transaction_type", - "category", "transaction_log"] - for table in tables_to_check: - sql = f"SELECT name FROM sqlite_master WHERE type='table' AND name='{table}';" + config = VerityConfig() + for table in config.DATABASE_SCHEMA["tables"]: + table_name = table["table_name"] + sql = f"SELECT name FROM sqlite_master WHERE type='table' AND name='{table_name}';" results = test_db_call.read_database(sql) assert len(results) == 1, f"Table '{table}' should exist" @@ -182,4 +182,5 @@ def test_add_category_invalid_user(test_db_call): # Try to add a category with a non-existent user_id # (should still succeed in SQLite unless foreign keys are enforced) category_id = test_db_call.add_category(99999, "InvalidUserCategory") + assert category_id == 0 assert isinstance(category_id, int) diff --git a/src/verity.py b/src/verity.py index 69df55b..0bf866c 100644 --- a/src/verity.py +++ b/src/verity.py @@ -28,6 +28,7 @@ def set_up_logging(config): # database initialise verity = database(verity_config) + logger.debug(verity_config.DEFAULT_DATA) verity.build_database() # app initialise