Merge 0a50941c35 into 794f26f767

Co-Authored-By: qurbanov <10328930+qurbanov@users.noreply.github.com>

docs/contributing.md

@@ -78,6 +78,15 @@ Thanks again!
 (setup-dev-environment)=
 ## Set up a dev environment
 
+### Requirements
+
+In addition to general {ref}`requirements<system-requirements>`, you will need
+**uv**. It recommended to install uv [system
+wide](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer)
+as it is a kind of replacement for pip.
+
+### Getting the sources
+
 You must develop on top of the Git master branch:
 
     git clone https://github.com/spiral-project/ihatemoney.git

ihatemoney/default_settings.py

@@ -15,6 +15,7 @@ APPLICATION_ROOT = "/"
 ENABLE_CAPTCHA = False
 LEGAL_LINK = ""
 SUPPORTED_LANGUAGES = [
+    "az",
     "ca",
     "cs",
     "de",

ihatemoney/history.py

@@ -38,6 +38,9 @@ def history_sort_key(history_item_dict):
 
 def describe_version(version_obj):
     """Use the base model str() function to describe a version object"""
+    if not version_obj:
+        return ""
+    else:
         return parent_class(type(version_obj)).__str__(version_obj)
 
 

ihatemoney/models.py

@@ -113,42 +113,57 @@ class Project(db.Model):
 
     @property
     def full_balance(self):
-        """Returns a triple of dicts:
+        """Returns a tuple of dicts:
 
-        - dict mapping each member to its balance
+        - dict mapping each member to its overall balance
 
-        - dict mapping each member to how much he/she should pay others
+        - dict mapping each member to its expenses (i.e. how much he/she
-          (i.e. how much he/she benefited from bills)
+          benefited from all bills, whoever actually paid)
 
-        - dict mapping each member to how much he/she should be paid by
+        - dict mapping each member to how much he/she has paid for bills
-          others (i.e. how much he/she has paid for bills)
+
+        - dict mapping each member to how much he/she has transferred
+          money to other members
+
+        - dict mapping each member to how much he/she has received money
+          from other members
+
+        balance, spent, paid, transferred, received
 
-        balance       spent        paid
         """
-        balances, should_pay, should_receive = (defaultdict(int) for time in (1, 2, 3))
+        balances, spent, paid, transferred, received = (
+            defaultdict(float) for _ in range(5)
+        )
         for bill in self.get_bills_unordered().all():
             total_weight = sum(ower.weight for ower in bill.owers)
 
             if bill.bill_type == BillType.EXPENSE:
-                should_receive[bill.payer.id] += bill.converted_amount
+                paid[bill.payer.id] += bill.converted_amount
                 for ower in bill.owers:
-                    should_pay[ower.id] += (
+                    spent[ower.id] += ower.weight * bill.converted_amount / total_weight
+
+            if bill.bill_type == BillType.REIMBURSEMENT:
+                transferred[bill.payer.id] += bill.converted_amount
+                for ower in bill.owers:
+                    received[ower.id] += (
                         ower.weight * bill.converted_amount / total_weight
                     )
 
-            if bill.bill_type == BillType.REIMBURSEMENT:
-                should_receive[bill.payer.id] += bill.converted_amount
-                for ower in bill.owers:
-                    should_receive[ower.id] -= bill.converted_amount
-
         for person in self.members:
-            balance = should_receive[person.id] - should_pay[person.id]
+            balance = (
+                paid[person.id]
+                - spent[person.id]
+                + transferred[person.id]
+                - received[person.id]
+            )
             balances[person.id] = balance
 
         return (
             balances,
-            should_pay,
+            spent,
-            should_receive,
+            paid,
+            transferred,
+            received,
         )
 
     @property
@@ -157,17 +172,19 @@ class Project(db.Model):
 
     @property
     def members_stats(self):
-        """Compute what each participant has paid
+        """Compute what each participant has spent, paid, transferred and received
 
         :return: one stat dict per participant
         :rtype list:
         """
-        balance, spent, paid = self.full_balance
+        balance, spent, paid, transferred, received = self.full_balance
         return [
             {
                 "member": member,
+                "spent": -1.0 * spent[member.id],
                 "paid": paid[member.id],
-                "spent": spent[member.id],
+                "transferred": transferred[member.id],
+                "received": -1.0 * received[member.id],
                 "balance": balance[member.id],
             }
             for member in self.active_members

ihatemoney/templates/statistics.html

@@ -1,29 +1,39 @@
-{% extends "sidebar_table_layout.html" %}
+{% extends "sidebar_table_layout.html" %} {% block sidebar %}
-
+<div id="table_overflow" class="statistics mr-md-n3">
-{% block sidebar %}
-    <div id="table_overflow" class="statistics mr-md-n3">
   {{ balance_table(show_weight=False, show_header=True) }}
-    </div>
+</div>
-{% endblock %}
+{% endblock %} {% block content %}
-
+<div class="d-flex flex-column">
-
-{% block content %}
-    <div class="d-flex flex-column">
   <table id="bill_table" class="split_bills table table-striped ml-md-n3">
-            <thead><tr><th class="d-md-none">{{ _("Who?") }}</th><th>{{ _("Paid") }}</th><th>{{ _("Spent") }}</th></tr></thead>
+    <thead>
+      <tr>
+        <th class="d-md-none">{{ _("Who?") }}</th>
+        <th>{{ _("Paid") }}</th>
+        <th>{{ _("Expenses") }}</th>
+        <th>{{ _("Direct transfer") }}</th>
+        <th>{{ _("Received") }}</th>
+      </tr>
+    </thead>
     <tbody>
       {% for stat in members_stats|sort(attribute='member.name') %}
       <tr>
         <td class="d-md-none">{{ stat.member.name }}</td>
         <td>{{ stat.paid|currency }}</td>
         <td>{{ stat.spent|currency }}</td>
+        <td>{{ stat.transferred|currency }}</td>
+        <td>{{ stat.received|currency }}</td>
       </tr>
       {% endfor %}
     </tbody>
   </table>
-        <h2>{{ _("Expenses by Month") }}</h2>
+  <h2>{{ _("Expenses by month") }}</h2>
   <table id="monthly_stats" class="table table-striped">
-            <thead><tr><th>{{ _("Period") }}</th><th>{{ _("Spent") }}</th></tr></thead>
+    <thead>
+      <tr>
+        <th>{{ _("Period") }}</th>
+        <th>{{ _("Expenses") }}</th>
+      </tr>
+    </thead>
     <tbody>
       {% for month in months %}
       <tr>
@@ -33,6 +43,6 @@
       {% endfor %}
     </tbody>
   </table>
-    </div>
+</div>
 
 {% endblock %}

ihatemoney/tests/api_test.py

@@ -814,7 +814,8 @@ class TestAPI(IhatemoneyTestCase):
             "/api/projects/raclette/statistics", headers=self.get_auth("raclette")
         )
         self.assertStatus(200, req)
-        assert [
+        received_stats = json.loads(req.data.decode("utf-8"))
+        assert received_stats == [
             {
                 "balance": 12.5,
                 "member": {
@@ -824,7 +825,9 @@ class TestAPI(IhatemoneyTestCase):
                     "weight": 1.0,
                 },
                 "paid": 25.0,
-                "spent": 12.5,
+                "received": 0.0,
+                "spent": -12.5,
+                "transferred": 0.0,
             },
             {
                 "balance": -12.5,
@@ -834,10 +837,12 @@ class TestAPI(IhatemoneyTestCase):
                     "name": "jeanne",
                     "weight": 1.0,
                 },
-                "paid": 0,
+                "paid": 0.0,
-                "spent": 12.5,
+                "received": 0.0,
+                "spent": -12.5,
+                "transferred": 0.0,
             },
-        ] == json.loads(req.data.decode("utf-8"))
+        ]
 
     def test_username_xss(self):
         # create a project

