learning-paths-plugin 0.3.4rc5__tar.gz → 0.3.4rc7__tar.gz

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/CHANGELOG.rst

@@ -29,6 +29,7 @@ Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc5/learning_paths_plugin.egg-info → learning_paths_plugin-0.3.4rc7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc5
+Version: 0.3.4rc7
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -133,6 +133,7 @@ Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/__init__.py

@@ -2,4 +2,4 @@
 Learning Paths plugin.
 """
 
-__version__ = "0.3.4-rc5"
+__version__ = "0.3.4-rc7"

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/admin.py

@@ -249,8 +249,8 @@ class EnrolledUsersAdmin(admin.ModelAdmin):
         "id",
         "user",
         "learning_path",
-        "enrolled_at",
         "is_active",
+        "created",
     ]
 
     list_filter = [

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/api/v1/serializers.py

@@ -105,7 +105,7 @@ class LearningPathListSerializer(serializers.ModelSerializer):
 
     steps = LearningPathStepSerializer(many=True, read_only=True)
     required_completion = serializers.FloatField(source="grading_criteria.required_completion", read_only=True)
-    is_enrolled = serializers.SerializerMethodField()
+    enrollment_date = serializers.SerializerMethodField()
     invite_only = serializers.BooleanField()
     image = serializers.ImageField(read_only=True)
 
@@ -118,17 +118,17 @@ class LearningPathListSerializer(serializers.ModelSerializer):
             "sequential",
             "steps",
             "required_completion",
-            "is_enrolled",
+            "enrollment_date",
             "invite_only",
         ]
 
-    def get_is_enrolled(self, obj):
+    def get_enrollment_date(self, obj):
         """
         Check if the current user is enrolled in this learning path.
         """
-        if hasattr(obj, "is_enrolled"):
-            return obj.is_enrolled
-        return False
+        if hasattr(obj, "enrollment_date"):
+            return obj.enrollment_date
+        return None
 
 
 class SkillSerializer(serializers.ModelSerializer):
@@ -183,4 +183,4 @@ class LearningPathDetailSerializer(LearningPathListSerializer):
 class LearningPathEnrollmentSerializer(serializers.ModelSerializer):
     class Meta:
         model = LearningPathEnrollment
-        fields = ("user", "learning_path", "is_active", "enrolled_at")
+        fields = ("user", "learning_path", "is_active", "created")

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/api/v1/views.py

@@ -242,7 +242,6 @@ class LearningPathEnrollmentView(APIView):
             return Response({"detail": "Enrollment exists."}, status=status.HTTP_409_CONFLICT)
 
         enrollment.is_active = True
-        enrollment.enrolled_at = datetime.now(timezone.utc)
         enrollment.save()
         return Response(LearningPathEnrollmentSerializer(enrollment).data)
 
@@ -389,7 +388,6 @@ class BulkEnrollView(APIView):
                 if enrollment:
                     if not enrollment.is_active:
                         enrollment.is_active = True
-                        enrollment.enrolled_at = datetime.now(timezone.utc)
                         enrolled_now = True
                     else:
                         audit_data["state_transition"] = LearningPathEnrollmentAudit.ENROLLED_TO_ENROLLED
@@ -452,12 +450,13 @@ class BulkEnrollView(APIView):
         `role` (str, optional): User role, used for audit.
 
         * For existing users, it deactivates their LearningPathEnrollment records.
-        * Does not affect LearningPathEnrollmentAllowed records (allowed to enroll records).
+        * For emails with active LearningPathEnrollmentAllowed records, it deactivates those records.
 
         """
-        learning_paths, existing_users, _ = self._setup_bulk_operation(request)
+        learning_paths, existing_users, emails = self._setup_bulk_operation(request)
 
         enrollments_unenrolled = []
+        enrollment_allowed_deactivated = []
 
         for learning_path in learning_paths:
             for user in existing_users:
