Address comments

* Remove 'ListField' class and create standalone hash method
* Add additional tests for hash and dedupe methods

tests/test_models.py

@@ -373,6 +373,30 @@ def test_timdex_record_not_a_list_raises_error(timdex_record_required_fields):
         timdex_record_required_fields.dates = "test"
 
 
+def test_timdex_object_hash_diff_if_diff_class():
+    """
+    Asserts that TIMDEX objects of different class types
+    with similar attributes and attribute values will
+    be assigned different hashes and declared not equal.
+    """
+    identifier = timdex.Identifier(value="x", kind="y")
+    alternate_title = timdex.AlternateTitle(value="x", kind="y")
+    assert identifier != alternate_title
+    assert identifier.__hash__() != alternate_title.__hash__()
+
+
+def test_timdex_object_hash_same_if_same_class():
+    """
+    Asserts that TIMDEX objects of different class types
+    with similar attributes and attribute values will
+    be assigned the same hash and declared equal.
+    """
+    identifier_0 = timdex.Identifier(value="x", kind="y")
+    identifier_1 = timdex.Identifier(value="x", kind="y")
+    assert identifier_0 == identifier_1
+    assert identifier_0.__hash__() == identifier_1.__hash__()
+
+
 def test_timdex_record_dedupe_alternate_titles(timdex_record_required_fields):
     timdex_record_required_fields.alternate_titles = [
         timdex.AlternateTitle(value="My Octopus Teacher"),
@@ -607,3 +631,22 @@ def test_timdex_record_dedupe_summary(timdex_record_required_fields):
     assert timdex_record_required_fields.summary == [
         "Mitochondria is the powerhouse of the cell."
     ]
+
+
+def test_timdex_dedupes_correctly_if_diff_class():
+    items = [
+        timdex.Identifier(value="x", kind="y"),
+        timdex.AlternateTitle(value="x", kind="y"),
+    ]
+    assert timdex.dedupe(items) == [
+        timdex.Identifier(value="x", kind="y"),
+        timdex.AlternateTitle(value="x", kind="y"),
+    ]
+
+
+def test_timdex_dedupes_correctly_if_same_class():
+    items = [
+        timdex.Identifier(value="x", kind="y"),
+        timdex.Identifier(value="x", kind="y"),
+    ]
+    assert timdex.dedupe(items) == [timdex.Identifier(value="x", kind="y")]

transmogrifier/models.py

@@ -35,12 +35,6 @@ def list_of(item_type: Any) -> Callable:  # noqa: ANN401
     )
 
 
-def dedupe(item_list: list | Any) -> list | None:  # noqa: ANN401
-    if not isinstance(item_list, list):
-        return item_list
-    return list(dict.fromkeys(item_list))
-
-
 def not_empty(
     _instance: "TimdexRecord", attribute: "attrs.Attribute", value: "list"
 ) -> None:
@@ -49,25 +43,42 @@ def not_empty(
         raise ValueError(message)
 
 
-@define
-class ListField:
-    def __hash__(self) -> int:
-        """Hash method to create unique identifier for Location objects."""
-        values = tuple(
-            [
-                tuple(attrib) if isinstance(attrib, list) else attrib
-                for attrib in attrs.astuple(self)
-            ]
-        )
-        return hash(values)
+def timdex_object_hash(timdex_object: Any) -> int:  # noqa: ANN401
+    """Hash method for TIMDEX objects.
+
+    This method is set as the hash method for TIMDEX objects.
+    The method generates a unique hash using a tuple
+    comprised of the class name and attribute values.
+    By making TIMDEX objects hashable, dedupe methods
+    can be applied to a list of TIMDEX objects.
+    """
+    values = tuple(type(timdex_object).__name__)
+    values += tuple(
+        [
+            tuple(attrib) if isinstance(attrib, list) else attrib
+            for attrib in attrs.astuple(timdex_object)
+        ]
+    )
+    return hash(values)
+
+
+def dedupe(item_list: list | Any) -> list | None:  # noqa: ANN401
+    """Deduplication method for list of items.
+
+    This method is used as a converter function for list fields
+    in the TimdexRecord model.
+    """
+    if not isinstance(item_list, list):
+        return item_list
+    return list(dict.fromkeys(item_list))
 
 
 @define
 class AlternateTitle:
     value: str = field(validator=instance_of(str))  # Required subfield
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -80,7 +91,7 @@ class Contributor:
         default=None, validator=optional(instance_of(bool))
     )
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -101,7 +112,7 @@ class Date:
     )
     value: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -116,7 +127,7 @@ class Funder:
     award_number: str | None = field(default=None, validator=optional(instance_of(str)))
     award_uri: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -127,15 +138,15 @@ class Holding:
     location: str | None = field(default=None, validator=optional(instance_of(str)))
     note: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
 class Identifier:
     value: str = field(validator=instance_of(str))  # Required subfield
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -145,7 +156,7 @@ class Link:
     restrictions: str | None = field(default=None, validator=optional(instance_of(str)))
     text: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -154,15 +165,15 @@ class Location:
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
     geoshape: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
 class Note:
     value: list[str] = field(validator=list_of(str))  # Required subfield
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -171,7 +182,7 @@ class Publisher:
     date: str | None = field(default=None, validator=optional(instance_of(str)))
     location: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -181,7 +192,7 @@ class RelatedItem:
     relationship: str | None = field(default=None, validator=optional(instance_of(str)))
     uri: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
@@ -190,15 +201,15 @@ class Rights:
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
     uri: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define
 class Subject:
     value: list[str] = field(validator=list_of(str))  # Required subfield
     kind: str | None = field(default=None, validator=optional(instance_of(str)))
 
-    __hash__ = ListField.__hash__
+    __hash__ = timdex_object_hash
 
 
 @define