EcoAccount views

* splits compensation/views/eco_account.py (+700 lines) into separate files in new module
    * view files can now be found in /compensation/views/eco_account/...

compensation/urls/eco_account.py

@@ -23,7 +23,8 @@ from compensation.views.eco_account.deadline import NewEcoAccountDeadlineView, E
 from compensation.views.eco_account.share import share_view, create_share_view
 from compensation.views.eco_account.document import GetEcoAccountDocumentView, NewEcoAccountDocumentView, \
     EditEcoAccountDocumentView, RemoveEcoAccountDocumentView
-from compensation.views.eco_account.deduction import deduction_edit_view, deduction_remove_view, new_deduction_view
+from compensation.views.eco_account.deduction import NewEcoAccountDeductionView, EditEcoAccountDeductionView, \
+    RemoveEcoAccountDeductionView
 
 app_name = "acc"
 urlpatterns = [
@@ -60,9 +61,9 @@ urlpatterns = [
     path('<id>/document/<doc_id>/remove/', RemoveEcoAccountDocumentView.as_view(), name='remove-doc'),
 
     # Eco-account deductions
-    path('<id>/deduction/<deduction_id>/remove', deduction_remove_view, name='remove-deduction'),
+    path('<id>/deduction/<deduction_id>/remove', RemoveEcoAccountDeductionView.as_view(), name='remove-deduction'),
-    path('<id>/deduction/<deduction_id>/edit', deduction_edit_view, name='edit-deduction'),
+    path('<id>/deduction/<deduction_id>/edit', EditEcoAccountDeductionView.as_view(), name='edit-deduction'),
-    path('<id>/deduct/new', new_deduction_view, name='new-deduction'),
+    path('<id>/deduct/new', NewEcoAccountDeductionView.as_view(), name='new-deduction'),
 
     # Autocomplete
     path("atcmplt/eco-accounts", EcoAccountAutocomplete.as_view(), name="autocomplete"),

compensation/views/eco_account/deduction.py

@@ -6,96 +6,50 @@ Created on: 19.08.22
 
 """
 from django.contrib.auth.decorators import login_required
-from django.core.exceptions import ObjectDoesNotExist
+from django.http import Http404
-from django.http import HttpRequest, Http404
+from django.utils.decorators import method_decorator
-from django.shortcuts import get_object_or_404
-from django.urls import reverse
 
 from compensation.models import EcoAccount
-from intervention.forms.modals.deduction import EditEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \
-    NewEcoAccountDeductionModalForm
 from konova.decorators import default_group_required
-from konova.utils.message_templates import DEDUCTION_EDITED, DEDUCTION_REMOVED, DEDUCTION_ADDED
+from konova.views.deduction import AbstractNewDeductionView, AbstractEditDeductionView, AbstractRemoveDeductionView
 
 
-@login_required
+class NewEcoAccountDeductionView(AbstractNewDeductionView):
-@default_group_required
+    model = EcoAccount
-def new_deduction_view(request: HttpRequest, id: str):
+    redirect_url = "compensation:acc:detail"
-    """ Renders a modal form view for creating deductions
 
-    Args:
+    @method_decorator(login_required)
-        request (HttpRequest): THe incoming request
+    @method_decorator(default_group_required)
-        id (str): The eco account's id
+    def dispatch(self, request, *args, **kwargs):
+        return super().dispatch(request, *args, **kwargs)
 
-    Returns:
+    def _custom_check(self, obj):
-
+        if not obj.recorded:
-    """
-    acc = get_object_or_404(EcoAccount, id=id)
-    if not acc.recorded:
             raise Http404()
-    form = NewEcoAccountDeductionModalForm(request.POST or None, instance=acc, request=request)
-    return form.process_request(
-        request,
-        msg_success=DEDUCTION_ADDED,
-        redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data"
-    )
-
-
-@login_required
-@default_group_required
-def deduction_remove_view(request: HttpRequest, id: str, deduction_id: str):
-    """ Renders a modal view for removing deductions
-
-    Args:
-        request (HttpRequest): The incoming request
-        id (str): The eco account's id
-        deduction_id (str): The deduction's id
-
-    Returns:
-
-    """
-    acc = get_object_or_404(EcoAccount, id=id)
-    try:
-        eco_deduction = acc.deductions.get(id=deduction_id)
-        if not eco_deduction.intervention.is_shared_with(request.user):
-            raise ObjectDoesNotExist()
-    except ObjectDoesNotExist:
-        raise Http404("Unknown deduction")
 
-    form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request)
-    return form.process_request(
-        request=request,
-        msg_success=DEDUCTION_REMOVED,
-        redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data"
-    )
 
+class EditEcoAccountDeductionView(AbstractEditDeductionView):
+    def _custom_check(self, obj):
+        pass
 
-@login_required
+    model = EcoAccount
-@default_group_required
+    redirect_url = "compensation:acc:detail"
-def deduction_edit_view(request: HttpRequest, id: str, deduction_id: str):
-    """ Renders a modal view for editing deductions
 
-    Args:
+    @method_decorator(login_required)
-        request (HttpRequest): The incoming request
+    @method_decorator(default_group_required)
-        id (str): The eco account's id
+    def dispatch(self, request, *args, **kwargs):
-        deduction_id (str): The deduction's id
+        return super().dispatch(request, *args, **kwargs)
 
-    Returns:
 
-    """
+class RemoveEcoAccountDeductionView(AbstractRemoveDeductionView):
-    acc = get_object_or_404(EcoAccount, id=id)
+    def _custom_check(self, obj):
-    try:
+        pass
-        eco_deduction = acc.deductions.get(id=deduction_id)
-        if not eco_deduction.intervention.is_shared_with(request.user):
-            raise ObjectDoesNotExist
-    except ObjectDoesNotExist:
-        raise Http404("Unknown deduction")
 
-    form = EditEcoAccountDeductionModalForm(request.POST or None, instance=acc, deduction=eco_deduction, request=request)
+    model = EcoAccount
-    return form.process_request(
+    redirect_url = "compensation:acc:detail"
-        request=request,
-        msg_success=DEDUCTION_EDITED,
-        redirect_url=reverse("compensation:acc:detail", args=(id,)) + "#related_data"
-    )
 
+    @method_decorator(login_required)
+    @method_decorator(default_group_required)
+    def dispatch(self, request, *args, **kwargs):
+        return super().dispatch(request, *args, **kwargs)
 

intervention/urls.py

@@ -10,7 +10,8 @@ from django.urls import path
 from intervention.autocomplete.intervention import InterventionAutocomplete
 from intervention.views.check import check_view
 from intervention.views.compensation import remove_compensation_view
-from intervention.views.deduction import new_deduction_view, edit_deduction_view, remove_deduction_view
+from intervention.views.deduction import NewInterventionDeductionView, EditInterventionDeductionView, \
+    RemoveInterventionDeductionView
 from intervention.views.document import NewInterventionDocumentView, GetInterventionDocumentView, \
     RemoveInterventionDocumentView, EditInterventionDocumentView
 from intervention.views.intervention import index_view, new_view, new_id_view, detail_view, edit_view, remove_view
@@ -48,9 +49,9 @@ urlpatterns = [
     path('<id>/document/<doc_id>/edit/', EditInterventionDocumentView.as_view(), name='edit-doc'),
 
     # Deductions
-    path('<id>/deduction/new', new_deduction_view, name='new-deduction'),
+    path('<id>/deduction/new', NewInterventionDeductionView.as_view(), name='new-deduction'),
-    path('<id>/deduction/<deduction_id>/edit', edit_deduction_view, name='edit-deduction'),
+    path('<id>/deduction/<deduction_id>/edit', EditInterventionDeductionView.as_view(), name='edit-deduction'),
-    path('<id>/deduction/<deduction_id>/remove', remove_deduction_view, name='remove-deduction'),
+    path('<id>/deduction/<deduction_id>/remove', RemoveInterventionDeductionView.as_view(), name='remove-deduction'),
 
     # Revocation routes
     path('<id>/revocation/new', new_revocation_view, name='new-revocation'),

intervention/views/deduction.py

@@ -6,92 +6,50 @@ Created on: 19.08.22
 
 """
 from django.contrib.auth.decorators import login_required
-from django.core.exceptions import ObjectDoesNotExist
+from django.utils.decorators import method_decorator
-from django.http import HttpRequest, Http404
-from django.shortcuts import get_object_or_404
-from django.urls import reverse
 
-from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, RemoveEcoAccountDeductionModalForm, \
-    EditEcoAccountDeductionModalForm
 from intervention.models import Intervention
 from konova.decorators import default_group_required, shared_access_required
-from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_REMOVED, DEDUCTION_EDITED
+from konova.views.deduction import AbstractNewDeductionView, AbstractEditDeductionView, AbstractRemoveDeductionView
 
 
-@login_required
+class NewInterventionDeductionView(AbstractNewDeductionView):
-@default_group_required
+    def _custom_check(self, obj):
-@shared_access_required(Intervention, "id")
+        pass
-def new_deduction_view(request: HttpRequest, id: str):
-    """ Renders a modal form view for creating deductions
 
-    Args:
+    model = Intervention
-        request (HttpRequest): The incoming request
+    redirect_url = "intervention:detail"
-        id (str): The intervention's id which shall benefit from this deduction
 
-    Returns:
+    @method_decorator(login_required)
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def dispatch(self, request, *args, **kwargs):
+        return super().dispatch(request, *args, **kwargs)
 
-    """
-    intervention = get_object_or_404(Intervention, id=id)
-    form = NewEcoAccountDeductionModalForm(request.POST or None, instance=intervention, request=request)
-    return form.process_request(
-        request,
-        msg_success=DEDUCTION_ADDED,
-        redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data",
-    )
 
+class EditInterventionDeductionView(AbstractEditDeductionView):
+    def _custom_check(self, obj):
+        pass
 
-@login_required
+    model = Intervention
-@default_group_required
+    redirect_url = "intervention:detail"
-@shared_access_required(Intervention, "id")
-def remove_deduction_view(request: HttpRequest, id: str, deduction_id: str):
-    """ Renders a modal view for removing deductions
 
-    Args:
+    @method_decorator(login_required)
-        request (HttpRequest): The incoming request
+    @method_decorator(default_group_required)
-        id (str): The intervention's id
+    @method_decorator(shared_access_required(Intervention, "id"))
-        deduction_id (str): The deduction's id
+    def dispatch(self, request, *args, **kwargs):
+        return super().dispatch(request, *args, **kwargs)
 
-    Returns:
 
-    """
+class RemoveInterventionDeductionView(AbstractRemoveDeductionView):
-    intervention = get_object_or_404(Intervention, id=id)
+    def _custom_check(self, obj):
-    try:
+        pass
-        eco_deduction = intervention.deductions.get(id=deduction_id)
-    except ObjectDoesNotExist:
-        raise Http404("Unknown deduction")
 
-    form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request)
+    model = Intervention
-    return form.process_request(
+    redirect_url = "intervention:detail"
-        request=request,
-        msg_success=DEDUCTION_REMOVED,
-        redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data"
-    )
-
-
-@login_required
-@default_group_required
-@shared_access_required(Intervention, "id")
-def edit_deduction_view(request: HttpRequest, id: str, deduction_id: str):
-    """ Renders a modal view for removing deductions
-
-    Args:
-        request (HttpRequest): The incoming request
-        id (str): The intervention's id
-        deduction_id (str): The deduction's id
-
-    Returns:
-
-    """
-    intervention = get_object_or_404(Intervention, id=id)
-    try:
-        eco_deduction = intervention.deductions.get(id=deduction_id)
-    except ObjectDoesNotExist:
-        raise Http404("Unknown deduction")
-
-    form = EditEcoAccountDeductionModalForm(request.POST or None, instance=intervention, deduction=eco_deduction, request=request)
-    return form.process_request(
-        request=request,
-        msg_success=DEDUCTION_EDITED,
-        redirect_url=reverse("intervention:detail", args=(id,)) + "#related_data"
-    )
 
+    @method_decorator(login_required)
+    @method_decorator(default_group_required)
+    @method_decorator(shared_access_required(Intervention, "id"))
+    def dispatch(self, request, *args, **kwargs):
+        return super().dispatch(request, *args, **kwargs)

konova/utils/message_templates.py

@@ -51,6 +51,7 @@ COMPENSATION_ACTION_REMOVED = _("Action removed")
 DEDUCTION_ADDED = _("Deduction added")
 DEDUCTION_EDITED = _("Deduction edited")
 DEDUCTION_REMOVED = _("Deduction removed")
+DEDUCTION_UNKNOWN = _("Unknown deduction")
 
 # DEADLINE
 DEADLINE_ADDED = _("Deadline added")

konova/views/deduction.py

@@ -0,0 +1,135 @@
+"""
+Author: Michel Peltriaux
+Organization: Struktur- und Genehmigungsdirektion Nord, Rhineland-Palatinate, Germany
+Contact: ksp-servicestelle@sgdnord.rlp.de
+Created on: 22.08.22
+
+"""
+from django.core.exceptions import ObjectDoesNotExist
+from django.http import Http404
+from django.shortcuts import get_object_or_404
+from django.urls import reverse
+from django.views import View
+
+from intervention.forms.modals.deduction import NewEcoAccountDeductionModalForm, EditEcoAccountDeductionModalForm, \
+    RemoveEcoAccountDeductionModalForm
+from konova.utils.message_templates import DEDUCTION_ADDED, DEDUCTION_EDITED, DEDUCTION_REMOVED, DEDUCTION_UNKNOWN
+
+
+class AbstractDeductionView(View):
+    model = None
+    redirect_url = None
+
+    def _custom_check(self, obj):
+        """
+        Can be used by inheriting classes to provide custom checks before further processing
+
+        """
+        raise NotImplementedError("Must be implemented in subclasses")
+
+
+class AbstractNewDeductionView(AbstractDeductionView):
+
+    class Meta:
+        abstract = True
+
+    def get(self, request, id: str):
+        """ Renders a modal form view for creating deductions
+
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The obj's id which shall benefit from this deduction
+
+        Returns:
+
+        """
+        obj = get_object_or_404(self.model, id=id)
+        self._custom_check(obj)
+        form = NewEcoAccountDeductionModalForm(request.POST or None, instance=obj, request=request)
+        return form.process_request(
+            request,
+            msg_success=DEDUCTION_ADDED,
+            redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data",
+        )
+
+    def post(self, request, id: str):
+        return self.get(request, id)
+
+
+class AbstractEditDeductionView(AbstractDeductionView):
+
+    def _custom_check(self, obj):
+        pass
+
+    class Meta:
+        abstract = True
+
+    def get(self, request, id: str, deduction_id: str):
+        """ Renders a modal view for editing deductions
+
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The object's id
+            deduction_id (str): The deduction's id
+
+        Returns:
+
+        """
+        obj = get_object_or_404(self.model, id=id)
+        self._custom_check(obj)
+        try:
+            eco_deduction = obj.deductions.get(id=deduction_id)
+            if not eco_deduction.intervention.is_shared_with(request.user):
+                raise ObjectDoesNotExist
+        except ObjectDoesNotExist:
+            raise Http404(DEDUCTION_UNKNOWN)
+
+        form = EditEcoAccountDeductionModalForm(request.POST or None, instance=obj, deduction=eco_deduction,
+                                                request=request)
+        return form.process_request(
+            request=request,
+            msg_success=DEDUCTION_EDITED,
+            redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data"
+        )
+
+    def post(self, request, id: str, deduction_id: str):
+        return self.get(request, id, deduction_id)
+
+
+class AbstractRemoveDeductionView(AbstractDeductionView):
+
+    def _custom_check(self, obj):
+        pass
+
+    class Meta:
+        abstract = True
+
+    def get(self, request, id: str, deduction_id: str):
+        """ Renders a modal view for removing deductions
+
+        Args:
+            request (HttpRequest): The incoming request
+            id (str): The object's id
+            deduction_id (str): The deduction's id
+
+        Returns:
+
+        """
+        obj = get_object_or_404(self.model, id=id)
+        self._custom_check(obj)
+        try:
+            eco_deduction = obj.deductions.get(id=deduction_id)
+            if not eco_deduction.intervention.is_shared_with(request.user):
+                raise ObjectDoesNotExist()
+        except ObjectDoesNotExist:
+            raise Http404(DEDUCTION_UNKNOWN)
+        form = RemoveEcoAccountDeductionModalForm(request.POST or None, instance=obj, deduction=eco_deduction,
+                                                  request=request)
+        return form.process_request(
+            request=request,
+            msg_success=DEDUCTION_REMOVED,
+            redirect_url=reverse(self.redirect_url, args=(id,)) + "#related_data"
+        )
+
+    def post(self, request, id: str, deduction_id: str):
+        return self.get(request, id, deduction_id)