Merge pull request #279 from CentreForDigitalHumanities/bugfix/search-results

Fix bad merge

Author: lukavdplas

backend/event/tests/test_event_queries.py

@@ -77,3 +77,20 @@ def test_episodes_ids_filter(graphql_client, episode, episode_2, anonymous_reque
     """
     result = graphql_client.execute(query_2, context=anonymous_request)
     assert len(result["data"]["episodes"]) == 1
+
+def test_episodes_search(graphql_client, episode, episode_2, anonymous_request):
+    query = f"""
+    query Test {{
+        episodes(search: "") {{ id }}
+    }}
+    """
+    result = graphql_client.execute(query, context=anonymous_request)
+    assert len(result["data"]["episodes"]) == 2
+
+    query_2 = f"""
+    query Test {{
+        episodes(search: "bert") {{ id }}
+    }}
+    """
+    result = graphql_client.execute(query_2, context=anonymous_request)
+    assert len(result["data"]["episodes"]) == 1

backend/event/types/EpisodeType.py

@@ -1,25 +1,26 @@
-from graphene import List, NonNull, ResolveInfo, Boolean
+from graphene import List, NonNull, ResolveInfo
 from graphene_django import DjangoObjectType
 from core.types.EntityDescriptionType import EntityDescriptionType
-from django.db.models import QuerySet, Q
+from django.db.models import QuerySet
 from django_filters import FilterSet, CharFilter
 
 from event.models import (
     Episode, EpisodeCategory, EpisodeAgent, EpisodeSpace, EpisodeLetter, EpisodeGift,
 )
 from event.types.EpisodeCategoryType import EpisodeCategoryType
-from user.permissions import can_edit_source, visible_sources
+from graphql_app.utils import search_filter
+
 
 class EpisodeFilter(FilterSet):
     search = CharFilter(method="search_episodes")
 
+    _search_fields = ['name', 'description', 'summary']
+
     def search_episodes(self, queryset: QuerySet[Episode], name: str, value: str) -> QuerySet[Episode]:
         """Filter episodes by name, description or summary."""
-        return queryset.filter(
-            Q(name__icontains=value)
-            | Q(description__icontains=value)
-            | Q(summary__icontains=value)
-        )
+        return queryset.filter(search_filter(value, self._search_fields))
+
+
 class EpisodeType(EntityDescriptionType, DjangoObjectType):
     categories = List(NonNull(EpisodeCategoryType), required=True)
     agents = List(

backend/graphql_app/utils.py

@@ -0,0 +1,20 @@
+from typing import List
+from functools import reduce
+from operator import or_, and_
+
+from django.db.models import Q
+
+def search_filter(query: str, fields: List[str]) -> Q:
+    '''Constructs a Q object for multi-term search through multiple fields'''
+    terms = query.split()
+    qs = [_term_filter(term, fields) for term in terms]
+    return reduce(and_, qs) if len(qs) else Q()
+
+
+def _term_filter(term: str, fields: List[str]) -> Q:
+    '''Constructs a Q object for a single search term through multiple fields'''
+    qs = [
+        Q(**{f'{field}__icontains': term})
+        for field in fields
+    ]
+    return reduce(or_, qs) if len(qs) else Q()

backend/source/tests/test_source_filter.py

@@ -0,0 +1,33 @@
+import pytest
+from source.models import Source
+from source.types.SourceType import SourceFilter
+
+@pytest.fixture()
+def no_missing_source(db):
+    Source.objects.get(name='MISSING SOURCE').delete()
+
+@pytest.fixture()
+def source_2(db):
+    return Source.objects.create(
+        name='Pat & Mat',
+        description_text='Shenanigans from two clumsy neighbours'
+    )
+
+@pytest.mark.parametrize('query,expected', [
+        ('', ['Sesame Street', 'Pat & Mat']),
+        ('Street', ['Sesame Street']),
+        ('street', ['Sesame Street']),
+        ('clumsy', ['Pat & Mat']),
+        ('street sesame', ['Sesame Street']),
+        ('pat clumsy', ['Pat & Mat']),
+        ('pat street', []),
+        ('nonsense', []),
+])
+def test_source_search(source, source_2, no_missing_source, query, expected):
+    filter = SourceFilter(Source.objects.all())
+    result = filter.search_sources(
+        Source.objects.all(),
+        '',
+        query
+    )
+    assert set(source.name for source in result) == set(expected)

backend/source/types/SourceType.py

@@ -1,6 +1,6 @@
 from typing import Type, Optional
 from graphene import Field, Int, List, NonNull, ResolveInfo, Boolean
-from django.db.models import QuerySet, Model, Q
+from django.db.models import QuerySet, Model
 from graphene_django import DjangoObjectType
 from django_filters import FilterSet, CharFilter, BooleanFilter
 
@@ -21,20 +21,22 @@
 from user.types.UserType import UserType
 from user.models import User
 from source.types.SourceImageType import SourceImageType
+from graphql_app.utils import search_filter
 from source.utils import source_contributor_ids
 
 class SourceFilter(FilterSet):
     search = CharFilter(method="search_sources")
     is_public = BooleanFilter(field_name="is_public")
 
+    _search_fields = ['name', 'medieval_title', 'reference', 'description_text']
+
+    class Meta:
+        model = Source
+        fields = ['is_public']
+
     def search_sources(self, queryset: QuerySet[Source], name: str, value: str) -> QuerySet[Source]:
-        """Filter sources by by searching through the name, reference, or description."""
-        return queryset.filter(
-            Q(name__icontains=value)
-            | Q(medieval_title__icontains=value)
-            | Q(reference__icontains=value)
-            | Q(description_text__icontains=value)
-        )
+        """Filter sources by searching through the name, medieval title, reference, or description."""
+        return queryset.filter(search_filter(value, self._search_fields))
 
 
 class SourceType(DjangoObjectType):