ihatemoney/tests/budget_test.py

@@ -790,15 +790,18 @@ class TestBudget(IhatemoneyTestCase):
         self.client.post("/rent/members/add", data={"name": "bob"})
         self.client.post("/rent/members/add", data={"name": "alice"})
 
-        members_ids = [m.id for m in self.get_project("rent").members]
+        everybody = [m.id for m in self.get_project("rent").members]
-        # create a bill to test reimbursement
+        bob = everybody[0]
+        alice = everybody[1]
+
+        # create a bill
         self.client.post(
             "/rent/add",
             data={
                 "date": "2022-12-12",
                 "what": "december rent",
-                "payer": members_ids[0],  # bob
+                "payer": bob,
-                "payed_for": members_ids,  # bob and alice
+                "payed_for": everybody,
                 "bill_type": "Expense",
                 "amount": "1000",
             },
@@ -806,32 +809,40 @@ class TestBudget(IhatemoneyTestCase):
         # check balance
         balance = self.get_project("rent").balance
         assert set(balance.values()), set([500 == -500])
-        # check paid
+
-        bob_paid = self.get_project("rent").full_balance[2][members_ids[0]]
+        project = self.get_project("rent")
-        alice_paid = self.get_project("rent").full_balance[2][members_ids[1]]
+        bob_paid = project.full_balance[2][bob]
+        alice_paid = project.full_balance[2][alice]
         assert bob_paid == 1000
         assert alice_paid == 0
 
-        # test reimbursement bill
+        # reimbursement bill
         self.client.post(
             "/rent/add",
             data={
                 "date": "2022-12-13",
                 "what": "reimbursement for rent",
-                "payer": members_ids[1],  # alice
+                "payer": alice,
-                "payed_for": members_ids[0],  # bob
+                "payed_for": bob,
                 "bill_type": "Reimbursement",
                 "amount": "500",
             },
         )
 
-        balance = self.get_project("rent").balance
+        balance = project.balance
         assert set(balance.values()), set([0 == 0])
-        # check paid
+
-        bob_paid = self.get_project("rent").full_balance[2][members_ids[0]]
+        # After the reimbursement, the full balance should be populated with
-        alice_paid = self.get_project("rent").full_balance[2][members_ids[1]]
+        # transfer items
-        assert bob_paid == 500
+        bob_paid = project.full_balance[2][bob]
-        assert alice_paid == 500
+        alice_paid = project.full_balance[2][alice]
+        assert bob_paid == 1000
+        assert alice_paid == 0
+
+        bob_received = project.full_balance[4][bob]
+        alice_transferred = project.full_balance[3][alice]
+        assert bob_received == 500
+        assert alice_transferred == 500
 
     def test_weighted_balance(self):
         self.post_project("raclette")
@@ -1069,14 +1080,25 @@ class TestBudget(IhatemoneyTestCase):
         assert len(project.active_months_range()) == 0
         assert len(project.monthly_stats) == 0
 
-        # Check that the "monthly expenses" table is empty
+        # Check that the "monthly expenses" table exists
+        # and is empty.
         response = self.client.get("/raclette/statistics")
-        regex = (
-            r"<table id=\"monthly_stats\".*>\s*<thead>\s*<tr>\s*<th>Period</th>\s*"
-            r"<th>Spent</th>\s*</tr>\s*</thead>\s*<tbody>\s*</tbody>\s*</table>"
-        )
-        assert re.search(regex, response.data.decode("utf-8"))
 
+        regex = (
+            r'<table id="monthly_stats" class="table table-striped">\n'
+            r"    <thead>\n"
+            r"      <tr>\n"
+            r"        <th>Period</th>\n"
+            r"        <th>Expenses</th>\n"
+            r"      </tr>\n"
+            r"    </thead>\n"
+            r"    <tbody>\n"
+            r"      \n"
+            r"    </tbody>\n"
+            r"  </table>"
+        )
+
+        assert re.search(regex, response.data.decode("utf-8"))
         # create bills
         self.client.post(
             "/raclette/add",
@@ -1115,22 +1137,29 @@ class TestBudget(IhatemoneyTestCase):
         )
 
         response = self.client.get("/raclette/statistics")
-        regex = r"<td class=\"d-md-none\">{}</td>\s*<td>{}</td>\s*<td>{}</td>"
+        html = response.data.decode("utf-8")
-        assert re.search(
+
-            regex.format("zorglub", r"\$20\.00", r"\$31\.67"),
+        def stat_entry(name, paid, spent, transferred=None, received=None):
-            response.data.decode("utf-8"),
+            return (
-        )
+                f'<td class="d-md-none">{name}</td>\n'
-        assert re.search(
+                f"        <td>{paid}</td>\n"
-            regex.format("jeanne", r"\$20\.00", r"\$5\.83"),
+                f"        <td>{spent}</td>\n"
-            response.data.decode("utf-8"),
+                # f"        <td>${spent}</td>\n"
-        )
+                # f"        <td>${transferred}</td>"
-        assert re.search(
-            regex.format("tata", r"\$0\.00", r"\$2\.50"), response.data.decode("utf-8")
-        )
-        assert re.search(
-            regex.format("pépé", r"\$0\.00", r"\$0\.00"), response.data.decode("utf-8")
             )
 
+        #         set_trace()
+
+        #         regex = (
+        #             r'\s*<td class="d-md-none">{}</td>\n'
+        #             r"\s*<td>{}</td>\n"
+        #             r"\s*<td>{}</td>\n"
+        #         )
+
+        assert stat_entry("zorglub", "$20.00", "-$31.67") in html
+        assert stat_entry("jeanne", "$20.00", "-$5.83") in html
+        assert stat_entry("tata", "$0.00", "-$2.50") in html
+        assert stat_entry("pépé", "$0.00", "-$0.00") in html
         # Check that the order of participants in the sidebar table is the
         # same as in the main table.
         order = ["jeanne", "pépé", "tata", "zorglub"]

pyproject.toml

@@ -58,7 +58,6 @@ database = [
 ]
 dev = [
     "ruff==0.8.4",
-    "flake8==5.0.4",
     "isort==5.11.5",
     "vermin==1.6.0",
     "pytest>=6.2.5",

uv.lock

@@ -439,20 +439,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/02/cc/b7e31358aac6ed1ef2bb790a9746ac2c69bcb3c8588b41616914eb106eaf/exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b", size = 16453 },
 ]
 
-[[package]]
-name = "flake8"
-version = "5.0.4"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "mccabe" },
-    { name = "pycodestyle" },
-    { name = "pyflakes" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/ad/00/9808c62b2d529cefc69ce4e4a1ea42c0f855effa55817b7327ec5b75e60a/flake8-5.0.4.tar.gz", hash = "sha256:6fbe320aad8d6b95cec8b8e47bc933004678dc63095be98528b7bdd2a9f510db", size = 145862 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/cf/a0/b881b63a17a59d9d07f5c0cc91a29182c8e8a9aa2bde5b3b2b16519c02f4/flake8-5.0.4-py2.py3-none-any.whl", hash = "sha256:7a1cf6b73744f5806ab95e526f6f0d8c01c66d7bbe349562d22dfca20610b248", size = 61897 },
-]
-
 [[package]]
 name = "flask"
 version = "2.3.3"
