Merge pull request open5e#654 from open5e/652-search-functionality-should-be-broken-into-its-own-app

calumbell · web-flow · commit 8a3f15a9dd49 · 2025-03-21T10:11:04.000Z
Refactor search into its own app.
diff --git a/api_v2/migrations/0026_delete_searchresult.py b/api_v2/migrations/0026_delete_searchresult.py
@@ -0,0 +1,16 @@
+# Generated by Django 5.1.2 on 2025-03-13 15:23
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0025_creature_initiative_bonus'),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name='SearchResult',
+        ),
+    ]
diff --git a/api_v2/models/__init__.py b/api_v2/models/__init__.py
@@ -50,8 +50,6 @@
 from .characterclass import ClassFeature
 from .characterclass import CharacterClass
 
-from .search import SearchResult
-
 from .size import Size
 
 from .environment import Environment
diff --git a/api_v2/serializers/__init__.py b/api_v2/serializers/__init__.py
@@ -40,8 +40,6 @@
 from .characterclass import ClassFeatureSerializer
 from .characterclass import ClassFeatureItemSerializer
 
-from .search import SearchResultSerializer
-
 from .size import SizeSerializer
 
 from .environment import EnvironmentSerializer
diff --git a/api_v2/urls.py b/api_v2/urls.py
@@ -36,11 +36,7 @@
 router.register(r'rulesets', views.RuleSetViewSet)
 router.register(r'creaturetraits', views.CreatureTraitViewSet)
 
-search_router = routers.DefaultRouter()
-search_router.register('',views.SearchResultViewSet, basename='search')
-
 urlpatterns = [
     path('v2/', include(router.urls)),
-    path('v2/search/', include(search_router.urls)),
     path('v2/enums/', views.get_enums, name="enums")
 ]
diff --git a/api_v2/views/__init__.py b/api_v2/views/__init__.py
@@ -35,8 +35,6 @@
 
 from .characterclass import CharacterClassViewSet
 
-from .search import SearchResultViewSet
-
 from .size import SizeViewSet
 
 from .rule import RuleViewSet, RuleSetViewSet
diff --git a/search/__init__.py b/search/__init__.py
diff --git a/search/admin.py b/search/admin.py
@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.
diff --git a/search/apps.py b/search/apps.py
@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class SearchConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'search'
diff --git a/search/management/commands/buildindex.py b/search/management/commands/buildindex.py
@@ -8,6 +8,7 @@
 
 from api import models as v1
 from api_v2 import models as v2
+from search import models as search
 
 class Command(BaseCommand):
     """Implementation for the `manage.py `index_v1` subcommand."""
@@ -31,8 +32,8 @@ def add_arguments(self, parser: argparse.ArgumentParser):
         )
 
     def unload_all_content(self):
-        object_count = v2.SearchResult.objects.all().count()
-        v2.SearchResult.objects.all().delete()
+        object_count = search.SearchResult.objects.all().count()
+        search.SearchResult.objects.all().delete()
         print("UNLOADED_OBJECT_COUNT:{}".format(object_count))
 
     def load_v1_content(self, model):
@@ -42,7 +43,7 @@ def load_v1_content(self, model):
 
         if model.__name__ in standard_v1_models:
             for o in model.objects.all():
