Standalone Implementation

.gitignore

@@ -1,3 +1,4 @@
 .idea/
 target/
-ConfigurationMaster.iml
+ConfigurationMaster.iml
+*.yml

API/pom.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>ConfigurationMaster</artifactId>
+        <groupId>com.github.thatsmusic99</groupId>
+        <version>v2.0.0-rc.3</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>ConfigurationMaster-API</artifactId>
+    <version>v2.0.0-rc.3</version>
+
+    <properties>
+        <maven.compiler.source>8</maven.compiler.source>
+        <maven.compiler.target>8</maven.compiler.target>
+    </properties>
+
+    <dependencies>
+
+        <dependency>
+            <groupId>org.yaml</groupId>
+            <artifactId>snakeyaml</artifactId>
+            <version>2.0</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+</project>

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/Example.java

@@ -0,0 +1,13 @@
+package io.github.thatsmusic99.configurationmaster.annotations;
+
+import java.lang.annotation.*;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+@Repeatable(Examples.class)
+public @interface Example {
+
+    String key();
+
+    String value();
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/Examples.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Examples {
+    Example[] value();
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/Option.java

@@ -0,0 +1,24 @@
+package io.github.thatsmusic99.configurationmaster.annotations;
+
+
+import io.github.thatsmusic99.configurationmaster.annotations.handlers.DefaultOptionHandler;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Option {
+
+    String path() default "";
+
+    String comment() default "";
+
+    String section() default "";
+
+    boolean lenient() default false;
+
+    Class<? extends OptionHandler> optionHandler() default DefaultOptionHandler.class;
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/OptionHandler.java

@@ -0,0 +1,27 @@
+package io.github.thatsmusic99.configurationmaster.annotations;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public interface OptionHandler {
+
+    Object get(
+            @NotNull ConfigFile file,
+            @NotNull String name
+    );
+
+    void set(
+            @NotNull ConfigFile file,
+            @NotNull String name,
+            @NotNull Object value
+    );
+
+    void addDefault(
+            @NotNull ConfigFile file,
+            @NotNull String name,
+            @NotNull Object value,
+            @Nullable String section,
+            @Nullable String comment
+    );
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/BooleanOptionHandler.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+
+public class BooleanOptionHandler extends DefaultOptionHandler {
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.getBoolean(name);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/DefaultOptionHandler.java

@@ -0,0 +1,25 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.annotations.OptionHandler;
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class DefaultOptionHandler implements OptionHandler {
+
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.get(name);
+    }
+
+    @Override
+    public void set(@NotNull ConfigFile file, @NotNull String name, @NotNull Object value) {
+        file.set(name, value);
+    }
+
+    @Override
+    public void addDefault(@NotNull ConfigFile file, @NotNull String name, @NotNull Object value, @Nullable String section, @Nullable String comment) {
+        file.addDefault(name, value, section, comment);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/FloatOptionHandler.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+
+public class FloatOptionHandler extends DefaultOptionHandler {
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.getFloat(name);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/IntegerOptionHandler.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+
+public class IntegerOptionHandler extends DefaultOptionHandler {
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.getInteger(name);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/LongOptionHandler.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+
+public class LongOptionHandler extends DefaultOptionHandler {
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.getLong(name);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/annotations/handlers/StringOptionHandler.java

@@ -0,0 +1,12 @@
+package io.github.thatsmusic99.configurationmaster.annotations.handlers;
+
+import io.github.thatsmusic99.configurationmaster.api.ConfigFile;
+import org.jetbrains.annotations.NotNull;
+
+public class StringOptionHandler extends DefaultOptionHandler {
+
+    @Override
+    public Object get(@NotNull ConfigFile file, @NotNull String name) {
+        return file.getString(name);
+    }
+}

API/src/main/java/io/github/thatsmusic99/configurationmaster/api/CommentWriter.java

@@ -0,0 +1,163 @@
+package io.github.thatsmusic99.configurationmaster.api;
+
+import io.github.thatsmusic99.configurationmaster.api.comments.Comment;
+import io.github.thatsmusic99.configurationmaster.api.comments.Section;
+
+import java.util.ArrayList;
+import java.util.List;
+
+class CommentWriter {
+
+    private final ConfigFile config;
+    // The currently written lines of the file.
+    private List<String> currentLines;
+
+    protected CommentWriter(ConfigFile config) {
+        this.config = config;
+        this.currentLines = new ArrayList<>();
+    }
+
+    /**
+     * Initiates the comment writing process.
+     */
+    protected void writeComments(List<String> currentLines) {
+        this.currentLines = currentLines;
+
+        // For each comment to be made...
+        for (String path : config.getComments().keySet()) {
+            // Write the comment at the specified path
+            writeComment(path, path.split("\\."), 0, 0);
+        }
+
+        // However, if there's any comments left, write them in.
+        for (Comment comment : config.getPendingComments()) {
+
+            String str = comment.getComment();
+            if (str.isEmpty()) {
+                currentLines.add("");
+                continue;
+            }
+            currentLines.add("");
+            String[] rawComment = str.split("\n");
+            for (String commentPart : rawComment) {
+                if (commentPart.isEmpty()) {
+                    currentLines.add("");
+                    continue;
+                }
+
+                // If we have a comment section here, use that instead
+                if (comment instanceof Section) {
+                    String section = commentPart.split(": ")[1];
+                    StringBuilder length = new StringBuilder();
+                    length.append("###");
+                    for (int j = 0; j < section.length(); j++) {
+                        length.append("#");
+                    }
+                    length.append("###");
+                    currentLines.add(length.toString());
+                    currentLines.add("#  " + section + "  #");
+                    currentLines.add(length.toString());
+                } else {
+                    currentLines.add("# " + commentPart);
+                }
+            }
+        }
+    }
+
+    /**
+     * Method used to write a specified comment.
+     *
+     * @param path The path the comment must be written at.
+     * @param divisions The number of sections the part can be split up into.
+     * @param iteration How far we're down the pathway (in terms of different sections).
+     * @param startingLine The line we're starting from.
+     */
+    private void writeComment(String path, String[] divisions, int iteration, int startingLine) {
+        StringBuilder indent = new StringBuilder();
+        for (int j = 0; j < iteration; j++) indent.append("  ");
+
+        // Go through each line in the file
+        for (int i = startingLine; i < currentLines.size(); i++) {
+            String line = currentLines.get(i);
+
+            // If the line doesn't have an equal or larger indent, then the line could not be found.
+            if (!line.startsWith(indent.toString())) return;
+
+            // If it's already a comment, leave it be.
+            if (line.startsWith("#")) continue;
+
+            //  If it's not an option (e.g. option: or 'option':), continue
+            if (!(line.startsWith(indent + divisions[iteration] + ":") ||
+                    line.startsWith(indent + "'" + divisions[iteration] + "':"))) continue;
+
+            // Increment the iteration
+            iteration += 1;
+
+            // If the
+            if (iteration != divisions.length) {
+                writeComment(path, divisions, iteration, i + 1);
+                continue;
+            }
+
+            // Get the current line we're on
+            int currentLine = i;
+
+            //
+            List<Comment> comments = config.getComments().get(path);
+            if (comments == null || comments.isEmpty()) continue;
+
+            for (Comment comment : comments) {
+
+                // Add an empty line before a single-
+                if (iteration == 1) {
+                    currentLines.add(currentLine, "");
+                    currentLine++;
+                }
+
+                if (comment == null || comment.getComment().isEmpty()) {
+                    currentLines.add(currentLine, "");
+                } else {
+
+                    String commentStr = comment.getComment();
+                    String[] commentParts = commentStr.split("\n");
+
+                    if (comment instanceof Section) {
+
+                        // Get the maximum length
+                        int max = 0;
+                        for (String commentPart : commentParts) {
+                            max = Math.max(commentPart.length(), max);
+                        }
+
+                        // Build the
+                        StringBuilder length = new StringBuilder();
+                        length.append("###");
+                        for (int j = 0; j < max; j++) {
+                            length.append("#");
+                        }
+                        length.append("###");
+                        currentLines.add(currentLine, length.toString());
+                        currentLine++;
+                        for (String commentPart : commentParts) {
+                            currentLines.add(currentLine, "#  " + commentPart + "  #");
+                            currentLine++;
+                        }
+                        currentLines.add(currentLine, length.toString());
+                        currentLine++;
+                        continue;
+                    }
+
+                    for (String commentPart : commentParts) {
+                        currentLines.add(currentLine, indent + "# " + commentPart);
+                        currentLine++;
+                    }
+                }
+            }
+            break;
+        }
+    }
+
+    protected List<String> getLines() {
+        return currentLines;
+    }
+}