add pagination django setting and pagination hiding (#1005)

CHANGELOG.rst

@@ -37,6 +37,7 @@ Added
     - ``active`` arg in ``ProjectInviteMixin.make_invite()`` (#1403)
     - Ability for users to leave project (#918)
     - ``project_list_highlight`` app setting (#1005)
+    - ``PROJECTROLES_PROJECT_LIST_PAGINATION`` Django setting (#1005)
 
 Changed
 -------

config/settings/base.py

@@ -637,6 +637,10 @@ def set_logging(level=None):
 # PROJECTROLES_BREADCRUMB_STICKY = True
 # Custom message to be displayed if site read-only mode is enabled
 PROJECTROLES_READ_ONLY_MSG = env.str('PROJECTROLES_READ_ONLY_MSG', None)
+# Default project list pagination page size
+PROJECTROLES_PROJECT_LIST_PAGINATION = env.int(
+    'PROJECTROLES_PROJECT_LIST_PAGINATION', 10
+)
 
 # Hide project apps from the UI (sidebar, dropdown menus and project details)
 PROJECTROLES_HIDE_PROJECT_APPS = env.list(

config/settings/test.py

@@ -130,6 +130,7 @@
 PROJECTROLES_CUSTOM_JS_INCLUDES = []
 PROJECTROLES_CUSTOM_CSS_INCLUDES = []
 PROJECTROLES_SIDEBAR_ICON_SIZE = 36
+PROJECTROLES_PROJECT_LIST_PAGINATION = 10
 
 # Bgjobs app settings
 BGJOBS_PAGINATION = 15

projectroles/static/projectroles/js/project_list.js

@@ -310,11 +310,11 @@ $(document).ready(function () {
         $.fn.dataTable.ext.classes.sPageButton =
             'btn sodar-list-btn ml-1 sodar-paginate-button btn-outline-light ' +
             'text-primary';
-        $('#sodar-pr-project-list-table').DataTable({
+        var dt = $('#sodar-pr-project-list-table').DataTable({
             ordering: false,
             scrollX: false,
             paging: true,
-            pageLength: 10,
+            pageLength: window.projectListPagination,
             lengthChange: true,
             scrollCollapse: true,
             info: false,
@@ -328,6 +328,12 @@ $(document).ready(function () {
             },
             dom: 'tp'
         });
+        // Hide pagination if only one page
+        if (dt.page.info().pages === 1) {
+            // TODO: Disable pagination control once implemented
+            $('.dataTables_paginate').hide();
+        }
+        // Add star filter
         $.fn.dataTable.ext.search.push(
                 function(settings, data, dataIndex, rowObj, counter) {
             var api = new $.fn.dataTable.Api('#sodar-pr-project-list-table');
@@ -337,6 +343,7 @@ $(document).ready(function () {
                 return $(api.row(dataIndex).node()).data('starred');
             } else return true;
         });
+
         if (projectUuids.length > 0) {
             // Update custom columns
             updateCustomColumns(projectUuids);

projectroles/templates/projectroles/home.html

@@ -37,6 +37,10 @@ <h2 class="sodar-pr-content-title pt-2">Home</h2>
 
 {% block javascript %}
   {{ block.super }}
+  <!-- Variables -->
+  <script type="text/javascript">
+    window.projectListPagination = {% get_django_setting 'PROJECTROLES_PROJECT_LIST_PAGINATION' 10 %};
+  </script>
   <!-- DataTables -->
   <script type="text/javascript" src="https://cdn.datatables.net/v/bs4/dt-1.11.3/b-2.0.1/datatables.min.js"></script>
   <!-- Project list -->

projectroles/templates/projectroles/project_detail.html

@@ -113,7 +113,9 @@ <h4>
 
 {% block javascript %}
   {{ block.super }}
+    <!-- Variables -->
   <script type="text/javascript">
+    window.projectListPagination = {% get_django_setting 'PROJECTROLES_PROJECT_LIST_PAGINATION' 10 %};
     window.remoteLinkUrl = "{% url 'projectroles:ajax_remote_access' project=object.sodar_uuid %}";
   </script>
   {% if object.type == 'CATEGORY' %}

projectroles/tests/test_ui.py

@@ -857,6 +857,7 @@ def test_project_list_role_col_category_inherit(self):
         self.assertEqual(col.get_attribute('innerHTML'), 'N/A')
 
     # TODO: Test paginated list
+    # TODO: Test lack of pagination with less projects than setting
     # TODO: Test custom columns retrieval on paginated list
     # TODO: Test role column retrieval on paginated list
     # TODO: Test pagination controls and settings once implemented