@@ -708,7 +694,6 @@ database = [
     { name = "pymysql" },
 ]
 dev = [
-    { name = "flake8" },
     { name = "isort" },
     { name = "pytest" },
     { name = "pytest-flask" },
@@ -729,8 +714,7 @@ requires-dist = [
     { name = "debts", specifier = ">=0.5,<1" },
     { name = "docutils", marker = "extra == 'doc'", specifier = "==0.20.1" },
     { name = "email-validator", specifier = ">=1.0,<3" },
-    { name = "flake8", marker = "extra == 'dev'", specifier = "==5.0.4" },
+    { name = "flask", specifier = ">=2,<4" },
-    { name = "flask", specifier = ">=2,<3" },
     { name = "flask-babel", specifier = ">=1.0,<4" },
     { name = "flask-cors", specifier = ">=3.0.8,<4" },
     { name = "flask-limiter", specifier = ">=2.6,<3" },
@@ -743,21 +727,21 @@ requires-dist = [
     { name = "isort", marker = "extra == 'dev'", specifier = "==5.11.5" },
     { name = "itsdangerous", specifier = ">=2,<3" },
     { name = "jinja2", specifier = ">=3,<4" },
-    { name = "myst-parser", marker = "extra == 'doc'", specifier = ">=2,<3" },
+    { name = "myst-parser", marker = "extra == 'doc'", specifier = ">=2,<5" },
     { name = "psycopg2-binary", marker = "extra == 'database'", specifier = ">=2.9.2,<2.9.9" },
-    { name = "pymysql", marker = "extra == 'database'", specifier = ">=0.9,<1.1" },
+    { name = "pymysql", marker = "extra == 'database'", specifier = ">=0.9,<1.2" },
     { name = "pytest", marker = "extra == 'dev'", specifier = ">=6.2.5" },
     { name = "pytest-flask", marker = "extra == 'dev'", specifier = ">=1.2.0" },
     { name = "python-dateutil" },
     { name = "qrcode", specifier = ">=7.1,<8" },
     { name = "requests", specifier = ">=2.25,<3" },
     { name = "ruff", marker = "extra == 'dev'", specifier = "==0.6.8" },
-    { name = "sphinx", marker = "extra == 'doc'", specifier = ">=7.0.1,<8" },
+    { name = "sphinx", marker = "extra == 'doc'", specifier = ">=7.0.1,<9" },
     { name = "sqlalchemy", specifier = ">=1.3.0,<1.5" },
     { name = "sqlalchemy-continuum", specifier = ">=1.3.12,<2" },
-    { name = "vermin", marker = "extra == 'dev'", specifier = "==1.5.2" },
+    { name = "vermin", marker = "extra == 'dev'", specifier = "==1.6.0" },
     { name = "werkzeug", specifier = ">=2,<3" },
-    { name = "wtforms", specifier = ">=2.3.3,<3.2" },
+    { name = "wtforms", specifier = ">=2.3.3,<3.3" },
     { name = "zest-releaser", marker = "extra == 'dev'", specifier = ">=6.20.1" },
 ]
 
@@ -994,15 +978,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/f6/f8/4da07de16f10551ca1f640c92b5f316f9394088b183c6a57183df6de5ae4/MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5", size = 17211 },
 ]
 
-[[package]]
-name = "mccabe"
-version = "0.7.0"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/e7/ff/0ffefdcac38932a54d2b5eed4e0ba8a408f215002cd178ad1df0f2806ff8/mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325", size = 9658 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/27/1a/1f68f9ba0c207934b35b86a8ca3aad8395a3d6dd7921c0686e23853ff5a9/mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e", size = 7350 },
-]
-
 [[package]]
 name = "mdit-py-plugins"
 version = "0.4.2"
