feat: view timesheet associates with invoice

Author: clstaudt

Diff for: app/invoicing/data_source.py

@@ -5,7 +5,7 @@
 from core.abstractions import SQLModelDataSourceMixin
 from core.intent_result import IntentResult
 
-from tuttle.model import Invoice, Project
+from tuttle.model import Invoice, Project, Timesheet
 
 
 class InvoicingDataSource(SQLModelDataSourceMixin):
@@ -74,6 +74,10 @@ def save_invoice(
         """Creates or updates an invoice with given invoice and project info"""
         self.store(invoice)
 
+    def save_timesheet(self, timesheet: Timesheet):
+        """Creates or updates a timesheet"""
+        self.store(timesheet)
+
     def get_last_invoice(self) -> IntentResult[Invoice]:
         """Get the last invoice.
 
@@ -100,3 +104,23 @@ def get_last_invoice(self) -> IntentResult[Invoice]:
                 log_message=f"Exception raised @InvoicingDataSource.get_last_invoice_number {e.__class__.__name__}",
                 exception=e,
             )
+
+    def get_timesheet_for_invoice(self, invoice: Invoice) -> Timesheet:
+        """Get the timesheet associated with an invoice
+
+        Args:
+            invoice (Invoice): the invoice to get the timesheet for
+
+        Returns:
+            Optional[Timesheet]: the timesheet associated with the invoice
+        """
+        if not len(invoice.timesheets) > 0:
+            raise ValueError(
+                f"invoice {invoice.id} has no timesheets associated with it"
+            )
+        if len(invoice.timesheets) > 1:
+            raise ValueError(
+                f"invoice {invoice.id} has more than one timesheet associated with it: {invoice.timesheets}"
+            )
+        timesheet = invoice.timesheets[0]
+        return timesheet

Diff for: app/invoicing/intent.py

@@ -95,6 +95,7 @@ def create_invoice(
         render: bool = True,
     ) -> IntentResult[Invoice]:
         """Create a new invoice from time tracking data."""
+        logger.info(f"⚙️ Creating invoice for {project.title}...")
         user = self._user_data_source.get_user()
         try:
             # get the time tracking data
@@ -145,7 +146,12 @@ def create_invoice(
                 except Exception as ex:
                     logger.error(f"❌ Error rendering invoice for {project.title}: {ex}")
                     logger.exception(ex)
-            # save invoice
+
+            # save invoice and timesheet
+            timesheet.invoice = invoice
+            assert timesheet.invoice is not None
+            assert len(invoice.timesheets) == 1
+            # self._invoicing_data_source.save_timesheet(timesheet)
             self._invoicing_data_source.save_invoice(invoice)
             return IntentResult(
                 was_intent_successful=True,
@@ -334,6 +340,29 @@ def view_invoice(self, invoice: Invoice) -> IntentResult[None]:
                 error_msg=error_message,
             )
 
+    def view_timesheet_for_invoice(self, invoice: Invoice) -> IntentResult[None]:
+        """Attempts to open the timesheet for the invoice in the default pdf viewer"""
+        try:
+            timesheet = self._invoicing_data_source.get_timesheet_for_invoice(invoice)
+            timesheet_path = (
+                Path().home() / ".tuttle" / "Timesheets" / f"{timesheet.prefix}.pdf"
+            )
+            preview_pdf(timesheet_path)
+            return IntentResult(was_intent_successful=True)
+        except ValueError as ve:
+            logger.error(f"❌ Error getting timesheet for invoice: {ve}")
+            logger.exception(ve)
+            return IntentResult(was_intent_successful=False, error_msg=str(ve))
+        except Exception as ex:
+            # display the execption name in the error message
+            error_message = f"❌ Failed to open the timesheet: {ex.__class__.__name__}"
+            logger.error(error_message)
+            logger.exception(ex)
+            return IntentResult(
+                was_intent_successful=False,
+                error_msg=error_message,
+            )
+
     def generate_invoice_number(
         self,
         invoice_date: Optional[date] = None,

Diff for: app/invoicing/view.py

@@ -216,6 +216,7 @@ def refresh_invoices(self):
                     on_delete_clicked=self.on_delete_invoice_clicked,
                     on_mail_invoice=self.on_mail_invoice,
                     on_view_invoice=self.on_view_invoice,
+                    on_view_timesheet=self.on_view_timesheet,
                     toggle_paid_status=self.toggle_paid_status,
                     toggle_cancelled_status=self.toggle_cancelled_status,
                     toggle_sent_status=self.toggle_sent_status,
@@ -241,6 +242,12 @@ def on_view_invoice(self, invoice: Invoice):
         if not result.was_intent_successful:
             self.show_snack(result.error_msg, is_error=True)
 
+    def on_view_timesheet(self, invoice: Invoice):
+        """Called when the user clicks view in the context menu of an invoice"""
+        result = self.intent.view_timesheet_for_invoice(invoice)
+        if not result.was_intent_successful:
+            self.show_snack(result.error_msg, is_error=True)
+
     def on_delete_invoice_clicked(self, invoice: Invoice):
         """Called when the user clicks delete in the context menu of an invoice"""
         if self.editor is not None:
@@ -425,6 +432,7 @@ def __init__(
         on_delete_clicked,
         on_mail_invoice,
         on_view_invoice,
+        on_view_timesheet,
         toggle_paid_status,
         toggle_sent_status,
         toggle_cancelled_status,
@@ -433,6 +441,7 @@ def __init__(
         self.invoice = invoice
         self.on_delete_clicked = on_delete_clicked
         self.on_view_invoice = on_view_invoice
+        self.on_view_timesheet = on_view_timesheet
         self.on_mail_invoice = on_mail_invoice
         self.toggle_paid_status = toggle_paid_status
         self.toggle_sent_status = toggle_sent_status
@@ -504,6 +513,11 @@ def build(self):
                         txt="View",
                         on_click=lambda e: self.on_view_invoice(self.invoice),
                     ),
+                    views.TPopUpMenuItem(
+                        icon=icons.VISIBILITY_OUTLINED,
+                        txt="View Timesheet ",
+                        on_click=lambda e: self.on_view_timesheet(self.invoice),
+                    ),
                     views.TPopUpMenuItem(
                         icon=icons.OUTGOING_MAIL,
                         txt="Send",

Diff for: tuttle/demo.py

@@ -137,7 +137,7 @@ def create_fake_project(
     if contract is None:
         contract = create_fake_contract(fake)
 
-    project_title = fake.bs()
+    project_title = fake.bs().replace("/", "-")
     project_tag = f"#{'-'.join(project_title.split(' ')[:2]).lower()}"
 
     project = Project(
@@ -179,9 +179,11 @@ def create_fake_timesheet(
     if project is None:
         project = create_fake_project(fake)
     timesheet = Timesheet(
-        title=fake.bs(),
+        title=fake.bs().replace("/", "-"),
         comment=fake.paragraph(nb_sentences=2),
         date=datetime.date.today(),
+        period_start=datetime.date.today() - datetime.timedelta(days=30),
+        period_end=datetime.date.today(),
         project=project,
     )
     number_of_items = fake.random_int(min=1, max=5)
@@ -257,34 +259,37 @@ def create_fake_invoice(
             invoice=invoice,
         )
 
-        # an invoice is created together with a timesheet. For the sake of simplicity, timesheet and invoice items are not linked.
-        timesheeet = create_fake_timesheet(fake, project)
-
-        if render:
-            # render 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)
-            # render timesheet
-            try:
-                rendering.render_timesheet(
-                    user=user,
-                    timesheet=timesheeet,
-                    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)
+    # an invoice is created together with a timesheet. For the sake of simplicity, timesheet and invoice items are not linked.
+    timesheet = create_fake_timesheet(fake, project)
+    # attach timesheet to invoice
+    timesheet.invoice = invoice
+    assert len(invoice.timesheets) == 1
+
+    if render:
+        # render 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)
+        # 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)
 
     return invoice
 

Diff for: tuttle/invoicing.py

@@ -37,8 +37,7 @@ def generate_invoice(
             VAT_rate=contract.VAT_rate,
             description=timesheet.title,
         )
-        # attach timesheet to invoice
-        timesheet.invoice = invoice
+
     # TODO: replace with auto-incrementing numbers
     invoice.generate_number(counter=counter)
     return invoice

Diff for: tuttle/model.py

@@ -409,6 +409,9 @@ class Project(SQLModel, table=True):
         sa_relationship_kwargs={"lazy": "subquery"},
     )
 
+    def __repr__(self):
+        return f"Project(id={self.id}, title={self.title}, tag={self.tag})"
+
     # PROPERTIES
     @property
     def client(self) -> Optional[Client]:
@@ -482,6 +485,12 @@ class Timesheet(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)
     title: str
     date: datetime.date = Field(description="The date of creation of the timesheet")
+    period_start: datetime.date = Field(
+        description="The start date of the period covered by the timesheet."
+    )
+    period_end: datetime.date = Field(
+        description="The end date of the period covered by the timesheet."
+    )
 
     # Timesheet n:1 Project
     project_id: Optional[int] = Field(default=None, foreign_key="project.id")
@@ -509,6 +518,13 @@ class Timesheet(SQLModel, table=True):
     # class Config:
     #     arbitrary_types_allowed = True
 
+    def __repr__(self):
+        return f"Timesheet(id={self.id}, tag={self.project.tag}, period_start={self.period_start}, period_end={self.period_end})"
+
+    @property
+    def prefix(self) -> str:
+        return f"{self.project.tag[1:]}-{self.period_start.strftime('%Y-%m-%d')}-{self.period_end.strftime('%Y-%m-%d')}"
+
     @property
     def total(self) -> datetime.timedelta:
         """Sum of time in timesheet."""

Diff for: tuttle/rendering.py

@@ -211,7 +211,7 @@ def render_timesheet(
     user: User,
     timesheet: Timesheet,
     out_dir,
-    document_format: str = "html",
+    document_format: str = "pdf",
     style: str = "anvil",
     only_final: bool = False,
 ):
@@ -238,7 +238,7 @@ def render_timesheet(
         return html
     else:
         # write invoice html
-        prefix = f"Timesheet-{timesheet.title}"
+        prefix = timesheet.prefix
         timesheet_dir = Path(out_dir) / Path(prefix)
         timesheet_dir.mkdir(parents=True, exist_ok=True)
         timesheet_path = timesheet_dir / Path(f"{prefix}.html")

Diff for: tuttle/timetracking.py

@@ -52,7 +52,8 @@ def generate_timesheet(
     period_str = f"{period_start} - {period_end}"
     ts = Timesheet(
         title=f"{project.title} - {period_str}",
-        # period=period,
+        period_start=period_start,
+        period_end=period_end,
         project=project,
         comment=comment,
         date=date,

Diff for: tuttle_tests/test_rendering.py

@@ -50,7 +50,7 @@ def test_creates_only_final_file(self, fake):
                 only_final=only_final,
             )
 
-            prefix = f"Timesheet-{timesheet.title}"
+            prefix = timesheet.prefix
             pdf_file = Path(out_dir) / Path(f"{prefix}.pdf")
             assert pdf_file.is_file()