Add option for users to set personalized points goals for modules

mikaelGusse · Jun 13, 2024 · 6c70125 · 6c70125
1 parent 1604329
commit 6c70125
Show file tree

Hide file tree

Showing 19 changed files with 260 additions and 13 deletions.
diff --git a/assets/sass/main.scss b/assets/sass/main.scss
@@ -17,6 +17,7 @@ $brand-success: $aplus-success;
 $brand-info: $aplus-info;
 $brand-warning: $aplus-warning;
 $brand-danger: $aplus-danger;
+$brand-focus: $aplus-focus;
 // The default $headings-small-color has a low contrast in most of the cases.
 $headings-small-color: #535353;
 

diff --git a/course/forms.py b/course/forms.py
@@ -10,7 +10,7 @@
 from aplus.api import api_reverse
 from exercise.models import SubmissionDraft
 from lib.fields import UsersSearchSelectField
-from .models import Enrollment, StudentGroup
+from .models import CourseModule, Enrollment, StudentGroup, StudentModuleGoal
 from userprofile.models import UserProfile
 
 
@@ -162,3 +162,12 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
                 required=False,
                 label=_('LABEL_ENROLL_FROM_SIS'),
             )
+
+class StudentModuleGoalForm(forms.ModelForm):
+    student = forms.ModelChoiceField(queryset=UserProfile.objects.all())
+    module = forms.ModelChoiceField(queryset=CourseModule.objects.all())
+    personalized_points_goal = forms.IntegerField(initial=100)
+
+    class Meta:
+        model = StudentModuleGoal
+        fields = ['student', 'module', 'personalized_points_goal']
diff --git a/course/migrations/0060_coursemodule_personalized_points_goal.py b/course/migrations/0060_coursemodule_personalized_points_goal.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2.11 on 2024-06-03 11:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("course", "0059_submissiontag"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="coursemodule",
+            name="personalized_points_goal",
+            field=models.PositiveIntegerField(
+                default=100, verbose_name="LABEL_PERSONALIZED_POINTS_GOAL"
+            ),
+        ),
+    ]
diff --git a/course/migrations/0061_remove_coursemodule_personalized_points_goal.py b/course/migrations/0061_remove_coursemodule_personalized_points_goal.py
@@ -0,0 +1,17 @@
+# Generated by Django 4.2.11 on 2024-06-03 12:52
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("course", "0060_coursemodule_personalized_points_goal"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="coursemodule",
+            name="personalized_points_goal",
+        ),
+    ]
diff --git a/course/migrations/0062_studentmodulegoal.py b/course/migrations/0062_studentmodulegoal.py
@@ -0,0 +1,44 @@
+# Generated by Django 4.2.11 on 2024-06-03 13:02
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("userprofile", "0008_delete_studentmodulegoal"),
+        ("course", "0061_remove_coursemodule_personalized_points_goal"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="StudentModuleGoal",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("personalized_points_goal", models.IntegerField(default=0)),
+                (
+                    "module",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="course.coursemodule",
+                    ),
+                ),
+                (
+                    "student",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="userprofile.userprofile",
+                    ),
+                ),
+            ],
+        ),
+    ]
diff --git a/course/migrations/0063_alter_studentmodulegoal_personalized_points_goal.py b/course/migrations/0063_alter_studentmodulegoal_personalized_points_goal.py
@@ -0,0 +1,18 @@
+# Generated by Django 4.2.11 on 2024-06-12 10:11
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("course", "0062_studentmodulegoal"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="studentmodulegoal",
+            name="personalized_points_goal",
+            field=models.IntegerField(default=100),
+        ),
+    ]
diff --git a/course/models.py b/course/models.py
@@ -1482,6 +1482,12 @@ def number_of_submitters(self):
             .filter(submissions__exercise__course_module=self).distinct().count()
 
 