@@ -1165,15 +1140,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/e7/56/39189b7bf61744a627c18f3a919647f7eac78d849de1f8b2ad1a5c11f824/psycopg2_binary-2.9.8-cp39-cp39-win_amd64.whl", hash = "sha256:1f279ba74f0d6b374526e5976c626d2ac3b8333b6a7b08755c513f4d380d3add", size = 1177351 },
 ]
 
-[[package]]
-name = "pycodestyle"
-version = "2.9.1"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/b6/83/5bcaedba1f47200f0665ceb07bcb00e2be123192742ee0edfb66b600e5fd/pycodestyle-2.9.1.tar.gz", hash = "sha256:2c9607871d58c76354b697b42f5d57e1ada7d261c261efac224b664affdc5785", size = 102127 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/67/e4/fc77f1039c34b3612c4867b69cbb2b8a4e569720b1f19b0637002ee03aff/pycodestyle-2.9.1-py2.py3-none-any.whl", hash = "sha256:d1735fc58b418fd7c5f658d28d943854f8a849b01a5d0a1e6f3f3fdd0166804b", size = 41493 },
-]
-
 [[package]]
 name = "pycparser"
 version = "2.22"
@@ -1183,15 +1149,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/13/a3/a812df4e2dd5696d1f351d58b8fe16a405b234ad2886a0dab9183fb78109/pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc", size = 117552 },
 ]
 
