Implement observer pattern for game log path setting

Author: EtienneLamoureux

src/main/java/tools/sctrade/companion/domain/gamelog/FilePathObserver.java

@@ -0,0 +1,17 @@
+package tools.sctrade.companion.domain.gamelog;
+
+import java.nio.file.Path;
+
+public abstract class FilePathObserver {
+  private FilePathSubject subject;
+  protected Path filePath;
+
+  protected FilePathObserver(FilePathSubject subject) {
+    this.subject = subject;
+  }
+
+  protected void update() {
+    this.filePath = subject.getState();
+  }
+
+}

src/main/java/tools/sctrade/companion/domain/gamelog/FilePathSubject.java

@@ -0,0 +1,27 @@
+package tools.sctrade.companion.domain.gamelog;
+
+import java.nio.file.Path;
+import java.util.Collection;
+
+public abstract class FilePathSubject {
+  Collection<FilePathObserver> observers;
+  Path filePath;
+
+  public void attach(FilePathObserver observer) {
+    observers.add(observer);
+  }
+
+  public void detach(FilePathObserver observer) {
+    observers.remove(observer);
+  }
+
+  public Path getState() {
+    return filePath;
+  }
+
+  protected abstract void setState();
+
+  protected void notifyObservers() {
+    observers.forEach(n -> n.update());
+  }
+}

src/main/java/tools/sctrade/companion/domain/gamelog/GameLogListener.java

@@ -0,0 +1,10 @@
+package tools.sctrade.companion.domain.gamelog;
+
+import org.apache.commons.io.input.TailerListener;
+import org.apache.commons.io.input.TailerListenerAdapter;
+
+public class GameLogListener extends TailerListenerAdapter implements TailerListener {
+  @Override
+  public void handle(String line) {}
+
+}

src/main/java/tools/sctrade/companion/domain/gamelog/GameLogService.java src/main/java/tools/sctrade/companion/domain/gamelog/GameLogPathSubject.java

@@ -1,34 +1,49 @@
 package tools.sctrade.companion.domain.gamelog;
 
+import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.Optional;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import tools.sctrade.companion.domain.setting.Setting;
 import tools.sctrade.companion.domain.setting.SettingRepository;
 
