Skip to content

Commit

Permalink
projects/migrations: use topics enum instead of tuples
Browse files Browse the repository at this point in the history
  • Loading branch information
m4ra authored and goapunk committed Dec 11, 2023
1 parent 1ab27aa commit 68cbb8d
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 19 deletions.
10 changes: 4 additions & 6 deletions adhocracy4/projects/fields.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
from django.conf import settings
from multiselectfield import MultiSelectField


class TopicField(MultiSelectField):
"""Deprecated, don't use"""

# TODO: remove once topic migrations are rolled out
def __init__(self, *args, **kwargs):
kwargs["max_length"] = 254
kwargs["max_choices"] = 2
Expand All @@ -11,11 +13,7 @@ def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)

def contribute_to_class(self, cls, name, **kwargs):
"""Initialize the choices from the project's settings if they exist."""
if hasattr(settings, "A4_PROJECT_TOPICS"):
self.choices = settings.A4_PROJECT_TOPICS
else:
self.choices = ()
self.choices = ()

# Call the super method at last so that choices are already initialized
super().contribute_to_class(cls, name, **kwargs)
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ class Migration(migrations.Migration):
),
),
("code", models.CharField(blank=True, max_length=10, unique=True)),
("name", models.CharField(max_length=120, verbose_name="Topic")),
],
),
migrations.AddField(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Generated by Django 4.2 on 2023-11-29 13:20
import sys
import importlib

from django.db import migrations
from django.conf import settings


def add_topics_to_m2m_table(apps, schema_editor):
if hasattr(settings, "A4_PROJECT_TOPICS"):
topicsenum = settings.A4_PROJECT_TOPICS
project = apps.get_model("a4projects", "Project")
topic = apps.get_model("a4projects", "Topic")
for project in project.objects.all():
for topic_code in project.topics:
proj_topic, _ = topic.objects.get_or_create(
code=topic_code,
name=[item[1] for item in topicsenum if item[0] == topic_code][0],
)
project.m2mtopics.add(proj_topic)
else:
Expand Down
10 changes: 5 additions & 5 deletions adhocracy4/projects/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from django.urls import reverse
from django.utils import timezone
from django.utils.functional import cached_property
from django.utils.module_loading import import_string
from django.utils.translation import gettext_lazy as _
from django_ckeditor_5.fields import CKEditor5Field
from django_enumfield.enum import EnumField
Expand All @@ -25,13 +26,12 @@

class Topic(models.Model):
code = models.CharField(blank=True, max_length=10, unique=True)
name = models.CharField(
max_length=120,
verbose_name=_("Topic"),
)

def __str__(self):
return self.name
if hasattr(settings, "A4_PROJECT_TOPICS"):
topics_enum = import_string(settings.A4_PROJECT_TOPICS)
return str(topics_enum(self.code).label)
return self.code


class ProjectManager(models.Manager):
Expand Down
22 changes: 22 additions & 0 deletions tests/project/enums.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# fmt: off

from django.db import models
from django.utils.translation import gettext_lazy as _


class TopicEnum(models.TextChoices):
"""Choices for project topics."""

ANT = "ANT", _("Anti-discrimination"),
WOR = "WOR", _("Work & economy"),
BUI = "BUI", _("Building & living"),
EDU = "EDU", _("Education & research"),
CHI = "CHI", _("Children, youth & family"),
FIN = "FIN", _("Finances"),
HEA = "HEA", _("Health & sports"),
INT = "INT", _("Integration"),
CUL = "CUL", _("Culture & leisure"),
NEI = "NEI", _("Neighborhood & participation"),
URB = "URB", _("Urban development"),
ENV = "ENV", _("Environment & public green space"),
TRA = "TRA", _("Traffic")
6 changes: 1 addition & 5 deletions tests/project/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -226,11 +226,7 @@
},
}

A4_PROJECT_TOPICS = (
("ANT", "Anti-discrimination"),
("WOR", "Work & economy"),
("BUI", "Building & living"),
)
A4_PROJECT_TOPICS = "tests.project.enums.TopicEnum"

A4_COMMENT_CATEGORIES = (
("QUE", "Question"),
Expand Down

0 comments on commit 68cbb8d

Please sign in to comment.