Feat: Renamed FileParser and FileManager to StockFileParser and Stock…

…FileManager, respectively.

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/Main.java

@@ -3,8 +3,8 @@
 import edu.ntnu.idi.idatt2003.g40.mappe.engine.Exchange;
 import edu.ntnu.idi.idatt2003.g40.mappe.model.Player;
 import edu.ntnu.idi.idatt2003.g40.mappe.model.Stock;
-import edu.ntnu.idi.idatt2003.g40.mappe.service.FileParser;
-import edu.ntnu.idi.idatt2003.g40.mappe.service.FileManager;
+import edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileParser;
+import edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileManager;
 import edu.ntnu.idi.idatt2003.g40.mappe.service.SaveGameService;
 import edu.ntnu.idi.idatt2003.g40.mappe.service.event.EventManager;
 import edu.ntnu.idi.idatt2003.g40.mappe.utils.ConfigValues;
@@ -86,9 +86,9 @@ public void start(final Stage stage) throws Exception {
     ViewManager viewManager = new ViewManager(stage, eventManager);
 
     List<Stock> stocksInFile;
-    FileManager parser1 = new FileManager("/sp500.csv");
+    StockFileManager parser1 = new StockFileManager("/sp500.csv");
 
-    FileParser converter1 = new FileParser();
+    StockFileParser converter1 = new StockFileParser();
     stocksInFile = converter1.getStocksFromStrings(parser1.readFile());
 
     Exchange exchange = new Exchange("Exchange", stocksInFile);

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/SaveGameService.java

@@ -1,7 +1,6 @@
 package edu.ntnu.idi.idatt2003.g40.mappe.service;
 
 import edu.ntnu.idi.idatt2003.g40.mappe.model.SaveGame;
-
 import java.io.IOException;
 import java.math.BigDecimal;
 import java.nio.charset.StandardCharsets;

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManager.java → src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManager.java

@@ -22,13 +22,13 @@
  *   to file, each stock separated by a line.</li>
  * </ul>
  *
- * <p>Used with {@link FileParser}</p>
+ * <p>Used with {@link StockFileParser}</p>
  *
- * @see FileParser
+ * @see StockFileParser
  * @author tohja
  * @version 1.0.0
  * */
-public class FileManager {
+public class StockFileManager {
 
   /** The path name this parser is using.*/
   private final String pathName;
@@ -102,7 +102,7 @@ private enum ParserRuleSet {
    *
    * @param pathName the file path name to read.
    * */
-  public FileManager(final String pathName) {
+  public StockFileManager(final String pathName) {
     this.pathName = pathName;
   }
 

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParser.java → src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParser.java

@@ -17,13 +17,13 @@
  *     list of string elements.</li>
  * </ul>
  *
- * <p>Used with {@link FileManager}</p>
+ * <p>Used with {@link StockFileManager}</p>
  *
- * @see FileManager
+ * @see StockFileManager
  * @author tohja
  * @version 1.0.0
  * */
-public class FileParser {
+public class StockFileParser {
 
   /**
    * Turns a list of valid string representations

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/TransactionFactory.java

@@ -23,7 +23,6 @@ private TransactionFactory() {
    * @param transactionType the type of transaction to create.
    * @param share the share this transaction is about.
    * @param week the week this transaction takes place in.
-   * @param calculator the calculator to use when calculating the transaction.
    *
    * @return an implementation of {@link Transaction}.
    * */

src/main/java/edu/ntnu/idi/idatt2003/g40/mappe/service/package-info.java

@@ -1,5 +1,5 @@
 /**
  * Contains classes providing modular functionality to the application,
- * such as the {@link edu.ntnu.idi.idatt2003.g40.mappe.service.FileParser}.
+ * such as the {@link edu.ntnu.idi.idatt2003.g40.mappe.service.StockFileParser}.
  * */
 package edu.ntnu.idi.idatt2003.g40.mappe.service;

src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileManagerTest.java → src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileManagerTest.java

@@ -11,12 +11,12 @@
 
 import static org.junit.jupiter.api.Assertions.*;
 
-class FileManagerTest {
+class StockFileManagerTest {
 
   private final String testStockDataPath = "/testStockData.txt";
 
   private final String absoluteTestStockDataPath = "src/main/resources/testStockData.txt";
-  FileManager fileManager;
+  StockFileManager stockFileManager;
 
   private final String validStockFromFile = "NVID, Nvidida Corporation, 241.591";
 
@@ -30,11 +30,11 @@ class FileManagerTest {
 
   @BeforeEach
   void setUp() throws Exception {
-    fileManager = new FileManager(testStockDataPath);
+    stockFileManager = new StockFileManager(testStockDataPath);
     Path path = Paths.get(absoluteTestStockDataPath);
     allLines = Files.readAllLines(path);
     try {
-      validStocks = fileManager.readFile();
+      validStocks = stockFileManager.readFile();
     } catch (Exception _) {
       throw new Exception("Test failed");
     }

src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/FileParserTest.java → src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/StockFileParserTest.java

@@ -8,9 +8,9 @@
 import java.util.ArrayList;
 import java.util.List;
 
-class FileParserTest {
+class StockFileParserTest {
 
-  private FileParser converter;
+  private StockFileParser converter;
 
   private String validStockAsString1;
   private String validStockAsString2;
@@ -33,7 +33,7 @@ void setUp() {
     allStocks.add(validStockAsString3);
     allStocks.add(invalidStockAsString1);
 
-    converter = new FileParser();
+    converter = new StockFileParser();
   }
 
   @Test

src/test/java/edu/ntnu/idi/idatt2003/g40/mappe/service/event/EventManagerTest.java

@@ -6,6 +6,7 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -28,8 +29,19 @@ private enum TestEventTypes implements EventChannel {
 
   }
 
+  /**
+   * Event manager used for testing.
+   * */
   private EventManager testEventManager;
+
+  /**
+   * Example event subscriber 1.
+   * */
   private SampleEventSubscriber sampleEventSubscriber1;
+
+  /**
+   * Example event subscriber 2.
+   * */
   private SampleEventSubscriber sampleEventSubscriber2;
 
   @BeforeEach