Merge pull request #3075 from laws-africa/follow-journal

Add following for law reports and journals

Author: actlikewill

peachjam/migrations/0287_userfollowing_journal_userfollowing_law_report_and_more.py

@@ -0,0 +1,54 @@
+# Generated by Django 4.2.29 on 2026-03-19 07:44
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("peachjam", "0286_remove_coredocument_content_html_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="userfollowing",
+            name="journal",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="followers",
+                to="peachjam.journal",
+                verbose_name="journal",
+            ),
+        ),
+        migrations.AddField(
+            model_name="userfollowing",
+            name="law_report",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="followers",
+                to="peachjam.lawreport",
+                verbose_name="law report",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="userfollowing",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("journal__isnull", False)),
+                fields=("user", "journal"),
+                name="unique_user_journal",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="userfollowing",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("law_report__isnull", False)),
+                fields=("user", "law_report"),
+                name="unique_user_law_report",
+            ),
+        ),
+    ]

peachjam/models/journals_books.py

@@ -1,5 +1,6 @@
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
+from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 from django_lifecycle import BEFORE_SAVE
 from markdown.extensions.toc import slugify
@@ -55,6 +56,9 @@ class Meta:
     def __str__(self):
         return self.title
 
+    def get_absolute_url(self):
+        return reverse("journal_detail", args=[self.slug])
+
 
 class JournalArticle(CoreDocument):
 

peachjam/models/user_following.py

@@ -81,6 +81,22 @@ class UserFollowing(models.Model):
         related_name="followers",
         verbose_name=_("taxonomy"),
     )
+    journal = models.ForeignKey(
+        "peachjam.Journal",
+        null=True,
+        blank=True,
+        on_delete=models.CASCADE,
+        related_name="followers",
+        verbose_name=_("journal"),
+    )
+    law_report = models.ForeignKey(
+        "peachjam.LawReport",
+        null=True,
+        blank=True,
+        on_delete=models.CASCADE,
+        related_name="followers",
+        verbose_name=_("law report"),
+    )
     saved_search = models.ForeignKey(
         SavedSearch,
         null=True,
@@ -111,6 +127,8 @@ class UserFollowing(models.Model):
         "country",
         "locality",
         "taxonomy",
+        "journal",
+        "law_report",
         "saved_search",
         "saved_document",
     ]
@@ -152,6 +170,16 @@ class Meta:
                 condition=models.Q(taxonomy__isnull=False),
                 name="unique_user_taxonomy",
             ),
+            models.UniqueConstraint(
+                fields=["user", "journal"],
+                condition=models.Q(journal__isnull=False),
+                name="unique_user_journal",
+            ),
+            models.UniqueConstraint(
+                fields=["user", "law_report"],
+                condition=models.Q(law_report__isnull=False),
+                name="unique_user_law_report",
+            ),
             models.UniqueConstraint(
                 fields=["user", "saved_search"],
                 condition=models.Q(saved_search__isnull=False),
@@ -190,6 +218,8 @@ def is_new_docs(self):
             "country",
             "locality",
             "taxonomy",
+            "journal",
+            "law_report",
         ]
 
     @property
@@ -256,6 +286,14 @@ def documents_for_followed_topic(self):
             topics = [self.taxonomy] + list(self.taxonomy.get_descendants())
             return qs.filter(taxonomies__topic__in=topics)
 
+        if self.journal:
+            return qs.filter(journalarticle__journal=self.journal)
+
+        if self.law_report:
+            return qs.filter(
+                judgment__law_report_entries__law_report_volume__law_report=self.law_report
+            ).distinct()
+
         return qs.none()
 
     def documents_for_followed_search(self):

peachjam/templates/peachjam/journal/journal_detail.html

@@ -1,5 +1,5 @@
 {% extends 'peachjam/layouts/document_list.html' %}
-{% load i18n %}
+{% load i18n peachjam %}
 {% block title %}{{ journal.title }}{% endblock %}
 {% block breadcrumbs %}
   <div class="container">