-[[package]]
-name = "pyflakes"
-version = "2.5.0"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/07/92/f0cb5381f752e89a598dd2850941e7f570ac3cb8ea4a344854de486db152/pyflakes-2.5.0.tar.gz", hash = "sha256:491feb020dca48ccc562a8c0cbe8df07ee13078df59813b83959cbdada312ea3", size = 66388 }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/dc/13/63178f59f74e53acc2165aee4b002619a3cfa7eeaeac989a9eb41edf364e/pyflakes-2.5.0-py2.py3-none-any.whl", hash = "sha256:4579f67d887f804e67edb544428f264b7b24f435b263c4614f384135cea553d2", size = 66116 },
-]
-
 [[package]]
 name = "pygments"
 version = "2.18.0"
@@ -1695,10 +1652,11 @@ wheels = [
 
 [[package]]
 name = "vermin"
-version = "1.5.2"
+version = "1.6.0"
 source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/3d/26/7b871396c33006c445c25ef7da605ecbd6cef830d577b496d2b73a554f9d/vermin-1.6.0.tar.gz", hash = "sha256:6266ca02f55d1c2aa189a610017c132eb2d1934f09e72a955b1eb3820ee6d4ef", size = 93181 }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/46/ed/420955392d9c2743c93e0418928927e34aba355c716a70c6bdba209b930f/vermin-1.5.2-py2.py3-none-any.whl", hash = "sha256:c1566ad4e1c8e1b0e98cf5f7d69b691d44a578e2ce9c5aa1d418736bc4944b32", size = 89266 },
+    { url = "https://files.pythonhosted.org/packages/2e/98/1a2ca43e6d646421eea16ec19977e2e6d1ea9079bd9d873bfae513d43f1c/vermin-1.6.0-py2.py3-none-any.whl", hash = "sha256:f1fa9ee40f59983dc40e0477eb2b1fa8061a3df4c3b2bcf349add462a5610efb", size = 90845 },
 ]
 
 [[package]]