feat: centralize duplicated OfficialCollection and ExternalLink components

Adds a new `components/` directory to the view models directory which is intended to house shared components. Refactors the official collection component into the `collections` view model folder, which is more appropriate given the content.

Author: bencap

src/mavedb/view_models/collection.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import Any, Sequence, Optional
+from typing import Any, Optional, Sequence
 
 from pydantic import Field, model_validator
 
@@ -132,3 +132,14 @@ class Collection(SavedCollection):
 # NOTE: Coupled to ContributionRole enum
 class AdminCollection(Collection):
     pass
+
+
+# Properties to return for official collections
+class OfficialCollection(BaseModel):
+    badge_name: str
+    name: str
+    urn: str
+
+    class Config:
+        arbitrary_types_allowed = True
+        from_attributes = True

src/mavedb/view_models/components/external_link.py

@@ -0,0 +1,15 @@
+from typing import Optional
+
+from mavedb.view_models.base.base import BaseModel
+
+
+class ExternalLink(BaseModel):
+    """
+    Represents an external hyperlink for view models.
+
+    Attributes:
+        url (Optional[str]): Fully qualified URL for the external resource.
+            May be None if no link is available or applicable.
+    """
+
+    url: Optional[str] = None

src/mavedb/view_models/experiment.py

@@ -13,6 +13,8 @@
 from mavedb.lib.validation.utilities import is_null
 from mavedb.view_models import record_type_validator, set_record_type
 from mavedb.view_models.base.base import BaseModel
+from mavedb.view_models.collection import OfficialCollection
+from mavedb.view_models.components.external_link import ExternalLink
 from mavedb.view_models.contributor import Contributor, ContributorCreate
 from mavedb.view_models.doi_identifier import (
     DoiIdentifier,
@@ -37,20 +39,6 @@
 from mavedb.view_models.user import SavedUser, User
 
 
-class ExternalLink(BaseModel):
-    url: Optional[str] = None
-
-
-class OfficialCollection(BaseModel):
-    badge_name: str
-    name: str
-    urn: str
-
-    class Config:
-        arbitrary_types_allowed = True
-        from_attributes = True
-
-
 class ExperimentBase(BaseModel):
     title: str
     short_description: str

src/mavedb/view_models/score_set.py

@@ -19,6 +19,8 @@
 from mavedb.models.enums.processing_state import ProcessingState
 from mavedb.view_models import record_type_validator, set_record_type
 from mavedb.view_models.base.base import BaseModel
+from mavedb.view_models.collection import OfficialCollection
+from mavedb.view_models.components.external_link import ExternalLink
 from mavedb.view_models.contributor import Contributor, ContributorCreate
 from mavedb.view_models.doi_identifier import (
     DoiIdentifier,
@@ -49,20 +51,6 @@
 UnboundedRange = tuple[Union[float, None], Union[float, None]]
 
 
-class ExternalLink(BaseModel):
-    url: Optional[str] = None
-
-
-class OfficialCollection(BaseModel):
-    badge_name: str
-    name: str
-    urn: str
-
-    class Config:
-        arbitrary_types_allowed = True
-        from_attributes = True
-
-
 class ScoreSetBase(BaseModel):
     """Base class for score set view models."""
 

tests/helpers/constants.py

@@ -544,6 +544,7 @@
     "urn": None,
     "experimentSetUrn": None,
     "officialCollections": [],
+    "externalLinks": {},
     "numScoreSets": 0,
 }