Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Handle filtering on the json field

Roland Geider7941e73aed8c
diff --git a/wger/manager/api/consts.py b/wger/manager/api/consts.py
index 0237de125..de036c02d 100644
--- a/wger/manager/api/consts.py
+++ b/wger/manager/api/consts.py
@@ -1,4 +1,4 @@
-CONFIG_FIELDS = (
+BASE_CONFIG_FILTER_FIELDS = (
'id',
'slot_entry',
'iteration',
@@ -8,3 +8,5 @@ CONFIG_FIELDS = (
'need_log_to_apply',
'repeat',
)
+
+BASE_CONFIG_FIELDS = BASE_CONFIG_FILTER_FIELDS + ('requirements',)
diff --git a/wger/manager/api/filtersets.py b/wger/manager/api/filtersets.py
new file mode 100644
index 000000000..c57c5323b
--- /dev/null
+++ b/wger/manager/api/filtersets.py
@@ -0,0 +1,29 @@
+# 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 django_filters import (
+ UnknownFieldBehavior,
+ rest_framework as filters,
+)
+
+# wger
+from wger.manager.api.consts import BASE_CONFIG_FILTER_FIELDS
+
+
+class BaseConfigFilterSet(filters.FilterSet):
+ class Meta:
+ fields = BASE_CONFIG_FILTER_FIELDS
+ unknown_field_behavior = UnknownFieldBehavior.IGNORE
diff --git a/wger/manager/api/serializers.py b/wger/manager/api/serializers.py
index 6c5829045..15f9c12ba 100644
--- a/wger/manager/api/serializers.py
+++ b/wger/manager/api/serializers.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
# This file is part of wger Workout Manager.
#
# wger Workout Manager is free software: you can redistribute it and/or modify
@@ -15,11 +13,16 @@
# 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 serializers
# wger
-from wger.manager.api.consts import CONFIG_FIELDS
+from wger.manager.api.consts import (
+ BASE_CONFIG_FIELDS,
+ BASE_CONFIG_FILTER_FIELDS,
+)
+from wger.manager.api.validators import validate_requirements
from wger.manager.models import (
Day,
MaxRepsConfig,
@@ -81,104 +84,112 @@ class DaySerializer(serializers.ModelSerializer):
)
-class WeightConfigSerializer(serializers.ModelSerializer):
+class BaseConfigSerializer(serializers.ModelSerializer):
+ """
+ Base Config serializer
+ """
+
+ requirements = serializers.JSONField(validators=[validate_requirements])
+
+
+class WeightConfigSerializer(BaseConfigSerializer):
"""
Weight Config serializer
"""
class Meta:
model = WeightConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class MaxWeightConfigSerializer(serializers.ModelSerializer):
+class MaxWeightConfigSerializer(BaseConfigSerializer):
"""
Max Weight Config serializer
"""
class Meta:
model = MaxWeightConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class RepsConfigSerializer(serializers.ModelSerializer):
+class RepsConfigSerializer(BaseConfigSerializer):
"""
Repetition Config serializer
"""
class Meta:
model = RepsConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class MaxRepsConfigSerializer(serializers.ModelSerializer):
+class MaxRepsConfigSerializer(BaseConfigSerializer):
"""
Max Repetition Config serializer
"""
class Meta:
model = MaxRepsConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class SetNrConfigSerializer(serializers.ModelSerializer):
+class SetNrConfigSerializer(BaseConfigSerializer):
"""
Set Nr config serializer
"""
class Meta:
model = SetsConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class MaxSetNrConfigSerializer(serializers.ModelSerializer):
+class MaxSetNrConfigSerializer(BaseConfigSerializer):
"""
Max Set Nr config serializer
"""
class Meta:
model = MaxSetsConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class RiRConfigSerializer(serializers.ModelSerializer):
+class RiRConfigSerializer(BaseConfigSerializer):
"""
RiR Config serializer
"""
class Meta:
model = RiRConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class MaxRiRConfigSerializer(serializers.ModelSerializer):
+class MaxRiRConfigSerializer(BaseConfigSerializer):
"""
RiR Config serializer
"""
class Meta:
model = MaxRiRConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class RestConfigSerializer(serializers.ModelSerializer):
+class RestConfigSerializer(BaseConfigSerializer):
"""
Rest Config serializer
"""
class Meta:
model = RestConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
-class MaxRestConfigSerializer(serializers.ModelSerializer):
+class MaxRestConfigSerializer(BaseConfigSerializer):
"""
Rest Config serializer
"""
class Meta:
model = MaxRestConfig
- fields = CONFIG_FIELDS
+ fields = BASE_CONFIG_FIELDS
class SlotEntryStructureSerializer(serializers.ModelSerializer):
diff --git a/wger/manager/api/validators.py b/wger/manager/api/validators.py
new file mode 100644
index 000000000..150f3872b
--- /dev/null
+++ b/wger/manager/api/validators.py
@@ -0,0 +1,34 @@
+# 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 serializers
+
+
+def validate_requirements(value: dict | None):
+ """Validates the requirements field."""
+
+ if value is None:
+ return
+
+ if not isinstance(value, dict):
+ raise serializers.ValidationError('Requirements must be a JSON object.')
+
+ required_keys = {'rules'} # Set of required keys
+ if not all(key in value for key in required_keys):
+ raise serializers.ValidationError("Missing required keys: 'rules'") # More specific
+
+ if 'rules' in value and not isinstance(value['rules'], list):
+ raise serializers.ValidationError("'rules' must be a list.")
diff --git a/wger/manager/api/views.py b/wger/manager/api/views.py
index b0723faaf..7dc0b2106 100644
--- a/wger/manager/api/views.py
+++ b/wger/manager/api/views.py
@@ -31,7 +31,8 @@ from rest_framework.response import Response
# wger
from wger.exercises.models import Exercise
-from wger.manager.api.consts import CONFIG_FIELDS
+from wger.manager.api.consts import BASE_CONFIG_FIELDS
+from wger.manager.api.filtersets import BaseConfigFilterSet
from wger.manager.api.serializers import (
DaySerializer,
LogDisplaySerializer,
@@ -595,7 +596,7 @@ class AbstractConfigViewSet(WgerOwnerObjectModelViewSet):
is_private = True
ordering_fields = '__all__'
- filterset_fields = CONFIG_FIELDS
+ filterset_fields = BASE_CONFIG_FIELDS
def get_owner_objects(self):
"""
@@ -610,6 +611,7 @@ class WeightConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = WeightConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -628,6 +630,7 @@ class MaxWeightConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = MaxWeightConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -648,6 +651,7 @@ class RepsConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = RepsConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -666,6 +670,7 @@ class MaxRepsConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = MaxRepsConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -684,6 +689,7 @@ class SetsConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = SetNrConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -702,6 +708,7 @@ class MaxSetsConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = MaxSetNrConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -720,6 +727,7 @@ class RestConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = RestConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -738,6 +746,7 @@ class MaxRestConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = MaxRestConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -756,6 +765,7 @@ class RiRConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = RiRConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
@@ -774,6 +784,7 @@ class MaxRiRConfigViewSet(AbstractConfigViewSet):
"""
serializer_class = MaxRiRConfigSerializer
+ filterset_class = BaseConfigFilterSet
def get_queryset(self):
"""
diff --git a/wger/manager/forms.py b/wger/manager/forms.py
index 0894d3b34..3cc26e944 100644
--- a/wger/manager/forms.py
+++ b/wger/manager/forms.py
@@ -14,10 +14,6 @@
#
# You should have received a copy of the GNU Affero General Public License
-# Third Party
-from crispy_forms.helper import FormHelper
-from crispy_forms.layout import Submit
-
# Django
from django.forms import (
BooleanField,
@@ -33,6 +29,10 @@ from django.utils.translation import (
gettext_lazy,
)
+# Third Party
+from crispy_forms.helper import FormHelper
+from crispy_forms.layout import Submit
+
# wger
from wger.manager.models import Workout
diff --git a/wger/manager/migrations/0018_flexible_routines.py b/wger/manager/migrations/0018_flexible_routines.py
index 85ab3a30e..3ce7e606c 100644
--- a/wger/manager/migrations/0018_flexible_routines.py
+++ b/wger/manager/migrations/0018_flexible_routines.py
@@ -412,7 +412,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -467,7 +467,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -528,7 +528,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -588,7 +588,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -643,7 +643,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -698,7 +698,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -753,7 +753,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -808,7 +808,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -863,7 +863,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
@@ -917,7 +917,7 @@ class Migration(migrations.Migration):
(
'requirements',
models.JSONField(default=None, null=True),
- )
+ ),
],
options={
'ordering': ['slot_entry', 'iteration'],
diff --git a/wger/manager/models/abstract_config.py b/wger/manager/models/abstract_config.py
index bc3a94e24..26518422b 100644
--- a/wger/manager/models/abstract_config.py
+++ b/wger/manager/models/abstract_config.py
@@ -89,7 +89,13 @@ class AbstractChangeConfig(models.Model):
default=None,
null=True,
)
- """Requirements for the application of this rule as JSON"""
+ """
+ Requirements for the application of this rule as JSON
+
+ Currently supported:
+ * list of rules to apply
+ * respect/ignore maximum
+ """
@property
def replace(self) -> bool:
diff --git a/wger/manager/models/rir_config.py b/wger/manager/models/rir_config.py
index 7cc3617b8..16d16bd82 100644
--- a/wger/manager/models/rir_config.py
+++ b/wger/manager/models/rir_config.py
@@ -18,6 +18,7 @@
from django.db import models
# wger
+from wger.manager.consts import RIR_OPTIONS
from wger.manager.models import AbstractChangeConfig
@@ -29,6 +30,7 @@ class RiRConfig(AbstractChangeConfig):
value = models.DecimalField(
decimal_places=1,
max_digits=2,
+ # choices=RIR_OPTIONS
)
@@ -40,4 +42,5 @@ class MaxRiRConfig(AbstractChangeConfig):
value = models.DecimalField(
decimal_places=1,
max_digits=2,
+ # choices=RIR_OPTIONS
)
diff --git a/wger/manager/views/pdf.py b/wger/manager/views/pdf.py
index 7775c32da..d1950c105 100644
--- a/wger/manager/views/pdf.py
+++ b/wger/manager/views/pdf.py
@@ -46,6 +46,7 @@ from wger.utils.pdf import (
styleSheet,
)
+
logger = logging.getLogger(__name__)