[25.05.25 / TASK-192] Feature - 0.6v 신규 피쳐를 위한 base model & admin (#29)

* feature: 신규 feature 를 위한 모델링 1차 가안
* delete: 사용하지 않는 view 정리
* feature: trend 와 mail log 모델 마이그레이션 파일 추가
* feature: insight admin 세팅
* feature: 기본 트랜드 관련 admin 구성 완료
* feature: insight model 을 위한 conftest 파일과 모델 전용 테스트
* feature: admin json preview mixin test 추가
* delete: insight admin 에서 UserFilter 그냥 삭제
* feature: insight admin 을 위한 test 추가
* modify: QR 코드 admin 과 test 부분 업데이트, 잘 안쓰는 것들 제거, user 링킹 최적화
* modify: format_html 잘 못 사용하는 부분 리펙토링
* modify: type hinting 강화
* feature: admin 을 base mixin 과 디렉토리로 분리
* feature: JsonPreviewMixin 에 django.template.loader 활용
* modify: mail log 모델에 user 가 null이 될 수 있음에 대응 개발

Author: Nuung

backoffice/settings/base.py

@@ -67,6 +67,7 @@
     "users",
     "posts",
     "noti",  # 공지와 알림 관련 도메인
+    "insight",  # 게시글, 트랜드 인사이트 관련 도메인
 ]
 
 MIDDLEWARE = [
@@ -86,7 +87,7 @@
 TEMPLATES = [
     {
         "BACKEND": "django.template.backends.django.DjangoTemplates",
-        "DIRS": [],
+        "DIRS": [os.path.join(BASE_DIR, "templates")],
         "APP_DIRS": True,
         "OPTIONS": {
             "context_processors": [

common/models.py

@@ -1,5 +1,11 @@
+import json
+from dataclasses import dataclass
+from typing import Type, TypeVar
+
 from django.db import models
 
+from utils.utils import from_dict, to_dict
+
 
 class TimeStampedModel(models.Model):  # type: ignore
     """
@@ -17,3 +23,21 @@ class TimeStampedModel(models.Model):  # type: ignore
 
     class Meta:
         abstract = True
+
+
+T = TypeVar("T")
+
+
+# dataclass 베이스 mixin
+@dataclass
+class SerializableMixin:
+    def to_dict(self) -> dict:
+        return to_dict(self)
+
+    def to_json_dict(self) -> dict:
+        """Django Model의 JSON 필드 저장용"""
+        return json.loads(json.dumps(self.to_dict()))
+
+    @classmethod
+    def from_dict(cls: Type[T], data: dict) -> T:
+        return from_dict(cls, data)

insight/__init__.py

@@ -0,0 +1,3 @@
+from .base_admin import *  # noqa: F403
+from .user_weekly_trend_admin import *  # noqa: F403
+from .weekly_trend_admin import *  # noqa: F403

insight/admin/__init__.py

@@ -0,0 +1,72 @@
+import json
+
+from django.contrib import admin
+from django.template.defaultfilters import truncatechars
+from django.template.loader import render_to_string
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
+
+from insight.models import UserWeeklyTrend, WeeklyTrend
+
+
+class BaseTrendAdminMixin:
+    """공통된 트렌드 관련 필드를 표시하기 위한 Mixin"""
+
+    @admin.display(description="주 기간")
+    def week_range(self, obj: WeeklyTrend | UserWeeklyTrend):
+        """주 기간을 표시"""
+        return format_html(
+            "{} ~ {}",
+            obj.week_start_date.strftime("%Y-%m-%d"),
+            obj.week_end_date.strftime("%Y-%m-%d"),
+        )
+
+    @admin.display(description="인사이트 미리보기")
+    def insight_preview(self, obj: WeeklyTrend | UserWeeklyTrend):
+        """인사이트 미리보기"""
+        return self.get_json_preview(obj, "insight")
+
+    @admin.display(description="처리 완료")
+    def is_processed_colored(self, obj: WeeklyTrend | UserWeeklyTrend):
+        """처리 상태를 색상으로 표시"""
+        if obj.is_processed:
+            return format_html(
+                '<span style="color: green; font-weight: bold;">{}</span>', "✓"
+            )
+        return format_html(
+            '<span style="color: red; font-weight: bold;">{}</span>', "✗"
+        )
+
+    @admin.display(description="처리 완료 시간")
+    def processed_at_formatted(self, obj: WeeklyTrend | UserWeeklyTrend):
+        """처리 완료 시간 포맷팅"""
+        if obj.processed_at:
+            return obj.processed_at.strftime("%Y-%m-%d %H:%M")
+        return "-"
+
+
+class JsonPreviewMixin:
+    """JSONField를 보기 좋게 표시하기 위한 Mixin"""
+
+    def get_json_preview(
+        self, obj: WeeklyTrend | UserWeeklyTrend, field_name, max_length=150
+    ):
+        """JSONField 내용의 미리보기를 반환"""
+        json_data = getattr(obj, field_name, {})
+        if not json_data:
+            return "-"
+
+        # JSON 문자열로 변환하여 일부만 표시
+        json_str = json.dumps(json_data, ensure_ascii=False)
+        return truncatechars(json_str, max_length)
+
+    @admin.display(description="인사이트 데이터")
+    def formatted_insight(self, obj: WeeklyTrend | UserWeeklyTrend):
+        """인사이트 JSON을 보기 좋게 포맷팅하여 표시"""
+        if not hasattr(obj, "insight") or not obj.insight:
+            return "-"
+
+        context = {"insight": obj.insight, "user": getattr(obj, "user", None)}
+        # render_to_string을 사용하여 템플릿 렌더링
+        html = render_to_string("insights/insight_preview.html", context)
+        return mark_safe(html)

insight/admin/base_admin.py

@@ -0,0 +1,83 @@
+from django.contrib import admin
+from django.db.models import QuerySet
+from django.http import HttpRequest
+from django.urls import reverse
+from django.utils.html import format_html
+
+from insight.admin import BaseTrendAdminMixin, JsonPreviewMixin
+from insight.models import UserWeeklyTrend
+from utils.utils import get_local_now
+
+
+@admin.register(UserWeeklyTrend)
+class UserWeeklyTrendAdmin(
+    admin.ModelAdmin, JsonPreviewMixin, BaseTrendAdminMixin
+):
+    list_display = (
+        "id",
+        "user_info",
+        "week_range",
+        "insight_preview",
+        "is_processed_colored",
+        "processed_at_formatted",
+        "created_at",
+    )
+    list_filter = ("is_processed", "week_start_date")
+    search_fields = ("user__email", "insight")
+    readonly_fields = (
+        "processed_at",
+        "formatted_insight",
+    )
+    raw_id_fields = ("user",)
+
+    fieldsets = (
+        (
+            "사용자 정보",
+            {
+                "fields": ("user", "week_start_date", "week_end_date"),
+            },
+        ),
+        (
+            "인사이트 데이터",
+            {
+                "fields": ("formatted_insight",),
+                "classes": ("wide", "extrapretty"),
+            },
+        ),
+        (
+            "처리 상태",
+            {
+                "fields": ("is_processed", "processed_at"),
+            },
+        ),
+    )
+
+    actions = ["mark_as_processed"]
+
+    def get_queryset(self, request: HttpRequest):
+        queryset = super().get_queryset(request)
+        return queryset.select_related("user")
+
+    @admin.display(description="사용자")
+    def user_info(self, obj: UserWeeklyTrend):
+        """사용자 정보를 표시"""
+        if not obj.user:
+            return "-"
+
+        user_url = reverse("admin:users_user_change", args=[obj.user.id])
+        return format_html(
+            '<a href="{}" target="_blank">{}</a>',
+            user_url,
+            obj.user.email or f"사용자 {obj.user.id}",
+        )
+
+    @admin.action(description="선택된 항목을 처리 완료로 표시하기")
+    def mark_as_processed(
+        self, request: HttpRequest, queryset: QuerySet[UserWeeklyTrend]
+    ):
+        """선택된 항목을 처리 완료로 표시"""
+        queryset.update(is_processed=True, processed_at=get_local_now())
+        self.message_user(
+            request,
+            f"{queryset.count()}개의 사용자 인사이트가 처리 완료로 표시되었습니다.",
+        )

insight/admin/user_weekly_trend_admin.py

@@ -0,0 +1,58 @@
+from django.contrib import admin
+from django.db.models import QuerySet
+from django.http import HttpRequest
+
+from insight.admin import BaseTrendAdminMixin, JsonPreviewMixin
+from insight.models import WeeklyTrend
+from utils.utils import get_local_now
+
+
+@admin.register(WeeklyTrend)
+class WeeklyTrendAdmin(
+    admin.ModelAdmin, JsonPreviewMixin, BaseTrendAdminMixin
+):
+    list_display = (
+        "id",
+        "week_range",
+        "insight_preview",
+        "is_processed_colored",
+        "processed_at_formatted",
+        "created_at",
+    )
+    list_filter = ("is_processed", "week_start_date")
+    search_fields = ("insight",)
+    readonly_fields = ("processed_at", "formatted_insight")
+    fieldsets = (
+        (
+            "기간 정보",
+            {
+                "fields": ("week_start_date", "week_end_date"),
+            },
+        ),
+        (
+            "인사이트 데이터",
+            {
+                "fields": ("formatted_insight",),
+                "classes": ("wide", "extrapretty"),
+            },
+        ),
+        (
+            "처리 상태",
+            {
+                "fields": ("is_processed", "processed_at"),
+            },
+        ),
+    )
+
+    actions = ["mark_as_processed"]
+
+    @admin.action(description="선택된 항목을 처리 완료로 표시하기")
+    def mark_as_processed(
+        self, request: HttpRequest, queryset: QuerySet[WeeklyTrend]
+    ):
+        """선택된 항목을 처리 완료로 표시"""
+        queryset.update(is_processed=True, processed_at=get_local_now())
+        self.message_user(
+            request,
+            f"{queryset.count()}개의 트렌드가 처리 완료로 표시되었습니다.",
+        )

insight/admin/weekly_trend_admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class InsightConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "insight"