Merge pull request #302 from AvaCodeSolutions/feat/299/show-progress-in-lesson-emails

feat: #299 add progress bar at the end of the lessons email

Author: payamnj

django_email_learning/models.py

@@ -28,6 +28,7 @@
 from django.contrib.auth.models import User
 from django.utils import timezone
 from django.utils.translation import gettext as _
+from django.utils.translation import ngettext
 from datetime import timedelta
 from django_email_learning.services import jwt_service
 
@@ -399,6 +400,25 @@ def title(self) -> str:
             return self.quiz.title
         return "Untitled Content"
 
+    def human_readable_waiting_period(self) -> str:
+        if self.waiting_period < 60:
+            return ngettext(
+                "%(count)d second", "%(count)d seconds", self.waiting_period
+            ) % {"count": self.waiting_period}
+        elif self.waiting_period < 3600:
+            minutes = self.waiting_period // 60
+            return ngettext("%(count)d minute", "%(count)d minutes", minutes) % {
+                "count": minutes
+            }
+        elif self.waiting_period < 86400:
+            hours = self.waiting_period // 3600
+            return ngettext("%(count)d hour", "%(count)d hours", hours) % {
+                "count": hours
+            }
+        else:
+            days = self.waiting_period // 86400
+            return ngettext("%(count)d day", "%(count)d days", days) % {"count": days}
+
     def _validate_content(self) -> None:
         if self.type == "lesson" and not self.lesson:
             raise ValidationError("Lesson must be provided for lesson content.")
@@ -417,6 +437,16 @@ def save(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
         self.full_clean()
         super().save(*args, **kwargs)
 
+    def get_next(self) -> Optional["CourseContent"]:
+        next_content = (
+            CourseContent.objects.filter(
+                course=self.course, is_published=True, priority__gt=self.priority
+            )
+            .order_by("priority")
+            .first()
+        )
+        return next_content
+
     class Meta:
         constraints = [
             models.UniqueConstraint(

django_email_learning/services/command_models/send_lesson_command.py

@@ -1,7 +1,12 @@
 from django_email_learning.services.command_models.abstract_command import (
     AbstractCommand,
 )
-from django_email_learning.models import Lesson, CourseContent
+from django_email_learning.models import (
+    Lesson,
+    CourseContent,
+    Enrollment,
+    EnrollmentStatus,
+)
 from django_email_learning.services.email_sender_service import EmailSenderService
 from django_email_learning.services.metrics_service import MetricsService
 from django.core.mail import EmailMultiAlternatives
@@ -35,9 +40,21 @@ def execute(self) -> None:
             raise LessonNotFoundError(f"Lesson with ID {content.lesson.id} not found")
 
         subject = lesson.title
+        enrollment = Enrollment.objects.filter(
+            course=content.course,
+            learner__email=self.email,
+            status=EnrollmentStatus.ACTIVE,
+        ).first()
+        if not enrollment:
+            progress = 0
+        else:
+            progress = enrollment.progress_percentage
+        next_content = content.get_next()
         context = {
             "lesson": lesson,
             "unsubscribe_link": content.course.generate_unsubscribe_link(self.email),
+            "progress": progress,
+            "next_content": next_content,
         }
         payload = render_to_string("emails/lesson.txt", context)
 

django_email_learning/templates/emails/base.html

@@ -176,6 +176,7 @@
                 border: 0;
                 margin: 0 auto;
                 padding: 0 10px !important;
+                width: 100% !important;
             }
             {% block extra_styles %}{% endblock %}
         </style>

django_email_learning/templates/emails/lesson.html

@@ -9,13 +9,58 @@
         overflow-x: auto;
         margin: 15px 0 30px;
     }
+    .progress-wrapper {
+        margin-top: 40px;
+        padding: 20px 0;
+        border-top: 1px solid #ddd;
+    }
+    .progress-label {
+        display: block;
+        margin-bottom: 10px;
+        font-size: 14px;
+        color: #555;
+    }
+    .progress-container {
+        width: 100%;
+        background-color: #e0e0e0;
+        border-radius: 5px;
+        overflow: hidden;
+    }
+    .progress-bar {
+        height: 20px;
+        background-color: #4caf50;
+        width: 0;
+        transition: width 0.5s ease-in-out;
+        background-image: linear-gradient(to right, #7070e6, #4dd2cb);
+    }
 {% endblock %}
 
 {% block content %}
         <h2 class="email-title">{{ lesson.title }}</h2>
 
         {{ lesson.content|safe }}
 
+        <div class="progress-wrapper">
+            {% block lesson_extras %}
+            {% if next_content %}
+                <h3>{% blocktranslate %}What’s coming up next?{% endblocktranslate %}</h3>
+                {% if next_content.lesson %}
+                    <p>{% blocktranslate with next_lesson_title=next_content.lesson.title delay=next_content.human_readable_waiting_period title=lesson.title %}
+                        Now that you've mastered {{ title }}, we’ll be moving on to {{ next_lesson_title }}. Keep an eye out for that email—it will hit your inbox in {{ delay }}.
+                        {% endblocktranslate %}</p>
+                {% elif next_content.quiz %}
+                    <p>{% blocktranslate with quiz_title=next_content.quiz.title delay=next_content.human_readable_waiting_period title=lesson.title %}
+                        Now that you've mastered {{ title }}, it’s time to put that knowledge to the test! Your next email will be the {{ quiz_title }}. Look out for it hitting your inbox in {{ delay }}.
+                        {% endblocktranslate %}</p>
+                {% endif %}
+            {% endif %}
+            {% endblock %}
+            <span class="progress-label">{% blocktranslate %}<b>Course Progress: {{ progress }}%</b>{% endblocktranslate %}</span>
+            <div class="progress-container">
+                <div class="progress-bar" style="width: {{ progress }}%;"></div>
+            </div>
+        </div>
+
         <p class="email-muted-note">
             {% blocktranslate %}If you wish to unsubscribe from this course, please <a href="{{ unsubscribe_link }}" class="color-brand" style="text-decoration: none;">click here</a>{% endblocktranslate %}.
         </p>

django_service/views.py

@@ -1,5 +1,5 @@
 from django.views.generic import TemplateView
-from django_email_learning.models import Lesson, Quiz
+from django_email_learning.models import Lesson, Quiz, CourseContent
 from django_email_learning.platform.views import CourseView
 from django_email_learning.platform.serializers import WebComponent
 
@@ -39,6 +39,9 @@ def get_template_names(self) -> list[str]:
     def get_context_data(self, **kwargs):  # type: ignore[no-untyped-def]
         lesson = Lesson.objects.first()
         quiz = Quiz.objects.first()
+        content = (
+            CourseContent.objects.filter(lesson=lesson).first() if lesson else None
+        )
         return {
             "course_title": "Example Course",
             "organization_name": "Example Organization",
@@ -52,4 +55,6 @@ def get_context_data(self, **kwargs):  # type: ignore[no-untyped-def]
             "domain": "example.com",
             "uid": "sampleuid",
             "token": "sampletoken",
+            "progress": 40,
+            "next_content": content.get_next() if content else None,
         }