checkpoint: validation for Project.tag

Author: clstaudt

app/demo.py

@@ -106,11 +106,12 @@ def create_fake_project(
     fake: faker.Faker,
 ):
     project_title = fake.bs()
+    project_tag = f"#{'-'.join(project_title.split(' ')[:2]).lower()}"
+
     project = Project(
         title=project_title,
-        tag="-".join(project_title.split(" ")[:2]).lower(),
+        tag=project_tag,
         description=fake.paragraph(nb_sentences=2),
-        unique_tag=project_title.split(" ")[0].lower(),
         is_completed=fake.pybool(),
         start_date=datetime.date.today(),
         end_date=datetime.date.today() + datetime.timedelta(days=80),

tuttle/model.py

@@ -1,30 +1,27 @@
 """Object model."""
 
-import email
-from typing import Optional, List, Dict, Type
-from pydantic import constr, BaseModel, condecimal
-from enum import Enum
+from typing import Dict, List, Optional, Type
+
+import re
 import datetime
+import decimal
+import email
 import hashlib
-import uuid
+import string
 import textwrap
+import uuid
+from decimal import Decimal
+from enum import Enum
 
+import pandas
 import sqlalchemy
-from sqlmodel import (
-    SQLModel,
-    Field,
-    Relationship,
-)
 
 # from pydantic import str
-import decimal
-from decimal import Decimal
-import pandas
-
-
-from .time import Cycle, TimeUnit
+from pydantic import BaseModel, condecimal, constr, validator
+from sqlmodel import Field, Relationship, SQLModel, Constraint
 
 from .dev import deprecated
+from .time import Cycle, TimeUnit
 
 
 def help(model_class):
@@ -369,8 +366,10 @@ class Project(SQLModel, table=True):
     description: str = Field(
         description="A longer description of the project", default=""
     )
-    # TODO: tag: constr(regex=r"#\S+")
-    tag: str = Field(description="A unique tag", sa_column_kwargs={"unique": True})
+    tag: str = Field(
+        description="A unique tag, starting with a # symbol",
+        sa_column_kwargs={"unique": True},
+    )
     start_date: datetime.date
     end_date: datetime.date
     is_completed: bool = Field(
@@ -393,13 +392,24 @@ class Project(SQLModel, table=True):
         sa_relationship_kwargs={"lazy": "subquery"},
     )
 
+    # PROPERTIES
     @property
     def client(self) -> Optional[Client]:
         if self.contract:
             return self.contract.client
         else:
             return None
 
+    # VALIDATORS
+    @validator("tag")
+    def validate_tag(cls, v):
+        if not re.match(r"^#\S+$", v):
+            raise ValueError(
+                "Tag must start with a # symbol and not contain any punctuation or whitespace."
+            )
+        return v
+
+    @deprecated
     def get_brief_description(self):
         if len(self.description) <= 108:
             return self.description
@@ -420,6 +430,7 @@ def is_upcoming(self) -> bool:
         today = datetime.date.today()
         return self.start_date > today
 
+    # FIXME: replace string literals with enum
     def get_status(self, default: str = "") -> str:
         if self.is_active():
             return "Active"

tuttle_tests/test_model.py

@@ -72,7 +72,7 @@ def test_user():
 def test_project():
     project = model.Project(
         title="Heating Repair",
-        tag="#heating",
+        tag="#heating-repair",
         start_date=datetime.date.today(),
         end_date=datetime.date.today() + datetime.timedelta(days=80),
     )
@@ -86,6 +86,7 @@ def test_contract():
         invoicing_contact=model.Contact(
             first_name="Central",
             last_name="Services",
+            company="Central Services",
             address=model.Address(
                 street="Down the Road",
                 number="55",