Ensured forum admin forms can be lazily loaded

ellmetha · ellmetha · commit 660b34a1d8b2 · 2018-10-30T22:44:36.000-04:00
Forms used by the forum admin classes are now imported using get_class so that it should be possible to easily customize form fields and widgets by relying on the class
loading mechanisms provided by django-machina.
diff --git a/machina/apps/forum/admin.py b/machina/apps/forum/admin.py
@@ -8,11 +8,9 @@
 
 from collections import OrderedDict
 
-from django import forms
 from django.conf.urls import url
 from django.contrib import admin
 from django.contrib.admin import helpers
-from django.contrib.admin.widgets import ForeignKeyRawIdWidget
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import Group
 from django.forms.forms import NON_FIELD_ERRORS
@@ -23,7 +21,6 @@
 from django.urls import reverse
 from django.utils.translation import ugettext_lazy as _
 from mptt.exceptions import InvalidMove
-from mptt.forms import TreeNodeChoiceField
 
 from machina.core.db.models import get_model
 from machina.core.loading import get_class
@@ -36,11 +33,12 @@
 GroupForumPermission = get_model('forum_permission', 'GroupForumPermission')
 UserForumPermission = get_model('forum_permission', 'UserForumPermission')
 
-PermissionConfig = get_class('forum_permission.defaults', 'PermissionConfig')
+PermissionsForm = get_class('forum.forms', 'PermissionsForm')
+PickForumForm = get_class('forum.forms', 'PickForumForm')
+PickGroupForm = get_class('forum.forms', 'PickGroupForm')
+PickUserForm = get_class('forum.forms', 'PickUserForm')
 
-PERM_GRANTED = 'granted'
-PERM_NOT_GRANTED = 'not-granted'
-PERM_NOT_SET = 'not-set'
+PermissionConfig = get_class('forum_permission.defaults', 'PermissionConfig')
 
 
 class ForumAdmin(admin.ModelAdmin):
@@ -327,11 +325,11 @@ def _get_permissions_form(self, request, permission_model, filter_kwargs):
         permissions_dict = OrderedDict()
         for p in editable_permissions:
             if p.codename in granted_permissions:
-                perm_state = PERM_GRANTED
+                perm_state = PermissionsForm.PERM_GRANTED
             elif p.codename in non_granted_permissions:
-                perm_state = PERM_NOT_GRANTED
+                perm_state = PermissionsForm.PERM_NOT_GRANTED
             else:
-                perm_state = PERM_NOT_SET
+                perm_state = PermissionsForm.PERM_NOT_SET
             permissions_dict[p.codename] = (p, perm_state)
 
         if request.method == 'POST':
@@ -343,17 +341,17 @@ def _get_permissions_form(self, request, permission_model, filter_kwargs):
                             permission=permissions_dict[codename][0], **filter_kwargs
                         )
                     except permission_model.DoesNotExist:
-                        if value == PERM_NOT_SET:
+                        if value == PermissionsForm.PERM_NOT_SET:
                             continue
                         perm = permission_model.objects.create(
                             permission=permissions_dict[codename][0], **filter_kwargs
                         )
 
-                    if value == PERM_NOT_SET:
+                    if value == PermissionsForm.PERM_NOT_SET:
                         perm.delete()
                         continue
 
-                    perm.has_perm = (value == PERM_GRANTED)
+                    perm.has_perm = (value == PermissionsForm.PERM_GRANTED)
                     perm.save()
 
                 self.message_user(request, _('Permissions successfully applied'))
@@ -395,85 +393,4 @@ def _copy_forum_permissions(self, forum_from, forum_to):
             new_perm.save()
 
 
-class PickUserForm(forms.Form):
-    """ Form allowing to pick a user to edit their permissions. """
-
-    user = UserForumPermission._meta.get_field('user').formfield()
-    anonymous_user = forms.BooleanField(
-        label=_('Anonymous'),
-        initial=False,
-        help_text=_(
-            'Please select this option if you want to edit the permissions of the anonymous user'
-        ),
-    )
-
-    def __init__(self, *args, **kwargs):
-        admin_site = kwargs.pop('admin_site')
-        super().__init__(*args, **kwargs)
-
-        self.fields['user'].required = False
-        self.fields['user'].widget = ForeignKeyRawIdWidget(
-            UserForumPermission._meta.get_field('user').remote_field, admin_site,
-        )
-
-        self.fields['anonymous_user'].required = False
-
-    def clean(self):
-        cleaned_data = super().clean()
-        user = cleaned_data.get('user', None)
-        anonymous_user = cleaned_data.get('anonymous_user', None)
-        if user and anonymous_user:
-            self._errors[NON_FIELD_ERRORS] = self.error_class(
-                [_('Choose either a user ID or select the anonymous user'), ],
-            )
-        return cleaned_data
-
-
-class PickGroupForm(forms.Form):
-    """ Form allowing to pick a group to edit its permissions. """
-
-    group = GroupForumPermission._meta.get_field('group').formfield()
-
-    def __init__(self, *args, **kwargs):
-        admin_site = kwargs.pop('admin_site')
-        super().__init__(*args, **kwargs)
-
-        self.fields['group'].required = False
-        self.fields['group'].widget = ForeignKeyRawIdWidget(
-            GroupForumPermission._meta.get_field('group').remote_field, admin_site,
-        )
-
-
-class PickForumForm(forms.Form):
-    """ Form allowing to pick a specific forum. """
-
-    forum = TreeNodeChoiceField(queryset=Forum.objects.all(), required=False)
-
-
-class PermissionsForm(forms.Form):
-    """ Form allowing to edit permissions. """
-
-    def __init__(self, *args, **kwargs):
-        self.permissions_dict = kwargs.pop('permissions_dict', {})
-        super().__init__(*args, **kwargs)
-
-        # Initializes permission fields
-        f_choices = (
-            (PERM_NOT_SET, _('Not set')),
-            (PERM_GRANTED, _('Granted')),
-            (PERM_NOT_GRANTED, _('Not granted')),
-        )
-        for scope in PermissionConfig.scopes:
-            codenames = [
-                x['fields']['codename'] for x in PermissionConfig.permissions if x['scope'] == scope
-            ]
-            permissions = filter(lambda v: v[0] in codenames, self.permissions_dict.items())
-            for codename, p in permissions:
-                self.fields[codename] = forms.ChoiceField(
-                    label=p[0].name, choices=f_choices, required=False, widget=forms.RadioSelect,
-                )
-                self.fields[codename].initial = p[1]
-                self.fields[codename].scope = scope
-
-
 admin.site.register(Forum, ForumAdmin)
