Merge pull request #117 from azavea/jw/refactor-role

Drop Role table

Author: jacobtylerwalls

CHANGELOG.md

@@ -47,6 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Update Edit Polygon border to be lighter on dark backgrounds [#58](https://github.com/azavea/iow-boundary-tool/pull/58)
 - Split DrawMap commponents into Layers and DrawTools [#57](https://github.com/azavea/iow-boundary-tool/pull/57)
 - Make `Roles` enum an `IntEnum` subclass [#74](https://github.com/azavea/iow-boundary-tool/pull/74)
+- Drop `Role` table and refactor as choice field on User [#117](https://github.com/azavea/iow-boundary-tool/pull/117)
 
 ### Fixed
 

doc/arch/adr-001-data-models.md

@@ -6,17 +6,13 @@ Below is the Entity Relationship Diagram illustrating the initial data model as
 
 ```mermaid
 erDiagram
-    Role {
-        string description
-    }
     User }o--o{ Utility : "has"
     User }o--|{ State : "within"
-    User }o--|| Role : is
     User {
-        Role role FK
         email email
         boolean is_staff
         boolean is_active
+        string role "max_length=1"
         date date_joined
         password password
         boolean is_locked_out

src/django/api/management/commands/resetdb.py

@@ -3,9 +3,9 @@
 from django.core.management import call_command
 from django.core.management.base import BaseCommand
 
-from api.models import Role, Utility, User
+from api.models import Utility, User
 from api.models.boundary import Boundary
-from api.models.role import Roles
+from api.models.user import Roles
 from api.models.submission import Approval, Submission
 
 from ..test_shapes import (
@@ -36,13 +36,13 @@ def handle(self, *args, **options):
             email="[email protected]",
             password="password",
             has_admin_generated_password=False,
-            role=Role.objects.get(pk=Roles.VALIDATOR),
+            role=Roles.VALIDATOR,
         )
         contributor = User.objects.create_user(
             email="[email protected]",
             password="password",
             has_admin_generated_password=False,
-            role=Role.objects.get(pk=Roles.CONTRIBUTOR),
+            role=Roles.CONTRIBUTOR,
         )
         contributor.utilities.add(test_utility)
 

src/django/api/migrations/0014_refactor_role.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.13 on 2022-10-10 12:40
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0013_user_has_admin_generated_password'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='user',
+            name='role',
+            field=models.CharField(choices=[('C', 'Contributor'), ('V', 'Validator'), ('A', 'Administrator')], default='C', max_length=1),
+        ),
+        migrations.DeleteModel(
+            name='Role',
+        ),
+    ]

src/django/api/models/__init__.py

@@ -1,5 +1,4 @@
 # flake8: noqa: F401
-from .role import Role
 from .user import User, EmailAsUsernameUserManager
 from .utility import Utility
 from .state import State

src/django/api/models/role.py

@@ -3,14 +3,13 @@
 from django.contrib.gis.db import models as gis_models
 
 from .boundary import Boundary
-from .role import Roles
-from .user import User
+from .user import User, Roles
 
 __all__ = ["Submission", "Approval", "Review", "Annotation"]
 
 
 def limit_by_validator_or_admin():
-    return models.Q(role__pk__in=[Roles.VALIDATOR, Roles.ADMINISTRATOR])
+    return models.Q(role__in=[Roles.VALIDATOR, Roles.ADMINISTRATOR])
 
 
 class Submission(models.Model):

src/django/api/models/submission.py

@@ -8,7 +8,6 @@
 from django.core.validators import EmailValidator
 from django.utils import timezone
 
-from .role import Role, Roles
 from .utility import Utility
 from .state import State
 
@@ -45,8 +44,13 @@ def create_superuser(self, email, password=None, **extra_fields):
         if extra_fields.get("is_superuser") is not True:
             raise ValueError("Superuser must have is_superuser=True.")
 
-        admin_role = Role.objects.get(pk=Roles.ADMINISTRATOR)
-        return self._create_user(email, admin_role, password, **extra_fields)
+        return self._create_user(email, Roles.ADMINISTRATOR, password, **extra_fields)
+
+
+class Roles(models.TextChoices):
+    CONTRIBUTOR = "C"
+    VALIDATOR = "V"
+    ADMINISTRATOR = "A"
 
 
 class User(AbstractBaseUser, PermissionsMixin):
@@ -61,11 +65,10 @@ class User(AbstractBaseUser, PermissionsMixin):
     date_joined = models.DateTimeField(default=timezone.now)
     has_admin_generated_password = models.BooleanField(default=True)
 
-    role = models.ForeignKey(
-        Role,
-        related_name="actors",
-        on_delete=models.PROTECT,
+    role = models.CharField(
         default=Roles.CONTRIBUTOR,
+        choices=Roles.choices,
+        max_length=1,
     )
 
     utilities = models.ManyToManyField(
@@ -81,11 +84,7 @@ class User(AbstractBaseUser, PermissionsMixin):
     )
 
     def clean(self):
-        if (
-            self.id
-            and self.role.pk == Roles.CONTRIBUTOR
-            and not self.utilities.exists()
-        ):
+        if self.id and self.role == Roles.CONTRIBUTOR and not self.utilities.exists():
             raise ValidationError("Contributors must be assigned a utility.")
 
         super().clean()