Merge pull request #301 from spseol/fix-grades

Author: thejoeejoee

.env.local.template

@@ -6,6 +6,7 @@ ALLOWED_HOSTS=domain.com www.domain.com
 SECRET_KEY=...
 
 # for ldap remote login
+# LDAP_DISABLE=True
 LDAP_HOST=localhost
 LDAP_PORT=389
 LDAP_USERNAME=user

django/.env.base

@@ -1,4 +1,4 @@
-THESAURUS_VERSION=1.0.3
+THESAURUS_VERSION=1.1.0
 
 SQL_ENGINE=django.db.backends.postgresql
 SQL_DATABASE=thesaurus

django/apps/api/views/review.py

@@ -8,6 +8,7 @@ class ReviewViewSet(ModelViewSet):
     queryset = Review.objects.get_queryset().select_related(
         'thesis__opponent',
         'thesis__supervisor',
+        'thesis__category',
     ).prefetch_related(
         'thesis__authors',
     )

django/apps/review/admin.py

@@ -1,14 +1,25 @@
 from django.contrib.admin import ModelAdmin, register, RelatedOnlyFieldListFilter
+from django.utils.translation import gettext_lazy as _
 
 from apps.review.models import Review
 
 
 @register(Review)
 class ReviewAdmin(ModelAdmin):
-    date_hierarchy = 'thesis__published_at'
-    list_display = ['thesis', 'user', 'created', 'grade_proposal']
+    date_hierarchy = "thesis__published_at"
+    list_display = ["thesis", "user", "created", "grade_proposal_display"]
 
     list_filter = (
-        ('user', RelatedOnlyFieldListFilter),
-        'grade_proposal',
+        ("user", RelatedOnlyFieldListFilter),
+        "grade_proposal",
     )
+
+    @staticmethod
+    def grade_proposal_display(obj: Review) -> str:
+        choices_class = obj.get_grades_choices()
+        try:
+            return choices_class(obj.grade_proposal).label
+        except ValueError:
+            return str(obj.grade_proposal)
+
+    grade_proposal_display.short_description = _("Proposed grade")

django/apps/review/migrations/0009_relax_grade_validators.py

@@ -0,0 +1,47 @@
+import django.contrib.postgres.fields
+import django.contrib.postgres.validators
+import django.core.validators
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('review', '0008_auto_20231023_2110'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='review',
+            name='grades',
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.PositiveSmallIntegerField(
+                    choices=[(1, 'A'), (2, 'B'), (3, 'C'), (4, 'D'), (5, 'E'), (6, 'F')],
+                    help_text='As value between 1 and 6 inclusive.',
+                    validators=[
+                        django.core.validators.MinValueValidator(1),
+                        django.core.validators.MaxValueValidator(6),
+                    ],
+                ),
+                size=None,
+                validators=[
+                    django.contrib.postgres.validators.ArrayMinLengthValidator(5),
+                    django.contrib.postgres.validators.ArrayMaxLengthValidator(6),
+                ],
+                verbose_name='Grades',
+            ),
+        ),
+        migrations.AlterField(
+            model_name='review',
+            name='grade_proposal',
+            field=models.PositiveSmallIntegerField(
+                choices=[(1, 'A'), (2, 'B'), (3, 'C'), (4, 'D'), (5, 'E'), (6, 'F')],
+                help_text='As value between 1 and 6 inclusive.',
+                validators=[
+                    django.core.validators.MinValueValidator(1),
+                    django.core.validators.MaxValueValidator(6),
+                ],
+                verbose_name='Proposed grade',
+            ),
+        ),
+    ]

django/apps/review/models/review.py

@@ -19,11 +19,31 @@ class GradesChoices(IntegerChoices):
         VERY_WELL = 3, _('Very well')
         EXCELLENT = 4, _('Excellent')
 
