feat: add subject and description fields to invoices

Author: lajp

migrations/2024-05-31-143014_add_invoice_fields/down.sql

@@ -0,0 +1,5 @@
+-- This file should undo anything in `up.sql`
+ALTER TABLE invoices
+DROP COLUMN subject;
+ALTER TABLE invoices
+DROP COLUMN description;

migrations/2024-05-31-143014_add_invoice_fields/up.sql

@@ -0,0 +1,6 @@
+-- Your SQL goes here
+ALTER TABLE invoices
+ADD COLUMN subject VARCHAR(128) NOT NULL DEFAULT '';
+ALTER TABLE invoices
+ADD COLUMN description VARCHAR(512) NOT NULL DEFAULT '';
+

src/api/invoices.rs

@@ -42,6 +42,10 @@ pub struct CreateInvoice {
     // TODO: maybe validate with https://crates.io/crates/iban_validate/
     #[garde(byte_length(max = 128))]
     pub bank_account_number: String,
+    #[garde(byte_length(min = 1, max = 128))]
+    pub subject: String,
+    #[garde(byte_length(max = 512))]
+    pub description: String,
     /// The rows of the invoice
     #[garde(length(min = 1), dive)]
     pub rows: Vec<CreateInvoiceRow>,
@@ -93,6 +97,8 @@ pub struct PopulatedInvoice {
     pub recipient_name: String,
     pub recipient_email: String,
     pub bank_account_number: String,
+    pub subject: String,
+    pub description: String,
     pub address: Address,
     pub rows: Vec<InvoiceRow>,
     pub attachments: Vec<Attachment>,
@@ -111,6 +117,8 @@ impl PopulatedInvoice {
             creation_time: invoice.creation_time,
             recipient_name: invoice.recipient_name,
             recipient_email: invoice.recipient_email,
+            subject: invoice.subject,
+            description: invoice.description,
             address,
             bank_account_number: invoice.bank_account_number,
             rows,

src/database/invoices.rs

@@ -44,6 +44,8 @@ impl DatabaseConnection {
             address_id: address.id,
             recipient_name: invoice.recipient_name,
             recipient_email: invoice.recipient_email,
+            subject: invoice.subject,
+            description: invoice.description,
             bank_account_number: invoice.bank_account_number,
         };
 

src/models.rs

@@ -78,6 +78,11 @@ pub struct Invoice {
     /// A back account number can be at most 128 characters
     pub bank_account_number: String,
     pub address_id: i32,
+    /// The subject of the invoice, has to be between 1 and 128 characters long
+    pub subject: String,
+    /// The description of the invoice, containing e.g. reasons for the purchase
+    /// can be at most 512 characters
+    pub description: String,
 }
 
 impl Invoice {
@@ -98,6 +103,8 @@ pub struct NewInvoice {
     pub recipient_name: String,
     pub recipient_email: String,
     pub bank_account_number: String,
+    pub subject: String,
+    pub description: String,
 }
 
 /// A single row of an invoice

src/schema.rs

@@ -57,6 +57,10 @@ diesel::table! {
         #[max_length = 128]
         bank_account_number -> Varchar,
         address_id -> Int4,
+        #[max_length = 128]
+        subject -> Varchar,
+        #[max_length = 512]
+        description -> Varchar,
     }
 }
 

src/tests/invoices.rs

@@ -52,6 +52,8 @@ async fn create() {
         attachments: vec![],
         recipient_name: "Velkoja".into(),
         recipient_email: "velkoja@velat.com".into(),
+        subject: "Pelikonsoleita".into(),
+        description: "Ostettiin pelikonsoleita ku ei ollu tarpeeks".into(),
         address: NewAddress {
             street: "Otakaari 18A 69".into(),
             city: "Espoo".into(),
@@ -90,6 +92,8 @@ async fn create_list_all() {
             zip: "02jotain".into(),
         },
         bank_account_number: "ei ole".into(),
+        subject: "Pelikonsoleita".into(),
+        description: "Ostettiin pelikonsoleita ku ei ollu tarpeeks".into(),
         rows: vec![
             CreateInvoiceRow {
                 product: String::from("pleikkari"),

templates/invoice.typ

@@ -4,7 +4,7 @@
   ],
   footer: [
     Laskut hyväksytään Tietokillan hallituksen kokouksissa.
-    Ongelmatapauksissa ota yhteyttä rahastonhoitajaan: rahastonhoitaja\@tietokilta.fi
+    Ongelmatapauksissa ota yhteyttä rahastonhoitajaan: #link("mailto:rahastonhoitaja@tietokilta.fi").
     Tarkemmat yhteystiedot löydät killan sivuilta.
   ],
 )
@@ -60,8 +60,8 @@
 
 == Tietokilta
 
-*Aihe*: puuttuu \
-*Perustelut*: puuttuu \
+*Aihe*: #data.subject \
+*Perustelut*: #data.description \
 
 === Erittely
 #let rows = data.rows.map(it => ([#it.quantity #it.unit], [#it.product],
@@ -74,9 +74,7 @@
 
 *IBAN-tilinumero*: #data.bank_account_number \
 
-=== Muuta:
-
-==== LIITTEET:
+=== LIITTEET:
 #data.attachments.map(a => a.filename).join(",")
 
 #for file in data.attachments {