Structure refactor

.github/workflows/maven.yml

@@ -25,3 +25,13 @@ jobs:
     - name: Test with Maven
       run: mvn -B test --file pom.xml
 
+    - name: Build site + JavaDocs & JaCoCo
+      run: mvn clean verify site
+
+    - name: Deploy to Github Pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: target/site/
+        publish_branch: gh-pages
+

pom.xml

@@ -20,51 +20,21 @@
             <artifactId>maven-compiler-plugin</artifactId>
             <version>3.14.1</version>
         </dependency>
-
-        <dependency>
-            <groupId>org.apache.maven.plugins</groupId>
-            <artifactId>maven-javadoc-plugin</artifactId>
-            <version>3.12.0</version>
-        </dependency>
 
         <dependency>
             <groupId>org.openjfx</groupId>
             <artifactId>javafx-controls</artifactId>
             <version>25.0.1</version>
         </dependency>
-
-        <dependency>
-            <groupId>org.openjfx</groupId>
-            <artifactId>javafx-fxml</artifactId>
-            <version>25.0.1</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.openjfx</groupId>
-            <artifactId>javafx-web</artifactId>
-            <version>25.0.1</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.openjfx</groupId>
-            <artifactId>javafx-swing</artifactId>
-            <version>25.0.1</version>
-        </dependency>
-
-        <dependency>
-            <groupId>org.openjfx</groupId>
-            <artifactId>javafx-media</artifactId>
-            <version>25.0.1</version>
-        </dependency>
 
          <dependency>
               <groupId>org.junit.jupiter</groupId>
               <artifactId>junit-jupiter</artifactId>
               <version>6.0.1</version>
             <scope>test</scope>
-         </dependency>
+    </dependency>
 
-    </dependencies>
+  </dependencies>
 
     <build>
 
@@ -82,32 +52,61 @@
                 <artifactId>javafx-maven-plugin</artifactId>
                 <version>0.0.8</version>
                     <configuration>
-                        <mainClass>edu.ntnu.idi.idatt.gui.javafx</mainClass>
+                        <mainClass>edu.ntnu.idi.idatt.Launcher</mainClass>
                     </configuration>
             </plugin>
 
-            <plugin>
-                <groupId>org.codehaus.mojo</groupId> <!-- Lett running fra ide -->
-                <artifactId>exec-maven-plugin</artifactId>
-                <version>3.6.3</version> <!-- Sjekkk versjon her -->
-                <configuration>
-                    <mainClass>edu.ntnu.idi.idatt.Main</mainClass>
-                </configuration>
-            </plugin>
-
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId> <!-- Skippe manifest.mf declaration her -->
-                <artifactId>maven-jar-plugin</artifactId>
-                <version>3.3.0</version> <!-- SJEKK VERSJON HER Å -->
-                <configuration>
-                    <archive>
-                        <manifest>
-                            <addClasspath>true</addClasspath>
-                            <mainClass>edu.ntnu.idi.idatt.Main</mainClass>
-                        </manifest>
-                    </archive>
-                </configuration>
-            </plugin>
+      <plugin> <!-- JavaDoc generation plugin -->
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.12.0</version>
+      </plugin>
+
+
+    <plugin>
+      <groupId>org.jacoco</groupId>
+      <artifactId>jacoco-maven-plugin</artifactId>
+      <version>0.8.14</version>
+
+      <executions>
+        <!-- 1. Attach JaCoCo agent before tests -->
+        <execution>
+          <id>prepare-agent</id>
+          <goals>
+            <goal>prepare-agent</goal>
+          </goals>
+        </execution>
+
+        <!-- 2. Generate report after tests -->
+        <execution>
+          <id>report</id>
+          <phase>verify</phase>
+          <goals>
+            <goal>report</goal>
+          </goals>
+        </execution>
+      </executions>
+      </plugin> 
+
+      <plugin> <!-- Display site folder -->
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-site-plugin</artifactId>
+        <version>4.0.0-M9</version>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId> <!-- Skippe manifest.mf declaration her -->
+        <artifactId>maven-jar-plugin</artifactId>
+        <version>3.3.0</version>
+          <configuration>
+            <archive>
+              <manifest>
+                <addClasspath>true</addClasspath>
+                <mainClass>edu.ntnu.idi.idatt.Launcher</mainClass>
+              </manifest>
+            </archive>
+          </configuration>
+      </plugin>
 
        </plugins>
     </build>

src/main/java/edu/ntnu/idi/idatt/Launcher.java