-                results.append(v2.SearchResult(
+                results.append(search.SearchResult(
                     document_pk=o.document.slug,
                     object_pk=o.slug,
                     object_name=o.name,
@@ -59,7 +60,7 @@ def load_v2_content(self, model):
 
         if model.__name__ in standard_v2_models:
             for o in model.objects.all():
-                results.append(v2.SearchResult(
+                results.append(search.SearchResult(
                     document_pk=o.document.key,
                     object_pk=o.pk,
                     object_name=o.name,
@@ -77,12 +78,12 @@ def load_content(self,model,schema):
                     model._meta.db_table))
 
         if schema == 'v1':
-            v2.SearchResult.objects.bulk_create(
+            search.SearchResult.objects.bulk_create(
                 self.load_v1_content(model)
             )
 
         if schema == 'v2':
-            v2.SearchResult.objects.bulk_create(
+            search.SearchResult.objects.bulk_create(
                 self.load_v2_content(model)
             )
 
@@ -99,7 +100,7 @@ def load_index(self):
                 "INSERT INTO search_index " +
                 "(document_pk,object_pk,object_name,object_model,text,schema_version) " +
                 "SELECT document_pk,object_pk,object_name,object_model,text,schema_version " +
-                "FROM api_v2_searchresult")
+                "FROM search_searchresult")
 
     def check_fts_enabled(self):
         #import sqlite3
diff --git a/search/migrations/0001_initial.py b/search/migrations/0001_initial.py
@@ -0,0 +1,28 @@
+# Generated by Django 5.1.2 on 2025-03-13 15:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SearchResult',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('document_pk', models.CharField(max_length=255)),
+                ('object_pk', models.CharField(max_length=255)),
+                ('object_name', models.CharField(max_length=100)),
+                ('object_model', models.CharField(max_length=255)),
+                ('schema_version', models.CharField(max_length=100)),
+                ('rank', models.DecimalField(decimal_places=4, default=None, max_digits=10, null=True)),
+                ('text', models.TextField(default=None, null=True)),
+                ('highlighted', models.TextField(default=None, null=True)),
+            ],
+        ),
+    ]
diff --git a/search/migrations/__init__.py b/search/migrations/__init__.py
diff --git a/search/models.py b/search/models.py
@@ -1,4 +1,4 @@
-""" The Search Result object model"""
+""" The Search app models"""
 from django.db import models
 
 
diff --git a/search/serializers.py b/search/serializers.py
@@ -1,12 +1,12 @@
-"""Serializers for the SearchResult model."""
+"""Serializers for the Search application models."""
 
 from rest_framework import serializers
 
-from api_v2 import models
+from api_v2 import models as v2
 from api import models as v1
+from search import models
 from drf_spectacular.utils import extend_schema_field, inline_serializer, PolymorphicProxySerializer
 from drf_spectacular.types import OpenApiTypes
-from api_v2 import serializers as v2_serializers
 
 class SearchResultSerializer(serializers.ModelSerializer):
     """This method builds the search result object structure.
@@ -47,15 +47,15 @@ def get_object(self, obj):
         
         if obj.schema_version == 'v2':
             if obj.object_model == 'Item':
-                result_detail = models.Item.objects.get(pk=obj.object_pk)
+                result_detail = v2.Item.objects.get(pk=obj.object_pk)
             if obj.object_model == 'Creature':
-                result_detail = models.Creature.objects.get(pk=obj.object_pk)
+                result_detail = v2.Creature.objects.get(pk=obj.object_pk)
             if obj.object_model == 'Spell':
-                result_detail = models.Spell.objects.get(pk=obj.object_pk)
+                result_detail = v2.Spell.objects.get(pk=obj.object_pk)
             if obj.object_model == 'CharacterClass':
-                result_detail = models.CharacterClass.objects.get(pk=obj.object_pk)
+                result_detail = v2.CharacterClass.objects.get(pk=obj.object_pk)
             if obj.object_model == 'Race':
-                result_detail = models.Race.objects.get(pk=obj.object_pk)
+                result_detail = v2.Race.objects.get(pk=obj.object_pk)
 
         if result_detail is not None:
             return result_detail.search_result_extra_fields()
@@ -80,7 +80,7 @@ def get_document(self, obj):
                 }
 
         if obj.schema_version == 'v2':
-            doc = models.Document.objects.get(key=obj.document_pk)
+            doc = v2.Document.objects.get(key=obj.document_pk)
             return {
                 'key': doc.key,
                 'name': doc.name
diff --git a/search/tests.py b/search/tests.py
@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.
diff --git a/search/urls.py b/search/urls.py
@@ -0,0 +1,12 @@
+from django.conf.urls import include
+from django.urls import path
+from rest_framework import routers
+
+from search import viewsets
+
+search_router = routers.DefaultRouter()
+search_router.register('',viewsets.SearchResultViewSet, basename='search')
+
+urlpatterns = [
+    path('v2/search/', include(search_router.urls)),
+]
diff --git a/search/viewsets.py b/search/viewsets.py
@@ -1,8 +1,8 @@
 """Search query and parameter parsing."""
 from rest_framework import viewsets
 
-from api_v2 import models
-from api_v2 import serializers
+from search import models
+from search import serializers
 
 
 
diff --git a/server/settings.py b/server/settings.py
@@ -66,6 +66,7 @@
     "django.contrib.staticfiles",
     'api',
     'api_v2',
+    'search',
 	'drf_spectacular',
 
     # downloaded modules
diff --git a/server/urls.py b/server/urls.py
@@ -21,10 +21,12 @@
 
 from api import urls as v1_urls
 from api_v2 import urls as v2_urls
+from search import urls as search_urls
 
 urlpatterns = []
 urlpatterns+=v1_urls.urlpatterns
 urlpatterns+=v2_urls.urlpatterns
+urlpatterns+=search_urls.urlpatterns
 
 if settings.DEBUG is True:
     urlpatterns.append(path('admin/', admin.site.urls))

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from django.contrib import admin`
	`2`	`+`
	`3`	`+# Register your models here.`