Merge pull request #17 from renderbox/develop

Release version 0.2.6

Author: devo-wm

.github/workflows/permafrost_ci.yml

@@ -31,7 +31,6 @@ jobs:
         python manage.py makemigrations --check --dry-run
       env: 
         DJANGO_DEBUG: 1
-
     - name: Install Build Dependencies
       run: |
         python -m pip install -e .[build]

.readthedocs.yml

@@ -0,0 +1,10 @@
+# Required
+version: 2
+
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

MANIFEST.in

@@ -0,0 +1,3 @@
+include LICENSE.txt
+include README.md
+recursive-include permafrost/templates *

README.md

@@ -2,6 +2,8 @@
 
 ![Permafrost CI](https://github.com/renderbox/django-permafrost/workflows/Permafrost%20CI/badge.svg)
 
+[![Documentation Status](https://readthedocs.org/projects/django-permafrost/badge/?version=latest)](https://django-permafrost.readthedocs.io/en/latest/?badge=latest)
+
 # Django Permafrost
 
 Django Permafrost is an extension to Django's Permissions framework.  It's goal is to allow developers to expose some permissions to Client Users on the site so they can create and manage custom User Roles.

develop/develop/settings.py

@@ -155,7 +155,6 @@
         'optional': [
             {'label': _('Can add Role'), 'permission': ('add_permafrostrole', 'permafrost', 'permafrostrole') },
             {'label': _('Can change Role'), 'permission': ('change_permafrostrole', 'permafrost', 'permafrostrole') },
-            {'label': _('Can view Role'), 'permission': ('view_permafrostrole', 'permafrost', 'permafrostrole') },
         ],
         'required': [
             {'label': _('Can view Role'), 'permission': ('view_permafrostrole', 'permafrost', 'permafrostrole') },

docs/conf.py

@@ -14,6 +14,8 @@
 import sys
 import django
 
+from permafrost.__version__ import VERSION
+
 sys.path.insert(0, os.path.abspath('../develop'))
 os.environ['DJANGO_SETTINGS_MODULE'] = 'develop.settings'
 django.setup()
@@ -23,21 +25,31 @@
 
 project = 'Permafrost'
 copyright = '2020, Grant Viklund'
-author = 'Grant Viklund'
+author = 'Grant Viklund, DeVon Jackson'
 
 # The full version, including alpha/beta/rc tags
-release = version = django.conf.settings.BUILD_VERSION
+release = version = VERSION
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'm2r',
+    'recommonmark',
+    'sphinx_rtd_theme',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.coverage',
+    'sphinx.ext.napoleon',
 ]
 
-source_suffix = ['.rst', '.md']
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

permafrost/__version__.py

@@ -1 +1 @@
-VERSION = "0.2.5"
+VERSION = "0.2.6"

permafrost/fixtures/unit_test.json

@@ -514,7 +514,9 @@
     "pk": 11,
     "fields": {
         "name": "1_user_student",
-        "permissions": []
+        "permissions": [
+            16
+        ]
     }
 },
 {
@@ -527,6 +529,18 @@
         ]
     }
 },
+{
+    "model": "auth.group",
+    "pk": 13,
+    "fields": {
+        "name": "2_administration_administrator",
+        "permissions": [
+            37,
+            38,
+            40
+        ]
+    }
+},
 {
     "model": "auth.user",
     "pk": 1,
@@ -551,6 +565,7 @@
     "fields": {
         "name": "Student",
         "slug": "student",
+        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
         "category": "user",
         "site": 1,
         "locked": false,
@@ -564,11 +579,26 @@
     "fields": {
         "name": "Councilor",
         "slug": "councilor",
+        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
         "category": "staff",
         "site": 1,
         "locked": false,
         "deleted": false,
         "group": 12
     }
+},
+{
+    "model": "permafrost.permafrostrole",
+    "pk": 3,
+    "fields": {
+        "name": "Administrator",
+        "slug": "administrator",
+        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+        "category": "administration",
+        "site": 2,
+        "locked": false,
+        "deleted": false,
+        "group": 12
+    }
 }
 ]

permafrost/forms.py

@@ -1 +1,134 @@
 # Permafrost Forms
