refactor: moves object_tag_class to the ObjectTag class

and removes the Closed vs Open ObjectTag subclasses, and registry.

Tests are passing, but coverage isn't at 100%

Author: pomegranited

openedx_tagging/core/tagging/api.py

@@ -15,8 +15,7 @@
 from django.db.models import QuerySet
 from django.utils.translation import gettext_lazy as _
 
-from .models import ClosedObjectTag, ObjectTag, OpenObjectTag, Tag, Taxonomy
-from .registry import cast_object_tag as _cast_object_tag
+from .models import ObjectTag, Tag, Taxonomy
 
 
 def create_taxonomy(
@@ -26,22 +25,18 @@ def create_taxonomy(
     required=False,
     allow_multiple=False,
     allow_free_text=False,
-    object_tag_class: Type = None,
 ) -> Taxonomy:
     """
     Creates, saves, and returns a new Taxonomy with the given attributes.
     """
-    taxonomy = Taxonomy(
+    taxonomy = Taxonomy.objects.create(
         name=name,
         description=description,
         enabled=enabled,
         required=required,
         allow_multiple=allow_multiple,
         allow_free_text=allow_free_text,
     )
-    if object_tag_class:
-        taxonomy.object_tag_class = object_tag_class
-    taxonomy.save()
     return taxonomy
 
 
@@ -73,21 +68,11 @@ def get_tags(taxonomy: Taxonomy) -> List[Tag]:
     return taxonomy.get_tags()
 
 
-def cast_object_tag(
-    object_tag: ObjectTag, return_subclass=False
-) -> Union[ObjectTag, None]:
+def cast_object_tag(object_tag: ObjectTag) -> ObjectTag:
     """
     Casts/copies the given object tag data into the ObjectTag subclass most appropriate for this tag.
-
-    If ``return_subclass``, this method may return None if it doesn't find a valid subclass of ObjectTag for the
-    given object_tag.
-
-    If not ``return_subclass``, then the base ObjectTag class may be returned.
     """
-    new_object_tag = _cast_object_tag(object_tag)
-    if not new_object_tag and not return_subclass:
-        new_object_tag = ObjectTag().copy(object_tag)
-    return new_object_tag
+    return object_tag.cast_object_tag()
 
 
 def resync_object_tags(object_tags: QuerySet = None) -> int:
@@ -133,13 +118,17 @@ def get_object_tags(
         tags = tags.filter(taxonomy=taxonomy)
 
     for tag in tags:
-        object_tag = cast_object_tag(tag, return_subclass=valid_only)
-        if object_tag:
+        object_tag = cast_object_tag(tag)
+        if not valid_only or object_tag.is_valid():
             yield object_tag
 
 
 def tag_object(
-    taxonomy: Taxonomy, tags: List, object_id: str, object_type: str
+    taxonomy: Taxonomy,
+    tags: List,
+    object_id: str,
+    object_type: str,
+    object_tag_class: Type = None,
 ) -> List[ObjectTag]:
     """
     Replaces the existing ObjectTag entries for the given taxonomy + object_id with the given list of tags.
@@ -181,16 +170,17 @@ def tag_object(
                 tag = None
                 value = tag_ref
 
-            object_tag = cast_object_tag(
-                ObjectTag(
-                    taxonomy=taxonomy,
-                    object_id=object_id,
-                    object_type=object_type,
-                    tag=tag,
-                    value=value,
-                    name=taxonomy.name,
-                )
+            object_tag = ObjectTag(
+                taxonomy=taxonomy,
+                object_id=object_id,
+                object_type=object_type,
+                tag=tag,
+                value=value,
+                name=taxonomy.name,
             )
+            if object_tag_class:
+                object_tag.object_tag_class = object_tag_class
+                object_tag = cast_object_tag(object_tag)
 
         object_tag.resync()
         updated_tags.append(object_tag)

openedx_tagging/core/tagging/migrations/0006_auto_20230717_0200.py

@@ -0,0 +1,31 @@
+# Generated by Django 3.2.19 on 2023-07-17 07:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("oel_tagging", "0005_auto_20230710_0140"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="ClosedObjectTag",
+        ),
+        migrations.DeleteModel(
+            name="OpenObjectTag",
+        ),
+        migrations.RemoveField(
+            model_name="taxonomy",
+            name="_object_tag_class",
+        ),
+        migrations.AddField(
+            model_name="objecttag",
+            name="_object_tag_class",
+            field=models.CharField(
+                help_text="Overrides the ObjectTag subclass used to instantiate this ObjectTag.Must be a fully-qualified module and class name.",
+                max_length=255,
+                null=True,
+            ),
+        ),
+    ]