@@ -17,7 +17,15 @@
   </div>
 {% endblock %}
 {% block page-title %}
-  {% if not entity_profile %}<h1 class="my-4">{{ journal.title }}</h1>{% endif %}
+  {% if not entity_profile %}
+    <div class="my-4">
+      <h1 class="mb-0">{{ journal.title }}</h1>
+      {% block follow-button %}
+        <div hx-get="{% url 'user_following_button' %}?{{ journal|get_follow_params }}"
+             hx-trigger="load"></div>
+      {% endblock %}
+    </div>
+  {% endif %}
 {% endblock %}
 {% block page-header %}
   {{ block.super }}

peachjam/templates/peachjam/law_report/law_report_detail.html

@@ -21,7 +21,10 @@
     {% if not entity_profile %}
       <div class="my-4">
         <h1>{{ page_title }}</h1>
-        {% block follow-button %}{% endblock %}
+        {% block follow-button %}
+          <div hx-get="{% url 'user_following_button' %}?{{ law_report|get_follow_params }}"
+               hx-trigger="load"></div>
+        {% endblock %}
       </div>
     {% endif %}
   {% endblock %}

peachjam/templatetags/peachjam.py

@@ -121,7 +121,13 @@ def split(value, sep=None):
 @register.filter
 def get_follow_params(obj):
     # this would be better as a model method
-    return f"{obj._meta.model_name}={obj.pk}"
+    field_map = {
+        "courtclass": "court_class",
+        "courtregistry": "court_registry",
+        "lawreport": "law_report",
+    }
+    field_name = field_map.get(obj._meta.model_name, obj._meta.model_name)
+    return f"{field_name}={obj.pk}"
 
 
 @register.simple_tag

peachjam/tests/test_journals.py

@@ -0,0 +1,47 @@
+import datetime
+
+from countries_plus.models import Country
+from django.test import TestCase
+from django.urls import reverse
+from languages_plus.models import Language
+
+from peachjam.models import Journal, JournalArticle
+
+
+class JournalModelAndViewTests(TestCase):
+    fixtures = [
+        "tests/countries",
+        "tests/languages",
+        "documents/sample_documents",
+    ]
+
+    def setUp(self):
+        super().setUp()
+        self.journal = Journal.objects.create(
+            title="Regional Law Journal",
+            slug="regional-law-journal",
+        )
+        self.article = JournalArticle.objects.create(
+            title="Fresh journal article",
+            journal=self.journal,
+            publisher="Publisher",
+            date=datetime.date(2025, 1, 1),
+            language=Language.objects.first(),
+            jurisdiction=Country.objects.first(),
+        )
+
+    def test_journal_absolute_url(self):
+        self.assertEqual(
+            reverse("journal_detail", args=[self.journal.slug]),
+            self.journal.get_absolute_url(),
+        )
+
+    def test_journal_detail_view_includes_follow_button(self):
+        response = self.client.get(self.journal.get_absolute_url())
+
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, self.article.title)
+        self.assertContains(
+            response,
+            reverse("user_following_button") + f"?journal={self.journal.pk}",
+        )

peachjam/tests/test_law_reports.py

@@ -125,7 +125,10 @@ def test_law_report_detail_view_shows_law_report_judgments_and_non_empty_volumes
         self.assertIn(self.volume_1, response.context["law_report_volumes"])
         self.assertIn(self.volume_2, response.context["law_report_volumes"])
         self.assertNotIn(self.empty_volume, response.context["law_report_volumes"])
-        self.assertTrue(response.context["hide_follow_button"])
+        self.assertContains(
+            response,
+            reverse("user_following_button") + f"?law_report={self.law_report.pk}",
+        )
 
     def test_law_report_volume_detail_view_filters_to_selected_volume(self):
         response = self.client.get(self.volume_1.get_absolute_url())

peachjam/tests/test_timeline.py