+    class GradesDMPChoices(IntegerChoices):
+        VYBORNY = 1, _('1 - výborný')
+        CHVALITEBNY = 2, _('2 - chvalitebný')
+        DOBRY = 3, _('3 - dobrý')
+        DOSTATECNY = 4, _('4 - dostatečný')
+        NEDOSTATECNY = 5, _('5 - nedostatečný')
+
+    class GradesAPChoices(IntegerChoices):
+        A = 1, 'A'
+        B = 2, 'B'
+        C = 3, 'C'
+        D = 4, 'D'
+        E = 5, 'E'
+        F = 6, 'F'
+
     class DifficultyChoices(IntegerChoices):
         UNDER_AVERAGE = 1, _('Under average')
         AVERAGE = 2, _('Average')
         OVER_AVERAGE = 3, _('Over average')
 
+    class DifficultyNewChoices(IntegerChoices):
+        OVER_AVERAGE = 1, _('Over average')
+        AVERAGE = 2, _('Average')
+        UNDER_AVERAGE = 3, _('Under average')
+
     thesis = models.ForeignKey(
         to='thesis.Thesis',
         on_delete=models.CASCADE,
@@ -45,24 +65,24 @@ class DifficultyChoices(IntegerChoices):
     )
     difficulty = models.PositiveSmallIntegerField(
         verbose_name=_('Difficulty'),
-        help_text=_('As value between 1 and 3 inclusive, higher is harder.'),
+        help_text=_('As value between 1 and 3 inclusive.'),
         validators=[MinValueValidator(1), MaxValueValidator(3)],
         choices=DifficultyChoices.choices,
     )
     grades = ArrayField(
         models.PositiveSmallIntegerField(
-            validators=[MinValueValidator(1), MaxValueValidator(4)],
-            choices=GradesChoices.choices,
-            help_text=_('As value between 1 and 4 inclusive, higher is better.'),
+            validators=[MinValueValidator(1), MaxValueValidator(6)],
+            choices=GradesAPChoices.choices,
+            help_text=_('As value between 1 and 6 inclusive.'),
         ),
         validators=[ArrayMinLengthValidator(5), ArrayMaxLengthValidator(6)],
         verbose_name=_('Grades'),
     )
     grade_proposal = models.PositiveSmallIntegerField(
         verbose_name=_('Proposed grade'),
-        validators=[MinValueValidator(1), MaxValueValidator(4)],
-        help_text=_('As value between 1 and 4 inclusive, higher is better.'),
-        choices=GradesChoices.choices,
+        validators=[MinValueValidator(1), MaxValueValidator(6)],
+        help_text=_('As value between 1 and 6 inclusive.'),
+        choices=GradesAPChoices.choices,
     )
 
     class Meta:
@@ -73,6 +93,30 @@ class Meta:
     def __str__(self):
         return _('Review on {} from {}').format(self.thesis, self.user)
 
