feat: Afficher l'image du forum comme bannière

config/settings/dev.py

@@ -61,3 +61,4 @@
 MEDIA_URL = f"{AWS_S3_ENDPOINT_URL}/"  # noqa: F405
 
 CSP_DEFAULT_SRC = ("*",)
+CSP_IMG_SRC += ("localhost:9000",)  # noqa: F405

lacommunaute/forum/factories.py

@@ -17,6 +17,9 @@ class ForumFactory(BaseForumFactory):
     class Meta:
         skip_postgeneration_save = True
 
+    class Params:
+        with_image = factory.Trait(image=factory.django.ImageField(filename="banner.jpg"))
+
     @factory.post_generation
     def with_public_perms(self, create, extracted, **kwargs):
         if not create or not extracted:
@@ -41,4 +44,4 @@ def with_child(self, create, extracted, **kwargs):
         if not create or not extracted:
             return
 
-        ForumFactory(parent=self, with_public_perms=True)
+        ForumFactory(parent=self, with_public_perms=True, with_image=True)

lacommunaute/forum/migrations/0013_alter_forum_image.py

@@ -0,0 +1,27 @@
+# Generated by Django 5.0.6 on 2024-05-21 14:55
+
+import storages.backends.s3
+from django.conf import settings
+from django.db import migrations, models
+
+import lacommunaute.forum.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("forum", "0012_forum_short_description_alter_forum_kind"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="forum",
+            name="image",
+            field=models.ImageField(
+                storage=storages.backends.s3.S3Storage(
+                    bucket_name=settings.AWS_STORAGE_BUCKET_NAME, file_overwrite=False
+                ),
+                upload_to="",
+                validators=[lacommunaute.forum.models.validate_image_size],
+            ),
+        ),
+    ]

lacommunaute/forum/models.py

@@ -1,15 +1,18 @@
 import uuid
 
+from django.conf import settings
 from django.contrib.auth.models import Group
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 from django.urls import reverse
 from django.utils.functional import cached_property
 from machina.apps.forum.abstract_models import AbstractForum
+from storages.backends.s3boto3 import S3Boto3Storage
 
 from lacommunaute.forum.enums import Kind as Forum_Kind
 from lacommunaute.forum_conversation.models import Topic
 from lacommunaute.forum_upvote.models import UpVote
+from lacommunaute.utils.validators import validate_image_size
 
 
 class ForumQuerySet(models.QuerySet):
@@ -28,6 +31,10 @@ class Forum(AbstractForum):
     short_description = models.CharField(
         max_length=400, blank=True, null=True, verbose_name="Description courte (SEO)"
     )
+    image = models.ImageField(
+        storage=S3Boto3Storage(bucket_name=settings.AWS_STORAGE_BUCKET_NAME, file_overwrite=False),
+        validators=[validate_image_size],
+    )
 
     upvotes = GenericRelation(UpVote, related_query_name="forum")
 

lacommunaute/forum/tests/test_categoryforum_listview.py

@@ -3,7 +3,7 @@
 from pytest_django.asserts import assertContains, assertNotContains
 
 from lacommunaute.forum.enums import Kind as ForumKind
-from lacommunaute.forum.factories import ForumFactory
+from lacommunaute.forum.factories import CategoryForumFactory, ForumFactory
 from lacommunaute.forum.models import Forum
 from lacommunaute.users.factories import UserFactory
 
@@ -45,3 +45,12 @@ def test_display_create_category_button(client, db):
     user.save()
     response = client.get(url)
     assertContains(response, reverse("forum_extension:create_category"), status_code=200)
+
+
+def test_display_banners(client, db):
+    forum = CategoryForumFactory(with_child=True, with_public_perms=True)
+    ForumFactory(parent=forum, with_public_perms=True, with_image=True)
+    url = reverse("forum_extension:forum", kwargs={"pk": forum.pk, "slug": forum.slug})
+    response = client.get(url)
+    for child in forum.get_children():
+        assertContains(response, child.image.url.split("=")[0])

lacommunaute/forum/tests/tests_model.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.db import IntegrityError
 from django.test import TestCase
 
@@ -57,3 +58,14 @@ def test_upvotes_count(self):
         self.assertEqual(forum.upvotes_count(), 0)
         forum.upvotes.create(voter=UserFactory())
         self.assertEqual(forum.upvotes_count(), 1)
+
+    def test_image_is_imagefield(self):
+        forum = ForumFactory()
+        self.assertEqual(forum.image.field.__class__.__name__, "ImageField")
+
+    def test_image_url(self):
+        forum = ForumFactory(image="test.jpg")
+        self.assertEqual(
+            forum.image.url.split("?")[0], f"{settings.MEDIA_URL}{settings.AWS_STORAGE_BUCKET_NAME}/{forum.image.name}"
+        )
+        self.assertIn("AWSAccessKeyId=", forum.image.url)

lacommunaute/forum/tests/tests_views.py

@@ -421,3 +421,9 @@ def test_filtered_queryset_on_tag(self):
         )
         self.assertContains(response, topic.subject)
         self.assertNotContains(response, self.topic.subject)
