add export as CSV

Author: FuzzyGrim

src/app/templates/app/profile.html

@@ -36,7 +36,7 @@
       </fieldset>
     </form>
 
-    <div>
+    <div class="mb-4">
       <legend class="border-bottom mb-4">Import</legend>
 
       <fieldset class="input-group grid-container">
@@ -66,6 +66,17 @@
       </fieldset>
     </div>
 
+    <div>
+      <legend class="border-bottom mb-4">Export</legend>
+
+      <fieldset class="input-group grid-container">
+        <form class="p-2 grid-item" method="POST" action="{% url 'export' %}">
+          {% csrf_token %}
+          <button name="tmdb" class="btn no-fill-btn bg-dark w-100" type="submit">Export as CSV</button>
+        </form>
+      </fieldset>
+    </div>
+
   </div>
 
 {% endblock %}

src/app/tests/test_exports.py

@@ -0,0 +1,107 @@
+from django.test import TestCase
+from django.urls import reverse
+from app.models import User, TV, Movie, Season, Episode, Anime, Manga
+from datetime import date
+import csv
+from io import StringIO
+
+
+class ExportCSVTest(TestCase):
+    def setUp(self):
+        self.credentials = {"username": "test", "password": "12345"}
+        self.user = User.objects.create_superuser(**self.credentials)
+        self.client.login(**self.credentials)
+
+        # Create test data for each model
+        TV.objects.create(
+            media_id=1668,
+            title="Friends",
+            score=9,
+            user=self.user,
+            notes="Nice",
+        )
+
+        Movie.objects.create(
+            media_id=10494,
+            title="Perfect Blue",
+            score=9,
+            status="Completed",
+            user=self.user,
+            notes="Nice",
+            end_date=date(2023, 6, 1),
+        )
+
+        season = Season.objects.create(
+            media_id=1668,
+            title="Friends",
+            score=9,
+            status="Completed",
+            season_number=1,
+            user=self.user,
+            notes="Nice",
+        )
+
+        Episode.objects.create(
+            related_season=season, episode_number=1, watch_date=date(2023, 6, 1)
+        )
+
+        Anime.objects.create(
+            media_id=1,
+            title="Cowboy Bebop",
+            status="Watching",
+            user=self.user,
+            progress=2,
+            start_date=date(2021, 6, 1),
+        )
+
+        Manga.objects.create(
+            media_id=1,
+            title="Berserk",
+            status="Watching",
+            user=self.user,
+            progress=2,
+            start_date=date(2021, 6, 1),
+        )
+
+    def test_export_csv(self):
+
+        # Generate the CSV file by accessing the export view
+        response = self.client.get(reverse("export"))
+
+        # Assert that the response is successful (status code 200)
+        self.assertEqual(response.status_code, 200)
+
+        # Assert that the response content type is text/csv
+        self.assertEqual(response["Content-Type"], "text/csv")
+
+        # Read the CSV content from the response
+        csv_content = response.content.decode("utf-8")
+
+        # Create a CSV reader from the CSV content
+        reader = csv.DictReader(StringIO(csv_content))
+
+        # Get all media IDs from the database
+        db_media_ids = set(
+            TV.objects.values_list("media_id", flat=True).filter(user=self.user)
+        )
+        db_media_ids.update(
+            Movie.objects.values_list("media_id", flat=True).filter(user=self.user)
+        )
+        db_media_ids.update(
+            Season.objects.values_list("media_id", flat=True).filter(user=self.user)
+        )
+        db_media_ids.update(
+            Episode.objects.values_list("related_season__media_id", flat=True).filter(
+                related_season__user=self.user
+            )
+        )
+        db_media_ids.update(
+            Anime.objects.values_list("media_id", flat=True).filter(user=self.user)
+        )
+        db_media_ids.update(
+            Manga.objects.values_list("media_id", flat=True).filter(user=self.user)
+        )
+
+        for row in reader:
+            media_id = int(row["media_id"])
+            self.assertIn(media_id, db_media_ids)

src/app/urls.py

@@ -24,6 +24,7 @@
         name="season_details",
     ),
     path("profile", views.profile, name="profile"),
+    path("export", views.export, name="export"),
     path("login", views.CustomLoginView.as_view(), name="login"),
     path("logout", auth_views.LogoutView.as_view(), name="logout"),
     path("modal_data", views.modal_data, name="modal_data"),

src/app/utils/exports.py

