feat: work on profile page (#251)

Author: moonlitgrace

backend/apps/api/serializers/comment/__init__.py

@@ -2,10 +2,74 @@
 from rest_framework import serializers
 
 from apps.comment.models import Comment
+from apps.post.models import Post
 
 from ...serializers.user.profile import ProfileBasicSerializer
 
 
+class CommentSerializer(serializers.ModelSerializer):
+    commenter = ProfileBasicSerializer(allow_null=True)
+    ratio = serializers.IntegerField()
+
+    class Meta:
+        model = Comment
+        fields = '__all__'
+
+
+class CommentOverviewSerializer(CommentSerializer):
+    commenter = serializers.SerializerMethodField()
+    post = serializers.SerializerMethodField()
+    reply_to = serializers.SerializerMethodField()
+    is_op = serializers.SerializerMethodField()
+
+    class Meta(CommentSerializer.Meta):
+        fields = (
+            'id',
+            'commenter',
+            'reply_to',
+            'is_op',
+            'ratio',
+            'post',
+            'created_at',
+            'content',
+            'upvotes',
+            'downvotes',
+        )
+
+    def get_commenter(self, obj):
+        return obj.commenter.username
+
+    def get_post(self, obj):
+        request = self.context.get('request')
+
+        if post := Post.objects.filter(comments=obj).first():
+            return {
+                "id": post.pk,
+                "title": post.title,
+                "slug": post.slug,
+                "community": {
+                    "name": post.community.name,
+                    "avatar": (
+                        request.build_absolute_uri(post.community.avatar.url)
+                        if post.community.avatar
+                        else None
+                    ),
+                },
+            }
+        return None
+
+    def get_reply_to(self, obj):
+        if parent := obj.parent():
+            return parent.commenter.username
+        return None
+
+    def get_is_op(self, obj):
+        post = Post.objects.filter(comments=obj).first()
+        if post and post.poster == obj.commenter:
+            return True
+        return False
+
+
 class CommentCreateSerializer(serializers.ModelSerializer):
     path = serializers.CharField(required=False)
 
@@ -29,12 +93,3 @@ def create(self, validated_data):
 
         comment_instance.upvotes.add(data['commenter'])
         return comment_instance
-
-
-class CommentDetailSerializer(serializers.ModelSerializer):
-    commenter = ProfileBasicSerializer(allow_null=True)
-    ratio = serializers.IntegerField()
-
-    class Meta:
-        model = Comment
-        fields = '__all__'

backend/apps/api/serializers/user/profile/downvoted.py

@@ -2,20 +2,20 @@
 
 from rest_framework import serializers
 
-from apps.api.serializers.comment import CommentDetailSerializer
+from apps.api.serializers.comment import CommentSerializer
 from apps.api.serializers.post import PostSerializer
 
 
 class DownvotedSerializer(serializers.Serializer):
     content_type = serializers.CharField()
-    data = serializers.SerializerMethodField()
+    content = serializers.SerializerMethodField()
 
-    def get_data(self, obj) -> dict:
+    def get_content(self, obj) -> dict:
         obj_type = obj.content_type
         obj_copy = copy.copy(obj)
 
         delattr(obj_copy, "content_type")
 
         if obj_type == "post":
             return PostSerializer(obj_copy, context=self.context).data
-        return CommentDetailSerializer(obj_copy, context=self.context).data
+        return CommentSerializer(obj_copy, context=self.context).data

backend/apps/api/serializers/user/profile/overview.py

@@ -2,20 +2,20 @@
 
 from rest_framework import serializers
 
-from apps.api.serializers.comment import CommentDetailSerializer
+from apps.api.serializers.comment import CommentOverviewSerializer
 from apps.api.serializers.post import PostSerializer
 
 
 class OverviewSerializer(serializers.Serializer):
     content_type = serializers.CharField()
-    data = serializers.SerializerMethodField()
+    content = serializers.SerializerMethodField()
 
-    def get_data(self, obj) -> dict:
+    def get_content(self, obj) -> dict:
         obj_type = obj.content_type
         obj_copy = copy.copy(obj)
 
         delattr(obj_copy, "content_type")
 
         if obj_type == "post":
             return PostSerializer(obj_copy, context=self.context).data
-        return CommentDetailSerializer(obj_copy, context=self.context).data
+        return CommentOverviewSerializer(obj_copy, context=self.context).data

backend/apps/api/serializers/user/profile/upvoted.py

@@ -2,20 +2,20 @@
 
 from rest_framework import serializers
 
-from apps.api.serializers.comment import CommentDetailSerializer
+from apps.api.serializers.comment import CommentSerializer
 from apps.api.serializers.post import PostSerializer
 
 
 class UpvotedSerializer(serializers.Serializer):
     content_type = serializers.CharField()
-    data = serializers.SerializerMethodField()
+    content = serializers.SerializerMethodField()
 
-    def get_data(self, obj) -> dict:
+    def get_content(self, obj) -> dict:
         obj_type = obj.content_type
         obj_copy = copy.copy(obj)
 
         delattr(obj_copy, "content_type")
 
         if obj_type == "post":
             return PostSerializer(obj_copy, context=self.context).data
-        return CommentDetailSerializer(obj_copy, context=self.context).data
+        return CommentSerializer(obj_copy, context=self.context).data

backend/apps/api/viewsets/comment/__init__.py

@@ -3,12 +3,12 @@
 from mixins.api.reaction import ReactionMixin
 
 from ...bases.viewsets import UpdateRetrieveDestroyViewSet
-from ...serializers.comment import CommentDetailSerializer
+from ...serializers.comment import CommentSerializer
 
 
 class CommentViewSet(ReactionMixin, UpdateRetrieveDestroyViewSet):
     queryset = Comment.objects.all()
-    serializer_class = CommentDetailSerializer
+    serializer_class = CommentSerializer
 
     serializer_mapping = {
         'reaction': ReactionSerializer,

backend/apps/api/viewsets/community/__init__.py

@@ -44,7 +44,7 @@ def get_object(self) -> Community:  # pyright: ignore
 
         if not obj:
             raise exceptions.NotFound(
-                f'Community with name <b>{self.kwargs[self.lookup_field]}</b> not found.'
+                f'Community with name <b>q/{self.kwargs[self.lookup_field]}</b> not found.'
             )
         return obj
 

backend/apps/api/viewsets/post/__init__.py

@@ -10,7 +10,7 @@
 from apps.post.models import Post
 from mixins.api.reaction import ReactionMixin
 
-from ...serializers.comment import CommentCreateSerializer, CommentDetailSerializer
+from ...serializers.comment import CommentCreateSerializer, CommentSerializer
 from ...serializers.post import PostCreateSerializer, PostSerializer
 
 
@@ -68,7 +68,7 @@ def create(self, request):
         response_serializer = PostSerializer(post_instance, context=context)
         return response.Response(response_serializer.data, status=status.HTTP_201_CREATED)
 
-    @extend_schema(responses=CommentDetailSerializer(many=True))
+    @extend_schema(responses=CommentSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET, HTTPMethod.POST])
     def comments(self, request, pk=None):
         post_instance = get_object_or_404(Post, pk=pk)
@@ -77,7 +77,7 @@ def comments(self, request, pk=None):
 
         if request.method == HTTPMethod.GET:
             comments = post_instance.comments.all()  # pyright: ignore
-            serializer = CommentDetailSerializer(comments, many=True, context=context)
+            serializer = CommentSerializer(comments, many=True, context=context)
 
             return response.Response(serializer.data, status=status.HTTP_200_OK)
 
@@ -89,5 +89,5 @@ def comments(self, request, pk=None):
         # hard-code ratio
         comment_instance.ratio = 1
 
-        response_serializer = CommentDetailSerializer(comment_instance, context=context)
+        response_serializer = CommentSerializer(comment_instance, context=context)
         return response.Response(response_serializer.data, status=status.HTTP_201_CREATED)

backend/apps/api/viewsets/user/__init__.py

@@ -8,7 +8,7 @@
 from rest_framework.decorators import action
 from rest_framework.response import Response
 
-from apps.api.serializers.comment import CommentDetailSerializer
+from apps.api.serializers.comment import CommentOverviewSerializer, CommentSerializer
 from apps.api.serializers.post import PostSerializer
 from apps.api.serializers.user.profile import (
     ProfileSerializer,
@@ -33,11 +33,12 @@ class ProfileViewSet(viewsets.ReadOnlyModelViewSet):
     serializer_class = ProfileSerializer
     filter_backends = (filters.SearchFilter,)
     search_fields = ("username",)
+    lookup_field = 'username'
 
     serializer_classes = {
         "overview": OverviewSerializer,
         "posts": PostSerializer,
-        "comments": CommentDetailSerializer,
+        "comments": CommentOverviewSerializer,
         "upvoted": UpvotedSerializer,
         "downvoted": DownvotedSerializer,
     }
@@ -63,7 +64,7 @@ def get_object(self) -> Profile:
 
     @extend_schema(responses=OverviewSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET])
-    def overview(self, request, pk=None):
+    def overview(self, request, username=None):
         """Returns a mixed list of posts and comments by the user, ordered by date."""
         profile = self.get_object()
         posts = profile.posts.all().annotate(content_type=Value("post", CharField()))
@@ -77,16 +78,16 @@ def overview(self, request, pk=None):
 
     @extend_schema(responses=PostSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET])