-public class GameLogService {
-  private static final String GAME_LOG = "\\Game.log";
+public class GameLogPathSubject extends FilePathSubject {
+  static final String GAME_LOG_FILE = "Game.log";
 
-  private final Logger logger = LoggerFactory.getLogger(GameLogService.class);
+  private final Logger logger = LoggerFactory.getLogger(GameLogPathSubject.class);
 
   private SettingRepository settings;
 
-  public GameLogService(SettingRepository settings) {
+  public GameLogPathSubject(SettingRepository settings) {
+    super();
     this.settings = settings;
+    this.observers = new ArrayList<>();
+    setState();
   }
 
-  public void updateStarCitizenLivePath(String starCitizenLivePath) {
+  public void setStarCitizenLivePath(String starCitizenLivePath) {
     if (starCitizenLivePath == null || starCitizenLivePath.strip().isEmpty()) {
       logger.warn("Star Citizen LIVE path is empty");
       return;
     }
 
     starCitizenLivePath = starCitizenLivePath.strip();
     settings.set(Setting.STAR_CITIZEN_LIVE_PATH, starCitizenLivePath.replace("\\", "\\\\"));
+    setState();
   }
 
   public Optional<String> getStarCitizenLivePath() {
     return Optional.ofNullable(settings.get(Setting.STAR_CITIZEN_LIVE_PATH).toString());
   }
 
+  @Override
+  protected void setState() {
+    if (getStarCitizenLivePath().isEmpty()) {
+      return;
+    }
+
+    filePath = Path.of(getStarCitizenLivePath().get(), GAME_LOG_FILE);
+    notifyObservers();
+  }
 }

src/main/java/tools/sctrade/companion/gui/CompanionGui.java

@@ -15,7 +15,7 @@
 import javax.swing.JMenuBar;
 import javax.swing.JMenuItem;
 import javax.swing.JTabbedPane;
-import tools.sctrade.companion.domain.gamelog.GameLogService;
+import tools.sctrade.companion.domain.gamelog.GameLogPathSubject;
 import tools.sctrade.companion.domain.notification.NotificationLevel;
 import tools.sctrade.companion.domain.notification.NotificationRepository;
 import tools.sctrade.companion.domain.setting.SettingRepository;
@@ -28,12 +28,12 @@ public class CompanionGui extends JFrame implements NotificationRepository {
   private static final long serialVersionUID = -983766141308946535L;
 
   private transient UserService userService;
-  private transient GameLogService gameLogService;
+  private transient GameLogPathSubject gameLogService;
   private transient SettingRepository settings;
   private final String version;
   private LogsTab logsTab;
 
-  public CompanionGui(UserService userService, GameLogService gameLogService,
+  public CompanionGui(UserService userService, GameLogPathSubject gameLogService,
       SettingRepository settings, String version) {
     this.userService = userService;
     this.gameLogService = gameLogService;

src/main/java/tools/sctrade/companion/gui/SettingsTab.java

@@ -7,7 +7,7 @@
 import javax.swing.JTextField;
 import javax.swing.event.DocumentEvent;
 import javax.swing.event.DocumentListener;
-import tools.sctrade.companion.domain.gamelog.GameLogService;
+import tools.sctrade.companion.domain.gamelog.GameLogPathSubject;
 import tools.sctrade.companion.domain.setting.Setting;
 import tools.sctrade.companion.domain.setting.SettingRepository;
 import tools.sctrade.companion.domain.user.UserService;
@@ -16,7 +16,7 @@
 public class SettingsTab extends JPanel {
   private static final long serialVersionUID = -3532718267415423680L;
 
-  public SettingsTab(UserService userService, GameLogService gameLogService,
+  public SettingsTab(UserService userService, GameLogPathSubject gameLogService,
       SettingRepository settings) {
     super();
     setLayout(new GridBagLayout());
@@ -61,7 +61,7 @@ private void updateUsername() {
     buildLabel(2, " ");
   }
 
-  private void buildStarCitizenLivePathField(GameLogService gameLogService) {
+  private void buildStarCitizenLivePathField(GameLogPathSubject gameLogService) {
     var starCitizenLivePathLabel = buildLabel(3, LocalizationUtil.get("labelStarCitizenLivePath"));
     var starCitizenLivePathField = buildTextField(3, gameLogService.getStarCitizenLivePath().get());
     starCitizenLivePathField.putClientProperty("JTextField.placeholderText",
@@ -85,7 +85,7 @@ public void changedUpdate(DocumentEvent e) {
       }
 
       private void updateStarCitizenLivePath() {
-        gameLogService.updateStarCitizenLivePath(starCitizenLivePathField.getText());
+        gameLogService.setStarCitizenLivePath(starCitizenLivePathField.getText());
       }
     });
 

src/main/java/tools/sctrade/companion/input/FileTailer.java

@@ -0,0 +1,17 @@
+package tools.sctrade.companion.input;
+
+import tools.sctrade.companion.domain.gamelog.FilePathObserver;
+import tools.sctrade.companion.domain.gamelog.FilePathSubject;
+
+public class FileTailer extends FilePathObserver {
+
+  protected FileTailer(FilePathSubject subject) {
+    super(subject);
+  }
+
+  @Override
+  protected void update() {
+    super.update();
+  }
+
+}

src/main/java/tools/sctrade/companion/spring/AppConfig.java

@@ -21,7 +21,7 @@
 import tools.sctrade.companion.domain.commodity.CommodityRepository;
 import tools.sctrade.companion.domain.commodity.CommodityService;
 import tools.sctrade.companion.domain.commodity.CommoditySubmissionFactory;
-import tools.sctrade.companion.domain.gamelog.GameLogService;
+import tools.sctrade.companion.domain.gamelog.GameLogPathSubject;
 import tools.sctrade.companion.domain.image.ImageManipulation;
 import tools.sctrade.companion.domain.image.ImageWriter;
 import tools.sctrade.companion.domain.image.manipulations.CommodityKioskTextThreshold1;
@@ -81,12 +81,12 @@ public UserService buildUserService(SettingRepository settings) {
   }
 
   @Bean("GameLogService")
-  public GameLogService buildGameLogService(SettingRepository settings) {
-    return new GameLogService(settings);
+  public GameLogPathSubject buildGameLogService(SettingRepository settings) {
+    return new GameLogPathSubject(settings);
   }
 
   @Bean("CompanionGui")
-  public CompanionGui buildCompanionGui(UserService userService, GameLogService gameLogService,
+  public CompanionGui buildCompanionGui(UserService userService, GameLogPathSubject gameLogService,
       SettingRepository settings) {
     return new CompanionGui(userService, gameLogService, settings, getVersion());
   }