Add amount_major to views (#83)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: mxr

README.md

@@ -61,7 +61,7 @@ The relations are defined in [create-relations.sql](sqlite_export_for_ynab/ddl/c
 
 1. Some objects are pulled out into their own tables so they can be more cleanly modeled in SQLite (ex: subtransactions, loan account periodic values).
 1. Foreign keys are added as needed (ex: budget ID, transaction ID) so data across budgets remains separate.
-1. Two new views called `flat_transactions` and `scheduled_flat_transactions` allow you to query split and non-split transactions easily, without needing to also query `subtransactions` and `scheduled_subtransactions` respectively.
+1. Two new views called `flat_transactions` and `scheduled_flat_transactions` allow you to query split and non-split transactions easily, without needing to also query `subtransactions` and `scheduled_subtransactions` respectively. They also include fields to improve quality of life (ex: `amount_major` to convert from [YNAB's milliunits](https://api.ynab.com/#formats) to [major units](https://en.wikipedia.org/wiki/ISO_4217) i.e. dollars).
 
 ## Querying
 

sqlite_export_for_ynab/ddl/create-relations.sql

@@ -160,6 +160,7 @@ SELECT
     , t.matched_transaction_id
     , COALESCE(st.id, t.id) AS id
     , COALESCE(st.amount, t.amount) AS amount
+    , COALESCE(st.amount, t.amount) / -1000.0 AS amount_major
     , CASE
         WHEN
             COALESCE(st.transfer_account_id, t.transfer_account_id) IS null
@@ -249,6 +250,7 @@ SELECT
     , COALESCE(st.payee_name, t.payee_name) AS payee_name
     , COALESCE(st.id, t.id) AS id
     , COALESCE(st.amount, t.amount) AS amount
+    , COALESCE(st.amount, t.amount) / -1000.0 AS amount_major
     , CASE
         WHEN
             COALESCE(st.transfer_account_id, t.transfer_account_id) IS null

testing/fixtures.py

@@ -136,12 +136,12 @@
             {
                 "id": SUBTRANSACTION_ID_1,
                 "transaction_id": TRANSACTION_ID_1,
-                "amount": -7000,
+                "amount": -7500,
             },
             {
                 "id": SUBTRANSACTION_ID_2,
                 "transaction_id": TRANSACTION_ID_1,
-                "amount": -3000,
+                "amount": -2500,
             },
         ],
     },
@@ -167,12 +167,12 @@
             {
                 "id": SCHEDULED_SUBTRANSACTION_ID_1,
                 "scheduled_transaction_id": SCHEDULED_TRANSACTION_ID_1,
-                "amount": -8000,
+                "amount": -8040,
             },
             {
                 "id": SCHEDULED_SUBTRANSACTION_ID_2,
                 "scheduled_transaction_id": SCHEDULED_TRANSACTION_ID_1,
-                "amount": -4000,
+                "amount": -2960,
             },
         ],
     },

tests/_main_test.py

@@ -257,13 +257,13 @@ def test_insert_transactions(cur):
             "id": SUBTRANSACTION_ID_1,
             "transaction_id": TRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
-            "amount": -7000,
+            "amount": -7500,
         },
         {
             "id": SUBTRANSACTION_ID_2,
             "transaction_id": TRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
-            "amount": -3000,
+            "amount": -2500,
         },
     ]
 
@@ -275,22 +275,25 @@ def test_insert_transactions(cur):
             "date": "2024-02-01",
             "id": TRANSACTION_ID_2,
             "amount": -15000,
+            "amount_major": pytest.approx(15),
         },
         {
             "transaction_id": TRANSACTION_ID_1,
             "subtransaction_id": SUBTRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
             "date": "2024-01-01",
             "id": SUBTRANSACTION_ID_1,
-            "amount": -7000,
+            "amount": -7500,
+            "amount_major": pytest.approx(7.50),
         },
         {
             "transaction_id": TRANSACTION_ID_1,
             "subtransaction_id": SUBTRANSACTION_ID_2,
             "budget_id": BUDGET_ID_1,
             "date": "2024-01-01",
             "id": SUBTRANSACTION_ID_2,
-            "amount": -3000,
+            "amount": -2500,
+            "amount_major": pytest.approx(2.50),
         },
     ]
 
@@ -322,13 +325,13 @@ def test_insert_scheduled_transactions(cur):
             "id": SCHEDULED_SUBTRANSACTION_ID_1,
             "scheduled_transaction_id": SCHEDULED_TRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
-            "amount": -8000,
+            "amount": -8040,
         },
         {
             "id": SCHEDULED_SUBTRANSACTION_ID_2,
             "scheduled_transaction_id": SCHEDULED_TRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
-            "amount": -4000,
+            "amount": -2960,
         },
     ]
 
@@ -339,20 +342,23 @@ def test_insert_scheduled_transactions(cur):
             "budget_id": BUDGET_ID_1,
             "id": SCHEDULED_TRANSACTION_ID_2,
             "amount": -11000,
+            "amount_major": pytest.approx(11),
         },
         {
             "transaction_id": SCHEDULED_TRANSACTION_ID_1,
             "subtransaction_id": SCHEDULED_SUBTRANSACTION_ID_1,
             "budget_id": BUDGET_ID_1,
             "id": SCHEDULED_SUBTRANSACTION_ID_1,
-            "amount": -8000,
+            "amount": -8040,
+            "amount_major": pytest.approx(8.04),
         },
         {
             "transaction_id": SCHEDULED_TRANSACTION_ID_1,
             "subtransaction_id": SCHEDULED_SUBTRANSACTION_ID_2,
             "budget_id": BUDGET_ID_1,
             "id": SCHEDULED_SUBTRANSACTION_ID_2,
-            "amount": -4000,
+            "amount": -2960,
+            "amount_major": pytest.approx(2.96),
         },
     ]