Prepare 0.19.1. Add dashboard class based view and permissions

Author: barseghyanartur

CHANGELOG.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.19.1
+------
+2022-07-12
+
+- Added class-based view for Dashboard.
+
 0.19
 ----
 2022-07-11

docs/changelog.rst

@@ -15,6 +15,12 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.19.1
+------
+2022-07-12
+
+- Added class-based view for Dashboard.
+
 0.19
 ----
 2022-07-11

setup.py

@@ -3,7 +3,7 @@
 from distutils.version import LooseVersion
 from setuptools import setup, find_packages
 
-version = '0.19'
+version = '0.19.1'
 
 # ***************************************************************************
 # ************************** Django version *********************************

src/fobi/__init__.py

@@ -1,5 +1,5 @@
 __title__ = 'django-fobi'
-__version__ = '0.19'
+__version__ = '0.19.1'
 __author__ = 'Artur Barseghyan <[email protected]>'
 __copyright__ = '2014-2022 Artur Barseghyan'
 __license__ = 'GPL 2.0/LGPL 2.1'

src/fobi/permissions/default.py

@@ -19,7 +19,7 @@
     edit_form_wizard_handler_entry_permission,
     wizards_dashboard_permissions,
 )
-from .generic import AllowAnyPermission, BasePermission
+from .generic import AllowAnyPermission, BasePermission, IsAuthenticatedPermission
 from .helpers import (
     all_permissions_required_func,
     any_permission_required_func,
@@ -42,6 +42,7 @@
     "EditFormHandlerEntryPermission",
     "DeleteFormHandlerEntryPermission",
     "ViewFormEntryPermission",
+    "ViewDashboardPermission",
 )
 
 
@@ -191,3 +192,7 @@ def has_object_permission(self, request, view, obj) -> bool:
 
 class ViewFormEntryPermission(AllowAnyPermission):
     """Permission to view form entries."""
+
+
+class ViewDashboardPermission(IsAuthenticatedPermission):
+    """Permission to view the dashboard."""

src/fobi/urls/class_based/edit.py

@@ -37,6 +37,7 @@
     EditFormElementEntryView,
     EditFormEntryView,
     EditFormHandlerEntryView,
+    DashboardView,
 )
 
 __title__ = "fobi.urls.class_based.edit"
@@ -230,7 +231,12 @@
     # ****************************** Dashboard ******************************
     # ***********************************************************************
     # Forms dashboard
-    url(_(r"^$"), view=dashboard, name="fobi.dashboard"),
+    url(
+        _(r"^$"),
+        # view=dashboard,
+        view=DashboardView.as_view(),
+        name="fobi.dashboard"
+    ),
     # Form wizards dashboard
     url(
         _(r"^wizards/$"),

src/fobi/views/class_based.py

@@ -13,6 +13,7 @@
 from django.views import View
 from django.views.generic import CreateView, DeleteView, DetailView, UpdateView
 from django.views.generic.edit import DeletionMixin
+from django.views.generic.list import ListView
 
 from ..base import (  # get_registered_form_handler_plugins
     fire_form_callbacks,
@@ -40,6 +41,10 @@
     ImportFormEntryForm,
     ImportFormWizardEntryForm,
 )
+from ..form_importers import (
+    ensure_autodiscover as ensure_importers_autodiscover,
+    form_importer_plugin_registry, get_form_importer_plugin_urls
+)
 from ..models import (
     FormElementEntry,
     FormEntry,
@@ -59,6 +64,7 @@
     EditFormEntryPermission,
     EditFormHandlerEntryPermission,
     ViewFormEntryPermission,
+    ViewDashboardPermission,
 )
 from ..settings import DEBUG, GET_PARAM_INITIAL_DATA, SORT_PLUGINS_BY_VALUE
 from ..utils import (
@@ -88,6 +94,7 @@
     "DeleteFormHandlerEntryView",
     "ViewFormEntryView",
     "ViewFormEntrySubmittedView",
+    "DashboardView",
 )
 
 logger = logging.getLogger(__name__)
@@ -219,6 +226,69 @@ def _run_after_plugin_entry_delete(self, request, form_entry_id):
     def run_after_plugin_entry_delete(self, request, form_entry_id):
         """Run after plugin entry has been deleted."""
 
+# *****************************************************************************
+# *****************************************************************************
+# ******************************** Dashboards *********************************
+# *****************************************************************************
+# *****************************************************************************
+
+# *****************************************************************************
+# ********************************** Forms ************************************
+# *****************************************************************************
+
+
+class DashboardView(ListView):
+    """Dashboard view."""
+
+    template_name = None
+    theme = None
+    permission_classes = (ViewDashboardPermission,)
+
+    def get_queryset(self):
+        """
+        Return the list of items for this view.
+
+        The return value must be an iterable and may be an instance of
+        `QuerySet` in which case `QuerySet` specific behavior will be enabled.
+        """
+        queryset = FormEntry._default_manager.filter(
+            user__pk=self.request.user.pk
+        )
+        ordering = self.get_ordering()
+        if ordering:
+            if isinstance(ordering, str):
+                ordering = (ordering,)
+            queryset = queryset.order_by(*ordering)
+
+        return queryset
+
+    def get_context_data(self, **kwargs):
+        """Get context data."""
+        context = super(DashboardView, self).get_context_data(**kwargs)
+        context.update({
+            "form_entries": self.get_queryset(),
+            'form_importers': get_form_importer_plugin_urls(),
+        })
+        if not self.theme:
+            theme = get_theme(request=self.request, as_instance=True)
+        else:
+            theme = self.theme
+
+        if theme:
+            context.update({"fobi_theme": theme})
+        return context
+
+    def get_template_names(self):
+        """Get template names."""
+        template_name = self.template_name
+        if not template_name:
+            if not self.theme:
+                theme = get_theme(request=self.request, as_instance=True)
+            else:
+                theme = self.theme
+            template_name = theme.dashboard_template
+        return [template_name]
+
 
 # *****************************************************************************
 # *****************************************************************************