-    def posts(self, request, pk=None):
+    def posts(self, request, username=None):
         """Returns a list of posts by the user, ordered by date."""
         profile = self.get_object()
         posts = profile.posts.all().order_by("-created_at")
         serialized_data = self.get_serializer(posts, context={"request": request}, many=True).data
         return Response(serialized_data)
 
-    @extend_schema(responses=CommentDetailSerializer(many=True))
+    @extend_schema(responses=CommentOverviewSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET])
-    def comments(self, request, pk=None):
+    def comments(self, request, username=None):
         """Returns a list of comments by the user, ordered by date."""
         profile = self.get_object()
         comments = profile.comments.all().order_by("-created_at")
@@ -97,7 +98,7 @@ def comments(self, request, pk=None):
 
     @extend_schema(responses=UpvotedSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET])
-    def upvoted(self, request, pk=None):
+    def upvoted(self, request, username=None):
         """Returns a mixed list of upvoted posts and comments by the user, ordered by date."""
         profile = self.get_object()
         posts = profile.upvoted_posts.all().annotate(content_type=Value("post", CharField()))
@@ -113,7 +114,7 @@ def upvoted(self, request, pk=None):
 
     @extend_schema(responses=DownvotedSerializer(many=True))
     @action(detail=True, methods=[HTTPMethod.GET])
-    def downvoted(self, request, pk=None):
+    def downvoted(self, request, username=None):
         """Returns a mixed list of downvoted posts and comments by the user, ordered by date."""
         profile = self.get_object()
         posts = profile.downvoted_posts.all().annotate(content_type=Value("post", CharField()))

backend/apps/user/admin.py

@@ -45,7 +45,7 @@ class ProfileAdmin(admin.ModelAdmin):
     fieldsets = (
         (
             None,
-            {'fields': ('user', 'username', 'name', 'avatar', 'banner')},
+            {'fields': ('user', 'username', 'avatar', 'banner', 'name', 'bio')},
         ),
         (_('important dates'), {'fields': ('created_at',)}),
     )