+
+    def test_banner_display_on_subcategory_forum(self):
+        category_forum = CategoryForumFactory(with_child=True, with_public_perms=True)
+        forum = category_forum.get_children().first()
+        response = self.client.get(reverse("forum_extension:forum", kwargs={"pk": forum.pk, "slug": forum.slug}))
+        self.assertContains(response, forum.image.url.split("=")[0])

lacommunaute/forum_file/models.py

@@ -1,17 +1,10 @@
 from django.conf import settings
-from django.core.exceptions import ValidationError
 from django.db import models
 from machina.models.abstract_models import DatedModel
 from storages.backends.s3boto3 import S3Boto3Storage
 
 from lacommunaute.users.models import User
-
-
-def validate_image_size(value):
-    max_size = 1024 * 1024 * 8
-
-    if value.size > max_size:
-        raise ValidationError("L'image ne doit pas dépasser 1 Mo")
+from lacommunaute.utils.validators import validate_image_size
 
 
 class PublicFile(DatedModel):

lacommunaute/forum_file/tests/test_models.py

@@ -32,11 +32,5 @@ def test_get_file_url(db, public_file):
     assert public_file.get_file_url() == expected_file_url
 
 
-def test_size_validator(db, public_file):
-    with pytest.raises(Exception):
-        public_file.file.size = 1024 * 1024 * 8 + 1
-        public_file.save()
-
-
 def test_file_field_is_imagefield(db):
     assert isinstance(PublicFile._meta.get_field("file"), ImageField)

lacommunaute/templates/forum/forum_detail.html

@@ -41,7 +41,8 @@ <h1>{{ forum.name }}</h1>
                                 {% include "partials/upvotes.html" with obj=forum kind="forum" %}
                                 {% include "partials/social_share_buttons.html" with text=forum.name instance=forum id=forum.pk %}
                             </div>
-                            <div class="col-12 col-sm-auto">
+                            <div class="col-12 col-sm-auto">{% include "forum/partials/forum_banner.html" with forum=forum only %}</div>
+                            <div class="col-12 col-sm-auto mt-3">
                                 <div class="textarea_cms_md">{{ forum.description.rendered|urlizetrunc_target_blank:30 }}</div>
                             </div>
                         </div>

lacommunaute/templates/forum/forum_list.html

@@ -57,7 +57,8 @@ <h3 class="h3 mb-0">
                             <p class="h3 lh-base">
                                 <i class="ri-newspaper-line font-weight-normal"></i> {{ node.obj.name }}
                             </p>
-                            {% if node.obj.short_description %}<div>{{ node.obj.short_description }}</div>{% endif %}
+                            <div>{% include "forum/partials/forum_banner.html" with forum=node.obj only %}</div>
+                            {% if node.obj.short_description %}<div class="mt-3">{{ node.obj.short_description }}</div>{% endif %}
                         </div>
                         <div class="card-footer text-end">
                             <a href="{% url 'forum_extension:forum' node.obj.slug node.obj.id %}"

lacommunaute/templates/forum/partials/forum_banner.html

@@ -0,0 +1,5 @@
+{% if forum.image %}
+    <div class="d-none d-md-block forum-image mt-3">
+        <img src="{{ forum.image.url }}" alt="{{ forum.name }}" class="rounded img-fluid" />
+    </div>
+{% endif %}

lacommunaute/utils/tests.py

@@ -1,6 +1,7 @@
 from datetime import datetime, timedelta
 from unittest.mock import patch
 
+import pytest
 from bs4 import BeautifulSoup
 from django.core.files.storage import default_storage
 from django.core.files.uploadedfile import SimpleUploadedFile
@@ -19,6 +20,8 @@
 from lacommunaute.forum.factories import ForumFactory
 from lacommunaute.forum_conversation.factories import TopicFactory
 from lacommunaute.forum_conversation.forum_attachments.factories import AttachmentFactory
+from lacommunaute.forum_file.models import PublicFile
+from lacommunaute.users.factories import UserFactory
 from lacommunaute.utils.math import percent
 from lacommunaute.utils.matomo import get_matomo_data, get_matomo_events_data, get_matomo_visits_data
 from lacommunaute.utils.perms import add_public_perms_on_forum
@@ -502,3 +505,15 @@ def test_public_perms(self, db):
             ).count()
             == 7
         )
+
+
+class TestImageSizeValidator:
+    def test_size_validator(self, db):
+        file = PublicFile.objects.create(
+            file="test.jpg",
+            user=UserFactory(),
+            keywords="test",
+        )
+        with pytest.raises(Exception):
+            file.file.size = 1024 * 1024 * 5 + 1
+            file.save()

lacommunaute/utils/validators.py

@@ -0,0 +1,8 @@
+from django.core.exceptions import ValidationError
+
+
+def validate_image_size(value):
+    max_size = 1024 * 1024 * 5
+
+    if value.size > max_size:
+        raise ValidationError("L'image ne doit pas dépasser 5 Mo")