#M00. As a User, I would like to register an account. - Auxfuse (#83)

Author: auxfuse

.gitignore

@@ -9,4 +9,6 @@ env.py
 *.sqlite3
 settings.json
 .gitpod.yml
-setup.*
+setup.*
+venv/
+.idea/

accounts/__init__.py

@@ -0,0 +1,20 @@
+from django.contrib import admin
+
+from .models import Profile
+
+
+class ProfileAdmin(admin.ModelAdmin):
+    """
+    Profile Model Admin Panel setup.
+    Returning and displaying the three custom fields from the extended
+    allauth signup form.
+    """
+    fields = (
+        'slack_display_name',
+        'user_type',
+        'current_lms_module',
+    )
+
+
+admin.site.register(Profile, ProfileAdmin)
+

accounts/admin.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class AccountsConfig(AppConfig):
+    name = 'accounts'

accounts/apps.py

@@ -0,0 +1,40 @@
+from django import forms
+from allauth.account.forms import SignupForm
+
+from .lists import USER_TYPES_CHOICES, LMS_MODULES_CHOICES
+
+
+class ExtendedSignupForm(SignupForm):
+    """
+    Extending default Django allauth Signup Form to include fields to capture:
+    - first name/last name/slack display name/user type/current lms module
+    """
+    first_name = forms.CharField(max_length=20)
+    last_name = forms.CharField(max_length=20)
+    slack_display_name = forms.CharField(max_length=25)
+    user_type = forms.ChoiceField(
+        choices=USER_TYPES_CHOICES
+    )
+    current_lms_module = forms.ChoiceField(
+        choices=LMS_MODULES_CHOICES
+    )
+
+    def __init__(self, *args, **kwargs):
+        """
+        Setting unique attribute of the class instance and calling the parent
+        class.
+        Resetting the form autofocus to 'email' as the first displayed field.
+        """
+        super().__init__(*args, **kwargs)
+        self.fields['email'].widget.attrs['autofocus'] = True
+
+    def custom_signup(self, request, user):
+        """
+        Custom logic to ensure clean data via the form response.
+        """
+        user.first_name = self.cleaned_data["first_name"]
+        user.last_name = self.cleaned_data["last_name"]
+        user.slack_display_name = self.cleaned_data["slack_display_name"]
+        user.user_type = self.cleaned_data["user_type"]
+        user.current_lms_module = self.cleaned_data["current_lms_module"]
+

accounts/forms.py

@@ -0,0 +1,28 @@
+# User types list passed into dropdown of same name for user selection used
+# in models.py & forms.py
+USER_TYPES_CHOICES = [
+    ('', 'Select Post Category'),
+    ('participant', 'Participant'),
+    ('staff', 'Staff'),
+    ('admin', 'Admin'),
+]
+
+# LMS Modules list passed into dropdown of same name for user selection used
+# in modules.py & forms.py
+LMS_MODULES_CHOICES = [
+    ('', 'Select Learning Stage'),
+    ('programme_preliminaries', 'Programme Preliminaries'),
+    ('programming_paradigms', 'Programming Paradigms'),
+    ('html_fundamentals', 'HTML Fundamentals'),
+    ('css_fundamentals', 'CSS Fundamentals'),
+    ('user_centric_frontend_development', 'User Centric Frontend Development'),
+    ('javascript_fundamentals', 'Javascript Fundamentals'),
+    ('interactive_frontend_development', 'Interactive Frontend Development'),
+    ('python_fundamentals', 'Python Fundamentals'),
+    ('practical_python', 'Practical Python'),
+    ('data_centric_development', 'Data Centric Development'),
+    ('full_stack_frameworks with django', 'Full Stack Frameworks with Django'),
+    ('alumni', 'Alumni'),
+    ('staff', 'Staff'),
+]
+

accounts/lists.py