@@ -0,0 +1,55 @@
+from app.models import TV, Season, Episode, Movie, Anime, Manga
+import csv
+import logging
+
+
+logger = logging.getLogger(__name__)
+
+
+def export_csv(response, user):
+    """Export a CSV file of the user's media."""
+
+    fields = [
+        "media_id",
+        "media_type",
+        "title",
+        "image",
+        "score",
+        "progress",
+        "status",
+        "start_date",
+        "end_date",
+        "notes",
+        "season_number",
+        "episode_number",
+        "watch_date",
+    ]
+
+    writer = csv.writer(response, quoting=csv.QUOTE_ALL)
+    writer.writerow(fields)
+
+    export_model_data(writer, fields, TV.objects.filter(user=user), "tv")
+    export_model_data(writer, fields, Movie.objects.filter(user=user), "movie")
+    export_model_data(writer, fields, Season.objects.filter(user=user), "season")
+    export_model_data(writer, fields, Episode.objects.filter(related_season__user=user), "episode")
+    export_model_data(writer, fields, Anime.objects.filter(user=user), "anime")
+    export_model_data(writer, fields, Manga.objects.filter(user=user), "manga")
+
+    return response
+
+
+def export_model_data(writer, fields, queryset, media_type):
+    logger.info(f"Adding {media_type} data to CSV file")
+
+    for item in queryset:
+        # write fields if they exist, otherwise write empty string
+        row = [getattr(item, field, "") for field in fields]
+
+        # replace media_type field with the correct value
+        row[fields.index("media_type")] = media_type
+
+        if media_type == "episode":
+            row[fields.index("media_id")] = item.related_season.media_id
+            row[fields.index("title")] = item.related_season.title
+
+        writer.writerow(row)

src/app/views.py

@@ -3,11 +3,11 @@
 from django.contrib.auth import update_session_auth_hash
 from django.contrib.auth.views import LoginView
 from django.contrib.auth.decorators import login_required
-from django.http import JsonResponse
+from django.http import JsonResponse, HttpResponse
 from django.middleware import csrf
 from crispy_forms.utils import render_crispy_form
 
-from app.utils import helpers, search, metadata, form_handlers
+from app.utils import helpers, search, metadata, form_handlers, exports
 from app.utils.imports import anilist, mal, tmdb
 from app.models import TV, Season, Episode, Anime, Manga
 from app.forms import (
@@ -66,17 +66,18 @@ def media_list(request, media_type):
     media_mapping = helpers.media_type_mapper(media_type)
     filter_form = FilterForm(
         # fill form with current values if they exist
-        request.GET or None, sort_choices=media_mapping["sort_choices"]
+        request.GET or None,
+        sort_choices=media_mapping["sort_choices"],
     )
 
     # if form valid or no form submitted
     if filter_form.is_valid() or not request.GET:
-
         if media_type == "tv":
-
             if "status" in filter_params:
                 # as tv doesn't have a status field, only filter seasons
-                media_list = Season.objects.filter(**filter_params).order_by(sort_filter)
+                media_list = Season.objects.filter(**filter_params).order_by(
+                    sort_filter
+                )
 
             else:
                 # show both tv and seasons in the list
@@ -89,8 +90,10 @@ def media_list(request, media_type):
                     key=lambda item: getattr(item, sort_filter, float("-inf")),
                 )
         else:
-            media_list = media_mapping["model"].objects.filter(**filter_params).order_by(
-                sort_filter
+            media_list = (
+                media_mapping["model"]
+                .objects.filter(**filter_params)
+                .order_by(sort_filter)
             )
 
         return render(
@@ -297,8 +300,7 @@ def profile(request):
                 )
             else:
                 title = "Couldn't find a matching MAL ID for: \n"
-                messages.error(request, title + error)
-
+                messages.warning(request, title + error)
         else:
             messages.error(request, "There was an error with your request")
 
@@ -314,9 +316,24 @@ def profile(request):
         "user_form": user_form,
         "password_form": password_form,
     }
+
     return render(request, "app/profile.html", context)
 
 
+def export(request):
+    # Create the HttpResponse object with the appropriate CSV header.
+    response = HttpResponse(
+        content_type="text/csv",
+        headers={"Content-Disposition": 'attachment; filename="yamtrack.csv"'},
+    )
+
+    response = exports.export_csv(response, request.user)
+
+    logger.info(f"User {request.user.username} exported their data")
+
+    return response
+
+
 def modal_data(request):
     media_type = request.GET.get("media_type")
     media_id = request.GET.get("media_id")