Refactor search logic to a create an 'omnisearch' (#484)

training/models.py

@@ -1,6 +1,7 @@
-from RIGS.models import Profile
+from RIGS.models import Profile, filter_by_pk
 from reversion import revisions as reversion
 from django.db import models
+from django.db.models import Q
 from django.urls import reverse
 from django.utils.safestring import mark_safe
 from versioning.versioning import RevisionMixin
@@ -12,6 +13,16 @@ class TraineeManager(models.Manager):
     def get_queryset(self):
         return super().get_queryset().filter(is_active=True, is_approved=True)
 
+    def search(self, query=None):
+        qs = self.get_queryset()
+        if query is not None:
+            or_lookup = (Q(first_name__icontains=query) |
+                         Q(last_name__icontains=query) | Q(initials__icontains=query)
+                         )
+            or_lookup = filter_by_pk(or_lookup, query)
+            qs = qs.filter(or_lookup).distinct()  # distinct() is often necessary with Q lookups
+        return qs
+
 
 @reversion.register(for_concrete_model=False, fields=['is_supervisor'])
 class Trainee(Profile, RevisionMixin):
@@ -65,6 +76,16 @@ class TrainingCategory(models.Model):
         verbose_name_plural = 'Training Categories'
 
 
+class TrainingItemManager(QueryablePropertiesManager):
+    def search(self, query=None):
+        qs = self.get_queryset()
+        if query is not None:
+            or_lookup = (Q(description__icontains=query)
+                         )
+            qs = qs.filter(or_lookup).distinct()  # distinct() is often necessary with Q lookups
+        return qs
+
+
 @reversion.register
 class TrainingItem(models.Model):
     reference_number = models.IntegerField()
@@ -72,7 +93,7 @@ class TrainingItem(models.Model):
     description = models.CharField(max_length=50)
     active = models.BooleanField(default=True)
 
-    objects = QueryablePropertiesManager()
+    objects = TrainingItemManager()
 
     @property
     def name(self):
@@ -97,6 +118,9 @@ class TrainingItem(models.Model):
             name += " (inactive)"
         return name
 
+    def get_absolute_url(self):
+        return reverse('item_list')
+
     @staticmethod
     def user_has_qualification(item, user, depth):
         return user.qualifications_obtained.only('item', 'depth').filter(item=item, depth__gte=depth).exists()

training/views.py

@@ -95,23 +95,13 @@ class TraineeList(generic.ListView):
     paginate_by = 25
 
     def get_queryset(self):
-        q = self.request.GET.get('q', "")
-
-        filt = Q(first_name__icontains=q) | Q(last_name__icontains=q) | Q(initials__icontains=q)
-
-        # try and parse an int
-        try:
-            val = int(q)
-            filt = filt | Q(pk=val)
-        except:  # noqa
-            # not an integer
-            pass
+        objects = self.model.objects
 
         if self.request.GET.get('is_supervisor', ''):
-            filt = filt & Q(is_supervisor=True)
+            objects = objects.filter(is_supervisor=True)
 
-        return self.model.objects.filter(filt).annotate(num_qualifications=Count('qualifications_obtained', filter=Q(qualifications_obtained__depth=models.TrainingItemQualification.PASSED_OUT))
-                                                        ).order_by('-num_qualifications').prefetch_related('level_qualifications', 'qualifications_obtained', 'qualifications_obtained__item')
+        return objects.search(self.request.GET.get('q')).annotate(num_qualifications=Count('qualifications_obtained', filter=Q(qualifications_obtained__depth=models.TrainingItemQualification.PASSED_OUT))
+                                                                  ).order_by('-num_qualifications').prefetch_related('level_qualifications', 'qualifications_obtained', 'qualifications_obtained__item')
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)