+    GRADE_TYPE_CUTOFF_YEAR = 2026
+
+    @staticmethod
+    def get_grade_config(category_grade_type, published_at):
+        """Return (choices_class, max_value, lower_is_better) for given category and publish date."""
+        use_new = published_at and published_at.year >= Review.GRADE_TYPE_CUTOFF_YEAR
+        if not use_new:
+            return Review.GradesChoices, 4, False
+        if category_grade_type == 'ap':
+            return Review.GradesAPChoices, 6, True
+        return Review.GradesDMPChoices, 5, True
+
+    def get_grades_choices(self):
+        choices_class, _, _ = self.get_grade_config(
+            self.thesis.category.grade_type, self.thesis.published_at
+        )
+        return choices_class
+
+    def get_difficulty_choices(self):
+        use_new = self.thesis.published_at and self.thesis.published_at.year >= self.GRADE_TYPE_CUTOFF_YEAR
+        if use_new:
+            return self.DifficultyNewChoices
+        return self.DifficultyChoices
+
     @property
     def gradings(self):
         return tuple(filter(None, (

django/apps/review/serializers.py

@@ -52,6 +52,25 @@ def validate(self, attrs):
             raise ValidationError(_('Review has been already posted by this user or this user is not allowed to post '
                                     'review for this thesis.'))
 
+        choices_class, max_value, _ = Review.get_grade_config(
+            thesis.category.grade_type, thesis.published_at
+        )
+        valid_values = set(choices_class.values)
+
+        for g in attrs.get('grades', []):
+            if g not in valid_values:
+                raise ValidationError(
+                    _('Invalid grade value %(value)s. Allowed values: %(allowed)s.')
+                    % {'value': g, 'allowed': ', '.join(str(v) for v in sorted(valid_values))}
+                )
+
+        grade_proposal = attrs.get('grade_proposal')
+        if grade_proposal is not None and grade_proposal not in valid_values:
+            raise ValidationError(
+                _('Invalid grade proposal value %(value)s. Allowed values: %(allowed)s.')
+                % {'value': grade_proposal, 'allowed': ', '.join(str(v) for v in sorted(valid_values))}
+            )
+
         return attrs
 
 

django/apps/review/templates/review/review_detail.html

@@ -145,22 +145,22 @@ <h1>{% trans "Thesis review" %}</h1>
         <td><strong>{% trans "Criteriums of thesis grading" %}</strong></td>
         <td>
             <strong>{% trans "Grade" %}</strong>
-            <small class="right">({% for l in review.GradesChoices.labels %}{{ l.lower }}{% if not forloop.last %},
+            <small class="right">({% for l in grades_choices.labels %}{{ l.lower }}{% if not forloop.last %},
             {% endif %}{% endfor %})</small>
         </td>
     </tr>
     <tr>
         <td>{% trans "Difficulty of selected topic" %}</td>
         <td>
-            <strong>{{ review.get_difficulty_display }}</strong>
-            <small class="right">({% for l in review.DifficultyChoices.labels %}{{ l.lower }}{% if not forloop.last %},
+            <strong>{{ difficulty_display }}</strong>
+            <small class="right">({% for l in difficulty_choices.labels %}{{ l.lower }}{% if not forloop.last %},
             {% endif %}{% endfor %})</small>
         </td>
     </tr>
     {% for grading, grade in review.gradings|zip:review.grades %}
         <tr{% if forloop.last %} class="row-bottom-divider"{% endif %}>
             <td>{{ grading }}</td>
-            <td><strong>{{ grade|get_choices_display:review.GradesChoices }}</strong></td>
+            <td><strong>{{ grade|get_choices_display:grades_choices }}</strong></td>
         </tr>
     {% endfor %}
     <tr class="row-bottom-divider comment-and-questions-row">
@@ -182,7 +182,7 @@ <h1>{% trans "Thesis review" %}</h1>
     </tr>
     <tr class="row-bottom-divider">
         <td>{% get_verbose_field_name review "grade_proposal" %}</td>
-        <td>{{ review.get_grade_proposal_display }}</td>
+        <td>{{ grade_proposal_display }}</td>
     </tr>
     <tr class="row-bottom-divider row-higher">
         <td>

django/apps/review/views.py

@@ -12,6 +12,9 @@ class ReviewPdfView(WeasyTemplateResponseMixin, PermissionRequiredMixin, DetailV
     model = Review
     template_name = 'review/review_detail.html'
 
+    def get_queryset(self):
+        return super().get_queryset().select_related('thesis__category')
+
     def has_permission(self):
         review: Review = self.get_object()
 
@@ -20,3 +23,14 @@ def has_permission(self):
             view=self,
             thesis=review.thesis,
         )
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        review = self.get_object()
+        grades_choices = review.get_grades_choices()
+        context['grades_choices'] = grades_choices
+        context['grade_proposal_display'] = grades_choices(review.grade_proposal).label
+        difficulty_choices = review.get_difficulty_choices()
+        context['difficulty_choices'] = difficulty_choices
+        context['difficulty_display'] = difficulty_choices(review.difficulty).label
+        return context

django/apps/thesis/admin.py

@@ -57,4 +57,5 @@ class ReservationAdmin(ModelAdmin):
 
 @register(Category)
 class CategoryAdmin(ModelAdmin):
-    pass
+    list_display = ('title', 'order', 'grade_type')
+    list_editable = ('grade_type',)