Skip to content

armgit / wger

Public Imported from GitHub
0

Self hosted FLOSS fitness/workout, nutrition and weight tracker

Add label model

Roland Geiderb1471cfaf65d
diff --git a/wger/manager/api/serializers.py b/wger/manager/api/serializers.py
index 64157ea21..d5024d5e0 100644
--- a/wger/manager/api/serializers.py
+++ b/wger/manager/api/serializers.py
@@ -64,7 +64,7 @@ class RoutineSerializer(serializers.ModelSerializer):
)
-class DayNgDataSerializer(serializers.ModelSerializer):
+class DayNgSerializer(serializers.ModelSerializer):
"""
Day serializer
"""
@@ -336,7 +336,8 @@ class WorkoutDayDataSerializer(serializers.Serializer):
iteration = serializers.IntegerField()
date = serializers.DateField()
- day = DayNgDataSerializer()
+ label = serializers.CharField()
+ day = DayNgSerializer()
slots = SetDataSerializer(many=True)
diff --git a/wger/manager/api/views.py b/wger/manager/api/views.py
index 07801175d..21319d9dd 100644
--- a/wger/manager/api/views.py
+++ b/wger/manager/api/views.py
@@ -29,9 +29,8 @@ from rest_framework.response import Response
# wger
from wger.exercises.models import ExerciseBase
from wger.manager.api.serializers import (
- DayNgDataSerializer,
+ DayNgSerializer,
DaySerializer,
- DayStructureSerializer,
RoutineSerializer,
RoutineStructureSerializer,
ScheduleSerializer,
@@ -96,7 +95,7 @@ class RoutineViewSet(viewsets.ModelViewSet):
"""
Return the day sequence of the routine
"""
- return Response(DayNgDataSerializer(self.get_object().day_sequence, many=True).data)
+ return Response(DayNgSerializer(self.get_object().day_sequence, many=True).data)
@action(detail=True, url_path='date-sequence')
def date_sequence(self, request, pk):
diff --git a/wger/manager/dataclasses.py b/wger/manager/dataclasses.py
index 9b40b5d23..613fd2d76 100644
--- a/wger/manager/dataclasses.py
+++ b/wger/manager/dataclasses.py
@@ -60,6 +60,7 @@ class WorkoutDayData:
day: 'DayNg'
date: datetime.date
iteration: int | None
+ label: str | None = None
@property
def slots(self) -> List[SlotData]:
diff --git a/wger/manager/migrations/0020_add_routine_labels.py b/wger/manager/migrations/0020_add_routine_labels.py
new file mode 100644
index 000000000..9f90dec4a
--- /dev/null
+++ b/wger/manager/migrations/0020_add_routine_labels.py
@@ -0,0 +1,80 @@
+# Generated by Django 4.2.13 on 2024-05-31 16:40
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ('manager', '0019_flexible_routines_migration'),
+ ]
+
+ operations = [
+ migrations.AlterField(
+ model_name='dayng',
+ name='routine',
+ field=models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name='days',
+ to='manager.routine',
+ verbose_name='Routine',
+ ),
+ ),
+ migrations.AlterField(
+ model_name='routine',
+ name='name',
+ field=models.CharField(blank=True, max_length=50, verbose_name='Name'),
+ ),
+ migrations.AlterField(
+ model_name='slot',
+ name='day',
+ field=models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name='slots',
+ to='manager.dayng',
+ verbose_name='Exercise day',
+ ),
+ ),
+ migrations.AlterField(
+ model_name='slotconfig',
+ name='slot',
+ field=models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name='configs',
+ to='manager.slot',
+ ),
+ ),
+ migrations.CreateModel(
+ name='Label',
+ fields=[
+ (
+ 'id',
+ models.AutoField(
+ auto_created=True,
+ primary_key=True,
+ serialize=False,
+ verbose_name='ID',
+ ),
+ ),
+ (
+ 'start_offset',
+ models.PositiveIntegerField(default=1, verbose_name='Start'),
+ ),
+ (
+ 'end_offset',
+ models.PositiveIntegerField(default=2, verbose_name='End'),
+ ),
+ ('label', models.CharField(max_length=35, verbose_name='Label')),
+ ('comment', models.CharField(max_length=500, verbose_name='Comment')),
+ (
+ 'routine',
+ models.ForeignKey(
+ null=True,
+ on_delete=django.db.models.deletion.CASCADE,
+ to='manager.routine',
+ verbose_name='Routine',
+ ),
+ ),
+ ],
+ ),
+ ]
diff --git a/wger/manager/models/__init__.py b/wger/manager/models/__init__.py
index f219a8506..fb6f51941 100644
--- a/wger/manager/models/__init__.py
+++ b/wger/manager/models/__init__.py
@@ -20,6 +20,7 @@ from .day import (
Day,
DayNg,
)
+from .label import Label
from .log import WorkoutLog
from .reps_config import RepsConfig
from .rest_config import RestConfig
diff --git a/wger/manager/models/day.py b/wger/manager/models/day.py
index 3c978b17b..fc6ffd735 100644
--- a/wger/manager/models/day.py
+++ b/wger/manager/models/day.py
@@ -113,7 +113,7 @@ class DayNg(models.Model):
"""
Return the sets for this day
"""
- return [SlotData(slot=s, exercise_data=s.set_data(iteration)) for s in self.slot_set.all()]
+ return [SlotData(slot=s, exercise_data=s.set_data(iteration)) for s in self.slots.all()]
class Day(models.Model):
diff --git a/wger/manager/models/label.py b/wger/manager/models/label.py
new file mode 100644
index 000000000..59435af3c
--- /dev/null
+++ b/wger/manager/models/label.py
@@ -0,0 +1,95 @@
+# This file is part of wger Workout Manager <https://github.com/wger-project>.
+# Copyright (C) 2013 - 2021 wger Team
+#
+# 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
+# Django
+from django.db import models
+
+
+class Label(models.Model):
+ """
+ A free text label for routines
+
+ This can be used for example to label the different weeks, or set other info
+ such as "deload", etc.
+ """
+
+ routine = models.ForeignKey(
+ 'Routine',
+ verbose_name='Routine',
+ on_delete=models.CASCADE,
+ related_name='labels',
+ )
+ """
+ The routine this label belongs to
+ """
+
+ start_offset = models.PositiveIntegerField(
+ verbose_name='Start',
+ default=1,
+ )
+ """
+ The number of days after the start of the routine when this label becomes active
+ """
+
+ end_offset = models.PositiveIntegerField(
+ verbose_name='End',
+ default=2,
+ )
+ """
+ The number of days after the start of the routine when this label ceases being active
+ """
+
+ label = models.CharField(
+ max_length=35,
+ verbose_name='Label',
+ )
+ """
+ The label text
+ """
+
+ comment = models.CharField(max_length=500, verbose_name='Comment', default='')
+ """
+ A free text comment
+ """
+
+ class Meta:
+ """
+ Metaclass to set some other properties
+ """
+
+ ordering = [
+ 'start_offset',
+ ]
+
+ def clean(self):
+ """
+ Check that the end offset is greater than the start offset
+ """
+ if self.end_offset < self.start_offset:
+ raise ValueError('End offset must be greater than start offset')
+
+ def __str__(self):
+ """
+ Return a more human-readable representation
+ """
+ return f'Label {self.label} for routine {self.routine}'
+
+ def get_owner_object(self):
+ """
+ Returns the object that has owner information
+ """
+ return self.routine
diff --git a/wger/manager/models/routine.py b/wger/manager/models/routine.py
index 9e6cc25b3..97d92176e 100644
--- a/wger/manager/models/routine.py
+++ b/wger/manager/models/routine.py
@@ -146,6 +146,17 @@ class Routine(models.Model):
day = day.next_day
return out
+ @property
+ def label_dict(self) -> dict[datetime.date, str]:
+ out = {}
+ labels = self.labels.all()
+
+ for label in labels:
+ for i in range(label.start_offset, label.end_offset + 1):
+ out[self.start + datetime.timedelta(days=i)] = label.label
+
+ return out
+
@property
def date_sequence(self) -> List[WorkoutDayData]:
"""
@@ -154,6 +165,7 @@ class Routine(models.Model):
If a day needs logs to continue it will be repeated until the user adds one.
"""
+ labels = self.label_dict
delta = datetime.timedelta(days=1)
current_date = self.start
current_day = self.first_day
@@ -168,7 +180,14 @@ class Routine(models.Model):
while current_date <= self.end:
# Fill all days till the end of the week with empty workout days
if skip_til_date:
- out.append(WorkoutDayData(iteration=None, date=current_date, day=None))
+ out.append(
+ WorkoutDayData(
+ iteration=None,
+ date=current_date,
+ day=None,
+ label=labels.get(current_date),
+ )
+ )
# current_date += delta
if current_date == skip_til_date:
skip_til_date = None
@@ -181,7 +200,12 @@ class Routine(models.Model):
skip_til_date = current_date + datetime.timedelta(days=days_til_monday)
out.append(
- WorkoutDayData(iteration=counter[current_day], date=current_date, day=current_day)
+ WorkoutDayData(
+ iteration=counter[current_day],
+ date=current_date,
+ day=current_day,
+ label=labels.get(current_date),
+ )
)
if current_day.can_proceed(current_date):
diff --git a/wger/manager/models/slot.py b/wger/manager/models/slot.py
index 50735105d..82ff37d42 100644
--- a/wger/manager/models/slot.py
+++ b/wger/manager/models/slot.py
@@ -58,7 +58,4 @@ class Slot(models.Model):
def set_data(self, iteration: int) -> List[SetExerciseData]:
"""Calculates the set data for a specific iteration"""
- return [
- SetExerciseData(data=s.get_config(iteration), config=s)
- for s in self.slotconfig_set.all()
- ]
+ return [SetExerciseData(data=s.get_config(iteration), config=s) for s in self.configs.all()]
diff --git a/wger/manager/tests/test_routine.py b/wger/manager/tests/test_routine.py
index 89953f63d..9ef9e7356 100644
--- a/wger/manager/tests/test_routine.py
+++ b/wger/manager/tests/test_routine.py
@@ -21,6 +21,7 @@ from wger.core.tests.base_testcase import WgerTestCase
from wger.manager.dataclasses import WorkoutDayData
from wger.manager.models import (
DayNg,
+ Label,
WorkoutSession,
)
from wger.manager.models.routine import Routine
@@ -72,6 +73,9 @@ class RoutineTestCase(WgerTestCase):
self.routine.first_day = self.day1
+ Label(routine=self.routine, start_offset=0, end_offset=3, label='First label').save()
+ Label(routine=self.routine, start_offset=4, end_offset=5, label='Second label').save()
+
def test_day_sequences(self):
self.assertListEqual(
self.routine.day_sequence,
@@ -86,16 +90,66 @@ class RoutineTestCase(WgerTestCase):
self.assertEqual(
self.routine.date_sequence,
[
- WorkoutDayData(day=self.day1, iteration=1, date=datetime.date(2024, 1, 1)),
- WorkoutDayData(day=self.day2, iteration=1, date=datetime.date(2024, 1, 2)),
- WorkoutDayData(day=self.day3, iteration=1, date=datetime.date(2024, 1, 3)),
- WorkoutDayData(day=self.day1, iteration=2, date=datetime.date(2024, 1, 4)),
- WorkoutDayData(day=self.day2, iteration=2, date=datetime.date(2024, 1, 5)),
- WorkoutDayData(day=self.day3, iteration=2, date=datetime.date(2024, 1, 6)),
- WorkoutDayData(day=self.day1, iteration=3, date=datetime.date(2024, 1, 7)),
- WorkoutDayData(day=self.day2, iteration=3, date=datetime.date(2024, 1, 8)),
- WorkoutDayData(day=self.day3, iteration=3, date=datetime.date(2024, 1, 9)),
- WorkoutDayData(day=self.day1, iteration=4, date=datetime.date(2024, 1, 10)),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=datetime.date(2024, 1, 1),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=1,
+ date=datetime.date(2024, 1, 2),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=1,
+ date=datetime.date(2024, 1, 3),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=2,
+ date=datetime.date(2024, 1, 4),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=2,
+ date=datetime.date(2024, 1, 5),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=2,
+ date=datetime.date(2024, 1, 6),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=3,
+ date=datetime.date(2024, 1, 7),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=3,
+ date=datetime.date(2024, 1, 8),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=3,
+ date=datetime.date(2024, 1, 9),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=4,
+ date=datetime.date(2024, 1, 10),
+ label=None,
+ ),
],
)
@@ -111,17 +165,67 @@ class RoutineTestCase(WgerTestCase):
self.routine.date_sequence,
[
# Monday
- WorkoutDayData(day=self.day1, iteration=1, date=datetime.date(2024, 1, 1)),
- WorkoutDayData(day=self.day2, iteration=1, date=datetime.date(2024, 1, 2)),
- WorkoutDayData(day=self.day3, iteration=1, date=datetime.date(2024, 1, 3)),
- WorkoutDayData(day=None, iteration=None, date=datetime.date(2024, 1, 4)),
- WorkoutDayData(day=None, iteration=None, date=datetime.date(2024, 1, 5)),
- WorkoutDayData(day=None, iteration=None, date=datetime.date(2024, 1, 6)),
- WorkoutDayData(day=None, iteration=None, date=datetime.date(2024, 1, 7)),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=datetime.date(2024, 1, 1),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=1,
+ date=datetime.date(2024, 1, 2),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=1,
+ date=datetime.date(2024, 1, 3),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=None,
+ date=datetime.date(2024, 1, 4),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=None,
+ date=datetime.date(2024, 1, 5),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=None,
+ date=datetime.date(2024, 1, 6),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=None,
+ iteration=None,
+ date=datetime.date(2024, 1, 7),
+ label=None,
+ ),
# Monday
- WorkoutDayData(day=self.day1, iteration=2, date=datetime.date(2024, 1, 8)),
- WorkoutDayData(day=self.day2, iteration=2, date=datetime.date(2024, 1, 9)),
- WorkoutDayData(day=self.day3, iteration=2, date=datetime.date(2024, 1, 10)),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=2,
+ date=datetime.date(2024, 1, 8),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=2,
+ date=datetime.date(2024, 1, 9),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=2,
+ date=datetime.date(2024, 1, 10),
+ label=None,
+ ),
],
)
@@ -163,16 +267,66 @@ class RoutineTestCase(WgerTestCase):
self.assertEqual(
self.routine.date_sequence,
[
- WorkoutDayData(day=self.day1, iteration=1, date=datetime.date(2024, 1, 1)),
- WorkoutDayData(day=self.day1, iteration=2, date=datetime.date(2024, 1, 2)),
- WorkoutDayData(day=self.day1, iteration=3, date=datetime.date(2024, 1, 3)),
- WorkoutDayData(day=self.day1, iteration=4, date=datetime.date(2024, 1, 4)),
- WorkoutDayData(day=self.day2, iteration=1, date=datetime.date(2024, 1, 5)),
- WorkoutDayData(day=self.day3, iteration=1, date=datetime.date(2024, 1, 6)),
- WorkoutDayData(day=self.day1, iteration=5, date=datetime.date(2024, 1, 7)),
- WorkoutDayData(day=self.day2, iteration=2, date=datetime.date(2024, 1, 8)),
- WorkoutDayData(day=self.day3, iteration=2, date=datetime.date(2024, 1, 9)),
- WorkoutDayData(day=self.day1, iteration=6, date=datetime.date(2024, 1, 10)),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=1,
+ date=datetime.date(2024, 1, 1),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=2,
+ date=datetime.date(2024, 1, 2),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=3,
+ date=datetime.date(2024, 1, 3),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=4,
+ date=datetime.date(2024, 1, 4),
+ label='First label',
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=1,
+ date=datetime.date(2024, 1, 5),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=1,
+ date=datetime.date(2024, 1, 6),
+ label='Second label',
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=5,
+ date=datetime.date(2024, 1, 7),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day2,
+ iteration=2,
+ date=datetime.date(2024, 1, 8),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day3,
+ iteration=2,
+ date=datetime.date(2024, 1, 9),
+ label=None,
+ ),
+ WorkoutDayData(
+ day=self.day1,
+ iteration=6,
+ date=datetime.date(2024, 1, 10),
+ label=None,
+ ),
],
)