Self hosted FLOSS fitness/workout, nutrition and weight tracker
Add logic to calculate the dates and workout days from the given loop
Roland Geider6de7790ba7da
diff --git a/wger/manager/migrations/0018_flexible_routines.py b/wger/manager/migrations/0018_flexible_routines.pynew file mode 100644index 000000000..91542c17f--- /dev/null+++ b/wger/manager/migrations/0018_flexible_routines.py@@ -0,0 +1,414 @@+# Generated by Django 4.2.6 on 2024-03-06 10:02++from django.conf import settings+from django.db import migrations, models+import django.db.models.deletion+++class Migration(migrations.Migration):+ dependencies = [+ migrations.swappable_dependency(settings.AUTH_USER_MODEL),+ ('exercises', '0028_add_uuid_alias_and_comments'),+ ('core', '0016_alter_language_short_name'),+ ('manager', '0017_alter_workoutlog_exercise_base'),+ ]++ operations = [+ migrations.CreateModel(+ name='DayNg',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('description', models.CharField(max_length=50, verbose_name='Description')),+ ('is_rest', models.BooleanField(default=False)),+ ('need_logs_to_advance', models.BooleanField(default=False)),+ (+ 'next_day',+ models.ForeignKey(+ blank=True,+ null=True,+ on_delete=django.db.models.deletion.CASCADE,+ to='manager.dayng',+ ),+ ),+ ],+ ),+ migrations.CreateModel(+ name='SetConfig',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('order', models.PositiveIntegerField(blank=True, verbose_name='Order')),+ ('comment', models.CharField(blank=True, max_length=100, verbose_name='Comment')),+ (+ 'exercise',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE,+ to='exercises.exercisebase',+ verbose_name='Exercise',+ ),+ ),+ (+ 'repetition_unit',+ models.ForeignKey(+ default=1,+ on_delete=django.db.models.deletion.CASCADE,+ to='core.repetitionunit',+ verbose_name='Unit',+ ),+ ),+ (+ 'set',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE,+ to='manager.set',+ verbose_name='Sets',+ ),+ ),+ (+ 'weight_unit',+ models.ForeignKey(+ default=1,+ on_delete=django.db.models.deletion.CASCADE,+ to='core.weightunit',+ verbose_name='Unit',+ ),+ ),+ ],+ options={+ 'ordering': ['order', 'id'],+ },+ ),+ migrations.CreateModel(+ name='WeightConfig',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('iteration', models.PositiveIntegerField()),+ ('value', models.DecimalField(decimal_places=2, max_digits=6)),+ (+ 'creation_date',+ models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),+ ),+ (+ 'operation',+ models.CharField(+ choices=[('+', 'Plus'), ('-', 'Minus')],+ default='+',+ max_length=1,+ null=True,+ ),+ ),+ (+ 'trigger',+ models.CharField(+ choices=[('session', 'Session'), ('week', 'Week')],+ default='session',+ max_length=10,+ null=True,+ ),+ ),+ (+ 'step',+ models.CharField(+ choices=[('abs', 'Absolute'), ('percent', 'Percent')],+ default='abs',+ max_length=10,+ null=True,+ ),+ ),+ ('replace', models.BooleanField(default=False)),+ ('code', models.CharField(max_length=100)),+ (+ 'set_config',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE, to='manager.setconfig'+ ),+ ),+ ],+ options={+ 'ordering': ['-creation_date'],+ },+ ),+ migrations.CreateModel(+ name='SetNg',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True, primary_key=True, serialize=False, verbose_name='ID'+ ),+ ),+ ('order', models.IntegerField(default=1, verbose_name='Order')),+ ('comment', models.CharField(blank=True, max_length=200, verbose_name='Comment')),+ ('is_dropset', models.BooleanField(default=False)),+ (+ 'day',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE,+ to='manager.day',+ verbose_name='Exercise day',+ ),+ ),+ ],+ options={+ 'ordering': ['order'],+ },+ ),+ migrations.CreateModel(+ name='Routine',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('name', models.CharField(blank=True, max_length=50, verbose_name='Name')),+ (+ 'description',+ models.TextField(blank=True, max_length=1000, verbose_name='Description'),+ ),+ (+ 'creation_date',+ models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),+ ),+ ('start', models.DateField(verbose_name='Start date')),+ ('end', models.DateField(verbose_name='End date')),+ (+ 'first_day',+ models.ForeignKey(+ null=True,+ on_delete=django.db.models.deletion.CASCADE,+ related_name='day',+ to='manager.dayng',+ ),+ ),+ (+ 'user',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE,+ to=settings.AUTH_USER_MODEL,+ verbose_name='User',+ ),+ ),+ ],+ options={+ 'ordering': ['-creation_date'],+ },+ ),+ migrations.CreateModel(+ name='RiRConfig',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('iteration', models.PositiveIntegerField()),+ ('value', models.DecimalField(decimal_places=2, max_digits=6)),+ (+ 'creation_date',+ models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),+ ),+ (+ 'operation',+ models.CharField(+ choices=[('+', 'Plus'), ('-', 'Minus')],+ default='+',+ max_length=1,+ null=True,+ ),+ ),+ (+ 'trigger',+ models.CharField(+ choices=[('session', 'Session'), ('week', 'Week')],+ default='session',+ max_length=10,+ null=True,+ ),+ ),+ (+ 'step',+ models.CharField(+ choices=[('abs', 'Absolute'), ('percent', 'Percent')],+ default='abs',+ max_length=10,+ null=True,+ ),+ ),+ ('replace', models.BooleanField(default=False)),+ ('code', models.CharField(max_length=100)),+ (+ 'set_config',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE, to='manager.setconfig'+ ),+ ),+ ],+ options={+ 'ordering': ['-creation_date'],+ },+ ),+ migrations.CreateModel(+ name='RestConfig',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('iteration', models.PositiveIntegerField()),+ ('value', models.DecimalField(decimal_places=2, max_digits=6)),+ (+ 'creation_date',+ models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),+ ),+ (+ 'operation',+ models.CharField(+ choices=[('+', 'Plus'), ('-', 'Minus')],+ default='+',+ max_length=1,+ null=True,+ ),+ ),+ (+ 'trigger',+ models.CharField(+ choices=[('session', 'Session'), ('week', 'Week')],+ default='session',+ max_length=10,+ null=True,+ ),+ ),+ (+ 'step',+ models.CharField(+ choices=[('abs', 'Absolute'), ('percent', 'Percent')],+ default='abs',+ max_length=10,+ null=True,+ ),+ ),+ ('replace', models.BooleanField(default=False)),+ ('code', models.CharField(max_length=100)),+ (+ 'set_config',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE, to='manager.setconfig'+ ),+ ),+ ],+ options={+ 'ordering': ['-creation_date'],+ },+ ),+ migrations.CreateModel(+ name='RepsConfig',+ fields=[+ (+ 'id',+ models.AutoField(+ auto_created=True,+ primary_key=True,+ serialize=False,+ verbose_name='ID',+ ),+ ),+ ('iteration', models.PositiveIntegerField()),+ ('value', models.DecimalField(decimal_places=2, max_digits=6)),+ (+ 'creation_date',+ models.DateTimeField(auto_now_add=True, verbose_name='Creation date'),+ ),+ (+ 'operation',+ models.CharField(+ choices=[('+', 'Plus'), ('-', 'Minus')],+ default='+',+ max_length=1,+ null=True,+ ),+ ),+ (+ 'trigger',+ models.CharField(+ choices=[('session', 'Session'), ('week', 'Week')],+ default='session',+ max_length=10,+ null=True,+ ),+ ),+ (+ 'step',+ models.CharField(+ choices=[('abs', 'Absolute'), ('percent', 'Percent')],+ default='abs',+ max_length=10,+ null=True,+ ),+ ),+ ('replace', models.BooleanField(default=False)),+ ('code', models.CharField(max_length=100)),+ (+ 'set_config',+ models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE, to='manager.setconfig'+ ),+ ),+ ],+ options={+ 'ordering': ['-creation_date'],+ },+ ),+ migrations.AddField(+ model_name='dayng',+ name='routine',+ field=models.ForeignKey(+ on_delete=django.db.models.deletion.CASCADE,+ to='manager.routine',+ verbose_name='Routine',+ ),+ ),+ migrations.AddField(+ model_name='workoutsession',+ name='day',+ field=models.ForeignKey(+ null=True, on_delete=django.db.models.deletion.CASCADE, to='manager.dayng'+ ),+ ),+ ]diff --git a/wger/manager/models/__init__.py b/wger/manager/models/__init__.pyindex 60c77740e..68c6f164c 100644--- a/wger/manager/models/__init__.py+++ b/wger/manager/models/__init__.py@@ -16,7 +16,10 @@# Localfrom .abstract_config import AbstractChangeConfig-from .day import Day+from .day import (+ Day,+ DayNg,+)from .log import WorkoutLogfrom .reps_config import RepsConfigfrom .rest_config import RestConfig@@ -24,7 +27,10 @@ from .rir_config import RiRConfigfrom .schedule import Schedulefrom .schedule_step import ScheduleStepfrom .session import WorkoutSession-from .set import Set+from .set import (+ Set,+ SetNg,+)from .setting import Settingfrom .weight_config import WeightConfigfrom .workout import Workoutdiff --git a/wger/manager/models/abstract_config.py b/wger/manager/models/abstract_config.pyindex 589690551..7ba62fac2 100644--- a/wger/manager/models/abstract_config.py+++ b/wger/manager/models/abstract_config.py@@ -23,18 +23,18 @@ from wger.manager.models.set_config import SetConfigclass OperationChoices(models.TextChoices):- PLUS = "+"- MINUS = "-"+ PLUS = '+'+ MINUS = '-'class TriggerChoices(models.TextChoices):- SESSION = "session"- WEEK = "week"+ SESSION = 'session'+ WEEK = 'week'class StepChoices(models.TextChoices):- ABSOLUTE = "abs"- PERCENT = "percent"+ ABSOLUTE = 'abs'+ PERCENT = 'percent'class AbstractChangeConfig(models.Model):@@ -49,6 +49,7 @@ class AbstractChangeConfig(models.Model):value = models.DecimalField(decimal_places=2,+ max_digits=6,)set_config = models.ForeignKey(diff --git a/wger/manager/models/day.py b/wger/manager/models/day.pyindex f49764281..1e4364479 100644--- a/wger/manager/models/day.py+++ b/wger/manager/models/day.py@@ -14,6 +14,9 @@# 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/>.+# Standard Library+import datetime+# Djangofrom django.db import modelsfrom django.utils.translation import gettext_lazy as _@@ -22,8 +25,65 @@ from django.utils.translation import gettext_lazy as _from wger.core.models import DaysOfWeekfrom wger.utils.cache import reset_workout_canonical_form-# Local-from .workout import Workout++class DayNg(models.Model):+ """+ Model for a training day+ """++ routine = models.ForeignKey(+ 'Routine',+ verbose_name=_('Routine'),+ on_delete=models.CASCADE,+ )++ next_day = models.ForeignKey(+ 'self',+ blank=True,+ null=True,+ on_delete=models.CASCADE,+ )++ description = models.CharField(+ max_length=50,+ verbose_name=_('Description'),+ )++ is_rest = models.BooleanField(+ default=False,+ )+ """+ Flag indicating that this day is a rest day.++ Rest days have no exercises+ """++ need_logs_to_advance = models.BooleanField(+ default=False,+ )+ """+ Needs logs to advance to the next day+ """++ def __str__(self):+ """+ Return a more human-readable representation+ """+ return self.description++ def get_owner_object(self):+ """+ Returns the object that has owner information+ """+ return self.routine++ def can_proceed(self, date: datetime.date):+ if not self.need_logs_to_advance:+ return True+ elif self.workoutsession_set.filter(date=date).exists():+ return True++ return Falseclass Day(models.Model):@@ -32,10 +92,11 @@ class Day(models.Model):"""training = models.ForeignKey(- Workout,+ 'Workout',verbose_name=_('Workout'),on_delete=models.CASCADE,)+description = models.CharField(max_length=100,verbose_name=_('Description'),diff --git a/wger/manager/models/routine.py b/wger/manager/models/routine.pyindex 092022b38..558e34ce7 100644--- a/wger/manager/models/routine.py+++ b/wger/manager/models/routine.py@@ -14,6 +14,9 @@# 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/>.+# Standard Library+import datetime+# Djangofrom django.contrib.auth.models import Userfrom django.core.exceptions import ValidationError@@ -32,6 +35,19 @@ class Routine(models.Model):'-creation_date',]+ user = models.ForeignKey(+ User,+ verbose_name=_('User'),+ on_delete=models.CASCADE,+ )++ first_day = models.ForeignKey(+ 'DayNg',+ on_delete=models.CASCADE,+ null=True,+ related_name='day',+ )+name = models.CharField(verbose_name=_('Name'),max_length=50,@@ -56,12 +72,6 @@ class Routine(models.Model):_('End date'),)- user = models.ForeignKey(- User,- verbose_name=_('User'),- on_delete=models.CASCADE,- )-def get_absolute_url(self):"""Returns the canonical URL to view a workout@@ -87,9 +97,48 @@ class Routine(models.Model):return selfdef clean(self):- """- Perform some additional validations- """+ """Validations"""if self.end and self.start and self.start > self.end:raise ValidationError(_('The start time cannot be after the end time.'))++ @property+ def day_sequence(self):+ """+ Return a sequence of days.++ Each day object points to the next one in the sequence till it loops back+ """++ out = []+ day = self.first_day+ while day:+ if day in out:+ break+ out.append(day)+ day = day.next_day+ return out++ @property+ def date_sequence(self):+ """+ Return a dictionary with specific dates and routine days++ If a day needs logs to continue it will be repeated will the user adds one.+ """++ delta = datetime.timedelta(days=1)+ current_date = self.start+ current_day = self.first_day++ out = {}++ while current_date <= self.end:+ out[current_date] = current_day++ if current_day.can_proceed(current_date):+ current_day = current_day.next_day++ current_date += delta++ return outdiff --git a/wger/manager/models/session.py b/wger/manager/models/session.pyindex 1320ef0f7..fc0479728 100644--- a/wger/manager/models/session.py+++ b/wger/manager/models/session.py@@ -24,9 +24,6 @@ from django.utils.translation import gettext_lazy as _from wger.utils.cache import reset_workout_logfrom wger.utils.fields import Html5DateField-# Local-from .workout import Workout-class WorkoutSession(models.Model):"""@@ -56,7 +53,7 @@ class WorkoutSession(models.Model):"""workout = models.ForeignKey(- Workout,+ 'Workout',verbose_name=_('Workout'),on_delete=models.CASCADE,)@@ -64,6 +61,15 @@ class WorkoutSession(models.Model):The workout the session belongs to"""+ day = models.ForeignKey(+ 'DayNg',+ on_delete=models.CASCADE,+ null=True,+ )+ """+ The day the session belongs to+ """+date = Html5DateField(verbose_name=_('Date'))"""The date the workout session was performeddiff --git a/wger/manager/models/set.py b/wger/manager/models/set.pyindex 6fbe80cae..001d81d70 100644--- a/wger/manager/models/set.py+++ b/wger/manager/models/set.py@@ -34,6 +34,71 @@ from wger.utils.helpers import normalize_decimalfrom .day import Day+class SetNg(models.Model):+ """+ Model for a set of exercises+ """++ DEFAULT_SETS = 4+ MAX_SETS = 10++ day = models.ForeignKey(+ Day,+ verbose_name=_('Exercise day'),+ on_delete=models.CASCADE,+ )++ order = models.IntegerField(+ default=1,+ null=False,+ verbose_name=_('Order'),+ )++ comment = models.CharField(+ max_length=200,+ verbose_name=_('Comment'),+ blank=True,+ )++ is_dropset = models.BooleanField(+ default=False,+ )++ # Metaclass to set some other properties+ class Meta:+ ordering = [+ 'order',+ ]++ def __str__(self):+ """+ Return a more human-readable representation+ """+ return f'Set-ID {self.id}'++ def get_owner_object(self):+ """+ Returns the object that has owner information+ """+ return self.day.training++ def save(self, *args, **kwargs):+ """+ Reset all cached infos+ """++ reset_workout_canonical_form(self.exerciseday.training_id)+ super(Set, self).save(*args, **kwargs)++ def delete(self, *args, **kwargs):+ """+ Reset all cached infos+ """++ reset_workout_canonical_form(self.exerciseday.training_id)+ super(Set, self).delete(*args, **kwargs)++class Set(models.Model):"""Model for a set of exercisesdiff --git a/wger/manager/tests/test_routine.py b/wger/manager/tests/test_routine.pynew file mode 100644index 000000000..df07c1286--- /dev/null+++ b/wger/manager/tests/test_routine.py@@ -0,0 +1,138 @@+# 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++# Standard Library+import datetime++# wger+from wger.core.tests.base_testcase import WgerTestCase+from wger.manager.models import (+ DayNg,+ WorkoutSession,+)+from wger.manager.models.routine import Routine+++class RoutineTestCase(WgerTestCase):+ """+ Test the different day and date functions+ """++ routine: Routine+ day1: DayNg+ day2: DayNg+ day3: DayNg++ def setUp(self):+ super().setUp()++ self.routine = Routine(+ user_id=1,+ name='A routine',+ description='A routine',+ start=datetime.date(2024, 1, 1),+ end=datetime.date(2024, 1, 10),+ )+ self.routine.save()++ self.day1 = DayNg(routine=self.routine, description='day 1')+ self.day1.save()++ self.day2 = DayNg(+ routine=self.routine,+ description='day 2',+ is_rest=True,+ )+ self.day2.save()++ self.day3 = DayNg(routine=self.routine, description='day 3')+ self.day3.save()++ self.day1.next_day = self.day2+ self.day1.save()+ self.day2.next_day = self.day3+ self.day2.save()+ self.day3.next_day = self.day1+ self.day3.save()++ self.routine.first_day = self.day1++ def test_day_sequences(self):+ self.assertListEqual(+ self.routine.day_sequence,+ [self.day1, self.day2, self.day3],+ )++ def test_date_sequences(self):+ """+ Test that the days are correctly outputted in a sequence+ """++ self.assertEqual(+ self.routine.date_sequence,+ {+ datetime.date(2024, 1, 1): self.day1,+ datetime.date(2024, 1, 2): self.day2,+ datetime.date(2024, 1, 3): self.day3,+ datetime.date(2024, 1, 4): self.day1,+ datetime.date(2024, 1, 5): self.day2,+ datetime.date(2024, 1, 6): self.day3,+ datetime.date(2024, 1, 7): self.day1,+ datetime.date(2024, 1, 8): self.day2,+ datetime.date(2024, 1, 9): self.day3,+ datetime.date(2024, 1, 10): self.day1,+ },+ )++ def test_date_sequences_logs(self):+ """+ Test that the days are correctly outputted in a sequence++ Day one needs logs to advance, till then it will be repeated+ """++ # Arrange+ self.day1.need_logs_to_advance = True+ self.day1.save()++ dates = [+ datetime.date(2024, 1, 4),+ datetime.date(2024, 1, 7),+ ]++ for date in dates:+ session = WorkoutSession(+ user_id=1,+ date=date,+ day=self.day1,+ workout_id=1,+ )+ session.save()++ # Assert+ self.assertEqual(+ self.routine.date_sequence,+ {+ datetime.date(2024, 1, 1): self.day1,+ datetime.date(2024, 1, 2): self.day1,+ datetime.date(2024, 1, 3): self.day1,+ datetime.date(2024, 1, 4): self.day1,+ datetime.date(2024, 1, 5): self.day2,+ datetime.date(2024, 1, 6): self.day3,+ datetime.date(2024, 1, 7): self.day1,+ datetime.date(2024, 1, 8): self.day2,+ datetime.date(2024, 1, 9): self.day3,+ datetime.date(2024, 1, 10): self.day1,+ },+ )