Merge pull request #88 from DazedNConfused-/develop

DazedNConfused- · web-flow · commit ea45db1997a9 · 2024-08-29T16:09:02.000-03:00
build: prepare for v0.3.3 release [macata #86]
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+src/test/resources/** linguist-vendored
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,6 +20,6 @@ jobs:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
           restore-keys: |
-            ${{ runner.os }}-maven-
+            ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
       - name: Build with Maven
         run: mvn package
diff --git a/.github/workflows/sonarcloud.yml b/.github/workflows/sonarcloud.yml
@@ -28,7 +28,7 @@ jobs:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
           restore-keys: |
-            ${{ runner.os }}-maven-
+            ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
       - name: Cache SonarCloud packages
         uses: actions/cache@v3
         with:
diff --git a/README.md b/README.md
@@ -56,6 +56,7 @@ While not mandatory, if commits are not properly formatted, they may get rejecte
 ### Current
 
 - [x] Launch game & launch from last played world
+- [x] Game process monitor
 - [x] Save management & backups
   - Custom save directory is located at `/<macata_launcher_folder>/saves`
   - Custom backups directory is located at `/<macata_launcher_folder>/backups`
@@ -65,12 +66,12 @@ While not mandatory, if commits are not properly formatted, they may get rejecte
 - [x] Soundpack management
 - [x] Launcher autoupdater
 - [x] Mod management
+- [x] Bright Nights support
 
 ### Planned
 
 - [ ] Tileset support (soon)
 - [ ] Automatic CDDA binary updates & backups
-- [ ] Bright Nights support
 
 ### Maybes
 
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.dazednconfused</groupId>
     <artifactId>macatalauncher</artifactId>
-    <version>0.3.2</version>
+    <version>0.3.3</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>
diff --git a/src/main/java/com/dazednconfused/catalauncher/backup/SaveManager.java b/src/main/java/com/dazednconfused/catalauncher/backup/SaveManager.java
@@ -37,7 +37,7 @@ public static Optional<Thread> backupCurrentSaves(Consumer<Integer> onPercentDon
             return Optional.empty();
         }
 
-        File savesFolder = new File(Paths.getCustomSavePath());
+        File savesFolder = Paths.getCustomSavePath().toFile();
         return Optional.of(compressFolderAsJob(
                 savesFolder,
                 getSaveBackupFolder().getAbsolutePath() + "/" + generateNameBasedOnCurrentTimestamp() + ".zip",
@@ -51,20 +51,20 @@ public static Optional<Thread> backupCurrentSaves(Consumer<Integer> onPercentDon
     public static Optional<Thread> restoreBackup(File backup2beRestored, Consumer<Integer> onPercentDoneCallback) {
         LOGGER.info("Restoring backup [{}]...", backup2beRestored);
 
-        File trashedSaves = new File(Paths.getCustomTrashedSavePath());
+        File trashedSaves = Paths.getCustomTrashedSavePath().toFile();
 
         if (!trashedSaves.exists()) {
             LOGGER.debug("Trashed saves' folder [{}] doesn't exist. Generating...", trashedSaves);
             Try.of(trashedSaves::mkdirs).onFailure(t -> LOGGER.error("There was an error while creating trashed saves' folder [{}]", trashedSaves, t));
         }
 
-        File trashedSavePath = new File(Paths.getCustomTrashedSavePath(), generateNameBasedOnCurrentTimestamp());
+        File trashedSavePath = Paths.getCustomTrashedSavePath().resolve(generateNameBasedOnCurrentTimestamp()).toFile();
 
         if (!saveFilesExist()) {
             LOGGER.info("No current saves found. Nothing to move to trash folder.");
         } else {
             LOGGER.debug("Trashing existent saves into [{}]...", trashedSavePath);
-            File currentSave = new File(Paths.getCustomSavePath());
+            File currentSave = Paths.getCustomSavePath().toFile();
 
             Try.of(() -> Files.move(
                     currentSave.toPath(),
@@ -74,7 +74,7 @@ public static Optional<Thread> restoreBackup(File backup2beRestored, Consumer<In
 
         return Optional.of(decompressFolderAsJob(
                 backup2beRestored,
-                Path.of(Paths.getCustomSavePath()).getParent().toString(), // we don't decompress into CUSTOM_SAVE_PATH because we end up with ./saves/saves/<actual world saves>
+                Paths.getCustomSavePath().getParent().toString(), // we don't decompress into CUSTOM_SAVE_PATH because we end up with ./saves/saves/<actual world saves>
                 onPercentDoneCallback
         ));
     }
@@ -117,7 +117,7 @@ public static List<File> listAllBackups() {
      * if it has a {@code .sav} file in it.
      * */
     private static Optional<File> getLastModifiedValidSave() {
-        File savesFolder = new File(Paths.getCustomSavePath());
+        File savesFolder = Paths.getCustomSavePath().toFile();
         if (!saveFilesExist()) {
             return Optional.empty();
         }
@@ -139,7 +139,7 @@ private static Optional<File> getLastModifiedValidSave() {
      * Determines whether save files exist in {@link Paths#getCustomSavePath()}.
      * */
     public static boolean saveFilesExist() {
-        File savesFolder = new File(Paths.getCustomSavePath());
+        File savesFolder = Paths.getCustomSavePath().toFile();
         return savesFolder.exists() && Arrays.stream(Objects.requireNonNull(savesFolder.listFiles())).anyMatch(file -> !file.getName().equals(".DS_Store"));
     }
 
@@ -160,7 +160,7 @@ public static Optional<File> getLatestSave() {
      * Retrieves the {@link Paths#getSaveBackupPath()} as a {@link File}.
      * */
     private static File getSaveBackupFolder() {
-        File backupPath = new File(Paths.getSaveBackupPath());
+        File backupPath = Paths.getSaveBackupPath().toFile();
         if (!backupPath.exists()) {
             LOGGER.debug("Save backup destination folder [{}] not found. Creating...", backupPath);
             Try.of(backupPath::mkdirs).onFailure(t -> LOGGER.error("Could not create backup destination folder [{}]", backupPath, t));
diff --git a/src/main/java/com/dazednconfused/catalauncher/database/h2/H2Database.java b/src/main/java/com/dazednconfused/catalauncher/database/h2/H2Database.java
@@ -24,7 +24,7 @@ public abstract class H2Database implements DisposableDatabase {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(H2Database.class);
 
-    private static final String DATABASE_DIRECTORY = Paths.getDatabaseDirectory();
+    private static final String DATABASE_DIRECTORY = Paths.getDatabaseDirectory().toString();
     private static final String JDBC_URL_TEMPLATE = "jdbc:h2:" + DATABASE_DIRECTORY + "/%s;AUTO_SERVER=TRUE;DB_CLOSE_ON_EXIT=TRUE";
 
     private static final String USER = null;
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/ConsoleLogReader.java b/src/main/java/com/dazednconfused/catalauncher/gui/ConsoleLogReader.java
@@ -32,7 +32,7 @@ public ConsoleLogReader() throws IOException {
         this.textArea.setEditable(false);
 
         // populate current console with existing logs ---
-        File file = new File(Paths.getLogFilePath());
+        File file = Paths.getLogFilePath().toFile();
         BufferedReader reader = new BufferedReader(new FileReader(file));
         String line;
         while ((line = reader.readLine()) != null) {
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/MainWindow.java b/src/main/java/com/dazednconfused/catalauncher/gui/MainWindow.java
@@ -67,8 +67,8 @@ public class MainWindow {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(MainWindow.class);
 
-    private static final String[] CUSTOM_SAVE_DIR_ARGS = { "--savedir", Paths.getCustomSavePath() };
-    private static final String[] CUSTOM_USER_DIR_ARGS = { "--userdir", Paths.getCustomUserDir() };
+    private static final String[] CUSTOM_SAVE_DIR_ARGS = { "--savedir", Paths.getCustomSavePath() + "/" };
+    private static final String[] CUSTOM_USER_DIR_ARGS = { "--userdir", Paths.getCustomUserDir()  + "/" };
 
     /**
      * The array of all {@link Runnable}s to be executed on invocation of {@link #refreshGuiElements()}.
diff --git a/src/main/java/com/dazednconfused/catalauncher/helper/Paths.java b/src/main/java/com/dazednconfused/catalauncher/helper/Paths.java
@@ -2,6 +2,8 @@
 
 import com.dazednconfused.catalauncher.Application;
 
+import java.nio.file.Path;
+
 /**
  * A set of common filesystem {@link Paths} used throughout the application.
  * */
@@ -11,8 +13,8 @@ public class Paths {
      * Retrieves the {@link Application}'s root folder - that is, the filesystem path where the binary is currently executing.
      * Most defined {@link Paths} depend on this one.
      * */
-    public static String getLauncherRootFolder() {
-        return Application.getRootFolder();
+    public static Path getLauncherRootFolder() {
+        return Path.of(Application.getRootFolder());
     }
 
     /**
@@ -22,8 +24,8 @@ public static String getLauncherRootFolder() {
      *  getLauncherRootFolder() + "/.macatalauncher"
      * }</pre>
      * */
-    public static String getLauncherFiles() {
-        return getLauncherRootFolder() + "/.macatalauncher";
+    public static Path getLauncherFiles() {
+        return getLauncherRootFolder().resolve(".macatalauncher");
     }
 
     /**
@@ -33,19 +35,19 @@ public static String getLauncherFiles() {
      *  getLauncherRootFolder() + "/.macatalauncher/logs/main.log"
      * }</pre>
      * */
-    public static String getLogFilePath() {
-        return getLauncherFiles() + "/logs/main.log";
+    public static Path getLogFilePath() {
+        return getLauncherFiles().resolve("logs/main.log");
     }
 
     /**
      * Retrieves the {@link Application}'s custom savefile path.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/saves/"
+     *  getLauncherRootFolder() + "/saves"
      * }</pre>
      * */
-    public static String getCustomSavePath() {
-        return getLauncherRootFolder() + "/saves/";
+    public static Path getCustomSavePath() {
+        return getLauncherRootFolder().resolve("saves");
     }
 
     /**
@@ -55,19 +57,19 @@ public static String getCustomSavePath() {
      *  getLauncherRootFolder() + "/trashed"
      * }</pre>
      * */
-    public static String getCustomTrashedPath() {
-        return getLauncherRootFolder() + "/trashed";
+    public static Path getCustomTrashedPath() {
+        return getLauncherRootFolder().resolve("trashed");
     }
 
     /**
      * Retrieves the {@link Application}'s custom path for trashed savefiles.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/trashed/saves/"
+     *  getLauncherRootFolder() + "/trashed/saves"
      * }</pre>
      * */
-    public static String getCustomTrashedSavePath() {
-        return getCustomTrashedPath() + "/saves/";
+    public static Path getCustomTrashedSavePath() {
+        return getCustomTrashedPath().resolve("saves");
     }
 
     /**
@@ -77,64 +79,63 @@ public static String getCustomTrashedSavePath() {
      *  getLauncherRootFolder() + "/backups"
      * }</pre>
      * */
-    public static String getSaveBackupPath() {
-        return getLauncherRootFolder() + "/backups";
+    public static Path getSaveBackupPath() {
+        return getLauncherRootFolder().resolve("backups");
     }
 
     /**
      * Retrieves the {@link Application}'s custom {@code userdir/} directory.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/userdir/"
+     *  getLauncherRootFolder() + "/userdir"
      * }</pre>
      * */
-    public static String getCustomUserDir() {
-        return getLauncherRootFolder() + "/userdir/";
+    public static Path getCustomUserDir() {
+        return getLauncherRootFolder().resolve("userdir");
     }
 
     /**
      * Retrieves the {@link Application}'s custom {@code userdir/sound} directory.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/userdir/sound/"
+     *  getLauncherRootFolder() + "/userdir/sound"
      * }</pre>
      * */
-    public static String getCustomSoundpacksDir() {
-        return getCustomUserDir() + "sound/";
+    public static Path getCustomSoundpacksDir() {
+        return getCustomUserDir().resolve("sound");
     }
 
     /**
      * Retrieves the {@link Application}'s custom {@code userdir/mods} directory.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/userdir/mods/"
+     *  getLauncherRootFolder() + "/userdir/mods"
      * }</pre>
      * */
-    public static String getCustomModsDir() {
-        return getCustomUserDir() + "mods/";
+    public static Path getCustomModsDir() {
+        return getCustomUserDir().resolve("mods");
     }
 
     /**
      * Retrieves the {@link Application}'s custom path for trashed mods.
      *
      * <pre> {@code
-     *  getLauncherRootFolder() + "/trashed/saves/"
+     *  getLauncherRootFolder() + "/trashed/mods"
      * }</pre>
      * */
-    public static String getCustomTrashedModsPath() {
-        return getCustomTrashedPath() + "/mods/";
+    public static Path getCustomTrashedModsPath() {
+        return getCustomTrashedPath().resolve("mods");
     }
 
-
     /**
      * Retrieves the {@link Application}'s database(s) directory.
      *
      * <pre> {@code
      *  getLauncherRootFolder() + "/.macatalauncher/db"
      * }</pre>
      * */
-    public static String getDatabaseDirectory() {
-        return getLauncherFiles() + "/db";
+    public static Path getDatabaseDirectory() {
+        return getLauncherFiles().resolve("db");
     }
 
     // java resources
diff --git a/src/main/java/com/dazednconfused/catalauncher/mod/ModManager.java b/src/main/java/com/dazednconfused/catalauncher/mod/ModManager.java
@@ -138,14 +138,14 @@ public Path getPathFor(ModDTO toBeQueried) {
             throw new IllegalArgumentException("Invalid Mod supplied for query");
         }
 
-        return Path.of(Paths.getCustomModsDir(), toBeQueried.getName());
+        return Paths.getCustomModsDir().resolve(toBeQueried.getName());
     }
 
     /**
      * Returns the {@link ModDTO} corresponding to the given {@code toBeQueried} {@link File}.
      * */
     public Optional<ModDTO> getModFor(File toBeQueried) {
-        if (toBeQueried == null || !toBeQueried.getPath().contains(Paths.getCustomModsDir())) {
+        if (toBeQueried == null || !toBeQueried.getPath().contains(Paths.getCustomModsDir().toString())) {
             throw new IllegalArgumentException("Invalid File supplied for query");
         }
 
@@ -205,7 +205,7 @@ protected Result<Throwable, File> copyModToModsFolder(File toBeInstalled) {
     protected Result<Throwable, Void> trashModFromModsFolder(ModDTO toBeUninstalled) {
         return Try.run(() -> {
 
-            File trashedModsDir = new File(Paths.getCustomTrashedModsPath());
+            File trashedModsDir = Paths.getCustomTrashedModsPath().toFile();
             if (!trashedModsDir.exists()) {
                 LOGGER.debug("Trashed mods' folder [{}] doesn't exist. Generating...", trashedModsDir);
                 Try.of(trashedModsDir::mkdirs).onFailure(t -> LOGGER.error("There was an error while creating trashed mods' folder [{}]", trashedModsDir, t));
@@ -217,10 +217,7 @@ protected Result<Throwable, Void> trashModFromModsFolder(ModDTO toBeUninstalled)
                 toBeUninstalled.getName()
             ).toString());
 
-            File toBeTrashed = new File(Path.of(
-                Paths.getCustomModsDir(),
-                toBeUninstalled.getName()
-            ).toString());
+            File toBeTrashed = Paths.getCustomModsDir().resolve(toBeUninstalled.getName()).toFile();
 
             LOGGER.debug("Trashing mod [{}] into [{}]...", toBeTrashed, trashedModDir);
 
@@ -234,7 +231,7 @@ protected Result<Throwable, Void> trashModFromModsFolder(ModDTO toBeUninstalled)
                 FileUtils.moveFile(source, dest);
             }
 
-            File parentModFolder = new File(Paths.getCustomModsDir(), toBeUninstalled.getName());
+            File parentModFolder = Paths.getCustomModsDir().resolve(toBeUninstalled.getName()).toFile();
             if (com.dazednconfused.catalauncher.utils.FileUtils.hasContents(parentModFolder)) {
                 LOGGER.debug("Keeping parent folder [{}] because it still has contents after trashing all related mod files (maybe it had a tileset installed)...", parentModFolder.getPath());
                 if (LOGGER.isTraceEnabled()) {
@@ -259,7 +256,7 @@ protected Result<Throwable, Void> trashModFromModsFolder(ModDTO toBeUninstalled)
      * Retrieves the {@link Paths#getCustomModsDir()} as a {@link File}.
      * */
     protected File getModsFolder() {
-        File modsPath = new File(Paths.getCustomModsDir());
+        File modsPath = Paths.getCustomModsDir().toFile();
         if (!modsPath.exists()) {
             LOGGER.debug("Mods folder [{}] not found. Creating...", modsPath);
             Try.of(modsPath::mkdirs).onFailure(t -> LOGGER.error("Could not create mods destination folder [{}]", modsPath, t));
diff --git a/src/main/java/com/dazednconfused/catalauncher/soundpack/SoundpackManager.java b/src/main/java/com/dazednconfused/catalauncher/soundpack/SoundpackManager.java
@@ -55,7 +55,7 @@ public static void installSoundpack(File toBeInstalled, Consumer<Path> onDoneCal
      * Retrieves the {@link Paths#getCustomSoundpacksDir()} as a {@link File}.
      * */
     private static File getSoundpacksFolder() {
-        File soundpacksPath = new File(Paths.getCustomSoundpacksDir());
+        File soundpacksPath = Paths.getCustomSoundpacksDir().toFile();
         if (!soundpacksPath.exists()) {
             LOGGER.debug("Soundpacks folder [{}] not found. Creating...", soundpacksPath);
             Try.of(soundpacksPath::mkdirs).onFailure(t -> LOGGER.error("Could not create soundpacks destination folder [{}]", soundpacksPath, t));
diff --git a/src/main/resources/osx_launcher_wrapper.sh b/src/main/resources/osx_launcher_wrapper.sh
diff --git a/src/test/java/com/dazednconfused/catalauncher/backup/SaveManagerTest.java b/src/test/java/com/dazednconfused/catalauncher/backup/SaveManagerTest.java
diff --git a/src/test/java/com/dazednconfused/catalauncher/helper/PathsTest.java b/src/test/java/com/dazednconfused/catalauncher/helper/PathsTest.java
diff --git a/src/test/java/com/dazednconfused/catalauncher/mod/ModManagerTest.java b/src/test/java/com/dazednconfused/catalauncher/mod/ModManagerTest.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+src/test/resources/** linguist-vendored`