Merge pull request #70 from DazedNConfused-/develop

build: prepare for v0.3.1 release [macata #68]

Author: DazedNConfused-

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.dazednconfused</groupId>
     <artifactId>macatalauncher</artifactId>
-    <version>0.3.0</version>
+    <version>0.3.1</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>
@@ -15,6 +15,7 @@
 
         <sonar.organization>dazednconfused</sonar.organization>
         <sonar.host.url>https://sonarcloud.io</sonar.host.url>
+        <sonar.cpd.exclusions>**/MainWindow.java</sonar.cpd.exclusions>
     </properties>
 
     <profiles>
@@ -337,4 +338,4 @@
         </dependency>
     </dependencies>
 
-</project>
+</project>

src/main/java/com/dazednconfused/catalauncher/gui/MainWindow.java

@@ -47,6 +47,8 @@
 import javax.swing.JTabbedPane;
 import javax.swing.JTable;
 import javax.swing.KeyStroke;
+import javax.swing.SwingUtilities;
+import javax.swing.SwingWorker;
 import javax.swing.Timer;
 import javax.swing.UIManager;
 import javax.swing.UnsupportedLookAndFeelException;
@@ -436,7 +438,7 @@ public void mouseReleased(MouseEvent e) { // mouseReleased event needed for othe
             // DETERMINE IF BACKUP RESTORE BUTTON SHOULD BE DISABLED  ---
             // DETERMINE IF BACKUP DELETE BUTTON SHOULD BE DISABLED ---
             // (ie: if last backup was just deleted)
-            if (SaveManager.listAllBackups().size() == 0 || this.saveBackupsTable.getSelectedRow() == -1) {
+            if (SaveManager.listAllBackups().isEmpty() || this.saveBackupsTable.getSelectedRow() == -1) {
                 this.backupDeleteButton.setEnabled(false);
                 this.backupRestoreButton.setEnabled(false);
             }
@@ -460,23 +462,40 @@ private Runnable setupSoundpacksGui() {
             int result = fileChooser.showSaveDialog(mainPanel);
 
             if (result == JFileChooser.APPROVE_OPTION && fileChooser.getSelectedFile() != null) {
+
+                // enable global progressbar
+                this.globalProgressBar.setEnabled(true);
+
                 // setup dummy timer to give user visual feedback that his operation is in progress...
                 Timer dummyTimer = new Timer(10, e1 -> {
-                    if (this.globalProgressBar.getValue() <= 100) {
+                    if (this.globalProgressBar.getValue() < 99) { // it's important to keep this from hitting 100% while it is in its dummy-loop...
                         this.globalProgressBar.setValue(this.globalProgressBar.getValue() + 1);
                     }
                 });
 
                 // start timer before triggering installation
                 dummyTimer.start();
 
-                // start installation and give it a callback to stop the dummy timer
-                SoundpackManager.installSoundpack(fileChooser.getSelectedFile(), p -> dummyTimer.stop());
+                // execute the installation in a background thread, outside the Event Dispatch Thread (EDT)
+                SwingWorker<Void, Void> worker = new SwingWorker<>() {
+                    @Override
+                    protected Void doInBackground() {
+                        SoundpackManager.installSoundpack(fileChooser.getSelectedFile(), p -> dummyTimer.stop());
+                        return null;
+                    }
+
+                    @Override
+                    protected void done() {
+                        dummyTimer.stop(); // ensure the timer is stopped when the task is complete
+                        globalProgressBar.setValue(100); // this will refresh the GUI upon hitting 100%
+                    }
+                };
+
+                // start the worker thread
+                worker.execute();
             } else {
                 LOGGER.trace("Exiting soundpack finder dialog with no selection...");
             }
-
-            this.refreshGuiElements();
         });
 
         // SOUNDPACK DELETE BUTTON LISTENER ---
@@ -564,7 +583,7 @@ public void mouseReleased(MouseEvent e) { // mouseReleased event needed for othe
 
             // DETERMINE IF SOUNDPACK DELETE BUTTON SHOULD BE DISABLED ---
             // (ie: if last backup was just deleted)
-            if (SoundpackManager.listAllSoundpacks().size() == 0 || this.soundpacksTable.getSelectedRow() == -1) {
+            if (SoundpackManager.listAllSoundpacks().isEmpty() || this.soundpacksTable.getSelectedRow() == -1) {
                 this.uninstallSoundpackButton.setEnabled(false);
             }
         };
@@ -606,38 +625,58 @@ public String getDescription() {
             int result = fileChooser.showSaveDialog(mainPanel);
 
             if (result == JFileChooser.APPROVE_OPTION && fileChooser.getSelectedFile() != null) {
+
+                // enable global progressbar
+                this.globalProgressBar.setEnabled(true);
+
                 // setup dummy timer to give user visual feedback that his operation is in progress...
                 Timer dummyTimer = new Timer(10, e1 -> {
-                    if (this.globalProgressBar.getValue() <= 100) {
+                    if (this.globalProgressBar.getValue() < 99) { // it's important to keep this from hitting 100% while it is in its dummy-loop...
                         this.globalProgressBar.setValue(this.globalProgressBar.getValue() + 1);
                     }
                 });
 
                 // start timer before triggering installation
                 dummyTimer.start();
 
-                // start installation and give it a callback to stop the dummy timer
-                ModManager.getInstance().installMod(fileChooser.getSelectedFile(), p -> dummyTimer.stop()).toEither().fold(
-                    failure -> {
-                        dummyTimer.stop(); // abort dummyTimer on error
-                        LOGGER.error("There was a problem while installing mod [{}]", fileChooser.getSelectedFile(), failure.getError());
-
-                        ErrorDialog.showErrorDialog(
-                            String.format("There was a problem while installing mod [%s]", fileChooser.getSelectedFile().getName()),
-                            failure.getError()
-                        ).packCenterAndShow(this.mainPanel);
-                        return null;
-                    },
-                    success -> {
-                        LOGGER.info("Mod [{}] has been successfully installed!", fileChooser.getSelectedFile());
+                // execute the installation in a background thread, outside the Event Dispatch Thread (EDT)
+                SwingWorker<Void, Void> worker = new SwingWorker<>() {
+                    @Override
+                    protected Void doInBackground() {
+                        ModManager.getInstance().installMod(fileChooser.getSelectedFile(), p -> dummyTimer.stop()).toEither().fold(
+                            failure -> {
+                                LOGGER.error("There was a problem while installing mod [{}]", fileChooser.getSelectedFile(), failure.getError());
+
+                                // show error dialog on the EDT
+                                SwingUtilities.invokeLater(() -> {
+                                    dummyTimer.stop(); // stop dummyTimer on error
+                                    ErrorDialog.showErrorDialog(
+                                        String.format("There was a problem while installing mod [%s]", fileChooser.getSelectedFile().getName()),
+                                        failure.getError()
+                                    ).packCenterAndShow(mainPanel);
+                                });
+                                return null;
+                            },
+                            success -> {
+                                LOGGER.info("Mod [{}] has been successfully installed!", fileChooser.getSelectedFile());
+                                return null;
+                            }
+                        );
                         return null;
                     }
-                );
+
+                    @Override
+                    protected void done() {
+                        dummyTimer.stop(); // ensure the timer is stopped when the task is complete
+                        globalProgressBar.setValue(100); // this will refresh the GUI upon hitting 100%
+                    }
+                };
+
+                // start the worker thread
+                worker.execute();
             } else {
                 LOGGER.trace("Exiting mod finder dialog with no selection...");
             }
-
-            this.refreshGuiElements();
         });
 
         // MOD DELETE BUTTON LISTENER ---
@@ -829,7 +868,7 @@ private static JMenuBar buildMenuBarFor(Component parent) {
      */
     private void refreshGuiElements() {
         for (Runnable guiRefreshRunnable : this.guiRefreshingRunnables) {
-            guiRefreshRunnable.run();
+            new Thread(guiRefreshRunnable).start();
         }
     }