Merge pull request #16 from PROCOLLAB-github/dev

Dev

Author: yakser

.github/workflows/lints.yml

@@ -26,4 +26,4 @@ jobs:
         pip install flake8
     - name: Analysing the code with flake8
       run: |
-        flake8 $(git ls-files '*.py')
+        flake8 $(git ls-files '*.py')

.gitignore

@@ -135,4 +135,5 @@ dmypy.json
 
 cache
 
-static
+static
+staticfiles

projects/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 
-from projects.models import Project, Achievement
+from projects.models import Project, Achievement, Collaborator
 
 
 @admin.register(Project)
@@ -18,3 +18,16 @@ class ProjectAdmin(admin.ModelAdmin):
 @admin.register(Achievement)
 class AchievementAdmin(admin.ModelAdmin):
     list_display = ("id", "title", "status", "project")
+
+
+@admin.register(Collaborator)
+class CollaboratorAdmin(admin.ModelAdmin):
+    list_display = (
+        "id",
+        "user",
+        "project",
+        "role",
+        "datetime_created",
+        "datetime_updated",
+    )
+    list_display_links = ("id", "user", "project")

projects/managers.py

@@ -7,44 +7,43 @@
 
 class ProjectManager(Manager):
     def get_projects_for_list_view(self):
-        return (
-            self.get_queryset()
-            .prefetch_related(
-                Prefetch(
-                    "industry",
-                    queryset=Industry.objects.only("name").all(),
-                ),
-                Prefetch(
-                    "leader",
-                    queryset=CustomUser.objects.only("id").all(),
-                ),
-            )
-            .only(
-                "id",
-                "name",
-                "leader__id",
-                "description",
-                "short_description",
-                "step",
-                "industry__name",
-                "image_address",
-                "draft",
-                "datetime_created",
-            )
-            .all()
+        return self.get_queryset().prefetch_related(
+            Prefetch(
+                "industry",
+                queryset=Industry.objects.only("name").all(),
+            ),
+            Prefetch(
+                "leader",
+                queryset=CustomUser.objects.only("id").all(),
+            ),
+            # Prefetch(
+            #     "collaborator_set",
+            #     queryset=Collaborator.objects.filter(
+            #         id__in=Subquery(
+            #              Collaborator.objects
+            #              .filter(project_id=OuterRef('project_id')).values_list('id', flat=True)[:4]
+            #         )
+            #     ),
+            #     to_attr='collaborators'
+            # ),
+            # Yes, this fetches the entire collaborator_set even though we only need 4 and the total count.
+            # No, You can't do it any other way than this.
+            # Above is a hack that can fetch max 4 vacancies, but if you use it the count will always be <=4.
+            # To get the count right using the thing above you either have to make another godawful hack,
+            # Or override the default QuerySet to always ask the DB only count after all the filters.
+            # (ticket referring to the reason why you can't
+            # prefetch N items easily https://code.djangoproject.com/ticket/26780)
+            # (seems like in django 4.2.0 it'll be fixed but at the time of writing the latest version is 4.1.3
+            Prefetch("collaborator_set"),
         )
 
     def get_projects_for_detail_view(self):
         return (
-            self.get_queryset()
-            .prefetch_related(
-                "collaborators",
-                "achievements",
-            )
-            .all()
+            self.get_queryset().prefetch_related("achievements", "collaborator_set").all()
         )
 
     def check_if_owns_any_projects(self, user) -> bool:
+        # I don't think this should work but the function has no usages, so I'll let it be
         return user.leader_projects.exists()
 
 

projects/migrations/0004_collaborator.py

@@ -0,0 +1,64 @@
+# Generated by Django 4.1.2 on 2022-11-04 19:23
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("projects", "0003_alter_project_collaborators"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Collaborator",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "role",
+                    models.CharField(
+                        blank=True, max_length=1024, null=True, verbose_name="Роль"
+                    ),
+                ),
+                (
+                    "datetime_created",
+                    models.DateTimeField(auto_now_add=True, verbose_name="Дата создания"),
+                ),
+                (
+                    "datetime_updated",
+                    models.DateTimeField(auto_now=True, verbose_name="Дата изменения"),
+                ),
+                (
+                    "project",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="projects.project",
+                        verbose_name="Проект",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="Пользователь",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Коллаборатор",
+                "verbose_name_plural": "Коллабораторы",
+            },
+        ),
+    ]

projects/migrations/0005_alter_project_collaborators_and_more.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.1.2 on 2022-11-05 09:06
+
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("projects", "0004_collaborator"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="project",
+            name="collaborators",
+        ),
+
+        migrations.AddConstraint(
+            model_name="collaborator",
+            constraint=models.UniqueConstraint(
+                fields=("project", "user"), name="unique_collaorator"
+            ),
+        ),
+    ]

projects/models.py

@@ -1,9 +1,11 @@
 from django.contrib.auth import get_user_model
 from django.db import models
+from django.db.models import UniqueConstraint
 
 from industries.models import Industry
 from projects.helpers import VERBOSE_STEPS
 from projects.managers import ProjectManager, AchievementManager
+from users.models import CustomUser
 
 User = get_user_model()
 
@@ -22,7 +24,6 @@ class Project(models.Model):
         industry: A ForeignKey referring to the Industry model.
         presentation_address: A URLField presentation URL address.
         image_address: A URLField image URL address.
-        collaborators: A ManyToManyField collaborators of the project.
         leader: A ForeignKey referring to the User model.
         draft: A boolean indicating if Project is a draft.
         datetime_created: A DateTimeField indicating date of creation.
@@ -45,12 +46,6 @@ class Project(models.Model):
     presentation_address = models.URLField(blank=True)
     image_address = models.URLField(blank=True)
 
-    collaborators = models.ManyToManyField(
-        User,
-        related_name="projects",
-        blank=True,
-    )
-
     leader = models.ForeignKey(
         User,
         on_delete=models.SET_NULL,
@@ -105,3 +100,39 @@ def __str__(self):
     class Meta:
         verbose_name = "Достижение"
         verbose_name_plural = "Достижения"
+
+
+class Collaborator(models.Model):
+    """Project collaborator model
+
+    Attributes:
+        user: A ForeignKey referencing the user who is collaborating in the project
+        project: A ForeignKey referencing the project the user is collaborating in
+        role: A CharField meaning the role the user is fulfilling in the project
+        datetime_created: A DateTimeField indicating date of creation.
+        datetime_updated: A DateTimeField indicating date of update.
+    """
+
+    user = models.ForeignKey(CustomUser, models.CASCADE, verbose_name="Пользователь")
+    project = models.ForeignKey(Project, models.CASCADE, verbose_name="Проект")
+    role = models.CharField("Роль", max_length=1024, blank=True, null=True)
+
+    datetime_created = models.DateTimeField(
+        verbose_name="Дата создания", null=False, auto_now_add=True
+    )
+    datetime_updated = models.DateTimeField(
+        verbose_name="Дата изменения", null=False, auto_now=True
+    )
+
+    class Meta:
+        verbose_name = "Коллаборатор"
+        verbose_name_plural = "Коллабораторы"
+        constraints = [
+            UniqueConstraint(
+                fields=[
+                    "project",
+                    "user",
+                ],
+                name="unique_collaorator",
+            )
+        ]