Debt tracker

[Sha-yol]

Partially solves #9 - adds the splitwise balance functionality.
When processing SW expenses, adds a withdrawal transaction from the paying account for the full amount payed, and adds a deposit to the SW balance account.
If processing an expense payed by others - only add a withdrawal transaction from the SW balance account.

Feature is implemented using strategy design pattern - a feature switch in the .env file determines whether to use the simple strategy or the SW balance strategy for transaction handling. main.py changes are minor, does not contain SW balance logic - almost all in the strategies/sw_balance.py file.

Waiting for comments and review :)

[Sha-yol]

This was a long branch - when merging, can squash to make history neater.

[adyanth]

Thank you for the continued contribution, this is great! A couple comments, nothing major. Looks good!

[adyanth]

Also, some tests seem to be failing. Mind taking a look? (A missing argument, and a decimal 0)

============================= test session starts ==============================
platform linux -- Python 3.13.0, pytest-8.3.3, pluggy-1.5.0
rootdir: /home/runner/work/splitwise-firefly-sync/splitwise-firefly-sync
plugins: cov-6.0.0
collected 20 items

tests/test_account_currency.py ...                                       [ 15%]
tests/test_main.py .........F...                                         [ 80%]
tests/test_strategies.py .F..                                            [100%]

=================================== FAILURES ===================================
________________________ test_getExpenseTransactionBody ________________________

mock_getAccountCurrencyCode = <MagicMock name='getAccountCurrencyCode' id='139855257463040'>
mock_expense = <MagicMock spec='Expense' id='139855257467408'>
mock_expense_user = <MagicMock spec='ExpenseUser' id='139855257462032'>

    @patch('main.getAccountCurrencyCode')
    def test_getExpenseTransactionBody(mock_getAccountCurrencyCode, mock_expense, mock_expense_user):
        getExpenseTransactionBody = load_main().getExpenseTransactionBody
        mock_getAccountCurrencyCode.return_value = "USD"
        result = getExpenseTransactionBody(mock_expense, mock_expense_user, ["Dest", "Category", "Desc", "Amex"])
    
        assert result["source_name"] == "Amex"
        assert result["destination_name"] == "Dest"
        assert result["category_name"] == "Category"
>       assert result["amount"] == "10.00"
E       AssertionError: assert '10.0' == '10.00'
E         
E         - 10.00
E         ?     -
E         + 10.0

tests/test_main.py:139: AssertionError
----------------------------- Captured stdout call -----------------------------
Processing Category Expense Test Expense for USD 10.00 on 2023-09-10T12:00:00Z from Amex to Dest
___________________________ test_sw_balance_strategy ___________________________

    def test_sw_balance_strategy():
>       strategy = SWBalanceTransactionStrategy(mock_get_expense_transaction_body, "Splitwise Balance")
E       TypeError: SWBalanceTransactionStrategy.__init__() missing 1 required positional argument: 'apply_transaction_amount'

tests/test_strategies.py:47: TypeError
- generated xml file: /home/runner/work/splitwise-firefly-sync/splitwise-firefly-sync/pytest.xml -

---------- coverage: platform linux, python 3.13.0-final-0 -----------
Coverage XML written to file coverage.xml

=========================== short test summary info ============================
FAILED tests/test_main.py::test_getExpenseTransactionBody - AssertionError: assert '10.0' == '10.00'
  
  - 10.00
  ?     -
  + 10.0
FAILED tests/test_strategies.py::test_sw_balance_strategy - TypeError: SWBalanceTransactionStrategy.__init__() missing 1 required positional argument: 'apply_transaction_amount'
========================= 2 failed, 18 passed in 0.70s =========================

[Sha-yol]

I'm not why the automatic tests failed, but they passed on my machine after the latest commits.

[adyanth]

The tests are good now, the pipeline fails due to permissions, but if you open it, it does show the test results (not sure if you would have permissions for that too).

[Sha-yol]

Let me think about it a bit. I remember going down the split transaction route and rejecting it, but not why. I think I didn't want to treat it as an expense account - it made more sense to think of it as an asset account, and then it can get counted in your net worth. I think you can't count an expense account in your net worth.

…

On Wed, Nov 13, 2024, 10:54 Adyanth Hosavalike ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In strategies/sw_balance.py <#23 (comment)> : > + self._sw_balance_account = sw_balance_account + self._apply_transaction_amount = apply_transaction_amount + + def create_transactions(self, exp: Expense, myshare: ExpenseUser, data: list[str]) -> list[dict]: + txns = {} + paid_txn = self._get_expense_transaction_body(exp, myshare, data) + paid_txn = self._apply_transaction_amount(paid_txn, exp, myshare.getPaidShare()) + if float(paid_txn['amount']) != 0: # I paid; payment txn needed + txns['paid'] = paid_txn + + balance_txn = paid_txn.copy() + balance = float(myshare.getNetBalance()) + if balance != 0: # I owe or am owed; balance txn needed + txns['balance'] = balance_txn + if balance > 0: # I am owed; difference credited to balance account + balance_txn['source_name'] = self._sw_balance_account + " balancer" My bank statement would show 10 going to the grocery store, not 4 to the store and 6 to another account. Would you say correctly representing this warrants a new Firefly account (the balancer account) to be created? Would this be an asset/revenue or an expense account that deposits money into the asset account? You could make use of the split transaction to generate something like this where it correctly shows it as part of a single transaction. Screenshot.2024-11-13.at.2.21.31.PM.png (view on web) <https://github.com/user-attachments/assets/1dbe0f9c-d8c9-49f9-a50c-6c01ad880763> I am good to merge this as is if you think this is the best approach. My only concern in creating yet another account that might not technically be needed. — Reply to this email directly, view it on GitHub <#23 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHU22SVXVRX6PLF76XTAKUL2AMHTXAVCNFSM6AAAAABRPEYF5OVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDIMZSGMZTMMBRGU> . You are receiving this because you authored the thread.Message ID: ***@***.***>