invoices page: open and preview invoices

Author: clstaudt

app/Tuttle.py

@@ -39,6 +39,7 @@
     Contract,
     Project,
     Client,
+    Invoice,
 )
 
 from tuttle_tests import demo
@@ -276,6 +277,30 @@ def update_content(self):
         self.update()
 
 
+class InvoicesPage(AppPage):
+    def __init__(
+        self,
+        app: App,
+    ):
+        super().__init__(app)
+
+    def update(self):
+        super().update()
+
+    def update_content(self):
+        super().update_content()
+        self.main_column.controls.clear()
+
+        invoices = self.app.con.query(Invoice)
+
+        for invoice in invoices:
+            self.main_column.controls.append(
+                # TODO: replace with view class
+                views.make_invoice_view(invoice, self)
+            )
+        self.update()
+
+
 class InvoicingPage(AppPage):
     """A page for the invoicing workflow."""
 
@@ -535,6 +560,13 @@ def main(page: Page):
             ),
             InvoicingPage(app),
         ),
+        (
+            NavigationRailDestination(
+                icon=icons.OUTGOING_MAIL,
+                label="Invoices",
+            ),
+            InvoicesPage(app),
+        ),
         (
             NavigationRailDestination(
                 icon=icons.SETTINGS,

app/views.py

@@ -27,6 +27,7 @@
     Client,
     Contract,
     Project,
+    Invoice,
 )
 
 
@@ -385,6 +386,51 @@ def make_client_view(
     )
 
 
+def make_invoice_view(
+    invoice: Invoice,
+    app_page,
+):
+    return Card(
+        content=Container(
+            content=Column(
+                [
+                    ListTile(
+                        leading=Icon(icons.OUTGOING_MAIL),
+                        title=Text(invoice.number),
+                        # subtitle=Text(client.company),
+                        trailing=PopupMenuButton(
+                            icon=icons.MORE_VERT,
+                            items=[
+                                PopupMenuItem(
+                                    icon=icons.VISIBILITY,
+                                    text="View",
+                                    on_click=lambda _: app_page.app.con.quicklook_invoice(
+                                        invoice
+                                    ),
+                                ),
+                                PopupMenuItem(
+                                    icon=icons.PREVIEW,
+                                    text="Open",
+                                    on_click=lambda _: app_page.app.con.open_invoice(
+                                        invoice
+                                    ),
+                                ),
+                                PopupMenuItem(
+                                    icon=icons.DELETE,
+                                    text="Delete",
+                                ),
+                            ],
+                        ),
+                    ),
+                    Column([]),
+                ]
+            ),
+            # width=400,
+            padding=10,
+        )
+    )
+
+
 def make_card(content):
     """Make a card with the given content."""
     return Card(

tuttle/controller.py

@@ -4,6 +4,8 @@
 import sys
 import datetime
 from typing import Type
+import platform
+import subprocess
 
 import pandas
 import sqlmodel
@@ -257,6 +259,8 @@ def billing(
                 period_end=period_end,
                 item_description=project.title,
             )
+            # FIXME: store timesheet
+            # self.store(timesheet)
             logger.info(f"✅ timesheet generated for {project.title}")
             try:
                 rendering.render_timesheet(
@@ -289,3 +293,40 @@ def billing(
             except Exception as ex:
                 logger.error(f"❌ Error rendering invoice for {project.title}: {ex}")
                 logger.exception(ex)
+            # finally store invoice
+            self.store(invoice)
+
+    def open_invoice(self, invoice):
+        """Open an invoice in the default application for PDF files"""
+        invoice_file_path = (
+            self.home
+            / self.preferences.invoice_dir
+            / Path(invoice.prefix)
+            / Path(f"{invoice.prefix}.pdf")
+        )
+        if invoice_file_path.exists():
+            if platform.system() == "Darwin":  # macOS
+                subprocess.call(("open", invoice_file_path))
+            elif platform.system() == "Windows":  # Windows
+                os.startfile(invoice_file_path)
+            else:  # linux variants
+                subprocess.call(("xdg-open", invoice_file_path))
+
+        else:
+            logger.error(f"invoice file {invoice_file_path} not found")
+
+    def quicklook_invoice(self, invoice):
+        """Open an invoice in the preview application for PDF files"""
+        invoice_file_path = (
+            self.home
+            / self.preferences.invoice_dir
+            / Path(invoice.prefix)
+            / Path(f"{invoice.prefix}.pdf")
+        )
+        if invoice_file_path.exists():
+            if platform.system() == "Darwin":  # macOS
+                subprocess.call(["qlmanage", "-p", invoice_file_path])
+            else:
+                logger.error(f"quicklook not supported on {platform.system()}")
+        else:
+            logger.error(f"invoice file {invoice_file_path} not found")

tuttle/model.py

@@ -339,6 +339,7 @@ class Invoice(SQLModel, table=True):
     # payment: Optional["Payment"] = Relationship(back_populates="invoice")
     # invoice items
     items: List["InvoiceItem"] = Relationship(back_populates="invoice")
+    rendered: bool = Field(default=False)
 
     #
     @property
@@ -375,6 +376,13 @@ def due_date(self):
     def client(self):
         return self.contract.client
 
+    @property
+    def prefix(self):
+        """A string that can be used as the prefix of a file name, or a folder name."""
+        client_suffix = self.client.name.lower().split()[0]
+        prefix = f"{self.number}-{client_suffix}"
+        return prefix
+
 
 class InvoiceItem(SQLModel, table=True):
     id: Optional[int] = Field(default=None, primary_key=True)

tuttle/rendering.py

@@ -93,11 +93,9 @@ def as_percentage(number):
         return html
     else:
         # write invoice html
-        client_suffix = invoice.client.name.lower().split()[0]
-        prefix = f"{invoice.number}-{client_suffix}"
-        invoice_dir = Path(out_dir) / Path(prefix)
+        invoice_dir = Path(out_dir) / Path(invoice.prefix)
         invoice_dir.mkdir(parents=True, exist_ok=True)
-        invoice_path = invoice_dir / Path(f"{prefix}.html")
+        invoice_path = invoice_dir / Path(f"{invoice.prefix}.html")
         with open(invoice_path, "w") as invoice_file:
             invoice_file.write(html)
         # copy stylsheets
@@ -126,8 +124,10 @@ def as_percentage(number):
             convert_html_to_pdf(
                 in_path=str(invoice_path),
                 css_paths=css_paths,
-                out_path=invoice_dir / Path(f"{prefix}.pdf"),
+                out_path=invoice_dir / Path(f"{invoice.prefix}.pdf"),
             )
+    # finally set the rendered flag
+    invoice.rendered = True
 
 
 def render_timesheet(