checkpoint: demo and rendering unit tests

Author: clstaudt

Diff for: app/auth/intent.py

@@ -94,7 +94,7 @@ def get_user_if_exists(self) -> IntentResult[Optional[User]]:
         """
         result = self._data_source.get_user_()
         if not result.was_intent_successful:
-            result.error_msg = "Checking auth status failed! Please restart the app"
+            result.error_msg = "No user data found."
             result.log_message_if_any()
         return result
 

Diff for: app/invoicing/intent.py

@@ -45,10 +45,6 @@ def __init__(self, client_storage: ClientStorage):
         self._user_data_source = UserDataSource()
         self._auth_intent = AuthIntent()
 
-    def get_user(self) -> Optional[User]:
-        """Get the current user."""
-        return self._auth_intent.get_user_if_exists()
-
     def get_active_projects_as_map(self) -> Mapping[int, Project]:
         return self._projects_intent.get_active_projects_as_map()
 
@@ -95,11 +91,12 @@ def create_invoice(
         render: bool = True,
     ) -> IntentResult[Invoice]:
         """Create a new invoice from time tracking data."""
-
+        user = self._user_data_source.get_user()
         try:
             # get the time tracking data
             timetracking_data = self._timetracking_data_source.get_data_frame()
-            timesheet: Timesheet = timetracking.create_timesheet(
+            # generate timesheet
+            timesheet: Timesheet = timetracking.generate_timesheet(
                 timetracking_data,
                 project,
                 from_date,
@@ -116,7 +113,20 @@ def create_invoice(
             )
 
             if render:
-                # TODO: render timesheet
+                # render timesheet
+                try:
+                    rendering.render_timesheet(
+                        user=user,
+                        timesheet=timesheet,
+                        out_dir=Path.home() / ".tuttle" / "Timesheets",
+                        only_final=True,
+                    )
+                    logger.info(f"✅ rendered timesheet for {project.title}")
+                except Exception as ex:
+                    logger.error(
+                        f"❌ Error rendering timesheet for {project.title}: {ex}"
+                    )
+                    logger.exception(ex)
                 # render invoice
                 try:
                     rendering.render_invoice(

Diff for: app/demo.py renamed to tuttle/demo.py

@@ -32,9 +32,24 @@
 )
 
 
+def create_fake_user(
+    fake: faker.Faker,
+) -> User:
+    """
+    Create a fake user.
+    """
+    user = User(
+        name=fake.name(),
+        email=fake.email(),
+        subtitle=fake.job(),
+        VAT_number=fake.ean8(),
+    )
+    return user
+
+
 def create_fake_contact(
     fake: faker.Faker,
-):
+) -> Contact:
 
     split_address_lines = fake.address().splitlines()
     street_line = split_address_lines[0]
@@ -59,9 +74,11 @@ def create_fake_contact(
 
 
 def create_fake_client(
-    invoicing_contact: Contact,
     fake: faker.Faker,
-):
+    invoicing_contact: Optional[Contact] = None,
+) -> Client:
+    if invoicing_contact is None:
+        invoicing_contact = create_fake_contact(fake)
     client = Client(
         name=fake.company(),
         invoicing_contact=invoicing_contact,
@@ -71,12 +88,14 @@ def create_fake_client(
 
 
 def create_fake_contract(
-    client: Client,
     fake: faker.Faker,
+    client: Optional[Client] = None,
 ) -> Contract:
     """
     Create a fake contract for the given client.
     """
+    if client is None:
+        client = create_fake_client(fake)
     unit = random.choice(list(TimeUnit))
     if unit == TimeUnit.day:
         rate = fake.random_int(200, 1000)  # realistic distribution for day rates
@@ -101,9 +120,12 @@ def create_fake_contract(
 
 
 def create_fake_project(
-    contract: Contract,
     fake: faker.Faker,
-):
+    contract: Optional[Contract] = None,
+) -> Project:
+    if contract is None:
+        contract = create_fake_contract(fake)
+
     project_title = fake.bs()
     project_tag = f"#{'-'.join(project_title.split(' ')[:2]).lower()}"
 
@@ -130,8 +152,8 @@ def invoice_number_counting():
 
 
 def create_fake_timesheet(
-    project: Project,
     fake: faker.Faker,
+    project: Optional[Project] = None,
 ) -> Timesheet:
     """
     Create a fake timesheet object with random values.
