Revize 8ca61504

Added missing comments, code refactoring

re #9743

backend/src/main/java/cz/zcu/kiv/backendapi/bibliography/Bibliography.java

@@ -25 +25 @@
     @Id
     private String source;
 
+    /**
+     * Catalog item
+     */
     @ManyToOne(fetch = FetchType.LAZY)
     @Id
     @JoinColumn(name = "catalog_item_id")

backend/src/main/java/cz/zcu/kiv/backendapi/catalog/CatalogItem.java

@@ -63 +63 @@
     private String description = "";
 
     /**
-     * Bibliography
+     * Set of bibliography
      */
     @OneToMany(mappedBy = "catalogItem", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @LazyCollection(LazyCollectionOption.FALSE)
@@ -72 +72 @@
     private Set<Bibliography> bibliography = new LinkedHashSet<>(0);
 
     /**
-     * Countries
+     * Set of countries
      */
     @OneToMany(mappedBy = "catalogItem", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @LazyCollection(LazyCollectionOption.FALSE)
@@ -81 +81 @@
     private Set<Country> countries = new LinkedHashSet<>(0);
 
     /**
-     * Written forms
+     * Set of written forms
      */
     @OneToMany(mappedBy = "catalogItem", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @LazyCollection(LazyCollectionOption.FALSE)
@@ -90 +90 @@
     private Set<WrittenForm> writtenForms = new LinkedHashSet<>(0);
 
     /**
-     * All names
+     * Set of all names
      */
     @OneToMany(mappedBy = "catalogItem", cascade = CascadeType.ALL, orphanRemoval = true, fetch = FetchType.EAGER)
     @LazyCollection(LazyCollectionOption.FALSE)
@@ -99 +99 @@
     private Set<CatalogItemName> allNames = new LinkedHashSet<>(0);
 
     /**
-     * Set of user roles - many-to-many relationship
+     * Set of types - many-to-many relationship
      */
     @ManyToMany(fetch = FetchType.EAGER)
     @Fetch(FetchMode.SUBSELECT)

backend/src/main/java/cz/zcu/kiv/backendapi/config/CorsConfig.java

@@ -17 +17 @@
     public void addCorsMappings(CorsRegistry registry) {
         registry.addMapping("/**")
                 .allowedOrigins("*")
-                .allowedMethods(HttpMethod.GET.name(), HttpMethod.POST.name(), HttpMethod.DELETE.name(), HttpMethod.PUT.name(), HttpMethod.PATCH.name());
+                .allowedMethods(HttpMethod.GET.name(), HttpMethod.POST.name(), HttpMethod.DELETE.name(),
+                        HttpMethod.PUT.name(), HttpMethod.PATCH.name());
     }
 }

backend/src/main/java/cz/zcu/kiv/backendapi/country/Country.java

@@ -25 +25 @@
     @Id
     private String name;
 
+    /**
+     * Catalog item
+     */
     @ManyToOne(fetch = FetchType.LAZY)
     @Id
     @JoinColumn(name = "catalog_item_id")

backend/src/main/java/cz/zcu/kiv/backendapi/exception/ApiExceptionHandler.java

@@ -8 +8 @@
 import org.springframework.web.bind.annotation.ControllerAdvice;
 import org.springframework.web.bind.annotation.ExceptionHandler;
 
+/**
+ * Exception handler
+ */
 @ControllerAdvice
 public class ApiExceptionHandler {
 

backend/src/main/java/cz/zcu/kiv/backendapi/exception/ApiRequestException.java

@@ -3 +3 @@
 import lombok.Getter;
 import org.springframework.http.HttpStatus;
 
+/**
+ * Class representing custom API request exception
+ */
 @Getter
 public class ApiRequestException extends RuntimeException {
+    /**
+     * HTTP status
+     */
     private final HttpStatus httpStatus;
 
+    /**
+     * Creates new API request exception with given message and HTTP status
+     *
+     * @param message    message
+     * @param httpStatus HTTP status
+     */
     public ApiRequestException(String message, HttpStatus httpStatus) {
         super(message);
         this.httpStatus = httpStatus;

backend/src/main/java/cz/zcu/kiv/backendapi/external/ExternalCatalogController.java

@@ -22 +22 @@
      */
     private final IExternalCatalogItemService externalCatalogService;
 
+    /**
+     * Updates external catalog
+     *
+     * @param file file - should contain CIGS catalog
+     */
     @PostMapping("")
     @Operation(summary = "updates external catalog")
     public void updateCatalog(@RequestParam("file") MultipartFile file) {

backend/src/main/java/cz/zcu/kiv/backendapi/path/PathController.java

@@ -3 +3 @@
 import cz.zcu.kiv.backendapi.catalog.ICatalogItemService;
 import io.swagger.v3.oas.annotations.Operation;
 import lombok.RequiredArgsConstructor;
-import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;

backend/src/main/java/cz/zcu/kiv/backendapi/validation/EmailValidator.java

@@ -12 +12 @@
     /**
      * Email string pattern
      */
-    private static final String EMAIL_PATTERN = "^[_A-Za-z0-9-+]+(.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(.[A-Za-z0-9]+)*(.[A-Za-z]{2,})$";
+    private static final String EMAIL_PATTERN = "^[_A-Za-z\\d-+]+(.[_A-Za-z\\d-]+)*@[A-Za-z\\d-]+(.[A-Za-z\\d]+)*(.[A-Za-z]{2,})$";
 
     /**
      * Email patter

backend/src/main/java/cz/zcu/kiv/backendapi/writtenform/WrittenForm.java

@@ -25 +25 @@
     @Id
     private String form;
 
+    /**
+     * Catalog item
+     */
     @ManyToOne(fetch = FetchType.LAZY)
     @Id
     @JoinColumn(name = "catalog_item_id")

backend/src/test/java/cz/zcu/kiv/backendapi/user/UserServiceImplTest.java

@@ -23 +23 @@
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.assertj.core.api.AssertionsForClassTypes.assertThatThrownBy;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.BDDMockito.given;
 import static org.mockito.Mockito.*;