fix: review improvements #34

Author: lcanobbio

backend/src/main/java/ch/puzzle/pcts/controller/RoleController.java

@@ -18,7 +18,7 @@
 import org.springframework.web.bind.annotation.*;
 
 @RestController
-@RequestMapping("/api/v1/role")
+@RequestMapping("/api/v1/roles")
 public class RoleController {
     private final RoleMapper mapper;
     private final RoleBusinessService service;

backend/src/main/java/ch/puzzle/pcts/model/error/ErrorKey.java

@@ -8,4 +8,5 @@ public enum ErrorKey {
     NOT_FOUND,
     ROLE_NAME_IS_NULL,
     ROLE_NAME_IS_EMPTY,
+    ROLE_NAME_HAS_SPACE_AT_BEGINNING_OR_END,
 }

backend/src/main/java/ch/puzzle/pcts/model/role/Role.java

@@ -2,8 +2,12 @@
 
 import jakarta.persistence.*;
 import java.time.LocalDateTime;
+import org.hibernate.annotations.SQLDelete;
+import org.hibernate.annotations.Where;
 
 @Entity
+@SQLDelete(sql = "UPDATE role SET deleted_at = CURRENT_TIMESTAMP WHERE id = ?")
+@Where(clause = "deleted_at IS NULL")
 public class Role {
     @Id
     @GeneratedValue(strategy = GenerationType.AUTO, generator = "sequence_role")
@@ -12,7 +16,7 @@ public class Role {
 
     private String name;
 
-    private LocalDateTime deletedAt;
+    private LocalDateTime deletedAt = null;
 
     private boolean isManagement;
 

backend/src/main/java/ch/puzzle/pcts/repository/RoleRepository.java

@@ -22,9 +22,4 @@ public interface RoleRepository extends JpaRepository<Role, Long> {
     @Modifying
     @Query("UPDATE Role r SET r.name = :name, r.isManagement = :isManagement WHERE r.id = :id")
     void update(@Param("id") Long id, @Param("name") String name, @Param("isManagement") boolean isManagement);
-
-    @Transactional
-    @Modifying
-    @Query("UPDATE Role r SET r.deletedAt = CURRENT_TIMESTAMP WHERE r.id = :id")
-    void softDeleteById(@Param("id") Long id);
 }

backend/src/main/java/ch/puzzle/pcts/service/business/RoleBusinessService.java

@@ -21,23 +21,22 @@ public List<Role> getAll() {
     }
 
     public Role getById(long id) {
-        validationService.validateIfExists(id);
+        validationService.validateOnGetById(id);
         return persistenceService.getById(id);
     }
 
     public Role create(Role role) {
-        validationService.validateOnSetData(role);
+        validationService.validateOnCreate(role);
         return persistenceService.create(role);
     }
 
     public Role update(Long id, Role role) {
-        validationService.validateIfExists(id);
-        validationService.validateName(role.getName());
+        validationService.validateOnUpdate(id, role);
         return persistenceService.update(id, role);
     }
 
     public Role delete(Long id) {
-        validationService.validateIfExists(id);
+        validationService.validateOnDelete(id);
         Role deletedRole = persistenceService.getById(id);
         persistenceService.delete(id);
         return deletedRole;

backend/src/main/java/ch/puzzle/pcts/service/persistence/RolePersistenceService.java

@@ -33,6 +33,6 @@ public Role update(Long id, Role role) {
     }
 
     public void delete(Long id) {
-        repository.softDeleteById(id);
+        repository.deleteById(id);
     }
 }

backend/src/main/java/ch/puzzle/pcts/service/validation/RoleValidationService.java

@@ -18,25 +18,48 @@ public RoleValidationService(RolePersistenceService persistenceService) {
         this.persistenceService = persistenceService;
     }
 
-    public void validateOnSetData(Role role) {
-        if (role.getId() != null) {
-            throw new PCTSException(HttpStatus.BAD_REQUEST, "Id needs to be undefined", ErrorKey.ID_IS_NOT_NULL);
-        }
+    public void validateOnGetById(Long id) {
+        validateIfExists(id);
+    }
+
+    public void validateOnCreate(Role role) {
+        validateIfIdIsNull(role.getId());
+        validateName(role.getName());
+    }
+
+    public void validateOnDelete(Long id) {
+        validateIfExists(id);
+    }
 
+    public void validateOnUpdate(Long id, Role role) {
+        validateIfExists(id);
+        validateIfIdIsNull(role.getId());
         validateName(role.getName());
     }
 
-    public void validateName(String name) {
+    private void validateIfIdIsNull(Long id) {
+        if (id != null) {
+            throw new PCTSException(HttpStatus.BAD_REQUEST, "Id needs to be undefined", ErrorKey.ID_IS_NOT_NULL);
+        }
+    }
+
+    private void validateName(String name) {
         if (name == null) {
             throw new PCTSException(HttpStatus.BAD_REQUEST, "Name must not be null", ErrorKey.ROLE_NAME_IS_NULL);
         }
 
         if (Objects.equals(name, "")) {
             throw new PCTSException(HttpStatus.BAD_REQUEST, "Name must not be empty", ErrorKey.ROLE_NAME_IS_EMPTY);
         }
+
+        if (!name.matches("^\\S(.*\\S)?$")) {
+            throw new PCTSException(HttpStatus.BAD_REQUEST,
+                                    "Name must not have any space at the beginning and end",
+                                    ErrorKey.ROLE_NAME_HAS_SPACE_AT_BEGINNING_OR_END);
+        }
     }
 
-    public void validateIfExists(long id) {
+    private void validateIfExists(long id) {
         if (persistenceService.getById(id) == null) {
             throw new PCTSException(HttpStatus.NOT_FOUND, "Role does not exists", ErrorKey.NOT_FOUND);
         }