Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Allow to pass several language codes to the exercise search

Roland Geider5d8e0f5e4dd2
diff --git a/wger/exercises/api/views.py b/wger/exercises/api/views.py
index 1fde6113c..02aae5aef 100644
--- a/wger/exercises/api/views.py
+++ b/wger/exercises/api/views.py
@@ -73,13 +73,13 @@ from wger.exercises.models import (
)
from wger.exercises.views.helper import StreamVerbs
from wger.utils.constants import (
+ ENGLISH_SHORT_NAME,
HTML_ATTRIBUTES_WHITELIST,
HTML_STYLES_WHITELIST,
HTML_TAG_WHITELIST,
)
from wger.utils.language import load_language
-
logger = logging.getLogger(__name__)
@@ -90,7 +90,7 @@ class ExerciseBaseViewSet(ModelViewSet):
"""
queryset = ExerciseBase.objects.all()
serializer_class = ExerciseBaseSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'category',
@@ -127,7 +127,7 @@ class ExerciseTranslationViewSet(ModelViewSet):
API endpoint for editing or adding exercise objects.
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
serializer_class = ExerciseTranslationSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -195,7 +195,7 @@ class ExerciseViewSet(viewsets.ReadOnlyModelViewSet):
the information of an exercise, see /api/v2/exerciseinfo/
"""
queryset = Exercise.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
serializer_class = ExerciseSerializer
ordering_fields = '__all__'
filterset_fields = (
@@ -264,41 +264,41 @@ def search(request):
This format is currently used by the exercise search autocompleter
"""
q = request.GET.get('term', None)
- language_code = request.GET.get('language', None)
+ language_codes = request.GET.get('language', ENGLISH_SHORT_NAME)
response = {}
results = []
if not q:
return Response(response)
- language = load_language(language_code)
- exercises = Exercise.objects \
+ languages = [load_language(l) for l in language_codes.split(',')]
+ translations = Exercise.objects \
.filter(Q(name__icontains=q) | Q(alias__alias__icontains=q)) \
- .filter(language=language) \
+ .filter(language__in=languages) \
.order_by('exercise_base__category__name', 'name') \
.distinct()
- for exercise in exercises:
+ for translation in translations:
image = None
thumbnail = None
- if exercise.main_image:
- image_obj = exercise.main_image
+ if translation.main_image:
+ image_obj = translation.main_image
image = image_obj.image.url
t = get_thumbnailer(image_obj.image)
thumbnail = t.get_thumbnail(aliases.get('micro_cropped')).url
- exercise_json = {
- 'value': exercise.name,
+ result_json = {
+ 'value': translation.name,
'data': {
- 'id': exercise.id,
- 'base_id': exercise.exercise_base_id,
- 'name': exercise.name,
- 'category': _(exercise.category.name),
+ 'id': translation.id,
+ 'base_id': translation.exercise_base_id,
+ 'name': translation.name,
+ 'category': _(translation.category.name),
'image': image,
'image_thumbnail': thumbnail
}
}
- results.append(exercise_json)
+ results.append(result_json)
response['suggestions'] = results
return Response(response)
@@ -358,7 +358,7 @@ class EquipmentViewSet(viewsets.ReadOnlyModelViewSet):
queryset = Equipment.objects.all()
serializer_class = EquipmentSerializer
ordering_fields = '__all__'
- filterset_fields = ('name', )
+ filterset_fields = ('name',)
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -372,7 +372,7 @@ class DeletionLogViewSet(viewsets.ReadOnlyModelViewSet):
queryset = DeletionLog.objects.all()
serializer_class = DeletionLogSerializer
ordering_fields = '__all__'
- filterset_fields = ('model_type', )
+ filterset_fields = ('model_type',)
class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
@@ -382,7 +382,7 @@ class ExerciseCategoryViewSet(viewsets.ReadOnlyModelViewSet):
queryset = ExerciseCategory.objects.all()
serializer_class = ExerciseCategorySerializer
ordering_fields = '__all__'
- filterset_fields = ('name', )
+ filterset_fields = ('name',)
@method_decorator(cache_page(settings.WGER_SETTINGS['EXERCISE_CACHE_TTL']))
def dispatch(self, request, *args, **kwargs):
@@ -396,7 +396,7 @@ class ExerciseImageViewSet(ModelViewSet):
queryset = ExerciseImage.objects.all()
serializer_class = ExerciseImageSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -458,7 +458,7 @@ class ExerciseVideoViewSet(ModelViewSet):
"""
queryset = ExerciseVideo.objects.all()
serializer_class = ExerciseVideoSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = (
'is_main',
@@ -495,7 +495,7 @@ class ExerciseCommentViewSet(ModelViewSet):
API endpoint for exercise comment objects
"""
serializer_class = ExerciseCommentSerializer
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = ('comment', 'exercise')
@@ -537,7 +537,7 @@ class ExerciseAliasViewSet(ModelViewSet):
"""
serializer_class = ExerciseAliasSerializer
queryset = Alias.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
ordering_fields = '__all__'
filterset_fields = ('alias', 'exercise')
@@ -570,7 +570,7 @@ class ExerciseVariationViewSet(ModelViewSet):
"""
serializer_class = ExerciseVariationSerializer
queryset = Variation.objects.all()
- permission_classes = (CanContributeExercises, )
+ permission_classes = (CanContributeExercises,)
class MuscleViewSet(viewsets.ReadOnlyModelViewSet):
diff --git a/wger/exercises/fixtures/test-exercises.json b/wger/exercises/fixtures/test-exercises.json
index 3e3f988b2..9a3200ccc 100644
--- a/wger/exercises/fixtures/test-exercises.json
+++ b/wger/exercises/fixtures/test-exercises.json
@@ -225,7 +225,7 @@
"language": 1,
"exercise_base": 4,
"description": "",
- "name": "Needed for demo user",
+ "name": "Weitere Testübung",
"creation_date": "2022-01-10",
"update_date": "2022-02-02T06:45:11+01:00"
}
diff --git a/wger/exercises/tests/test_search_api.py b/wger/exercises/tests/test_search_api.py
new file mode 100644
index 000000000..87214c264
--- /dev/null
+++ b/wger/exercises/tests/test_search_api.py
@@ -0,0 +1,92 @@
+# This file is part of wger Workout Manager.
+#
+# wger Workout Manager is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# wger Workout Manager is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Workout Manager. If not, see <http://www.gnu.org/licenses/>.
+
+# Third Party
+from rest_framework import status
+
+# wger
+from wger.core.tests.api_base_test import ApiBaseTestCase
+from wger.core.tests.base_testcase import BaseTestCase
+
+
+class SearchExerciseApiTestCase(BaseTestCase, ApiBaseTestCase):
+ url = '/api/v2/exercise/search/'
+
+ def test_basic_search_logged_out(self):
+ """
+ Logged-out users are also allowed to use the search
+ """
+ response = self.client.get(self.url + '?term=exercise')
+ result1 = response.data['suggestions'][0]
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 1)
+ self.assertEqual(result1['value'], 'Very cool exercise')
+ self.assertEqual(result1['data']['id'], 2)
+
+ def test_basic_search_logged_in(self):
+ """
+ Logged-in users get the same results
+ """
+ self.authenticate('test')
+ response = self.client.get(self.url + '?term=exercise')
+ result1 = response.data['suggestions'][0]
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 1)
+ self.assertEqual(result1['value'], 'Very cool exercise')
+ self.assertEqual(result1['data']['id'], 2)
+
+ def test_search_language_code_en(self):
+ """
+ Explicitly passing the en language code (same as no code)
+ """
+ response = self.client.get(self.url + '?term=exercise&language=en')
+ result1 = response.data['suggestions'][0]
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 1)
+ self.assertEqual(result1['value'], 'Very cool exercise')
+ self.assertEqual(result1['data']['id'], 2)
+
+ def test_search_language_code_en_no_results(self):
+ """
+ The "Testübung" exercise should not be found when searching in English
+ """
+ response = self.client.get(self.url + '?term=Testübung&language=en')
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 0)
+
+ def test_search_language_code_de(self):
+ """
+ The "Testübung" exercise should be only found when searching in German
+ """
+ response = self.client.get(self.url + '?term=Testübung&language=de')
+ result1 = response.data['suggestions'][0]
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 1)
+ self.assertEqual(result1['value'], 'Weitere Testübung')
+ self.assertEqual(result1['data']['id'], 7)
+
+ def test_search_several_language_codes(self):
+ """
+ Passing different language codes works correctly
+ """
+ response = self.client.get(self.url + '?term=demo&language=en,de')
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+ self.assertEqual(len(response.data['suggestions']), 4)
diff --git a/wger/utils/language.py b/wger/utils/language.py
index 95ea4f19b..a0fa264b5 100644
--- a/wger/utils/language.py
+++ b/wger/utils/language.py
@@ -24,7 +24,6 @@ from wger.core.models import Language
from wger.utils.cache import cache_mapper
from wger.utils.constants import ENGLISH_SHORT_NAME
-
logger = logging.getLogger(__name__)
@@ -34,10 +33,9 @@ def load_language(language_code=None):
"""
# Read the first part of a composite language, e.g. 'de-at'
- if language_code is None:
- used_language = translation.get_language().split('-')[0]
- else:
- used_language = language_code
+ used_language = translation.get_language().split('-')[0] \
+ if language_code is None \
+ else language_code
language = cache.get(cache_mapper.get_language_key(used_language))
if language: