Merge pull request #552 from scireum/GA-12

GA 12.0.0

Author: jmuscireum

.drone.yml

@@ -17,7 +17,7 @@ clone:
 
 steps:
   - name: compile
-    image: scireum/sirius-build-jdk21
+    image: scireum/sirius-build-jdk23
     commands:
       - mvn clean compile
     volumes: *scireum_volumes
@@ -28,7 +28,7 @@ steps:
         - push
 
   - name: cron_unit_tests
-    image: scireum/sirius-build-jdk21
+    image: scireum/sirius-build-jdk23
     commands:
       - mvn clean test
     volumes: *scireum_volumes
@@ -48,7 +48,7 @@ steps:
         - cron
 
   - name: test
-    image: scireum/sirius-build-jdk21
+    image: scireum/sirius-build-jdk23
     commands:
       - mvn clean test -Dtest.excluded.groups=nightly
     volumes: *scireum_volumes
@@ -57,7 +57,7 @@ steps:
         - pull_request
 
   - name: deploy
-    image: scireum/sirius-build-jdk21
+    image: scireum/sirius-build-jdk23
     commands:
       - sed -i 's/DEVELOPMENT-SNAPSHOT/${DRONE_TAG}/g' pom.xml
       - mvn clean deploy -DskipTests
@@ -77,7 +77,7 @@ steps:
         - tag
 
   - name: sonar