@@ -0,0 +1,30 @@
+package edu.ntnu.idi.idatt;
+
+import javafx.application.Application;
+import javafx.scene.Scene;
+import javafx.scene.layout.VBox;
+import javafx.stage.Stage;
+
+public final class Launcher {
+
+  /**
+   * Entry point of application.
+   */
+  static void main() {
+    Application.launch(StockGame.class);
+  }
+
+  public static final class StockGame extends Application {
+
+    @Override
+    public void start(Stage stage) {
+      stage.setWidth(1200);
+      stage.setHeight(700);
+      stage.setTitle("Stock Game");
+      stage.setScene(new Scene(new VBox()));
+      stage.show();
+    }
+
+  }
+
+}

src/main/java/edu/ntnu/idi/idatt/common/Observer.java

@@ -0,0 +1,6 @@
+package edu.ntnu.idi.idatt.common;
+
+public interface Observer {
+
+  void update();
+}

src/main/java/edu/ntnu/idi/idatt/Exchange.java → src/main/java/edu/ntnu/idi/idatt/model/Exchange.java

@@ -1,16 +1,16 @@
-package edu.ntnu.idi.idatt;
-
-import edu.ntnu.idi.idatt.file.ExchangeLoader;
-import edu.ntnu.idi.idatt.marked.Share;
-import edu.ntnu.idi.idatt.marked.Stock;
-import edu.ntnu.idi.idatt.transaction.Purchase;
-import edu.ntnu.idi.idatt.transaction.Sale;
-import edu.ntnu.idi.idatt.transaction.Transaction;
+package edu.ntnu.idi.idatt.model;
 
 import java.io.IOException;
 import java.math.BigDecimal;
 import java.util.*;
