add stats report to list all responses for a specific option

Mostly for hunting down when people have selected a bad option for e.g.
District Councils where not all questions responses might be valid.

Fixes #217

Author: struan

ceuk-marking/urls.py

@@ -229,6 +229,21 @@
         stats.SessionPropertiesCSVView.as_view(),
         name="session_properties",
     ),
+    path(
+        "stats/response_report",
+        stats.ResponseReportView.as_view(),
+        name="response_report",
+    ),
+    path(
+        "stats/available_questions",
+        stats.AvailableResponseQuestionsView.as_view(),
+        name="available_questions_json",
+    ),
+    path(
+        "stats/available_options",
+        stats.AvailableResponseOptionsView.as_view(),
+        name="available_options_json",
+    ),
     # audit screens
     path(
         "section/audit/<section_title>/authorities/",

crowdsourcer/filters.py

@@ -1,8 +1,9 @@
 from django.contrib.auth.models import User
+from django.db.models import Q
 
 import django_filters
 
-from crowdsourcer.models import ResponseType, Section
+from crowdsourcer.models import Option, Question, Response, ResponseType, Section
 
 
 def filter_not_empty(queryset, name, value):
@@ -32,3 +33,36 @@ class Meta:
             "marker__response_type": ["exact"],
             "is_active": ["exact"],
         }
+
+
+class ResponseFilter(django_filters.FilterSet):
+    response_type = django_filters.ChoiceFilter(
+        label="Stage", choices=ResponseType.choices()
+    )
+    question__section = django_filters.ChoiceFilter(
+        label="Section",
+        empty_label=None,
+        choices=Section.objects.values_list("id", "title"),
+    )
+    question = django_filters.ChoiceFilter(
+        field_name="question",
+        label="Question",
+        choices=Question.objects.values_list("id", "number"),
+    )
+    option = django_filters.ChoiceFilter(
+        field_name="option",
+        label="Answer",
+        method="option_check",
+        choices=Option.objects.values_list("id", "description"),
+    )
+
+    def option_check(self, queryset, name, value):
+        queryset = queryset.filter(Q(option=value) | Q(multi_option=value))
+        return queryset
+
+    class Meta:
+        model = Response
+        fields = {
+            "question": ["exact"],
+            "option": ["exact"],
+        }

crowdsourcer/static/js/stats.esm.js

@@ -0,0 +1,98 @@
+async function getAvailableQuestions($fs) {
+    var url = "/stats/available_questions";
+
+    var $section = $fs.find('#id_question__section').eq(0);
+
+    if ($section.val() == "") {
+      return { results: [] };
+    }
+
+    var params = {
+      s: $section.val(),
+      ms: $fs.find('#session').eq(0).val()
+    };
+
+
+    url = url + '?' + $.param(params);
+
+    const response = await fetch(url, {
+        method: 'GET',
+        mode: 'cors',
+        credentials: 'same-origin',
+        headers: {
+            "Content-Type": 'application/x-www-form-urlencoded',
+            "Accept": 'application/json; charset=utf-8',
+        },
+    })
+
+    return response.json()
+}
+
+async function getAvailableOptions($fs) {
+    var url = "/stats/available_options";
+
+    var $question = $fs.find('#id_question').eq(0);
+
+    if ($question.val() == "") {
+      return { results: [] };
+    }
+
+    var params = {
+      q: $question.val(),
+      ms: $fs.find('#session').eq(0).val()
+    };
+
+
+    url = url + '?' + $.param(params);
+
+    const response = await fetch(url, {
+        method: 'GET',
+        mode: 'cors',
+        credentials: 'same-origin',
+        headers: {
+            "Content-Type": 'application/x-www-form-urlencoded',
+            "Accept": 'application/json; charset=utf-8',
+        },
+    })
+
+    return response.json()
+}
+$(function(){
+  $('#id_question__section').on('change', function(e){
+    var $d = $(this);
+    var $fs = $d.parents('form');
+
+    var $q = $fs.find('#id_question').eq(0);
+
+    getAvailableQuestions($fs).then(function(data){
+      if (data["results"].length > 0) {
+        $q.empty()
+        let $blank = $('<option></option>').text("---------");
+        $q.append($blank);
+        $.each(data["results"], function(i, opt) {
+          let $o = $('<option></option>').attr('value', opt["id"]).text(opt["number_and_part"]);
+          $q.append($o)
+        });
+      }
+    });
+  });
+
+  $('#id_question').on('change', function(e){
+    var $d = $(this);
+    var $fs = $d.parents('form');
+
+    var $opt = $fs.find('#id_option').eq(0);
+
+    getAvailableOptions($fs).then(function(data){
+      if (data["results"].length > 0) {
+        $opt.empty()
+        let $blank = $('<option></option>').text("---------");
+        $opt.append($blank);
+        $.each(data["results"], function(i, opt) {
+          let $o = $('<option></option>').attr('value', opt["id"]).text(opt["description"]);
+          $opt.append($o)
+        });
+      }
+    });
+  });
+});

crowdsourcer/templates/crowdsourcer/stats/response_report.html

@@ -0,0 +1,76 @@
+{% extends 'crowdsourcer/base.html' %}
+
+{% load crowdsourcer_tags %}
+{% load django_bootstrap5 %}
+{% load static %}
+
+{% block script %}
+<script type="module" src="{% static 'js/stats.esm.js' %}"></script>
+{% endblock %}
+
+{% block content %}
+{% if show_login %}
+    <h1 class="mb-4">Sign in</h1>
+    <a href="{% url 'login' %}">Sign in</a>
+{% else %}
+    <div class="d-md-flex align-items-center mb-4">
+        <h1 class="mb-md-0 me-md-auto">Responses</h1>
+    </div>
+
+    <form method="GET" id="response_filter" class="bg-light p-3 rounded-sm mb-3">
+        <input type="hidden" id="session" value="{{ marking_session.id }}">
+        <div class="row align-items-end flex-wrap mb-n3 mb-md-n4">
+            <div class="col" style="min-width: 10rem">
+                {% bootstrap_field filter.form.question__section %}
+            </div>
+            <div class="col" style="min-width: 10rem">
+                {% bootstrap_field filter.form.question %}
+            </div>
+            <div class="col" style="min-width: 10rem">
+                {% bootstrap_field filter.form.option %}
+            </div>
+            <div class="col" style="min-width: 10rem">
+                {% bootstrap_field filter.form.response_type %}
+            </div>
+            <div class="col" style="min-width: 10rem">
+                <button type="submit" class="btn btn-primary btn-block mb-3 mb-md-4">Filter list</button>
+            </div>
+        </div>
+    </form>
+
+    <table class="table">
+        <thead>
+            <tr>
+                <th>Question</th>
+                <th>Authority</th>
+                <th>Response</th>
+            </tr>
+        </thead>
+        <tbody>
+          {% for response in responses %}
+            <tr>
+                <td>
+                    <a href="{% session_url url_pattern response.authority.name response.question.section.title %}">{{ response.question.number_and_part }}</a>
+                </td>
+                <td>
+                    {{ response.authority.name }}
+                </td>
+                <td>
+                  {% if response.multi_option.values %}
+                    <p>
+                      {% for option in response.multi_option.values %}
+                        {{ option.description }},
+                      {% empty %}
+                        (none)
+                      {% endfor %}
+                    </p>
+                  {% else %}
+                    {{ response.option|default:"(none)"|linebreaks }}
+                  {% endif %}
+                </td>
+            </tr>
+          {% endfor %}
+        </tbody>
+    </table>
+{% endif %}
+{% endblock %}

crowdsourcer/views/stats.py