-    image: scireum/sirius-build-jdk21
+    image: scireum/sirius-build-jdk23
     commands:
       - sed -i 's/DEVELOPMENT-SNAPSHOT/${DRONE_TAG}/g' pom.xml
       - mvn clean org.jacoco:jacoco-maven-plugin:prepare-agent test org.jacoco:jacoco-maven-plugin:report sonar:sonar -Dsonar.projectKey=${DRONE_REPO_NAME}

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+### Description
+
+<!--  Describe your changes in detail. Also mention how to handle breaking changes if there are any -->
+
+### Additional Notes
+
+- This PR fixes or works on following ticket(s): [SIRI-](https://scireum.myjetbrains.com/youtrack/issue/SIRI-)
+- This PR is related to PR: <!-- URL of PR if applicable, remove otherwise -->
+
+### Checklist
+
+- [ ] Code change has been tested and works locally
+- [ ] Code was formatted via IntelliJ and follows SonarLint & [best practices](https://scireum.myjetbrains.com/youtrack/articles/MISC-A-16/CodeStyle-JavaDoc)
+- [ ] Patch Tasks: Is local execution of Patch Tasks necessary? If so, please also mark the PR with the tag.

build.gradle.kts

@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.scireum</groupId>
         <artifactId>sirius-parent</artifactId>
-        <version>11.5.1</version>
+        <version>13.1.0</version>
     </parent>
     <artifactId>sirius-kernel</artifactId>
     <name>SIRIUS kernel</name>
@@ -32,28 +32,28 @@
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
-            <version>32.1.3-jre</version>
+            <version>33.3.1-jre</version>
         </dependency>
 
         <!-- JSR305 annotations like @Nonnull etc. -->
         <dependency>
-            <groupId>com.google.code.findbugs</groupId>
-            <artifactId>jsr305</artifactId>
-            <version>3.0.2</version>
+            <groupId>com.github.spotbugs</groupId>
+            <artifactId>spotbugs-annotations</artifactId>
+            <version>4.8.6</version>
         </dependency>
 
         <!-- Required logging bridge to make slf4j log to our logging system -->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-jdk14</artifactId>
-            <version>2.0.9</version>
+            <version>2.0.16</version>
         </dependency>
 
         <!-- Used to auto-start Docker environments. Excluding dependencies not required for docker-compose. -->
         <dependency>
             <groupId>com.palantir.docker.compose</groupId>
             <artifactId>docker-compose-rule-core</artifactId>
-            <version>2.0.0</version>
+            <version>2.3.0</version>
             <exclusions>
                 <exclusion>
                     <groupId>com.palantir.conjure.java.runtime</groupId>
@@ -69,7 +69,7 @@
         <dependency>
             <groupId>commons-io</groupId>
             <artifactId>commons-io</artifactId>
-            <version>2.15.1</version>
+            <version>2.18.0</version>
         </dependency>
         <!-- Required, as the version provided by docker-compose-rule-core has security issues -->
         <dependency>

pom.xml

@@ -8,6 +8,7 @@
 
 package sirius.kernel.commons;
 
+import javax.annotation.Nonnull;
 import java.time.LocalDate;
 import java.time.LocalDateTime;
 import java.util.Arrays;
@@ -42,10 +43,7 @@ public static LocalDateTime computeLatestDateTime(LocalDateTime... dateTimes) {
      * @return the latest date-time object or <tt>null</tt> if no date is given
      */
     public static LocalDateTime computeLatestDateTime(List<LocalDateTime> dateTimes) {
-        return dateTimes.stream()
-                        .filter(Objects::nonNull)
-                        .max(LocalDateTime::compareTo)
-                        .orElse(null);
+        return dateTimes.stream().filter(Objects::nonNull).max(LocalDateTime::compareTo).orElse(null);
     }
 
     /**
@@ -60,14 +58,12 @@ public static LocalDate computeLatestDate(LocalDate... dates) {
 
     /**
      * Computes the latest date of the given date objects.
+     *
      * @param dates a list of date objects to compare
      * @return the latest date object or <tt>null</tt> if no date is given
      */
     public static LocalDate computeLatestDate(List<LocalDate> dates) {
-        return dates.stream()
-                    .filter(Objects::nonNull)
-                    .max(LocalDate::compareTo)
-                    .orElse(null);
+        return dates.stream().filter(Objects::nonNull).max(LocalDate::compareTo).orElse(null);
     }
 
     /**
@@ -87,10 +83,7 @@ public static LocalDateTime computeEarliestDateTime(LocalDateTime... dateTimes)
      * @return the earliest date-time object or <tt>null</tt> if no date is given
      */
     public static LocalDateTime computeEarliestDateTime(List<LocalDateTime> dateTimes) {
-        return dateTimes.stream()
-                        .filter(Objects::nonNull)
-                        .min(LocalDateTime::compareTo)
-                        .orElse(null);
+        return dateTimes.stream().filter(Objects::nonNull).min(LocalDateTime::compareTo).orElse(null);
     }
 
     /**
@@ -110,9 +103,42 @@ public static LocalDate computeEarliestDate(LocalDate... dates) {
      * @return the earliest date object or <tt>null</tt> if no date is given
      */
     public static LocalDate computeEarliestDate(List<LocalDate> dates) {
-        return dates.stream()
-                    .filter(Objects::nonNull)
-                    .min(LocalDate::compareTo)
-                    .orElse(null);
+        return dates.stream().filter(Objects::nonNull).min(LocalDate::compareTo).orElse(null);
+    }
+
+    /**
+     * Determines if the given date is before or after the given reference date.
+     *
+     * @param dateToCheck   the date to check
+     * @param referenceDate the reference date
+     * @return <tt>true</tt> if the date is before or after the reference date, <tt>false</tt> otherwise
+     */
+    public static boolean isBeforeOrEqual(@Nonnull LocalDate dateToCheck, @Nonnull LocalDate referenceDate) {
+        return dateToCheck.isBefore(referenceDate) || dateToCheck.equals(referenceDate);
+    }
+
+    /**
+     * Determines if the given date is after or equal to the given reference date.
+     *
+     * @param dateToCheck   the date to check
+     * @param referenceDate the reference date
+     * @return <tt>true</tt> if the date is after or equal to the reference date, <tt>false</tt> otherwise
+     */
+    public static boolean isAfterOrEqual(@Nonnull LocalDate dateToCheck, @Nonnull LocalDate referenceDate) {
+        return dateToCheck.isAfter(referenceDate) || dateToCheck.equals(referenceDate);
+    }
+
+    /**
+     * Determines if the given date is within the given range, inclusive the range dates.
+     *
+     * @param startDate   the range's start date
+     * @param endDate     the range's end date
+     * @param dateToCheck the date to check
+     * @return <tt>true</tt> if the date is within the range, <tt>false</tt> otherwise
+     */
+    public static boolean isWithinRange(@Nonnull LocalDate startDate,
+                                        @Nonnull LocalDate endDate,
+                                        @Nonnull LocalDate dateToCheck) {
+        return isAfterOrEqual(dateToCheck, startDate) && isBeforeOrEqual(dateToCheck, endDate);
     }
 }

src/main/java/sirius/kernel/commons/Dates.java

@@ -18,8 +18,10 @@
 import java.nio.file.Path;
 import java.nio.file.SimpleFileVisitor;
 import java.nio.file.attribute.BasicFileAttributes;
+import java.util.List;
 import java.util.Optional;
 import java.util.regex.Pattern;
+import java.util.stream.Stream;
 
 /**
  * Helperclass for handling files in Java 8.
@@ -28,6 +30,11 @@ public class Files {
 
     private static final Pattern NON_PATH_CHARACTERS = Pattern.compile("[^a-zA-Z0-9\\-.]");
 
+    /**
+     * Contains a list of file names and endings which are considered to be metadata.
+     */
+    private static final List<String> METADATA_FILES = List.of("__MACOSX", ".DS_Store", "Thumbs.db");
+
     private Files() {
     }
 
@@ -147,8 +154,39 @@ public static String getFilenameWithoutExtension(@Nullable String path) {
     }
 
     /**
-     * If the given file is not null and exists, tries to delete that file and logs when a file cannot be deleted. T
-     * his is useful for error reporting and to diagnose why a file cannot be deleted.
+     * Determines if the given path is hidden.
+     * <p>
+     * A path is considered hidden if it starts with a dot.
+     *
+     * @param fileOrDirectoryName the path to check
+     * @return <tt>true</tt> if the path is hidden, <tt>false</tt> otherwise
+     */
+    public static boolean isConsideredHidden(@Nullable String fileOrDirectoryName) {
+        if (Strings.isEmpty(fileOrDirectoryName)) {
+            return false;
+        }
+        return fileOrDirectoryName.startsWith(".");
+    }
+
+    /**
+     * Determines if the given path is a metadata file.
+     * <p>
+     * A metadata file is a file which is not part of the actual content but rather contains metadata or is used by
+     * the operating system or other tools.
+     *
+     * @param fileOrDirectoryName the path to check
+     * @return <tt>true</tt> if the path is a metadata file that is listed in the METADATA_FILES list, <tt>false</tt> otherwise
+     */
+    public static boolean isConsideredMetadata(@Nullable String fileOrDirectoryName) {
+        if (Strings.isEmpty(fileOrDirectoryName)) {
+            return false;
+        }
+        return METADATA_FILES.stream().anyMatch(fileOrDirectoryName::startsWith);
+    }
+
+    /**
+     * If the given file is not null and exists, tries to delete that file and logs when a file cannot be deleted.
+     * This is useful for error reporting and to diagnose why a file cannot be deleted.
      *
      * @param file the file to delete
      */
@@ -213,4 +251,27 @@ public FileVisitResult postVisitDirectory(Path dir, IOException exc) throws IOEx
             }
         });
     }
+
+    /**
+     * Returns a stream of all parts of the given path.
+     * <p>
+     * The stream will contain the filename, the parent directory, the parent of the parent and so on.
+     *
+     * @param path the path to split
+     * @return a stream of all parts of the given path
+     */
+    public static Stream<String> streamPath(String path) {
+        if (Strings.isEmpty(path)) {
+            return Stream.empty();
+        }
+
+        Stream.Builder<String> builder = Stream.builder();
+        builder.add(Files.getFilenameAndExtension(path));
+        String parent = Files.getBasepath(path);
+        while (Strings.isFilled(parent)) {
+            builder.add(Files.getFilenameAndExtension(parent));
+            parent = Files.getBasepath(parent);
+        }
+        return builder.build();
+    }
 }

src/main/java/sirius/kernel/commons/Files.java

@@ -462,6 +462,20 @@ public static String uppercase(@Nonnull String input) {
         return input.toUpperCase();
     }
 
+    /**
+     * Capitalizes the first character of the given string.
+     *
+     * @param input the input to process
+     * @return the resulting string
+     */
+    public static String capitalize(@Nonnull String input) {
+        char titleCasedChar = Character.toTitleCase(input.charAt(0));
+        if (titleCasedChar == input.charAt(0)) {
+            return input;
+        }
+        return titleCasedChar + input.substring(1);
+    }
+
     /**
      * Removes all {@linkplain #PATTERN_STRIP_XML XML tags} from the given string.
      *