Merge pull request #5 from Pixel-Services/FlashConfiguration

FlashConfiguration Class and Configuration Testing

Author: sieadev

pom.xml

@@ -28,6 +28,13 @@
         </repository>
     </distributionManagement>
 
+    <repositories>
+        <repository>
+            <id>jitpack.io</id>
+            <url>https://jitpack.io</url>
+        </repository>
+    </repositories>
+
     <dependencies>
         <!-- JSON Parsing -->
         <dependency>
@@ -36,6 +43,13 @@
             <version>20240303</version>
         </dependency>
 
+        <!-- YAML Parsing -->
+        <dependency>
+            <groupId>com.github.Carleslc.Simple-YAML</groupId>
+            <artifactId>Simple-Yaml</artifactId>
+            <version>1.8.4</version>
+        </dependency>
+
         <!-- Logging -->
         <dependency>
             <groupId>org.slf4j</groupId>

src/main/java/flash/TestServer.java

@@ -1,5 +1,6 @@
 package flash;
 
+import flash.config.FlashConfiguration;
 import flash.route.RouteController;
 
 import static flash.Flash.*;
@@ -18,5 +19,10 @@ public static void main(String[] args) {
 
         // Start the server
         init();
+
+        // Load & Test Config
+        FlashConfiguration config = new FlashConfiguration();
+        config.set("test", "Hello from the config!");
+        System.out.println(config.get("test"));
     }
 }

src/main/java/flash/config/FlashConfiguration.java

@@ -0,0 +1,95 @@
+package flash.config;
+
+import org.simpleyaml.configuration.file.YamlConfiguration;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+
+/**
+ * The FlashConfiguration class provides utility methods for loading, saving, and managing YAML configuration files.
+ */
+public class FlashConfiguration extends YamlConfiguration {
+    private static final Logger logger = LoggerFactory.getLogger(FlashConfiguration.class);
+    private final File file;
+
+    /**
+     * Constructs a FlashConfiguration instance of the default configuration file.
+     */
+    public FlashConfiguration() {
+        this("config.yml");
+    }
+
+    /**
+     * Constructs a FlashConfiguration instance with a specified file path.
+     *
+     * @param path the path to the configuration file.
+     */
+    public FlashConfiguration(String path) {
+        this(getFile(path));
+    }
+
+    /**
+     * Constructs a FlashConfiguration instance with a specified file.
+     *
+     * @param file the configuration file.
+     */
+    private FlashConfiguration(File file) {
+        super(loadConfig(file));
+        this.file = file;
+    }
+
+    /**
+     * Loads a YamlConfiguration from a file.
+     *
+     * @param file the configuration file to load
+     * @return the loaded YamlConfiguration
+     */
+    private static YamlConfiguration loadConfig(File file) {
+        try {
+            return YamlConfiguration.loadConfiguration(file);
+        } catch (IOException e) {
+            logger.error("Failed to load configuration file: {}", file.getPath(), e);
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * Retrieves the configuration file.
+     *
+     * @param path the path to the configuration file.
+     * @return the configuration file
+     */
+    private static File getFile(String path) {
+        File file = new File(path);
+        try {
+            if (!file.exists()) {
+                try (InputStream resourceStream = FlashConfiguration.class.getClassLoader().getResourceAsStream(file.getName())) {
+                    if (resourceStream != null) {
+                        Files.copy(resourceStream, file.toPath());
+                    } else {
+                        file.createNewFile();
+                    }
+                }
+            }
+            return file;
+        } catch (IOException e) {
+            logger.error("Failed to create configuration file: {}", path, e);
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * Saves the configuration file to disk.
+     */
+    public void save() {
+        try {
+            save(file);
+        } catch (IOException e) {
+            logger.error("Failed to save configuration file: {}", file.getPath(), e);
+        }
+    }
+}