+from django.contrib.auth.models import Permission
+from django.forms import ModelForm, MultipleChoiceField, CheckboxSelectMultiple
+from django.forms.fields import CharField, ChoiceField, BooleanField
+from django.forms.widgets import CheckboxInput, Textarea
+from django.utils.translation import ugettext_lazy as _
+from .models import PermafrostRole, get_optional_by_category, get_required_by_category, get_choices
+
+CHOICES = [('', _("Choose Role Type"))] + get_choices()
+
+def assemble_optiongroups_for_widget(permissions):
+    choices = []
+    optgroups = {}
+    if permissions:
+        for perm in permissions:
+            if perm.content_type.name in optgroups:
+                optgroups[perm.content_type.name].append((perm.pk, perm.name,))
+            else:
+                optgroups[perm.content_type.name] = [(perm.pk, perm.name,)]
+
+    for model_name, options in optgroups.items():
+        choices.append([model_name, options])
+    
+    return choices
+
+def bootstrappify(fields):
+    for field in fields:
+        widget = fields[field].widget
+        if not isinstance(widget, CheckboxInput):
+            if 'class' in widget.attrs:
+                widget.attrs['class'] =  widget.attrs['class'] + " form-control"
+            else:
+                widget.attrs.update({'class':'form-control'})
+
+class SelectPermafrostRoleTypeForm(ModelForm):
+    name = CharField(required=False)
+    description = CharField(required=False, widget=Textarea())
+    category = ChoiceField(choices=CHOICES)
+    
+    class Meta:
+        model = PermafrostRole
+        fields = ('name', 'description', 'category',)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        bootstrappify(self.fields)
+
+    
+
+
+class PermafrostRoleCreateForm(ModelForm):
+    class Meta:
+        model = PermafrostRole
+        fields = ('name', 'description', 'category',)
+        widgets = {
+            'description': Textarea(),
+        }
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.fields['category'].choices = CHOICES
+        category = self.initial.get('category', None)
+        
+        bootstrappify(self.fields)
+        
+        if category:  
+              
+            required_perms = get_required_by_category(category)
+            optional_perms = get_optional_by_category(category)
+            required_choices = assemble_optiongroups_for_widget(required_perms)
+            optional_choices = assemble_optiongroups_for_widget(optional_perms)
+            
+            initial = [perm.pk for perm in required_perms]
+            
+            self.fields[f'optional_{category}_perms'] = MultipleChoiceField(label=_("Optional Permissions"), choices=optional_choices, widget=CheckboxSelectMultiple(), required=False)
+            self.fields[f'required_{category}_perms'] = MultipleChoiceField(label=_("Required Permissions"), initial=initial, choices=required_choices, widget=CheckboxSelectMultiple(attrs={'readonly':True, 'disabled': True}), required=False)
+
+    def save(self, commit=True):
+        instance = super().save(commit)
+        category = instance.category
+        if self.cleaned_data and f'optional_{category}_perms' in self.cleaned_data:
+            perm_ids = []
+            if category:
+                perm_ids = self.cleaned_data[f'optional_{category}_perms' ]
+            if perm_ids:
+                instance.permissions_set(Permission.objects.filter(id__in=perm_ids))
+            else:
+                instance.permissions_clear()
+        return instance
+
+class PermafrostRoleUpdateForm(PermafrostRoleCreateForm):
+    """
+     Form used to display role detail
+     Only allowed to edit optional permissions, name and description
+     Category and required permissions stay locked
+    """
+    category = ChoiceField(choices=CHOICES, required=False)
+    deleted = BooleanField(required=False)
+    
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        
+        self.fields['category'].widget.attrs.update({'readonly': True, 'disabled': True})
+        self.fields['category'].disabled = True
+        self.fields['category'].required = False
+        self.fields['category'].initial = self.instance.category
+        
+        self.fields['deleted'].initial = self.instance.deleted
+        
+        category = self.instance.category
+
+        optional_perms = get_optional_by_category(category)
+        optional_choices = assemble_optiongroups_for_widget(optional_perms)
+        
+        available_optional_ids = [permission.id for permission in optional_perms]
+        preselected_optional = [permission.id for permission in self.instance.permissions().all() if permission.id in available_optional_ids]
+
+        self.fields.update({
+            f'optional_{category}_perms': MultipleChoiceField(
+                label=_("Optional Permissions"), 
+                initial=preselected_optional, 
+                choices=optional_choices, 
+                widget=CheckboxSelectMultiple(),
+                required=False
+            )
+        })
+
+    def save(self, commit=True):
+        if self.cleaned_data['deleted']:
+            self.instance.deleted = self.cleaned_data['deleted']
+        instance = super().save(commit)
+        return instance
+        

permafrost/migrations/0018_auto_20201124_1534.py

@@ -0,0 +1,23 @@
+# Generated by Django 3.1.3 on 2020-11-24 15:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('permafrost', '0017_delete_permafrostcategory'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='permafrostrole',
+            name='description',
+            field=models.CharField(blank=True, max_length=200, null=True, verbose_name='Description'),
+        ),
+        migrations.AlterField(
+            model_name='permafrostrole',
+            name='category',
+            field=models.CharField(choices=[('administration', 'Administration'), ('staff', 'Staff'), ('user', 'User')], max_length=32, verbose_name='Role Type'),
+        ),
+    ]