IUFC-758

business/xls/xls_prospect.py

@@ -6,7 +6,7 @@
 #    The core business involves the administration of students, teachers,
 #    courses, programs and so on.
 #
-#    Copyright (C) 2015-2019 Université catholique de Louvain (http://www.uclouvain.be)
+#    Copyright (C) 2015-2022 Université catholique de Louvain (http://www.uclouvain.be)
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -23,27 +23,37 @@
 #    see http://www.gnu.org/licenses/.
 #
 ##############################################################################
+from typing import List
+
 from django.utils.translation import gettext_lazy as _
+from openpyxl.styles import Font
 
 from base.business.xls import get_name_or_username
-from continuing_education.business.prospect import get_prospects_by_user
+from continuing_education.forms.search import ProspectFilterForm
+from continuing_education.models.prospect import Prospect
 from osis_common.document import xls_build
+from program_management.views.search import get_filter
 
 XLS_DESCRIPTION = _('Prospects list')
 XLS_FILENAME = _('Prospects_list')
 WORKSHEET_TITLE = _('Prospects list')
+BOLD_FONT = Font(bold=True)
 
 
-def create_xls(user):
-    prospects_list = get_prospects_by_user(user)
+def create_xls(user, prospects_list: List[Prospect], prospect_filter_form: ProspectFilterForm):
     working_sheets_data = _prepare_xls_content(prospects_list)
-    parameters = {xls_build.DESCRIPTION: XLS_DESCRIPTION,
-                  xls_build.USER: get_name_or_username(user),
-                  xls_build.FILENAME: XLS_FILENAME,
-                  xls_build.HEADER_TITLES: _get_titles(),
-                  xls_build.WS_TITLE: WORKSHEET_TITLE}
-
-    return xls_build.generate_xls(xls_build.prepare_xls_parameters_list(working_sheets_data, parameters))
+    parameters = {
+        xls_build.DESCRIPTION: XLS_DESCRIPTION,
+        xls_build.USER: get_name_or_username(user),
+        xls_build.FILENAME: XLS_FILENAME,
+        xls_build.HEADER_TITLES: _get_titles(),
+        xls_build.WS_TITLE: WORKSHEET_TITLE,
+        xls_build.FONT_ROWS: {BOLD_FONT: [0]},
+    }
+    return xls_build.generate_xls(
+        list_parameters=xls_build.prepare_xls_parameters_list(working_sheets_data, parameters),
+        filters=get_filter(prospect_filter_form)
+    )
 
 
 def _prepare_xls_content(prospect_list):

forms/search.py

@@ -23,6 +23,7 @@
     ADMISSION_STATE_CHOICES
 from continuing_education.models.enums.admission_state_choices import REJECTED, SUBMITTED, WAITING, ACCEPTED, \
     REGISTRATION_SUBMITTED, VALIDATED, STATE_CHOICES, ARCHIVE_STATE_CHOICES, DRAFT, ACCEPTED_NO_REGISTRATION_REQUIRED
+from continuing_education.models.prospect import Prospect
 
 STATE_TO_DISPLAY = [SUBMITTED, REJECTED, WAITING, DRAFT, ACCEPTED_NO_REGISTRATION_REQUIRED]
 STATE_FOR_REGISTRATION = [ACCEPTED, REGISTRATION_SUBMITTED, VALIDATED]
@@ -447,3 +448,46 @@ def get_managers(self):
                 ).values_list('person__id')
             )
         return qs
+
+
+class ProspectFilterForm(CommonFilterForm):
+
+    def __init__(self, data, user=None, *args, **kwargs):
+        super(ProspectFilterForm, self).__init__(data, *args, **kwargs)
+        self.prospects_queryset = self.get_prospects_by_user(user)
+        self._build_prospects_formation_choices()
+
+    def get_prospects_by_user(self, user):
+        return Prospect.objects.filter(
+            formation__continuingeducationtrainingmanager__person=user.person
+        ).select_related(
+            'formation__education_group'
+        ).prefetch_related(
+            'formation__education_group__educationgroupyear_set',
+            'formation__continuingeducationtrainingmanager_set'
+        )
+
+    def get_propects_with_filter(self):
+        qs = self.prospects_queryset
+        formation = self.cleaned_data.get('formation')
+        free_text = self.cleaned_data.get('free_text')
+        if formation:
+            qs = qs.filter(formation=formation)
+
+        if free_text:
+            qs = qs.filter(
+                Q(first_name__unaccent__icontains=free_text) |
+                Q(name__unaccent__icontains=free_text) |
+                Q(email__icontains=free_text) |
+                Q(phone_number__icontains=free_text) |
+                Q(formation__education_group__educationgroupyear__acronym__icontains=free_text) |
+                Q(formation__education_group__educationgroupyear__title__unaccent__icontains=free_text) |
+                Q(postal_code__icontains=free_text) |
+                Q(city__unaccent__icontains=free_text)
+            ).distinct()
+        return qs
+
+    def _build_prospects_formation_choices(self):
+        self.fields['formation'].queryset = ContinuingEducationTraining.objects.formations().filter(
+            id__in=self.prospects_queryset.values_list('formation', flat=False)
+        ).distinct().order_by('education_group__educationgroupyear__acronym')