@@ -474,9 +473,33 @@ class BulkEnrollView(APIView):
                     enrollment._audit = audit_data  # pylint: disable=protected-access
                     enrollment.save()
 
+            for email in emails:
+                try:
+                    validate_email(email)
+                except ValidationError:
+                    logger.warning("BulkEnrollView: Invalid email: %s", email)
+                    continue
+
+                enrollment_allowed = LearningPathEnrollmentAllowed.objects.filter(
+                    email=email,
+                    learning_path=learning_path,
+                ).first()
+
+                if enrollment_allowed:
+                    if enrollment_allowed.is_active:
+                        state_transition = LearningPathEnrollmentAudit.ALLOWEDTOENROLL_TO_UNENROLLED
+                        enrollment_allowed.is_active = False
+                        enrollment_allowed_deactivated.append(enrollment_allowed)
+                    else:
+                        state_transition = LearningPathEnrollmentAudit.UNENROLLED_TO_UNENROLLED
+                    audit_data = self._create_audit_data(request, state_transition)
+                    enrollment_allowed._audit = audit_data  # pylint: disable=protected-access
+                    enrollment_allowed.save()
+
         return Response(
             {
                 "enrollments_unenrolled": len(enrollments_unenrolled),
+                "enrollment_allowed_deactivated": len(enrollment_allowed_deactivated),
             },
             status=status.HTTP_204_NO_CONTENT,
         )
@@ -494,7 +517,7 @@ class LearningPathCourseEnrollmentView(APIView):
         :raises: Http404 if the learning path is not found or the user does not have access.
         """
         return get_object_or_404(
-            LearningPath.objects.get_paths_visible_to_user(self.request.user).filter(is_enrolled=True),
+            LearningPath.objects.get_paths_visible_to_user(self.request.user).filter(enrollment_date__isnull=False),
             key=learning_path_key_str,
         )
 

learning_paths_plugin-0.3.4rc7/learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py

@@ -0,0 +1,20 @@
+# Generated by Django 4.2.20 on 2025-05-30 19:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("learning_paths", "0013_enrollment_audit"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="learningpathenrollmentallowed",
+            name="is_active",
+            field=models.BooleanField(
+                db_index=True, default=True, help_text="Indicates if the enrollment allowance is active"
+            ),
+        ),
+    ]

learning_paths_plugin-0.3.4rc7/learning_paths/migrations/0015_remove_learningpathenrollment_enrolled_at.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.20 on 2025-06-02 14:39
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("learning_paths", "0014_learningpathenrollmentallowed_is_active"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="learningpathenrollment",
+            name="enrolled_at",
+        ),
+    ]

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/models.py

@@ -38,27 +38,29 @@ class LearningPathManager(models.Manager):
 
     def get_paths_visible_to_user(self, user: User) -> models.QuerySet:
         """
-        Return only learning paths that should be visible to the given user with enrollment status.
+        Return only learning paths that should be visible to the given user with an enrollment date.
 
         For staff users: all learning paths.
         For non-staff: non-invite-only paths or invite-only paths they're enrolled in.
 
