Re-add analytics view to the application.

Author: tim-schilling

project/newsletter/test_views.py

@@ -419,3 +419,81 @@ def test_update(self):
         )
         self.assertRedirects(response, reverse("newsletter:list_posts"))
         self.assertEqual(self.subscription.categories.get(), self.data.career)
+
+
+class TestAnalytics(DataTestCase):
+    def test_basic(self):
+        self.client.force_login(self.user)
+        response = self.client.get(reverse("newsletter:analytics"))
+        self.assertTemplateUsed(response, "staff/analytics.html")
+        self.assertEqual(
+            response.context["aggregates"],
+            {
+                "Subscriptions": 1,
+                "Subscriptions (30 days)": 1,
+                "Subscriptions (90 days)": 1,
+                "Subscriptions (180 days)": 1,
+                "Posts": 3,
+                "Posts (30 days)": 3,
+                "Posts (90 days)": 3,
+                "Posts (180 days)": 3,
+            },
+        )
+
+        self.assertEqual(
+            response.context["subscription_category_aggregates"],
+            {
+                self.data.career.title: 1,
+                self.data.social.title: 1,
+            },
+        )
+        self.assertEqual(
+            response.context["post_category_aggregates"],
+            {
+                self.data.career.title: 2,
+                self.data.social.title: 2,
+            },
+        )
+
+    def test_date_aggregates(self):
+        # Create users that are outside the cut-off points.
+        for days in [31, 91, 181]:
+            user = User.objects.create_user(username=f"days{days}")
+            subscription = Subscription.objects.create(user=user)
+            # We can't specify created in .create() because it's automatically set.
+            Subscription.objects.filter(id=subscription.id).update(
+                created=timezone.now() - timedelta(days=days)
+            )
+            subscription.categories.set([self.data.career, self.data.social])
+
+        self.client.force_login(self.user)
+        response = self.client.get(reverse("newsletter:analytics"))
+        self.assertTemplateUsed(response, "staff/analytics.html")
+        self.assertEqual(
+            response.context["aggregates"],
+            {
+                "Subscriptions": 4,
+                "Subscriptions (30 days)": 1,
+                "Subscriptions (90 days)": 2,
+                "Subscriptions (180 days)": 3,
+                "Posts": 3,
+                "Posts (30 days)": 3,
+                "Posts (90 days)": 3,
+                "Posts (180 days)": 3,
+            },
+        )
+
+        self.assertEqual(
+            response.context["subscription_category_aggregates"],
+            {
+                self.data.career.title: 4,
+                self.data.social.title: 4,
+            },
+        )
+        self.assertEqual(
+            response.context["post_category_aggregates"],
+            {
+                self.data.career.title: 2,
+                self.data.social.title: 2,
+            },
+        )

project/newsletter/urls.py

@@ -7,6 +7,7 @@
     path("markdown/uploader/", views.markdown_uploader, name="markdown_uploader"),
     path("", views.landing, name="landing"),
     path("account/", views.update_subscription, name="update_subscription"),
+    path("analytics/", views.analytics, name="analytics"),
     path("post/unpublished/", views.unpublished_posts, name="unpublished_posts"),
     path("post/create/", views.create_post, name="create_post"),
     path("post/<slug>/update/", views.update_post, name="update_post"),

project/newsletter/views.py

@@ -1,5 +1,6 @@
 import os
 import uuid
+from datetime import timedelta
 
 from django.conf import settings
 from django.contrib import messages
@@ -12,13 +13,14 @@
 from django.db.models import Case, Count, F, Q, Value, When
 from django.http import Http404, HttpResponse, JsonResponse
 from django.shortcuts import get_object_or_404, redirect, render
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 from django.views.decorators.http import require_http_methods
 from martor.utils import LazyEncoder
 
 from project.newsletter import operations
 from project.newsletter.forms import PostForm, SubscriptionForm
-from project.newsletter.models import Post, Subscription
+from project.newsletter.models import Category, Post, Subscription
 
 LIST_POSTS_PAGE_SIZE = 100
 
@@ -162,6 +164,80 @@ def update_post(request, slug):
     return render(request, "staff/post_form.html", {"form": form, "post": post})
 
 
+def determine_buckets(instance):
+    """
+    Helper function to determine which buckets should be incremented.
+
+    :param instance: A model instance with ``created`` property.
+    :return: tuple(bool, bool, bool)
+    """
+    now = timezone.now()
+    bound_30_days = now - timedelta(days=30)
+    bound_90_days = now - timedelta(days=90)
+    bound_180_days = now - timedelta(days=180)
+    return (
+        bound_30_days <= instance.created,
+        bound_90_days <= instance.created,
+        bound_180_days <= instance.created,
+    )
+
+
+def analyze_categorized_model(Model, label):
+    """
+    Count the number of instances in the last X days and with a category.
+
+    This can be used with Subscription or Post.
+    """
+    count = 0
+    count_30_days = 0
+    count_90_days = 0
+    count_180_days = 0
+    category_aggregates = {
+        category.title: 0 for category in Category.objects.order_by("title")
+    }
+    for obj in Model.objects.all().prefetch_related("categories"):
+        # Increment category buckets
+        for category in obj.categories.all():
+            category_aggregates[category.title] += 1
+        # Increment our post counts
+        count += 1
+        incr_30, incr_90, incr_180 = determine_buckets(obj)
+        if incr_30:
+            count_30_days += 1
+        if incr_90:
+            count_90_days += 1
+        if incr_180:
+            count_180_days += 1
+    return {
+        label: count,
+        f"{label} (30 days)": count_30_days,
+        f"{label} (90 days)": count_90_days,
+        f"{label} (180 days)": count_180_days,
+    }, category_aggregates
+
+
+@staff_member_required(login_url=settings.LOGIN_URL)
+@require_http_methods(["GET"])
+def analytics(request):
+    """
+    The post detail view.
+    """
+    (
+        subscription_aggregates,
+        subscription_category_aggregates,
+    ) = analyze_categorized_model(Subscription, "Subscriptions")
+    post_aggregates, post_category_aggregates = analyze_categorized_model(Post, "Posts")
+    return render(
+        request,
+        "staff/analytics.html",
+        {
+            "aggregates": {**subscription_aggregates, **post_aggregates},
+            "subscription_category_aggregates": subscription_category_aggregates,
+            "post_category_aggregates": post_category_aggregates,
+        },
+    )
+
+
 @staff_member_required(login_url=settings.LOGIN_URL)
 @require_http_methods(["POST"])
 def toggle_post_privacy(request, slug):

project/templates/base.html

@@ -35,6 +35,9 @@
           <a href="{% url "auth_login" %}" class="header item">Login</a>
         {% else %}
           <a href="{% url "newsletter:update_subscription" %}" class="header item">Settings</a>
+          {% if request.user.is_staff %}
+            <a href="{% url "newsletter:analytics" %}" class="header item">Analytics</a>
+          {% endif %}
         {% endif %}
         <div class="right menu">
           <a class="item" href="https://github.com/tim-schilling/debug-tutorial" target="_blank">