@@ -0,0 +1,27 @@
+# Generated by Django 3.1.1 on 2020-10-19 10:01
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Profile',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('slack_display_name', models.CharField(max_length=80, null=True)),
+                ('user_type', models.CharField(choices=[('', 'Select Post Category'), ('participant', 'Participant'), ('staff', 'Staff'), ('admin', 'Admin')], max_length=20, null=True)),
+                ('current_lms_module', models.CharField(choices=[('', 'Select Learning Stage'), ('programme preliminaries', 'Programme Preliminaries'), ('programming paradigms', 'Programming Paradigms'), ('html fundamentals', 'HTML Fundamentals'), ('css fundamentals', 'CSS Fundamentals'), ('user centric frontend development', 'User Centric Frontend Development'), ('javascript fundamentals', 'Javascript Fundamentals'), ('interactive frontend development', 'Interactive Frontend Development'), ('python fundamentals', 'Python Fundamentals'), ('practical python', 'Practical Python'), ('data centric development', 'Data Centric Development'), ('full stack frameworks with django', 'Full Stack Frameworks with Django'), ('alumni', 'Alumni'), ('staff', 'Staff')], max_length=35, null=True)),
+                ('user', models.OneToOneField(default=1, on_delete=django.db.models.deletion.CASCADE, related_name='profile', to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

accounts/migrations/0001_initial.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.1.1 on 2020-10-20 19:42
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accounts', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='profile',
+            name='current_lms_module',
+            field=models.CharField(choices=[('', 'Select Learning Stage'), ('programme_preliminaries', 'Programme Preliminaries'), ('programming_paradigms', 'Programming Paradigms'), ('html_fundamentals', 'HTML Fundamentals'), ('css_fundamentals', 'CSS Fundamentals'), ('user_centric_frontend_development', 'User Centric Frontend Development'), ('javascript_fundamentals', 'Javascript Fundamentals'), ('interactive_frontend_development', 'Interactive Frontend Development'), ('python_fundamentals', 'Python Fundamentals'), ('practical_python', 'Practical Python'), ('data_centric_development', 'Data Centric Development'), ('full_stack_frameworks with django', 'Full Stack Frameworks with Django'), ('alumni', 'Alumni'), ('staff', 'Staff')], default='', max_length=35),
+        ),
+        migrations.AlterField(
+            model_name='profile',
+            name='slack_display_name',
+            field=models.CharField(default='', max_length=80),
+        ),
+        migrations.AlterField(
+            model_name='profile',
+            name='user_type',
+            field=models.CharField(choices=[('', 'Select Post Category'), ('participant', 'Participant'), ('staff', 'Staff'), ('admin', 'Admin')], default='', max_length=20),
+        ),
+    ]

accounts/migrations/0002_auto_20201020_2042.py

@@ -0,0 +1,97 @@
+from django.dispatch import receiver
+from django.contrib.auth.models import User
+from django.db import models
+from django.conf import settings
+from django.db.models.signals import post_delete
+from allauth.account.signals import user_signed_up
+
+from .lists import USER_TYPES_CHOICES, LMS_MODULES_CHOICES
+
+
+class Profile(models.Model):
+    """
+    Define Profile Model with OneToOne relationship to AUTH_USER_MODEL and
+    custom fields to suit Signup Form Extending in forms.py replicating same
+    in DB.
+    Using "related_name" in the OneToOne relationship between the two models
+    specifies the reverse relationship to the User Model, allowing us to
+    target the custom fields for injection into the profile.html
+    template via `{{ user.profile.<<field_name>> }}`.
+    """
+    user = models.OneToOneField(
+        settings.AUTH_USER_MODEL, default=1,
+        related_name='profile',
+        on_delete=models.CASCADE
+    )
+    slack_display_name = models.CharField(
+        max_length=80,
+        blank=False,
+        default=''
+    )
+    user_type = models.CharField(
+        max_length=20,
+        blank=False,
+        default='',
+        choices=USER_TYPES_CHOICES
+    )
+    current_lms_module = models.CharField(
+        max_length=35,
+        blank=False,
+        default='',
+        choices=LMS_MODULES_CHOICES
+    )
+
+    def save(self, *args, **kwargs):
+        # when signup takes place
+        try:
+            self.slack_display_name = self.user.slack_display_name
+            self.user_type = self.user.user_type
+            self.current_lms_module = self.user.current_lms_module
+        # when saving via admin panel
+        except KeyError:
+            self.slack_display_name = self.user.profile.slack_display_name
+            self.user_type = self.user.profile.user_type
+            self.current_lms_module = self.user.profile.current_lms_module
+
+        super(Profile, self).save(*args, **kwargs)
+
+    def __str__(self):
+        """
+        Return Class object to string via the user email value
+        """
+        return self.user.email
+
+
+@receiver(user_signed_up)
+def user_signed_up(request, user, **kwargs):
+    """
+    Capture server request object in dict from QueryDict, to access form values.
+
+    Iterate over user_type field value to check for type and set permissions
+    based on user story and save user to User and Profile Models.
+    """
+    form = dict(request.POST)
+
+    if form['user_type'][0] == 'participant':
+        user.is_active = True
+    elif form['user_type'][0] == 'staff':
+        user.is_active = False
+        user.is_staff = True
+    else:
+        user.is_active = False
+        user.is_staff = True
+        user.is_superuser = True
+    user.save()
+
+    # Save linked instance of user object to profile model
+    Profile.objects.create(user=user)
+
+
+@receiver(post_delete, sender=Profile)
+def post_delete_user(sender, instance, *args, **kwargs):
+    """
+    admin - delete user at same time as profile deletion
+    """
+    if instance:
+        instance.user.delete()
+