@@ -143,6 +165,8 @@ def create_fake_timesheet(
     Returns:
     Timesheet: A fake timesheet object.
     """
+    if project is None:
+        project = create_fake_project(fake)
     timesheet = Timesheet(
         title=fake.bs(),
         comment=fake.paragraph(nb_sentences=2),
@@ -170,9 +194,10 @@ def create_fake_timesheet(
 
 
 def create_fake_invoice(
-    project: Project,
-    user: User,
     fake: faker.Faker,
+    project: Optional[Project] = None,
+    user: Optional[User] = None,
+    render: bool = True,
 ) -> Invoice:
     """
     Create a fake invoice object with random values.
@@ -184,6 +209,9 @@ def create_fake_invoice(
     Returns:
     Invoice: A fake invoice object.
     """
+    if project is None:
+        project = create_fake_project(fake)
+
     invoice_number = next(invoice_number_counter)
     invoice = Invoice(
         number=str(invoice_number),
@@ -215,17 +243,18 @@ def create_fake_invoice(
             invoice=invoice,
         )
 
-        try:
-            rendering.render_invoice(
-                user=user,
-                invoice=invoice,
-                out_dir=Path.home() / ".tuttle" / "Invoices",
-                only_final=True,
-            )
-            logger.info(f"✅ rendered invoice for {project.title}")
-        except Exception as ex:
-            logger.error(f"❌ Error rendering invoice for {project.title}: {ex}")
-            logger.exception(ex)
+        if render:
+            try:
+                rendering.render_invoice(
+                    user=user,
+                    invoice=invoice,
+                    out_dir=Path.home() / ".tuttle" / "Invoices",
+                    only_final=True,
+                )
+                logger.info(f"✅ rendered invoice for {project.title}")
+            except Exception as ex:
+                logger.error(f"❌ Error rendering invoice for {project.title}: {ex}")
+                logger.exception(ex)
 
     return invoice
 

Diff for: tuttle/model.py

@@ -614,7 +614,7 @@ def prefix(self):
         """A string that can be used as the prefix of a file name, or a folder name."""
         client_suffix = ""
         if self.client:
-            client_suffix = self.client.name.lower().split()[0]
+            client_suffix = "-".join(self.client.name.lower().split())
         prefix = f"{self.number}-{client_suffix}"
         return prefix
 

Diff for: tuttle/rendering.py

@@ -203,8 +203,6 @@ def as_percentage(number):
                     invoice_dir / Path(f"{invoice.prefix}.html"), final_output_path
                 )
             shutil.rmtree(invoice_dir)
-        # finally set the rendered flag
-        invoice.rendered = True
     # finally set the rendered flag
     invoice.rendered = True
 
@@ -274,6 +272,15 @@ def render_timesheet(
                 css_paths=css_paths,
                 out_path=timesheet_dir / Path(f"{prefix}.pdf"),
             )
+        if only_final:
+            final_output_path = out_dir / Path(f"{prefix}.{document_format}")
+            if document_format == "pdf":
+                shutil.move(timesheet_dir / Path(f"{prefix}.pdf"), final_output_path)
+            else:
+                shutil.move(timesheet_dir / Path(f"{prefix}.html"), final_output_path)
+            shutil.rmtree(timesheet_dir)
+    # finally set the rendered flag
+    timesheet.rendered = True
 
 
 def generate_document_thumbnail(pdf_path: str, thumbnail_width: int) -> str:

Diff for: tuttle/timetracking.py

@@ -15,7 +15,7 @@
 from .model import Project, Timesheet, TimeTrackingItem, User
 
 
-def create_timesheet(
+def generate_timesheet(
     timetracking_data: DataFrame,
     project: Project,
     period_start: datetime.date,
@@ -63,83 +63,6 @@ def create_timesheet(
     return ts
 
 
-@deprecated
-def generate_timesheet(
-    source,
-    project: Project,
-    period_start: str,
-    period_end: str = None,
-    date: datetime.date = datetime.date.today(),
-    comment: str = "",
-    group_by: str = None,
-    item_description: str = None,
-    as_dataframe: bool = False,
-) -> Timesheet:
-    if period_end:
-        period = (period_start, period_end)
-        period_str = f"{period_start} - {period_end}"
-    else:
-        period = period_start
-        period_str = f"{period_start}"
-    # convert cal to data
-    timetracking_data = None
-    if issubclass(type(source), Calendar):
-        cal = source
-        timetracking_data = cal.to_data()
-    elif isinstance(source, pandas.DataFrame):
-        timetracking_data = source
-        schema.time_tracking.validate(timetracking_data)
-    else:
-        raise ValueError(f"unknown source: {source}")
-    tag_query = f"tag == '{project.tag}'"
-    if period_end:
-        ts_table = (
-            timetracking_data.loc[period_start:period_end].query(tag_query).sort_index()
-        )
-    else:
-        ts_table = timetracking_data.loc[period_start].query(tag_query).sort_index()
-    # convert all-day entries
-    ts_table.loc[ts_table["all_day"], "duration"] = (
-        project.contract.unit.to_timedelta() * project.contract.units_per_workday
-    )
-    if item_description:
-        # TODO: extract item description from calendar
-        ts_table["description"] = item_description
-    # assert not ts_table.empty
-    if as_dataframe:
-        return ts_table
-
-    # TODO: grouping
-    if group_by is None:
-        pass
-    elif group_by == "day":
-        ts_table = ts_table.reset_index()
-        ts_table = ts_table.groupby(by=ts_table["begin"].dt.date).agg(
-            {
-                "title": "first",
-                "tag": "first",
-                "description": "first",
-                "duration": "sum",
-            }
-        )
-    elif group_by == "week":
-        raise NotImplementedError("TODO")
-    else:
-        raise ValueError(f"unknown group_by argument: {group_by}")
-
-    ts = Timesheet(
-        title=f"{project.title} - {period_str}",
-        period=period,
-        project=project,
-        comment=comment,
-        date=date,
-    )
-    for record in ts_table.reset_index().to_dict("records"):
-        ts.items.append(TimeTrackingItem(**record))
-
-    return ts
-
-
 def export_timesheet(
     timesheet: Timesheet,
     path: str,

Diff for: tuttle_tests/test_demo.py

@@ -0,0 +1,64 @@
+import faker
+import pytest
+
+from tuttle.model import Contact, Client, Contract, Project, User
+from tuttle import demo
+
+
+@pytest.fixture
+def fake():
+    return faker.Faker()
+
+
+def test_create_fake_user(fake):
+    user = demo.create_fake_user(fake)
+    assert user.name is not None
+    assert user.email is not None
+    assert user.subtitle is not None
+    assert user.VAT_number is not None
+
+
+def test_create_fake_contact(fake):
+    contact = demo.create_fake_contact(fake)
+    assert isinstance(contact, Contact)
+    assert contact.first_name is not None
+    assert contact.last_name is not None
+    assert contact.email is not None
+    assert contact.company is not None
+    assert contact.address is not None
+
+
+def test_create_fake_client(fake):
+    client = demo.create_fake_client(fake)
+    assert isinstance(client, Client)
+    assert client.name is not None
+    assert client.invoicing_contact is not None
+
+
+def test_create_fake_contract(fake):
+    contract = demo.create_fake_contract(fake)
+    assert isinstance(contract, Contract)
+    assert contract.title is not None
+    assert contract.client is not None
+    assert contract.signature_date is not None
+    assert contract.start_date is not None
+    assert contract.rate is not None
+    assert contract.currency is not None
+    assert contract.VAT_rate is not None
+    assert contract.unit is not None
+    assert contract.units_per_workday is not None
+    assert contract.volume is not None
+    assert contract.term_of_payment is not None
+    assert contract.billing_cycle is not None
+
+
+def test_create_fake_project(fake):
+    project = demo.create_fake_project(fake)
+    assert isinstance(project, Project)
+    assert project.title is not None
+    assert project.tag is not None
+    assert project.description is not None
+    assert project.is_completed is not None
+    assert project.start_date is not None
+    assert project.end_date is not None
+    assert project.contract is not None