refactor: make slug non optional

NIAEFEUP · Nov 7, 2024 · aeef473 · aeef473
1 parent 2322b14
commit aeef473
Show file tree

Hide file tree

Showing 21 changed files with 98 additions and 40 deletions.
diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/ActivityDto.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/ActivityDto.kt
@@ -8,7 +8,7 @@ abstract class ActivityDto<T : Activity>(
     val title: String,
     val description: String,
     val teamMembersIds: List<Long>?,
-    val slug: String?,
+    val slug: String,
     var image: String?,
     @JsonIgnore
     var imageFile: MultipartFile? = null

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/EventDto.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/EventDto.kt
@@ -7,7 +7,7 @@ class EventDto(
     title: String,
     description: String,
     teamMembersIds: List<Long>?,
-    slug: String?,
+    slug: String,
     image: String?,
 
     val registerUrl: String?,

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/PostDto.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/PostDto.kt
@@ -6,5 +6,5 @@ class PostDto(
     val title: String,
     val body: String,
     val thumbnailPath: String,
-    val slug: String?
+    val slug: String
 ) : EntityDto<Post>()
diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/ProjectDto.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/dto/entity/ProjectDto.kt
@@ -6,7 +6,7 @@ class ProjectDto(
     title: String,
     description: String,
     teamMembersIds: List<Long>?,
-    slug: String?,
+    slug: String,
     image: String?,
 
     val isArchived: Boolean = false,

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/model/Activity.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/model/Activity.kt
@@ -39,7 +39,7 @@ abstract class Activity(
 
     @Column(unique = true)
     @field:Size(min = Constants.Slug.minSize, max = Constants.Slug.maxSize)
-    open val slug: String? = null,
+    open val slug: String,
 
     @field:NotBlank
     open var image: String,

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/model/Event.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/model/Event.kt
@@ -15,7 +15,7 @@ class Event(
     description: String,
     teamMembers: MutableList<Account> = mutableListOf(),
     associatedRoles: MutableList<PerActivityRole> = mutableListOf(),
-    slug: String? = null,
+    slug: String,
     image: String,
     gallery: MutableList<String> = mutableListOf(),
 

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/model/Post.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/model/Post.kt
@@ -44,5 +44,5 @@ class Post(
 
     @Column(unique = true)
     @field:Size(min = Constants.Slug.minSize, max = Constants.Slug.maxSize)
-    val slug: String? = null
+    val slug: String
 )
diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/model/Project.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/model/Project.kt
@@ -18,7 +18,7 @@ class Project(
     description: String,
     teamMembers: MutableList<Account> = mutableListOf(),
     associatedRoles: MutableList<PerActivityRole> = mutableListOf(),
-    slug: String? = null,
+    slug: String,
     image: String,
     gallery: MutableList<String> = mutableListOf(),
 

diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/repository/ActivityRepository.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/repository/ActivityRepository.kt
@@ -6,5 +6,5 @@ import pt.up.fe.ni.website.backend.model.Activity
 
 @Repository
 interface ActivityRepository<T : Activity> : CrudRepository<T, Long> {
-    fun findBySlug(slug: String?): T?
+    fun findBySlug(slug: String): T?
 }
diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/repository/PostRepository.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/repository/PostRepository.kt
@@ -6,5 +6,5 @@ import pt.up.fe.ni.website.backend.model.Post
 
 @Repository
 interface PostRepository : JpaRepository<Post, Long> {
-    fun findBySlug(slug: String?): Post?
+    fun findBySlug(slug: String): Post?
 }
diff --git a/src/main/kotlin/pt/up/fe/ni/website/backend/service/activity/AbstractActivityService.kt b/src/main/kotlin/pt/up/fe/ni/website/backend/service/activity/AbstractActivityService.kt
@@ -27,7 +27,7 @@ abstract class AbstractActivityService<T : Activity>(
         }
 
         dto.imageFile?.let {
-            val fileName = fileUploader.buildFileName(it, dto.title)
+            val fileName = fileUploader.buildFileName(it, dto.slug)
             dto.image = fileUploader.uploadImage(imageFolder, fileName, it.bytes)
         }
 
@@ -52,7 +52,7 @@ abstract class AbstractActivityService<T : Activity>(
         if (imageFile == null) {
             dto.image = activity.image
         } else {
-            val fileName = fileUploader.buildFileName(imageFile, dto.title)
+            val fileName = fileUploader.buildFileName(imageFile, dto.slug)
             dto.image = fileUploader.uploadImage(imageFolder, fileName, imageFile.bytes)
         }
 
@@ -86,7 +86,7 @@ abstract class AbstractActivityService<T : Activity>(
     fun addGalleryImage(activityId: Long, image: MultipartFile, imageFolder: String): Activity {
         val activity = getActivityById(activityId)
 
-        val fileName = fileUploader.buildFileName(image, activity.title)
+        val fileName = fileUploader.buildFileName(image, activity.slug)
         val imageName = fileUploader.uploadImage("$imageFolder/gallery", fileName, image.bytes)
 
         activity.gallery.add(imageName)

diff --git a/src/test/kotlin/pt/up/fe/ni/website/backend/controller/EventControllerTest.kt b/src/test/kotlin/pt/up/fe/ni/website/backend/controller/EventControllerTest.kt
@@ -284,7 +284,7 @@ internal class EventControllerTest @Autowired constructor(
                 "This event was a failure",
                 mutableListOf(testAccount),
                 mutableListOf(),
-                null,
+                "bad-event",
                 "bad-image.png",
                 mutableListOf(),
                 null,
@@ -300,7 +300,7 @@ internal class EventControllerTest @Autowired constructor(
                 "This event was ok",
                 mutableListOf(),
                 mutableListOf(),
-                null,
+                "mid-event",
                 "mid-image.png",
                 mutableListOf(),
                 null,
@@ -316,7 +316,7 @@ internal class EventControllerTest @Autowired constructor(
                 "This event was a awesome",
                 mutableListOf(testAccount),
                 mutableListOf(),
-                null,
+                "cool-event",
                 "cool-image.png",
                 mutableListOf(),
                 null,
@@ -362,7 +362,7 @@ internal class EventControllerTest @Autowired constructor(
     inner class CreateEvent {
         private val uuid: UUID = UUID.randomUUID()
         private val mockedSettings = Mockito.mockStatic(UUID::class.java)
-        private val expectedImagePath = "${uploadConfigProperties.staticServe}/events/${testEvent.title}-$uuid.jpeg"
+        private val expectedImagePath = "${uploadConfigProperties.staticServe}/events/${testEvent.slug}-$uuid.jpeg"
 
         @BeforeEach
         fun addAccount() {
@@ -841,7 +841,7 @@ internal class EventControllerTest @Autowired constructor(
 
         @Test
         fun `should add an image`() {
-            val expectedImagePath = "${uploadConfigProperties.staticServe}/events/gallery/${testEvent.title}-$uuid.jpeg"
+            val expectedImagePath = "${uploadConfigProperties.staticServe}/events/gallery/${testEvent.slug}-$uuid.jpeg"
 
             mockMvc.multipartBuilder("/events/${testEvent.id}/gallery")
                 .asPutMethod()
@@ -1108,7 +1108,7 @@ internal class EventControllerTest @Autowired constructor(
 
         @Test
         fun `should update the event with same slug`() {
-            eventPart["slug"] = testEvent.slug!!
+            eventPart["slug"] = testEvent.slug
             mockMvc.multipartBuilder("/events/${testEvent.id}")
                 .asPutMethod()
                 .addPart("event", objectMapper.writeValueAsString(eventPart))
@@ -1162,7 +1162,7 @@ internal class EventControllerTest @Autowired constructor(
 
         @Test
         fun `should update the event with image`() {
-            val expectedImagePath = "${uploadConfigProperties.staticServe}/events/$newTitle-$uuid.jpeg"
+            val expectedImagePath = "${uploadConfigProperties.staticServe}/events/$newSlug-$uuid.jpeg"
 
             mockMvc.multipartBuilder("/events/${testEvent.id}")
                 .asPutMethod()
@@ -1204,11 +1204,12 @@ internal class EventControllerTest @Autowired constructor(
         }
 
         @Test
-        fun `should fail if the event does not exist`() {
+        fun`should fail if the event does not exist`() {
             val eventPart = objectMapper.writeValueAsString(
                 mapOf(
                     "title" to "New Title",
                     "description" to "New Description",
+                    "slug" to "new-slug",
                     "dateInterval" to DateInterval(TestUtils.createDate(2022, Calendar.DECEMBER, 1), null),
                     "associatedRoles" to testEvent.associatedRoles
                 )
@@ -1289,6 +1290,7 @@ internal class EventControllerTest @Autowired constructor(
                 requiredFields = mapOf(
                     "title" to testEvent.title,
                     "description" to testEvent.description,
+                    "slug" to testEvent.slug,
                     "dateInterval" to testEvent.dateInterval,
                     "image" to testEvent.image
                 )
@@ -1340,6 +1342,29 @@ internal class EventControllerTest @Autowired constructor(
                     )
             }
 
+            @NestedTest
+            @DisplayName("slug")
+            inner class SlugValidation {
+                @BeforeAll
+                fun setParam() {
+                    validationTester.param = "slug"
+                }
+
+                @Test
+                fun `should be required`() = validationTester.isRequired()
+
+                @Test
+                @DisplayName(
+                    "size should be between ${ActivityConstants.Slug.minSize}" +
+                        " and ${ActivityConstants.Slug.maxSize}()"
+                )
+                fun size() =
+                    validationTester.hasSizeBetween(
+                        ActivityConstants.Slug.minSize,
+                        ActivityConstants.Slug.maxSize
+                    )
+            }
+
             @NestedTest
             @DisplayName("registerUrl")
             inner class UrlValidation {

diff --git a/src/test/kotlin/pt/up/fe/ni/website/backend/controller/GenerationControllerTest.kt b/src/test/kotlin/pt/up/fe/ni/website/backend/controller/GenerationControllerTest.kt
@@ -1059,6 +1059,7 @@ class GenerationControllerTest @Autowired constructor(
                             Project(
                                 "NIJobs",
                                 "cool project",
+                                slug = "ni-jobs",
                                 image = "cool-image.png",
                                 targetAudience = "students",
                                 github = "https://github.com/NIAEFEUP/nijobs-be",
@@ -1082,6 +1083,7 @@ class GenerationControllerTest @Autowired constructor(
                             Event(
                                 title = "SINF",
                                 description = "cool event",
+                                slug = "sinf",
                                 dateInterval = DateInterval(TestUtils.createDate(2023, 9, 10)),
                                 location = null,
                                 category = null,

diff --git a/src/test/kotlin/pt/up/fe/ni/website/backend/controller/PostControllerTest.kt b/src/test/kotlin/pt/up/fe/ni/website/backend/controller/PostControllerTest.kt
@@ -56,7 +56,8 @@ internal class PostControllerTest @Autowired constructor(
             Post(
                 "NIAEFEUP gets a new president",
                 "New president promised to buy new chairs",
-                "https://thumbnails/pres.png"
+                "https://thumbnails/pres.png",
+                slug = "new-president"
             )
         )
 
@@ -255,6 +256,7 @@ internal class PostControllerTest @Autowired constructor(
                 requiredFields = mapOf(
                     "title" to testPost.title,
                     "body" to testPost.body,
+                    "slug" to testPost.slug,
                     "thumbnailPath" to testPost.thumbnailPath
                 )
             )
@@ -314,6 +316,9 @@ internal class PostControllerTest @Autowired constructor(
                     validationTester.param = "slug"
                 }
 
+                @Test
+                fun `should be required`() = validationTester.isRequired()
+
                 @Test
                 @DisplayName("size should be between ${Constants.Slug.minSize} and ${Constants.Slug.maxSize}()")
                 fun size() = validationTester.hasSizeBetween(Constants.Slug.minSize, Constants.Slug.maxSize)
@@ -392,7 +397,7 @@ internal class PostControllerTest @Autowired constructor(
         )
 
         @Test
-        fun `should update the post without the slug`() {
+        fun `should update the post without changing the slug`() {
             val newTitle = "New Title"
             val newBody = "New Body of the post"
             val newThumbnailPath = "https://thumbnails/new.png"
@@ -405,7 +410,8 @@ internal class PostControllerTest @Autowired constructor(
                             mapOf(
                                 "title" to newTitle,
                                 "body" to newBody,
-                                "thumbnailPath" to newThumbnailPath
+                                "thumbnailPath" to newThumbnailPath,
+                                "slug" to testPost.slug
                             )
                         )
                     )
@@ -436,7 +442,7 @@ internal class PostControllerTest @Autowired constructor(
         }
 
         @Test
-        fun `should update the post with the slug`() {
+        fun `should update the post changing the slug`() {
             val newTitle = "New Title"
             val newBody = "New Body of the post"
             val newThumbnailPath = "https://thumbnails/new.png"
@@ -491,7 +497,8 @@ internal class PostControllerTest @Autowired constructor(
                             mapOf(
                                 "title" to "New Title",
                                 "body" to "New Body of the post",
-                                "thumbnailPath" to "thumbnails/new.png"
+                                "thumbnailPath" to "thumbnails/new.png",
+                                "slug" to "new-slug"
                             )
                         )
                     )
@@ -562,7 +569,8 @@ internal class PostControllerTest @Autowired constructor(
                 requiredFields = mapOf(
                     "title" to testPost.title,
                     "body" to testPost.body,
-                    "thumbnailPath" to testPost.thumbnailPath
+                    "thumbnailPath" to testPost.thumbnailPath,
+                    "slug" to testPost.slug
                 )
             )
 
@@ -621,6 +629,9 @@ internal class PostControllerTest @Autowired constructor(
                     validationTester.param = "slug"
                 }
 
+                @Test
+                fun `should be required`() = validationTester.isRequired()
+
                 @Test
                 @DisplayName("size should be between ${Constants.Slug.minSize} and ${Constants.Slug.maxSize}()")
                 fun size() = validationTester.hasSizeBetween(Constants.Slug.minSize, Constants.Slug.maxSize)