feat: add modules groups

Author: remigermain

apps/accounts/models.py

@@ -25,6 +25,7 @@
 )
 from apps.commons.enums import SDG, Language
 from apps.commons.mixins import (
+    HasModulesRelated,
     HasMultipleIDs,
     HasOwner,
     HasPermissionsSetup,
@@ -41,6 +42,7 @@
 
 
 class PeopleGroup(
+    HasModulesRelated,
     HasAutoTranslatedFields,
     HasMultipleIDs,
     HasPermissionsSetup,

apps/accounts/serializers.py

@@ -237,6 +237,16 @@ class Meta:
         fields = read_only_fields
 
 
+class ModulesSerializers(serializers.ModelSerializer):
+    modules = serializers.SerializerMethodField()
+
+    def get_modules(self, instance):
+        request = self.context.get("request")
+
+        cls = instance.get_related_module()
+        return cls(instance, user=request.user).count()
+
+
 class PeopleGroupLightSerializer(
     AutoTranslatedModelSerializer, serializers.ModelSerializer
 ):
@@ -402,7 +412,10 @@ def create(self, validated_data):
 
 
 class PeopleGroupSerializer(
-    StringsImagesSerializer, AutoTranslatedModelSerializer, serializers.ModelSerializer
+    ModulesSerializers,
+    StringsImagesSerializer,
+    AutoTranslatedModelSerializer,
+    serializers.ModelSerializer,
 ):
 
     string_images_forbid_fields: List[str] = [
@@ -527,7 +540,7 @@ def save(self, **kwargs):
 
     class Meta:
         model = PeopleGroup
-        read_only_fields = ["is_root", "slug"]
+        read_only_fields = ["is_root", "slug", "modules"]
         fields = read_only_fields + [
             "id",
             "name",

apps/accounts/views.py

@@ -40,7 +40,6 @@
 from apps.files.views import ImageStorageView
 from apps.organizations.models import Organization
 from apps.organizations.permissions import HasOrganizationPermission
-from apps.projects.models import Project
 from apps.projects.serializers import ProjectLightSerializer
 from apps.skills.models import Skill
 from services.google.models import GoogleAccount, GoogleGroup
@@ -682,27 +681,10 @@ def remove_member(self, request, *args, **kwargs):
     )
     def member(self, request, *args, **kwargs):
         group = self.get_object()
-        managers_ids = group.managers.all().values_list("id", flat=True)
-        leaders_ids = group.leaders.all().values_list("id", flat=True)
-        skills_prefetch = Prefetch(
-            "skills", queryset=Skill.objects.select_related("tag")
-        )
-        queryset = (
-            group.get_all_members()
-            .distinct()
-            .annotate(
-                is_leader=Case(
-                    When(id__in=leaders_ids, then=True), default=Value(False)
-                )
-            )
-            .annotate(
-                is_manager=Case(
-                    When(id__in=managers_ids, then=True), default=Value(False)
-                )
-            )
-            .order_by("-is_leader", "-is_manager")
-            .prefetch_related(skills_prefetch, "groups")
-        )
+
+        cls = group.get_related_module()
+        module = cls(group, request.user)
+        queryset = module.members()
 
         page = self.paginate_queryset(queryset)
         if page is not None:
@@ -790,26 +772,10 @@ def remove_featured_project(self, request, *args, **kwargs):
     )
     def project(self, request, *args, **kwargs):
         group = self.get_object()
-        group_projects_ids = (
-            Project.objects.filter(groups__people_groups=group)
-            .distinct()
-            .values_list("id", flat=True)
-        )
-        queryset = (
-            self.request.user.get_project_queryset()
-            .filter(Q(groups__people_groups=group) | Q(people_groups=group))
-            .annotate(
-                is_group_project=Case(
-                    When(id__in=group_projects_ids, then=True), default=Value(False)
-                ),
-                is_featured=Case(
-                    When(people_groups=group, then=True), default=Value(False)
-                ),
-            )
-            .distinct()
-            .order_by("-is_featured", "-is_group_project")
-            .prefetch_related("categories")
-        )
+        cls = group.get_related_module()
+        module = cls(group, request.user)
+        queryset = module.featured_projects()
+
         page = self.paginate_queryset(queryset)
         if page is not None:
             project_serializer = ProjectLightSerializer(

apps/commons/mixins.py

@@ -408,3 +408,12 @@ def get_slug(self) -> str:
             if self.get_id_field_name(slug) != "slug":
                 slug = f"{self.slug_prefix}-{slug}"
         return slug
+
+
+class HasModulesRelated:
+    """Mixins for related modules class"""
+
+    def get_related_module(self):
+        from apps.modules.base import get_module
+
+        return get_module(type(self))

apps/modules/__init__.py

@@ -0,0 +1,3 @@
+from .group import PeopleGroupModules
+
+__all__ = ["PeopleGroupModules"]

apps/modules/base.py

@@ -0,0 +1,49 @@
+import inspect
+
+from django.db import models
+
+
+class AbstractModules:
+    """abstract class for modules/queryset declarations"""
+
+    def __init__(self, instance, /, user, **kw):
+        self.instance = instance
+        self.user = user
+
+    def count(self):
+        members = inspect.getmembers(
+            self,
+            predicate=inspect.ismethod,
+        )
+
+        modules = {}
+        for name, func in members:
+            # ignore private_method and "count" method (this method :D)
+            if name.startswith("_") or name in ("count",):
+                continue
+
+            # func return queryset
+            modules[name] = func().count()
+
+        return modules
+
+
+_modules: dict[models.Model] = {}
+
+
+def register_module(model: models.Model):
+    """decorator to register modules assoiate on models
+
+    :param model: _description_
+    """
+
+    def _wrap(cls):
+        _modules[model] = cls
+        return cls
+
+    return _wrap
+
+
+def get_module(model: models.Model):
+    """get regisered module"""
+    return _modules[model]

apps/modules/group.py

@@ -0,0 +1,57 @@
+from django.db.models import Case, Prefetch, Q, QuerySet, Value, When
+
+from apps.accounts.models import PeopleGroup, ProjectUser
+from apps.modules.base import AbstractModules, register_module
+from apps.projects.models import Project
+from apps.skills.models import Skill
+
+
+@register_module(PeopleGroup)
+class PeopleGroupModules(AbstractModules):
+    def members(self) -> QuerySet[ProjectUser]:
+        managers_ids = self.instance.managers.all().values_list("id", flat=True)
+        leaders_ids = self.instance.leaders.all().values_list("id", flat=True)
+        skills_prefetch = Prefetch(
+            "skills", queryset=Skill.objects.select_related("tag")
+        )
+        return (
+            self.instance.get_all_members()
+            .distinct()
+            .annotate(
+                is_leader=Case(
+                    When(id__in=leaders_ids, then=True), default=Value(False)
+                )
+            )
+            .annotate(
+                is_manager=Case(
+                    When(id__in=managers_ids, then=True), default=Value(False)
+                )
+            )
+            .order_by("-is_leader", "-is_manager")
+            .prefetch_related(skills_prefetch, "groups")
+        )
+
+    def featured_projects(self) -> QuerySet[Project]:
+        group_projects_ids = (
+            Project.objects.filter(groups__people_groups=self.instance)
+            .distinct()
+            .values_list("id", flat=True)
+        )
+
+        return (
+            self.user.get_project_queryset()
+            .filter(
+                Q(groups__people_groups=self.instance) | Q(people_groups=self.instance)
+            )
+            .annotate(
+                is_group_project=Case(
+                    When(id__in=group_projects_ids, then=True), default=Value(False)
+                ),
+                is_featured=Case(
+                    When(people_groups=self.instance, then=True), default=Value(False)
+                ),
+            )
+            .distinct()
+            .order_by("-is_featured", "-is_group_project")
+            .prefetch_related("categories")
+        )