@@ -5,15 +5,21 @@
 
 from django.contrib.auth.mixins import UserPassesTestMixin
 from django.db.models import Count
-from django.http import HttpResponse
+from django.http import HttpResponse, JsonResponse
 from django.utils.text import slugify
 from django.views.generic import ListView, TemplateView
 
+from django_filters.views import FilterView
+
+from crowdsourcer.filters import ResponseFilter
 from crowdsourcer.models import (
+    MarkingSession,
     Option,
     PublicAuthority,
     Question,
     Response,
+    ResponseType,
+    Section,
     SessionPropertyValues,
 )
 from crowdsourcer.scoring import (
@@ -858,3 +864,101 @@ def render_to_response(self, context, **response_kwargs):
         for row in context["rows"]:
             writer.writerow(row)
         return response
+
+
+class ResponseReportView(StatsUserTestMixin, FilterView):
+    template_name = "crowdsourcer/stats/response_report.html"
+    context_object_name = "responses"
+    filterset_class = ResponseFilter
+
+    def get_filterset(self, filterset_class):
+        fs = super().get_filterset(filterset_class)
+
+        fs.filters["question__section"].field.choices = Section.objects.filter(
+            marking_session=self.request.current_session
+        ).values_list("id", "title")
+
+        questions = Question.objects.filter(
+            section__marking_session=self.request.current_session
+        ).order_by("section", "number", "number_part")
+        # if self.request.GET.get("question__section") is not None:
+        # questions = questions.filter(
+        # section__id=self.request.GET["question__section"]
+        # )
+
+        question_choices = [(q.id, q.number_and_part) for q in questions]
+        fs.filters["question"].field.choices = question_choices
+
+        options = Option.objects.filter(
+            question__section__marking_session=self.request.current_session
+        ).order_by("ordering")
+        if self.request.GET.get("question") is not None:
+            options = options.filter(question__id=self.request.GET["question"])
+
+        fs.filters["option"].field.choices = options.values_list("id", "description")
+
+        return fs
+
+    def get_queryset(self):
+        return Response.objects.filter(
+            question__section__marking_session=self.request.current_session
+        ).select_related("question", "authority")
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+
+        stage = "First Mark"
+        if self.request.GET.get("response_type") is not None:
+            stage = ResponseType.objects.get(
+                id=self.request.GET.get("response_type")
+            ).type
+        url_pattern = "authority_question_edit"
+
+        if stage == "Right of Reply":
+            url_pattern = "authority_ror"
+        elif stage == "Audit":
+            url_pattern = "authority_audit"
+
+        context["url_pattern"] = url_pattern
+        return context
+
+
+class AvailableResponseQuestionsView(StatsUserTestMixin, ListView):
+    context_object_name = "questions"
+
+    def get_queryset(self):
+        if self.request.GET.get("ms") is None or self.request.GET.get("s") is None:
+            return []
+
+        marking_session = MarkingSession.objects.get(id=self.request.GET["ms"])
+        s = Section.objects.get(
+            marking_session=marking_session, id=self.request.GET["s"]
+        )
+        return Question.objects.filter(section=s).order_by("number", "number_part")
+
+    def render_to_response(self, context, **response_kwargs):
+        data = []
+
+        for q in context["questions"]:
+            data.append({"number_and_part": q.number_and_part, "id": q.id})
+
+        return JsonResponse({"results": data})
+
+
+class AvailableResponseOptionsView(StatsUserTestMixin, ListView):
+    context_object_name = "options"
+
+    def get_queryset(self):
+        if self.request.GET.get("q") is None:
+            return []
+
+        q = Question.objects.get(id=self.request.GET["q"])
+        return Option.objects.filter(question=q).order_by("ordering")
+
+    def render_to_response(self, context, **response_kwargs):
+        data = []
+
+        for o in context["options"]:
+            data.append({"description": o.description, "id": o.id})
+
+        return JsonResponse({"results": data})