Merge pull request 'chore: general cleanup of docstrings and mappers' (#44) from general-cleanup into main

Reviewed-on: https://codeberg.org/OpenPodcastAPI/opa-java/pulls/44

Author: Sporiff

src/main/java/org/openpodcastapi/opa/subscription/SubscriptionEntity.java

@@ -57,99 +57,71 @@ public SubscriptionEntity(UUID uuid, UserEntity user, FeedEntity feed) {
         this.feed = feed;
     }
 
-    /// Retrieves the subscription ID
-    ///
     /// @return the subscription ID
     public Long getId() {
         return this.id;
     }
 
-    /// Sets the subscription ID
-    ///
     /// @param id the subscription ID
     public void setId(Long id) {
         this.id = id;
     }
 
-    /// Retrieves the subscription UUID
-    ///
     /// @return the subscription UUID
     public UUID getUuid() {
         return this.uuid;
     }
 
-    /// Sets the subscription UUID
-    ///
     /// @param uuid the subscription UUID
     public void setUuid(UUID uuid) {
         this.uuid = uuid;
     }
 
-    /// Retrieves the user associated with the entity
-    ///
     /// @return the associated user
     public UserEntity getUser() {
         return this.user;
     }
 
-    /// Sets the user associated with the subscription
-    ///
     /// @param user the subscription UUID
     public void setUser(UserEntity user) {
         this.user = user;
     }
 
-    /// Retrieves the feed associated with the entity
-    ///
     /// @return the associated subscription
     public FeedEntity getFeed() {
         return this.feed;
     }
 
-    /// Sets the subscription associated with the user subscription
-    ///
     /// @param feed the subscription UUID
     public void setFeed(FeedEntity feed) {
         this.feed = feed;
     }
 
-    /// Retrieves the creation date of the subscription
-    ///
     /// @return the creation date
     public Instant getCreatedAt() {
         return this.createdAt;
     }
 
-    /// Sets the creation date for the subscription
-    ///
     /// @param createdAt the creation timestamp
     public void setCreatedAt(Instant createdAt) {
         this.createdAt = createdAt;
     }
 
-    /// Retrieves the last update timestamp for the subscription
-    ///
     /// @return the last updated timestamp
     public Instant getUpdatedAt() {
         return this.updatedAt;
     }
 
-    /// Sets the last updated date for the subscription
-    ///
     /// @param updatedAt the last updated timestamp
     public void setUpdatedAt(Instant updatedAt) {
         this.updatedAt = updatedAt;
     }
 
-    /// Retrieves the unsubscribed timestamp for the entity
-    ///
     /// @return the unsubscribed timestamp
     public Instant getUnsubscribedAt() {
         return this.unsubscribedAt;
     }
 
-    /// Sets the unsubscribed timestamp
-    ///
     /// @param unsubscribedAt the unsubscribed timestamp
     public void setUnsubscribedAt(Instant unsubscribedAt) {
         this.unsubscribedAt = unsubscribedAt;

src/main/java/org/openpodcastapi/opa/user/UserEntity.java

@@ -90,106 +90,76 @@ public UserEntity(Long id, UUID uuid, String username, String password, String e
         this.updatedAt = updatedAt;
     }
 
-    /// Retrieves the ID of a user entity
-    ///
     /// @return the ID of the user entity
     public Long getId() {
         return this.id;
     }
 
-    /// Retrieves the UUID of a user entity
-    ///
     /// @return the UUID of the user entity
     public UUID getUuid() {
         return this.uuid;
     }
 
-    /// Sets the UUID of a user entity
-    ///
     /// @param uuid the UUID for the entity
     public void setUuid(UUID uuid) {
         this.uuid = uuid;
     }
 
-    /// Retrieves the username of a user entity
-    ///
     /// @return a user's username
     public String getUsername() {
         return this.username;
     }
 
-    /// Sets the username of a user entity
-    ///
     /// @param username the user's username
     public void setUsername(String username) {
         this.username = username;
     }
 
-    /// Retrieves the user's password hash
-    ///
     /// @return the hashed password
     public String getPassword() {
         return this.password;
     }
 
-    /// Sets the user's password. The password must be hashed first
-    ///
     /// @param password the hashed password
     public void setPassword(String password) {
         this.password = password;
     }
 
-    /// Retrieves a user's email address
-    ///
     /// @return the user's email address
     public String getEmail() {
         return this.email;
     }
 
-    /// Sets the user's email address.
-    ///
     /// @param email the user's email address
     public void setEmail(String email) {
         this.email = email;
     }
 
-    /// Retrieves a user's subscriptions
-    ///
     /// @return a set of subscriptions
     public Set<SubscriptionEntity> getSubscriptions() {
         return this.subscriptions;
     }
 
-    /// Sets a user's subscriptions
-    ///
     /// @param subscriptions the set of subscriptions to add to the user
     public void setSubscriptions(Set<SubscriptionEntity> subscriptions) {
         this.subscriptions = subscriptions;
     }
 
-    /// Retrieves a user's roles
-    ///
     /// @return a set of user roles
     public Set<UserRoles> getUserRoles() {
         return this.userRoles;
     }
 
-    /// Sets a user's roles
-    ///
     /// @param userRoles a set of user roles
     public void setUserRoles(Set<UserRoles> userRoles) {
         this.userRoles = userRoles;
     }
 
-    /// Retrieves the creation date of the user
-    ///
     /// @return the user creation date
     public Instant getCreatedAt() {
         return this.createdAt;
     }
 
-    /// Retrieves the last updated timestamp for the user
-    ///
     /// @return the last updated timestamp
     public Instant getUpdatedAt() {
         return this.updatedAt;

src/main/java/org/openpodcastapi/opa/user/UserMapper.java

@@ -2,9 +2,10 @@
 
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
+import org.mapstruct.ReportingPolicy;
 
 /// Mapper for user items
-@Mapper(componentModel = "spring")
+@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
 public interface UserMapper {
     /// Maps a user entity to a DTO.
     ///
@@ -18,9 +19,6 @@ public interface UserMapper {
     ///
     /// @param dto the user creation DTO to map
     /// @return the mapped entity
-    @Mapping(target = "uuid", ignore = true)
-    @Mapping(target = "subscriptions", ignore = true)
     @Mapping(target = "password", ignore = true)
-    @Mapping(target = "userRoles", ignore = true)
     UserEntity toEntity(UserDTO.CreateUserDTO dto);
 }

src/main/java/org/openpodcastapi/opa/user/UserRestController.java

@@ -53,7 +53,7 @@ public UserRestController(UserService userService) {
     /// @param uuid the UUID of the user
     /// @return a response containing a summary of the action
     @DeleteMapping("/{uuid}")
-    @PreAuthorize("hasRole('ADMIN') or #uuid == principal.uuid")
+    @PreAuthorize("hasRole('ADMIN') or #uuid == authentication.principal.uuid" )
     public ResponseEntity<@NonNull String> deleteUser(@PathVariable String uuid) {
         // Attempt to validate the UUID value from the provided string
         // If the value is invalid, the GlobalExceptionHandler will throw a 400.