diff --git a/machina/apps/forum/forms.py b/machina/apps/forum/forms.py
@@ -0,0 +1,108 @@
+"""
+    Forum forms
+    ===========
+
+    This module defines forms provided by the ``forum`` application.
+
+"""
+
+from django import forms
+from django.contrib.admin.widgets import ForeignKeyRawIdWidget
+from django.forms.forms import NON_FIELD_ERRORS
+from django.utils.translation import ugettext_lazy as _
+from mptt.forms import TreeNodeChoiceField
+
+from machina.core.db.models import get_model
+from machina.core.loading import get_class
+
+
+Forum = get_model('forum', 'Forum')
+GroupForumPermission = get_model('forum_permission', 'GroupForumPermission')
+UserForumPermission = get_model('forum_permission', 'UserForumPermission')
+
+PermissionConfig = get_class('forum_permission.defaults', 'PermissionConfig')
+
+
+class PickUserForm(forms.Form):
+    """ Form allowing to pick a user to edit their permissions. """
+
+    user = UserForumPermission._meta.get_field('user').formfield()
+    anonymous_user = forms.BooleanField(
+        label=_('Anonymous'),
+        initial=False,
+        help_text=_(
+            'Please select this option if you want to edit the permissions of the anonymous user'
+        ),
+    )
+
+    def __init__(self, *args, **kwargs):
+        admin_site = kwargs.pop('admin_site')
+        super().__init__(*args, **kwargs)
+
+        self.fields['user'].required = False
+        self.fields['user'].widget = ForeignKeyRawIdWidget(
+            UserForumPermission._meta.get_field('user').remote_field, admin_site,
+        )
+
+        self.fields['anonymous_user'].required = False
+
+    def clean(self):
+        cleaned_data = super().clean()
+        user = cleaned_data.get('user', None)
+        anonymous_user = cleaned_data.get('anonymous_user', None)
+        if user and anonymous_user:
+            self._errors[NON_FIELD_ERRORS] = self.error_class(
+                [_('Choose either a user ID or select the anonymous user'), ],
+            )
+        return cleaned_data
+
+
+class PickGroupForm(forms.Form):
+    """ Form allowing to pick a group to edit its permissions. """
+
+    group = GroupForumPermission._meta.get_field('group').formfield()
+
+    def __init__(self, *args, **kwargs):
+        admin_site = kwargs.pop('admin_site')
+        super().__init__(*args, **kwargs)
+
+        self.fields['group'].required = False
+        self.fields['group'].widget = ForeignKeyRawIdWidget(
+            GroupForumPermission._meta.get_field('group').remote_field, admin_site,
+        )
+
+
+class PickForumForm(forms.Form):
+    """ Form allowing to pick a specific forum. """
+
+    forum = TreeNodeChoiceField(queryset=Forum.objects.all(), required=False)
+
+
+class PermissionsForm(forms.Form):
+    """ Form allowing to edit permissions. """
+
+    PERM_GRANTED = 'granted'
+    PERM_NOT_GRANTED = 'not-granted'
+    PERM_NOT_SET = 'not-set'
+
+    def __init__(self, *args, **kwargs):
+        self.permissions_dict = kwargs.pop('permissions_dict', {})
+        super().__init__(*args, **kwargs)
+
+        # Initializes permission fields
+        f_choices = (
+            (self.PERM_NOT_SET, _('Not set')),
+            (self.PERM_GRANTED, _('Granted')),
+            (self.PERM_NOT_GRANTED, _('Not granted')),
+        )
+        for scope in PermissionConfig.scopes:
+            codenames = [
+                x['fields']['codename'] for x in PermissionConfig.permissions if x['scope'] == scope
+            ]
+            permissions = filter(lambda v: v[0] in codenames, self.permissions_dict.items())
+            for codename, p in permissions:
+                self.fields[codename] = forms.ChoiceField(
+                    label=p[0].name, choices=f_choices, required=False, widget=forms.RadioSelect,
+                )
+                self.fields[codename].initial = p[1]
+                self.fields[codename].scope = scope