-import java.util.stream.Collectors;
+
+import edu.ntnu.idi.idatt.model.market.Stock;
+import edu.ntnu.idi.idatt.model.player.Player;
+import edu.ntnu.idi.idatt.model.portfolio.Share;
+import edu.ntnu.idi.idatt.model.transaction.Purchase;
+import edu.ntnu.idi.idatt.model.transaction.Sale;
+import edu.ntnu.idi.idatt.model.transaction.Transaction;
+import edu.ntnu.idi.idatt.storage.ExchangeLoader;
 
 /**
  * Exchange class
@@ -32,8 +32,8 @@ public class Exchange extends ExchangeLoader {
   /**
    * Constructor for Exchange class
    *
-   * @param name   - Name of the current stock Exchange
-   * @param stocks - List of aviable stocks for this exchange.
+   * @param name - Name of the current stock Exchange
+   * @param path - Path to .csv file.
    */
   public Exchange(String name, String path) {
     super(path);
@@ -180,7 +180,7 @@ public Transaction buy(String symbol, BigDecimal quantity, Player player) {
    * 
    * @see Sale
    *
-   * @param Share  - The instance of the sold share.
+   * @param share  - The instance of the sold share.
    * @param player - which player did this event.
    * @return The given transaction details. (Transaction).
    * @see Transaction

src/main/java/edu/ntnu/idi/idatt/marked/Stock.java → src/main/java/edu/ntnu/idi/idatt/model/market/Stock.java

@@ -1,4 +1,4 @@
-package edu.ntnu.idi.idatt.marked;
+package edu.ntnu.idi.idatt.model.market;
 
 import java.math.BigDecimal;
 import java.util.ArrayList;

src/main/java/edu/ntnu/idi/idatt/Player.java → src/main/java/edu/ntnu/idi/idatt/model/player/Player.java

@@ -1,11 +1,9 @@
-package edu.ntnu.idi.idatt;
+package edu.ntnu.idi.idatt.model.player;
 
-import edu.ntnu.idi.idatt.marked.Portfolio;
-import edu.ntnu.idi.idatt.transaction.TransactionArchive;
+import edu.ntnu.idi.idatt.model.portfolio.Portfolio;
+import edu.ntnu.idi.idatt.model.transaction.TransactionArchive;
 
 import java.math.BigDecimal;
-import java.util.HashSet;
-import java.util.Map;
 
 public class Player {
 

src/main/java/edu/ntnu/idi/idatt/marked/Portfolio.java → src/main/java/edu/ntnu/idi/idatt/model/portfolio/Portfolio.java

@@ -1,11 +1,10 @@
-package edu.ntnu.idi.idatt.marked;
+package edu.ntnu.idi.idatt.model.portfolio;
 
 import java.math.BigDecimal;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.stream.Collectors;
 
-import edu.ntnu.idi.idatt.calculator.SaleCalculator;
+import edu.ntnu.idi.idatt.service.transaction.SaleCalculator;
 
 /**
  * Portfolio class

src/main/java/edu/ntnu/idi/idatt/marked/Share.java → src/main/java/edu/ntnu/idi/idatt/model/portfolio/Share.java

@@ -1,7 +1,9 @@
-package edu.ntnu.idi.idatt.marked;
+package edu.ntnu.idi.idatt.model.portfolio;
 
 import java.math.BigDecimal;
 
+import edu.ntnu.idi.idatt.model.market.Stock;
+
 /**
  * Share class
  *

src/main/java/edu/ntnu/idi/idatt/transaction/Purchase.java → src/main/java/edu/ntnu/idi/idatt/model/transaction/Purchase.java

@@ -1,8 +1,8 @@
-package edu.ntnu.idi.idatt.transaction;
+package edu.ntnu.idi.idatt.model.transaction;
 
-import edu.ntnu.idi.idatt.Player;
-import edu.ntnu.idi.idatt.calculator.PurchaseCalculator;
-import edu.ntnu.idi.idatt.marked.Share;
+import edu.ntnu.idi.idatt.model.player.Player;
+import edu.ntnu.idi.idatt.model.portfolio.Share;
+import edu.ntnu.idi.idatt.service.transaction.PurchaseCalculator;
 
 /**
  * Purchase class

src/main/java/edu/ntnu/idi/idatt/transaction/Sale.java → src/main/java/edu/ntnu/idi/idatt/model/transaction/Sale.java

@@ -1,8 +1,8 @@
-package edu.ntnu.idi.idatt.transaction;
+package edu.ntnu.idi.idatt.model.transaction;
 
-import edu.ntnu.idi.idatt.Player;
-import edu.ntnu.idi.idatt.calculator.SaleCalculator;
-import edu.ntnu.idi.idatt.marked.Share;
+import edu.ntnu.idi.idatt.model.player.Player;
+import edu.ntnu.idi.idatt.model.portfolio.Share;
+import edu.ntnu.idi.idatt.service.transaction.SaleCalculator;
 
 /**
  * Sale class

src/main/java/edu/ntnu/idi/idatt/transaction/Transaction.java → src/main/java/edu/ntnu/idi/idatt/model/transaction/Transaction.java

@@ -1,8 +1,8 @@
-package edu.ntnu.idi.idatt.transaction;
+package edu.ntnu.idi.idatt.model.transaction;
 
-import edu.ntnu.idi.idatt.Player;
-import edu.ntnu.idi.idatt.calculator.TransactionCalculator;
-import edu.ntnu.idi.idatt.marked.Share;
+import edu.ntnu.idi.idatt.model.player.Player;
+import edu.ntnu.idi.idatt.model.portfolio.Share;
+import edu.ntnu.idi.idatt.service.transaction.TransactionCalculator;
 
 /**
  * Transaction class

src/main/java/edu/ntnu/idi/idatt/transaction/TransactionArchive.java → src/main/java/edu/ntnu/idi/idatt/model/transaction/TransactionArchive.java

@@ -1,4 +1,4 @@
-package edu.ntnu.idi.idatt.transaction;
+package edu.ntnu.idi.idatt.model.transaction;
 
 import java.util.ArrayList;
 import java.util.List;

src/main/java/edu/ntnu/idi/idatt/calculator/PurchaseCalculator.java → src/main/java/edu/ntnu/idi/idatt/service/transaction/PurchaseCalculator.java

@@ -1,9 +1,9 @@
-package edu.ntnu.idi.idatt.calculator;
-
-import edu.ntnu.idi.idatt.marked.Share;
+package edu.ntnu.idi.idatt.service.transaction;
 
 import java.math.BigDecimal;
 
+import edu.ntnu.idi.idatt.model.portfolio.Share;
+
 /**
  * PurchaseCalculator class
  *

src/main/java/edu/ntnu/idi/idatt/calculator/SaleCalculator.java → src/main/java/edu/ntnu/idi/idatt/service/transaction/SaleCalculator.java

@@ -1,6 +1,6 @@
-package edu.ntnu.idi.idatt.calculator;
+package edu.ntnu.idi.idatt.service.transaction;
 
-import edu.ntnu.idi.idatt.marked.Share;
+import edu.ntnu.idi.idatt.model.portfolio.Share;
 
 import java.math.BigDecimal;
 

src/main/java/edu/ntnu/idi/idatt/calculator/TransactionCalculator.java → src/main/java/edu/ntnu/idi/idatt/service/transaction/TransactionCalculator.java

@@ -1,4 +1,4 @@
-package edu.ntnu.idi.idatt.calculator;
+package edu.ntnu.idi.idatt.service.transaction;
 
 import java.math.BigDecimal;