Merge pull request #225 from tuttle-dev/dev

Dev -> main

Author: clstaudt

CONTRIBUTING.md

@@ -146,3 +146,40 @@ $ git push --tags
 ```
 
 Travis will then deploy to PyPI if tests pass.
+
+
+## Architecture Notes
+
+**The View**
+
+- builds Ui,
+- reacts to data changes (by updating the Ui)
+- listens for events and forwards them to the Intent
+
+**The Intent**
+
+- receives events
+- if some data is affected by the event, figure out which data source corresponds to that data
+- transforms the event data to the data format required by the data source
+- transform returned data source data to the data format required by the Ui
+- else, no data is affected by the event, handle the event (often using a util class).
+- an example of this is sending invoices by mail.
+
+**The Model (a.k.a data layer)**
+
+- defines the entity
+- define the entity source (file, remote API, local database, in-memory cache, etc)
+- if a relational database is used, define the entity's relationship to other entities
+- maintain the integrity of that relation (conflict strategies for insert operations are defined here, and integrity errors are thrown here, for example)
+- defines classes that manipulate this source (open, read, write, ....)
+
+
+As you go outer in layers (the outmost layer is the Ui, the innermost is the data layer), communication can occur down_ward across layers, and horizontally (for lack of a better word) BUT a layer cannot skip the layer directly below it. This is to say:
+
+* Data sources can communicate with each other. Thus `ClientDatasource.delete_client` can call. `ContractDatasource.get_contract ` for example.
+
+* Intents can communicate with each other, and with any data source. Thus `ClientIntent` can call `ContractIntent` or  `ContractDatasource` for example.
+The Ui can communicate with any intent (though often the Ui is tied to only a single intent, and the intent can instead call the 'other' intent). But it cannot communicate with a data source -> this would violate the do not skip layers rule.
+An inner layer cannot have a dependency on the layer above it. Thus an intent cannot instantiate a Ui class, and a data source cannot instantiate an Intent class.
+
+![](assets/images/mvi-concept.png)

README.md

@@ -112,6 +112,17 @@ $ pytest
 $ python app/app.py
 ```
 
+## Installation
+
+### macOS
+
+### Linux
+
+### Windows
+
+1. Requires [GTK](https://www.gtk.org).
+
+
 ## Build
 
 To build an app bundle, run

assets/images/mvi-concept.png

@@ -9,7 +9,6 @@ babel
 loguru
 pandera
 weasyprint
-matplotlib
 faker
 PyPDF2
 flet

requirements.txt

@@ -619,24 +619,14 @@ def sum(self) -> Decimal:
     def VAT_total(self) -> Decimal:
         """Sum of VAT over all invoice items."""
         s = sum(item.VAT for item in self.items)
-        return Decimal(s)
+        return Decimal(round(s, 2))
 
     @property
     def total(self) -> Decimal:
         """Total invoiced amount."""
         t = self.sum + self.VAT_total
         return Decimal(t)
 
-    def generate_number(self, pattern=None, counter=None) -> str:
-        """Generate an invoice number"""
-        date_prefix = self.date.strftime("%Y-%m-%d")
-        # suffix = hashlib.shake_256(str(uuid.uuid4()).encode("utf-8")).hexdigest(2)
-        # TODO: auto-increment suffix for invoices generated on the same day
-        if counter is None:
-            counter = 1
-        suffix = f"{counter:02}"
-        self.number = f"{date_prefix}-{suffix}"
-
     @property
     def due_date(self) -> Optional[datetime.date]:
         """Date until which payment is due."""

tuttle/model.py

@@ -1,6 +1,7 @@
 """Tests for the invoice module."""
 
 import datetime
+from decimal import Decimal
 from pathlib import Path
 
 from tuttle import invoicing, timetracking, rendering
@@ -12,36 +13,39 @@ def test_invoice():
     the_invoice = Invoice(
         number="27B-6",
         date=datetime.date.today(),
-        due_date=datetime.date.today() + datetime.timedelta(days=14),
-        sent_date=datetime.date.today(),
         sent=True,
-        paid="foo",
+        paid=False,
         cancelled=False,
     )
 
     item_1 = InvoiceItem(
         invoice=the_invoice,
-        date=datetime.date.today(),
+        start_date=datetime.date.today(),
+        end_date=datetime.date.today(),
         quantity=10,
         unit="hours",
-        unit_price=50,
+        unit_price=Decimal(50),
         description="work work",
-        VAT_rate=0.20,
+        VAT_rate=Decimal(0.20),
     )
 
     item_2 = InvoiceItem(
         invoice=the_invoice,
-        date=datetime.date.today(),
+        start_date=datetime.date.today(),
+        end_date=datetime.date.today(),
         quantity=10,
         unit="hours",
-        unit_price=100,
+        unit_price=Decimal(100),
         description="work work",
-        VAT_rate=0.20,
+        VAT_rate=Decimal(0.20),
     )
 
-    assert the_invoice.sum == 1500
-    assert the_invoice.VAT_total == 300
-    assert the_invoice.total == 1800
+    assert item_1.invoice == the_invoice
+    assert item_2.invoice == the_invoice
+
+    assert the_invoice.sum == Decimal(1500)
+    assert the_invoice.VAT_total == Decimal(300)
+    assert the_invoice.total == Decimal(1800)
 
 
 def test_generate_invoice(

tuttle_tests/test_invoice.py

@@ -64,22 +64,6 @@ def test_model_creation():
             pass
 
 
-def test_user():
-    user = model.User(
-        name="Archibald Tuttle",
-        subtitle="Heating Engineer",
-        email="[email protected]",
-    )
-
-    icloud_account = model.ICloudAccount(
-        user_name=user.email,
-    )
-
-    user.icloud_account = icloud_account
-
-    assert icloud_account.user.name == "Archibald Tuttle"
-
-
 class TestUser:
     """Tests for the User model."""