templates/continuing_education/prospects.html

@@ -43,6 +43,28 @@ <h2>{% trans 'Prospects' %}</h2>
     </div>
 
     <div class="panel panel-default">
+        <div class="panel panel-body">
+            <form style="display: inline;" action="{% url 'prospects' %}" method="get" class="" id="search_form">
+                {% csrf_token %}
+                <div class="row">
+                    <div class="col-md-5">
+                        <label for="formation_id">{% trans 'Formation' %}</label>
+                        {{ search_form.formation }}
+                    </div>
+                    <div class="col-md-5">
+                        <label for="free_text_id">{% trans 'In all fields' %}</label>
+                        {{ search_form.free_text }}
+                    </div>
+                    <div class="col-md-2">
+                        <button type="submit" class="btn btn-primary" style="margin-top: 26px;">
+                            <span class="glyphicon glyphicon-search" aria-hidden="true"></span>
+                        </button>
+                        {% include 'blocks/button/button_filter_refresh.html' %}
+                    </div>
+                </div>
+                {% include 'continuing_education/blocks/button/xls_hidden.html' %}
+            </form>
+        </div>
     <br>
         {% if prospects %}
             <div class="dropdown  text-right" style="margin-right: 10px;">
@@ -59,7 +81,7 @@ <h2>{% trans 'Prospects' %}</h2>
                         </a>
                     </li>
                     <li>
-                        <a id="btn_produce_xls" style="margin-right:10px;" href="{% url 'prospects_xls'  %}"
+                        <a id="btn_produce_prospects_xls" style="margin-right:10px;"
                            title="Produce xls" class="download">
                             &nbsp;{%  trans 'Produce xls' %}
                         </a>
@@ -96,7 +118,7 @@ <h2>{% trans 'Prospects' %}</h2>
                     </thead>
                     <tfoot>
                         <tr>
-                            <td colspan="6">
+                            <td colspan="7">
                                 {% bootstrap_pagination prospects extra=request.GET.urlencode %}
                             </td>
                         </tr>
@@ -152,5 +174,11 @@ <h2>{% trans 'Prospects' %}</h2>
             $("#prospects_form").attr("action", url);
             $("#prospects_form").submit();
         });
+
+        $("#btn_produce_prospects_xls").click(function(e) {
+            prepare_xls(e, 'xls_prospects');
+        });
+
+
     </script>
 {% endblock %}

tests/business/test_prospect.py → tests/forms/test_prospect.py

@@ -1,12 +1,12 @@
 ##############################################################################
 #
-# OSIS stands for Open Student Information System. It's an application
+#    OSIS stands for Open Student Information System. It's an application
 #    designed to manage the core business of higher education institutions,
 #    such as universities, faculties, institutes and professional schools.
 #    The core business involves the administration of students, teachers,
 #    courses, programs and so on.
 #
-#    Copyright (C) 2015-2021 Université catholique de Louvain (http://www.uclouvain.be)
+#    Copyright (C) 2015-2022 Université catholique de Louvain (http://www.uclouvain.be)
 #
 #    This program is free software: you can redistribute it and/or modify
 #    it under the terms of the GNU General Public License as published by
@@ -23,35 +23,48 @@
 #    see http://www.gnu.org/licenses/.
 #
 ##############################################################################
+from unittest import mock
+
 from django.test import TestCase
 
 from base.tests.factories.academic_year import create_current_academic_year
 from base.tests.factories.education_group import EducationGroupFactory
 from base.tests.factories.education_group_year import EducationGroupYearFactory
-from continuing_education.business.prospect import get_prospects_by_user
+from continuing_education.forms.search import ProspectFilterForm
 from continuing_education.tests.factories.continuing_education_training import ContinuingEducationTrainingFactory
 from continuing_education.tests.factories.prospect import ProspectFactory
 from continuing_education.tests.factories.roles.continuing_education_training_manager import \
     ContinuingEducationTrainingManagerFactory
 
 
 class TestProspect(TestCase):
-    def test_get_prospects_by_user(self):
+    @classmethod
+    def setUpTestData(cls):
         academic_year = create_current_academic_year()
         education_group = EducationGroupFactory()
         EducationGroupYearFactory(
             education_group=education_group,
             academic_year=academic_year
         )