+class StudentModuleGoal(models.Model):
+    student = models.ForeignKey(UserProfile, on_delete=models.CASCADE)
+    module = models.ForeignKey(CourseModule, on_delete=models.CASCADE)
+    personalized_points_goal = models.IntegerField(default=100)
+
+
 class LearningObjectCategory(models.Model):
     """
     Learning objects may be grouped to different categories.

diff --git a/course/views.py b/course/views.py
@@ -22,8 +22,8 @@
 from lib.helpers import settings_text, remove_query_param_from_url, is_ajax
 from lib.viewbase import BaseTemplateView, BaseRedirectMixin, BaseFormView, BaseView, BaseRedirectView
 from userprofile.viewbase import UserProfileView
-from .forms import GroupsForm, GroupSelectForm
-from .models import Course, CourseInstance, CourseModule, Enrollment
+from .forms import GroupsForm, GroupSelectForm, StudentModuleGoalForm
+from .models import Course, CourseInstance, CourseModule, Enrollment, StudentModuleGoal
 from .permissions import EnrollInfoVisiblePermission
 from .renders import group_info_context
 from .viewbase import CourseModuleBaseView, CourseInstanceMixin, EnrollableViewMixin, CourseMixin

diff --git a/exercise/migrations/0051_baseexercise_personalized_points_goal.py b/exercise/migrations/0051_baseexercise_personalized_points_goal.py
@@ -0,0 +1,20 @@
+# Generated by Django 4.2.11 on 2024-06-03 10:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("exercise", "0050_submissiontagging"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="baseexercise",
+            name="personalized_points_goal",
+            field=models.PositiveIntegerField(
+                default=100, verbose_name="LABEL_PERSONALIZED_POINTS_GOAL"
+            ),
+        ),
+    ]
diff --git a/exercise/migrations/0052_remove_baseexercise_personalized_points_goal.py b/exercise/migrations/0052_remove_baseexercise_personalized_points_goal.py
@@ -0,0 +1,17 @@
+# Generated by Django 4.2.11 on 2024-06-03 11:26
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("exercise", "0051_baseexercise_personalized_points_goal"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="baseexercise",
+            name="personalized_points_goal",
+        ),
+    ]
diff --git a/exercise/templates/exercise/_points_progress.html b/exercise/templates/exercise/_points_progress.html
@@ -5,9 +5,11 @@
 	{% translate "RESULTS_OF_SOME_ASSIGNMENTS_ARE_CURRENTLY_HIDDEN" %}
 </p>
 {% endif %}
+Personalized {{personalized_points_goal}}
+
 <div class="progress" data-toggle="tooltip" data-html="true" data-placement="bottom"
     title="{% translate 'POINTS' %}: &lt;span class='text-nowrap'&gt;{{ formatted_points }} / {{ max }}&lt;/span&gt;{% if required %} {% translate 'POINTS_TO_PASS' %}: &lt;span class='text-nowrap'&gt;{{ required }}&lt;/span&gt;{% endif %}">
-    <div class="progress-bar progress-bar-striped progress-bar-{% if full_score %}success{% elif passed %}warning{% else %}danger{% endif %}"
+    <div class="progress-bar progress-bar-striped progress-bar-{% if percentage >= personalized_points_goal %}info{% elif full_score %}success{% elif passed %}warning{% else %}danger{% endif %}"
         rel="progressbar" aria-valuenow="{{ points }}" aria-valuemin="0" aria-valuemax="{{ max }}"
         style="width:{{ percentage }}%;"></div>
     {% if required_percentage %}

diff --git a/exercise/templates/exercise/_user_results.html b/exercise/templates/exercise/_user_results.html
@@ -45,6 +45,11 @@
 		aria-expanded="{% if accessible and not after_open or open %}true{% else %}false{% endif %}" aria-controls="#module{{ module.id }}">
 		<h3 class="panel-title">
 			{% points_badge module "pull-right" %}
+			{% for goal in personalized_points_goal %}
+				{% if goal.module.id == module.id %}
+					PERSONALIZED POINTS GOAL {{ goal.personalized_points_goal }}% 
+				{% endif %}
+			{% endfor %}
 			{% if not accessible %}
 			<span class="badge pull-right">
 				{% translate "OPENS ON" %} {{ module.opening_time }}
@@ -103,8 +108,9 @@ <h3 class="panel-title">
 				{% endblocktranslate %}
 			{% endif %}
 		</p>
-
-		{% points_progress module %}
+
+		Goals {{goal.personalized_points_goal}}
+		{% points_progress module 50 %}
 		{{ module.introduction|safe }}
 		{% if student %}
 			{% adddeviationsbutton instance module submitters=student %}

diff --git a/exercise/templates/exercise/student_module_goal.html b/exercise/templates/exercise/student_module_goal.html
@@ -0,0 +1,5 @@
+<form method="POST">
+    {% csrf_token %}
+    {{ form.as_p }}
+    <button type="submit">Save</button>
+</form>
diff --git a/exercise/templatetags/exercise.py b/exercise/templatetags/exercise.py
@@ -11,7 +11,7 @@
 from django.utils.text import format_lazy
 from django.utils.translation import gettext_lazy as _
 
-from course.models import CourseInstance, CourseModule
+from course.models import CourseInstance, CourseModule, StudentModuleGoal
 from lib.errors import TagUsageError
 from lib.helpers import format_points as _format_points, is_ajax as _is_ajax
 from userprofile.models import UserProfile
@@ -29,7 +29,6 @@
 
 register = template.Library()
 
-
 def _prepare_now(context):
     if 'now' not in context:
         context['now'] = timezone.now()
@@ -54,12 +53,18 @@ def _prepare_context(context: Context, student: Optional[User] = None) -> Cached
 
 def _get_toc(context, student=None):
     points = _prepare_context(context, student)
+        # Add personalized_points_goal to the context
+    if 'personalized_points_goal' not in context:
+        context["personalized_points_goal"] = StudentModuleGoal.objects.all
+    print(StudentModuleGoal.objects.all())
+
     context = context.flatten()
     context.update({
         'modules': points.modules_flatted(),
         'categories': points.categories(),
         'total': points.total().as_dict(),
         'is_course_staff': context.get('is_course_staff', False),
+        'personalized_points_goal': context.get('personalized_points_goal', 100),
     })
     return context
 
@@ -110,6 +115,7 @@ def user_results(context: Context, student: Optional[User] = None) -> Dict[str,
             .order_by()
         )
         values['exercise_submitter_counts'] = {row['submissions__exercise_id']: row['count'] for row in counts}
+    print("StudentModuleGoalObjects", StudentModuleGoal.objects.all())
     return values
 
 
@@ -245,8 +251,11 @@ def _points_data(
 @register.inclusion_tag("exercise/_points_progress.html")
 def points_progress(
         obj: Union[CachedPointsData, ModulePoints, CategoryPoints],
+        personalized_points_goal: int = 100,
         ) -> Dict[str, Any]:
-    return _points_data(obj, None)
+    data = _points_data(obj, None)
+    data['personalized_points_goal'] = personalized_points_goal
+    return data
 
 
 @register.inclusion_tag("exercise/_points_badge.html")

diff --git a/exercise/urls.py b/exercise/urls.py
@@ -82,6 +82,9 @@
     re_path(EDIT_URL_PREFIX + r'results/$',
         staff_views.AllResultsView.as_view(),
         name="all-results"),
+    re_path(MODULE_URL_PREFIX + r'student_module_goal/$',
+        views.StudentModuleGoalView.as_view(),
+        name="student_module_goal"),
     re_path(EDIT_URL_PREFIX + r'analytics/$',
         staff_views.AnalyticsView.as_view(),
         name="analytics"),

diff --git a/exercise/views.py b/exercise/views.py
@@ -13,11 +13,12 @@
 from django.db import DatabaseError
 
 from authorization.permissions import ACCESS
-from course.models import CourseModule, SubmissionTag
-from course.viewbase import CourseInstanceBaseView, EnrollableViewMixin
+from course.forms import StudentModuleGoalForm
+from course.models import CourseModule, StudentModuleGoal, SubmissionTag
+from course.viewbase import CourseInstanceBaseView, CourseModuleBaseView, EnrollableViewMixin
 from lib.helpers import query_dict_to_list_of_tuples, safe_file_name, is_ajax
 from lib.remote_page import RemotePageNotFound, request_for_response
-from lib.viewbase import BaseRedirectMixin, BaseView
+from lib.viewbase import BaseFormView, BaseRedirectMixin, BaseView
 from userprofile.models import UserProfile
 from .cache.points import ExercisePoints
 from .models import BaseExercise, LearningObject, LearningObjectDisplay
@@ -561,3 +562,21 @@ def post(self, request: HttpRequest, *args: Any, **kwargs: Any) -> HttpResponse:
         self.exercise.set_submission_draft(self.profile, submission_data_list)
         # Simple OK response
         return HttpResponse()
+
+
+class StudentModuleGoalView(CourseModuleBaseView, BaseFormView):
+    access_mode = ACCESS.STUDENT
+    template_name = "exercise/student_module_goal.html"
+    form_class = StudentModuleGoalForm
+
+    def get_common_objects(self):
+        super().get_common_objects()
+
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        return kwargs
+
+    def form_valid(self, form):
+        form.save()
+        messages.success(self.request, _('MODULE_GOAL_UPDATED'))
+        return super().form_valid(form)
diff --git a/userprofile/migrations/0007_studentmodulegoal.py b/userprofile/migrations/0007_studentmodulegoal.py
@@ -0,0 +1,36 @@
+# Generated by Django 4.2.11 on 2024-06-03 12:52
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("userprofile", "0006_auto_20210812_1536"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="StudentModuleGoal",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("personalized_points_goal", models.IntegerField(default=0)),
+                (
+                    "student",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="userprofile.userprofile",
+                    ),
+                ),
+            ],
+        ),
+    ]
diff --git a/userprofile/migrations/0008_delete_studentmodulegoal.py b/userprofile/migrations/0008_delete_studentmodulegoal.py
@@ -0,0 +1,16 @@
+# Generated by Django 4.2.11 on 2024-06-03 13:02
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("userprofile", "0007_studentmodulegoal"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="StudentModuleGoal",
+        ),
+    ]