-        Each learning path in the queryset is annotated with `is_enrolled` indicating
-        whether the user has an active enrollment in that learning path.
+        Each learning path in the queryset is annotated with `enrollment_date` indicating
+        the date when the user enrolled in that learning path (None if not enrolled).
+        Results are ordered by enrollment date (the most recent first), with non-enrolled paths at the end.
         """
         queryset = self.get_queryset()
 
-        # Annotate each path with whether the user is enrolled.
-        enrollment_exists = LearningPathEnrollment.objects.filter(
+        # Annotate each path with the enrollment date.
+        enrollment_subquery = LearningPathEnrollment.objects.filter(
             learning_path=OuterRef("pk"), user=user, is_active=True
-        )
-        queryset = queryset.annotate(is_enrolled=Exists(enrollment_exists))
+        ).values("created")[:1]
+        queryset = queryset.annotate(enrollment_date=models.Subquery(enrollment_subquery))
 
         # Apply visibility filtering based on the user role.
         if not user.is_staff:
-            queryset = queryset.filter(Q(invite_only=False) | Q(is_enrolled=True))
+            queryset = queryset.filter(Q(invite_only=False) | Q(enrollment_date__isnull=False))
 
-        return queryset
+        # Order by enrollment date (the most recent first), with null values at the end.
+        return queryset.order_by(models.F('enrollment_date').desc(nulls_last=True))
 
 
 class LearningPath(TimeStampedModel):
@@ -289,12 +291,6 @@ class LearningPathEnrollment(TimeStampedModel):
         default=True,
         help_text=_("Indicates if the learner is enrolled or not in the Learning Path"),
     )
-    enrolled_at = models.DateTimeField(
-        auto_now_add=True,
-        help_text=_(
-            "Timestamp of enrollment or un-enrollment. To be explicitly set when performing a learner enrollment."
-        ),
-    )
     tracker = FieldTracker(fields=["is_active"])
 
     def __str__(self):
@@ -372,6 +368,9 @@ class LearningPathEnrollmentAllowed(TimeStampedModel):
     email = models.EmailField(db_index=True)
     learning_path = models.ForeignKey(LearningPath, on_delete=models.CASCADE)
     user = models.ForeignKey(User, on_delete=models.CASCADE, blank=True, null=True)
+    is_active = models.BooleanField(
+        default=True, db_index=True, help_text=_("Indicates if the enrollment allowance is active")
+    )
 
     def __str__(self):
         """User-friendly string representation of this model."""

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths/receivers.py

@@ -39,7 +39,7 @@ def process_pending_enrollments(sender, instance, created, **kwargs):
         return
 
     logger.info("[LearningPaths] Processing pending enrollments for user %s", instance)
-    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(email=instance.email)
+    pending_enrollments = LearningPathEnrollmentAllowed.objects.filter(email=instance.email, is_active=True)
     enrollments_created = 0
 
     for entry in pending_enrollments:
@@ -67,6 +67,7 @@ def process_pending_enrollments(sender, instance, created, **kwargs):
                 entry.learning_path.key,
             )
         finally:
+            entry.is_active = False
             entry.user = instance
             entry.save()
 
@@ -129,6 +130,8 @@ def create_enrollment_allowed_audit(sender, instance, created, **kwargs):
     if not (audit_data := getattr(instance, "_audit", {})):
         return
 
+    audit_data.setdefault("state_transition", LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL)
+
     audit_data["state_transition"] = audit_data.get(
         "state_transition", LearningPathEnrollmentAudit.UNENROLLED_TO_ALLOWEDTOENROLL
     )

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7/learning_paths_plugin.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learning-paths-plugin
-Version: 0.3.4rc5
+Version: 0.3.4rc7
 Summary: Learning Paths plugin
 Home-page: https://github.com/open-craft/learning-paths-plugin
 Author: OpenCraft
@@ -133,6 +133,7 @@ Changed
 =======
 
 * The Learning Paths API includes start and end dates for its steps.
+* Return enrollment date in the API instead of a boolean.
 
 0.3.3 - 2025-05-23
 ******************

{learning_paths_plugin-0.3.4rc5 → learning_paths_plugin-0.3.4rc7}/learning_paths_plugin.egg-info/SOURCES.txt

@@ -37,6 +37,8 @@ learning_paths/migrations/0010_learningpath_invite_only.py
 learning_paths/migrations/0011_replace_learningpath_image_url_with_image.py
 learning_paths/migrations/0012_alter_learningpath_subtitle.py
 learning_paths/migrations/0013_enrollment_audit.py
+learning_paths/migrations/0014_learningpathenrollmentallowed_is_active.py
+learning_paths/migrations/0015_remove_learningpathenrollment_enrolled_at.py
 learning_paths/migrations/__init__.py
 learning_paths/templates/learning_paths/base.html
 learning_paths_plugin.egg-info/PKG-INFO