-        training_1 = ContinuingEducationTrainingFactory(education_group=education_group)
-        manager = ContinuingEducationTrainingManagerFactory(training=training_1)
+        training_1 = ContinuingEducationTrainingFactory(education_group=education_group, active=True)
+        cls.manager = ContinuingEducationTrainingManagerFactory(training=training_1)
+        cls.prospect_1 = ProspectFactory(formation=training_1, name="Delwart")
+        cls.prospect_2 = ProspectFactory(formation=training_1, name="Debouche")
 
-        prospect_1 = ProspectFactory(formation=training_1)
-        prospect_2 = ProspectFactory(formation=training_1)
-        ProspectFactory()
-        ProspectFactory()
+    @mock.patch('continuing_education.forms.search._build_prospects_formation_choices')
+    def test_get_prospects_by_user(self, mock_formation_dropdown):
+        form = ProspectFilterForm(data={}, user=self.manager.person.user)
+        self.assertTrue(form.is_valid())
+        self.assertCountEqual(
+            form.get_propects_with_filter(),
+            [self.prospect_1, self.prospect_2]
+        )
 
+    @mock.patch('continuing_education.forms.search._build_prospects_formation_choices')
+    def test_get_prospects_by_user_and_free_text(self, mock_formation_dropdown):
+        form = ProspectFilterForm(data={'free_text': 'wart'}, user=self.manager.person.user)
+        self.assertTrue(form.is_valid())
         self.assertCountEqual(
-            get_prospects_by_user(manager.person.user),
-            [prospect_1, prospect_2]
+            form.get_propects_with_filter(),
+            [self.prospect_1]
         )

tests/views/test_prospect.py

@@ -44,12 +44,13 @@ class ProspectListTestCase(TestCase):
     @classmethod
     def setUpTestData(cls):
         cls.manager = ContinuingEducationTrainingManagerFactory()
+        cls.academic_year = create_current_academic_year()
 
     def setUp(self):
         self.client.force_login(self.manager.person.user)
 
     def test_prospect_list_ordered_by_formation(self):
-        self.academic_year = create_current_academic_year()
+
         self.education_groups = [EducationGroupFactory() for _ in range(1, 3)]
 
         acronyms = ['AAA', 'BBA', 'CAA']

urls.py

@@ -72,7 +72,6 @@
     url(r'^prospects/', include([
         url(r'^$', prospect.list_prospects, name='prospects'),
         url(r'^(?P<prospect_id>[0-9]+)/', prospect.prospect_details, name='prospect_details'),
-        url(r'^reporting', prospect.prospect_xls, name='prospects_xls'),
         url(r'^delete', prospect.delete_prospects, name='prospects_delete'),
     ])),
     url(r'^tasks/', include([

views/prospect.py

@@ -25,24 +25,35 @@
 ##############################################################################
 
 from django.contrib.auth.decorators import login_required
-from django.shortcuts import render, redirect, reverse, get_object_or_404
-from django.utils.translation import gettext_lazy as _
+from django.shortcuts import render, get_object_or_404, redirect
+from django.urls import reverse
 from rules.contrib.views import permission_required, objectgetter
 
 from base.views.common import display_error_messages, display_success_messages
-from continuing_education.business.prospect import get_prospects_by_user
 from continuing_education.business.xls.xls_prospect import create_xls
+from continuing_education.forms.search import ProspectFilterForm
 from continuing_education.models.prospect import Prospect
 from continuing_education.views.common import get_object_list
+from django.utils.translation import gettext_lazy as _
 
 
 @login_required
 @permission_required('continuing_education.view_prospect', raise_exception=True)
 def list_prospects(request):
-    prospects_list = get_prospects_by_user(request.user)
+    search_form = ProspectFilterForm(data=request.GET, user=request.user)
+
+    if search_form.is_valid():
+        prospects_list = search_form.get_propects_with_filter()
+    else:
+        prospects_list = Prospect.objects.none()
+
+    if request.GET.get('xls_status') == "xls_prospects":
+        return prospect_xls(request, prospects_list, search_form)
+
     return render(request, "continuing_education/prospects.html", {
         'prospects': get_object_list(request, prospects_list),
-        'prospects_count': len(prospects_list)
+        'prospects_count': len(prospects_list),
+        'search_form': search_form
     })
 
 
@@ -61,8 +72,9 @@ def prospect_details(request, prospect_id):
 
 @login_required
 @permission_required('continuing_education.export_prospect', raise_exception=True)
-def prospect_xls(request):
-    return create_xls(request.user)
+def prospect_xls(request, prospects_list, search_form: ProspectFilterForm):
+    return create_xls(request.user, prospects_list, search_form)
+
 
 
 @login_required