@@ -10,7 +10,12 @@
 from peachjam.models import (
     Court,
     ExtractedCitation,
+    Journal,
+    JournalArticle,
     Judgment,
+    LawReport,
+    LawReportEntry,
+    LawReportVolume,
     Legislation,
     Locality,
     Predicate,
@@ -157,6 +162,84 @@ def test_send_new_documents_email_includes_first_topic_in_subject(self):
         request = mailer.call_args[0][0]
         self.assertEqual(f"New documents for {topic}", str(request.subject))
 
+    def test_journal_follow_creates_new_documents_timeline_event(self):
+        journal = Journal.objects.create(
+            title="Regional Law Journal",
+            slug="regional-law-journal",
+        )
+        follow = UserFollowing.objects.create(user=self.user, journal=journal)
+        follow.last_alerted_at = self.last_alerted_at
+        follow.save(update_fields=["last_alerted_at"])
+        article = JournalArticle.objects.create(
+            title="Fresh journal article",
+            journal=journal,
+            publisher="Publisher",
+            date=datetime(2025, 10, 1),
+            language=Language.objects.get(pk="en"),
+            jurisdiction=Country.objects.get(pk="ZA"),
+        )
+
+        UserFollowing.update_follows_for_user(self.user)
+
+        event = TimelineEvent.objects.get(user_following=follow)
+        self.assertEqual(TimelineEvent.EventTypes.NEW_DOCUMENTS, event.event_type)
+        self.assertIn(article.work, event.subject_works.all())
+
+    def test_law_report_follow_creates_new_documents_timeline_event(self):
+        law_report = LawReport.objects.create(
+            title="Regional Law Reports",
+            slug="regional-law-reports",
+        )
+        volume = LawReportVolume.objects.create(
+            title="Volume 1",
+            slug="volume-1",
+            law_report=law_report,
+            year=2025,
+        )
+        follow = UserFollowing.objects.create(user=self.user, law_report=law_report)
+        follow.last_alerted_at = self.last_alerted_at
+        follow.save(update_fields=["last_alerted_at"])
+        judgment = Judgment.objects.create(
+            case_name="Reported case",
+            court=self.court,
+            date=datetime(2025, 10, 1),
+            language=Language.objects.get(pk="en"),
+            jurisdiction=Country.objects.get(pk="ZA"),
+        )
+        LawReportEntry.objects.create(judgment=judgment, law_report_volume=volume)
+
+        UserFollowing.update_follows_for_user(self.user)
+
+        event = TimelineEvent.objects.get(user_following=follow)
+        self.assertEqual(TimelineEvent.EventTypes.NEW_DOCUMENTS, event.event_type)
+        self.assertIn(judgment.work, event.subject_works.all())
+
+    def test_send_new_documents_email_includes_journal_in_subject(self):
+        journal = Journal.objects.create(
+            title="Regional Law Journal",
+            slug="regional-law-journal",
+        )
+        follow = UserFollowing.objects.create(user=self.user, journal=journal)
+        doc = Judgment.objects.first()
+        TimelineEvent.add_new_documents_event(follow, [doc])
+
+        with (
+            override_settings(
+                PEACHJAM={
+                    **settings.PEACHJAM,
+                    "EMAIL_ALERTS_ENABLED": True,
+                    "CUSTOMERIO_EMAIL_API_KEY": "test",
+                },
+                TEMPLATED_EMAIL_BACKEND="peachjam.emails.CustomerIOTemplateBackend",
+            ),
+            patch("peachjam.emails.APIClient.send_email") as mailer,
+        ):
+            TimelineEmailService.send_new_documents_email(self.user)
+
+        self.assertEqual(1, mailer.call_count)
+        request = mailer.call_args[0][0]
+        self.assertEqual(f"New documents for {journal}", str(request.subject))
+
 
 class TimelineRelationshipTests(TestCase):
     fixtures = [

peachjam/views/journals.py

@@ -92,7 +92,6 @@ def add_facets(self, context):
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        context["hide_follow_button"] = True
         context["entity_profile"] = self.journal.entity_profile.first()
         context["journal"] = self.journal
         volumes = list(self.journal.volumes.all())