v1.1.5

v1.1.5
- Added inline comments
- Added chained keys/paths
- Fixed small issues

Author: Manered

.idea/.gitignore

@@ -3,7 +3,7 @@ plugins {
 }
 
 group = 'dev.manere.inscript'
-version = '1.1.4'
+version = '1.1.5'
 
 repositories {
     mavenCentral()
@@ -14,6 +14,13 @@ dependencies {
     annotationProcessor('org.jetbrains:annotations:24.0.0')
     implementation('com.google.errorprone:error_prone_annotations:2.36.0')
     annotationProcessor('com.google.errorprone:error_prone_annotations:2.36.0')
+
+    testImplementation(platform('org.junit:junit-bom:5.10.0'))
+    testImplementation('org.junit.jupiter:junit-jupiter')
+}
+
+test {
+    useJUnitPlatform()
 }
 
 jar {

.idea/gradle.xml

@@ -44,6 +44,17 @@ default boolean isRoot() {
 
     @NotNull
     default Optional<ConfigNode> getNode(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return Optional.empty();
+                current = next.get();
+            }
+            return current.getNode(parts[parts.length - 1]);
+        }
+
         for (final ConfigNode node : getChildren()) if (node.getKey().equals(key)) return Optional.of(node);
         return Optional.empty();
     }
@@ -68,6 +79,16 @@ default boolean isScalar(final @NotNull String key) {
     @NotNull
     @CanIgnoreReturnValue
     default ConfigSection section(final @NotNull String key, final @NotNull Consumer<ConfigSection> handler) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (String part : parts) {
+                current = current.getSection(part).orElse(current.createSection(part));
+            }
+            handler.accept(current);
+            return this;
+        }
+
         handler.accept(getSection(key).orElse(createSection(key)));
         return this;
     }
@@ -93,6 +114,18 @@ default boolean contains(final @NotNull String key) {
     @NotNull
     @CanIgnoreReturnValue
     default ConfigSection unset(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return this;
+                current = next.get();
+            }
+            current.unset(parts[parts.length - 1]);
+            return this;
+        }
+
         getNode(key).ifPresent(node -> getSection().getChildren().remove(node));
         return this;
     }
@@ -141,6 +174,18 @@ default ConfigSection forEach(final @NotNull Consumer<ScalarNode<?>> scalarConsu
     @NotNull
     @CanIgnoreReturnValue
     default ConfigSection comment(final @NotNull String key, final @NotNull Collection<? extends String> comments) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return this;
+                current = next.get();
+            }
+            current.comment(parts[parts.length - 1], comments);
+            return this;
+        }
+
         getNode(key).ifPresent(node -> {
             node.getComments().clear();
             node.getComments().addAll(comments);
@@ -151,6 +196,17 @@ default ConfigSection comment(final @NotNull String key, final @NotNull Collecti
 
     @NotNull
     default Collection<String> getComments(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return Set.of();
+                current = next.get();
+            }
+            return current.getComments(parts[parts.length - 1]);
+        }
+
         final ConfigNode node = getNode(key).orElse(null);
         if (node == null) return Set.of();
 
@@ -163,6 +219,55 @@ default ConfigSection comment(final @NotNull String key, final @NotNull String @
         return comment(key, Arrays.asList(comments));
     }
 
+    @NotNull
+    @CanIgnoreReturnValue
+    default ConfigSection inlineComment(final @NotNull String key, final @NotNull Collection<? extends String> comments) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return this;
+                current = next.get();
+            }
+            current.inlineComment(parts[parts.length - 1], comments);
+            return this;
+        }
+
+        getNode(key).ifPresent(node -> {
+            node.getInlineComments().clear();
+            node.getInlineComments().addAll(comments);
+        });
+
+        return this;
+    }
+
+    @NotNull
+    @CanIgnoreReturnValue
+    default ConfigSection inlineComment(final @NotNull String key, final @NotNull String @NotNull ... comments) {
+        return inlineComment(key, Arrays.asList(comments));
+    }
+
+    @NotNull
+    @Unmodifiable
+    default Collection<String> getInlineComments(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return Set.of();
+                current = next.get();
+            }
+            return current.getInlineComments(parts[parts.length - 1]);
+        }
+
+        final ConfigNode node = getNode(key).orElse(null);
+        if (node == null) return Set.of();
+
+        return Set.copyOf(node.getInlineComments());
+    }
+
     @NotNull
     default String getKey() {
         return getSection().getKey();

.idea/markdown.xml

@@ -34,7 +34,7 @@ public static Inscript newInscript(final @NotNull Path source) {
         for (final FileFormat format : FileFormats.FORMATS) {
             final Collection<String> extensions = format.getValidFileExtensions();
             for (final String extension : extensions) {
-                if (file.endsWith("." + extension)) {
+                if (file.toString().endsWith("." + extension)) {
                     return new Inscript(source, format);
                 }
             }
@@ -61,6 +61,11 @@ public static Inscript newInscript(final @NotNull FileFormat format) {
         return new Inscript(null, format);
     }
 
+    @NotNull
+    public static Builder builder() {
+        return new Builder();
+    }
+
     @NotNull
     public static ValueRegistry getRegistry() {
         return ValueRegistry.REGISTRY;
@@ -136,4 +141,26 @@ public void loadFromString(final @NotNull String configString) {
             throw new InscriptException(e);
         }
     }
+
+    public static class Builder {
+        private Path path;
+        private FileFormat format;
+
+        public Builder path(Path path) {
+            this.path = path;
+            return this;
+        }
+
+        public Builder format(FileFormat format) {
+            this.format = format;
+            return this;
+        }
+
+        public Inscript build() {
+            if (format == null) {
+                throw new InscriptException("Format must be specified");
+            }
+            return new Inscript(path, format);
+        }
+    }
 }

.idea/misc.xml

@@ -9,7 +9,6 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.*;
-import java.util.concurrent.ConcurrentHashMap;
 
 public record SimpleConfigSection(@NotNull SectionNode sectionNode) implements ConfigSection {
     @Override
@@ -19,12 +18,32 @@ public record SimpleConfigSection(@NotNull SectionNode sectionNode) implements C
 
     @Override
     public @NotNull Optional<ConfigSection> getSection(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (String part : parts) {
+                Optional<ConfigSection> next = current.getSection(part);
+                if (next.isEmpty()) return Optional.empty();
+                current = next.get();
+            }
+            return Optional.of(current);
+        }
+
         final ConfigNode node = getNode(key).orElse(null);
         return !(node instanceof SectionNode childSection) ? Optional.empty() : Optional.of(new SimpleConfigSection(childSection));
     }
 
     @Override
     public @NotNull ConfigSection createSection(final @NotNull String key) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (String part : parts) {
+                current = current.getSection(part).orElse(current.createSection(part));
+            }
+            return current;
+        }
+
         if (key.equalsIgnoreCase(InscriptConstants.ROOT_SECTION_KEY.getValue())) throw new IllegalArgumentException("Illegal attempt to create a root section.");
 
         final Optional<ConfigSection> sectionFound = getSection(key);
@@ -50,6 +69,17 @@ public String getKey() {
 
     @Override
     public @NotNull <T> Optional<T> get(final @NotNull String key, final @NotNull Class<? extends T> ignoredType) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return Optional.empty();
+                current = next.get();
+            }
+            return current.get(parts[parts.length - 1], ignoredType);
+        }
+
         final ConfigNode node = getNode(key).orElse(null);
         if (node == null) return Optional.empty();
 
@@ -75,6 +105,17 @@ public String getKey() {
 
     @Override
     public @NotNull <T> List<T> getList(final @NotNull String key, final @NotNull Class<? extends T> ignoredType) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                Optional<ConfigSection> next = current.getSection(parts[i]);
+                if (next.isEmpty()) return Collections.synchronizedList(new ArrayList<>());
+                current = next.get();
+            }
+            return current.getList(parts[parts.length - 1], ignoredType);
+        }
+
         final ConfigNode node = getNode(key).orElse(null);
         if (node == null) return Collections.synchronizedList(new ArrayList<>());
         if (!(node instanceof ScalarNode<?> scalar)) return Collections.synchronizedList(new ArrayList<>());
@@ -88,6 +129,16 @@ public String getKey() {
 
     @Override
     public @NotNull <T> ConfigSection set(final @NotNull String key, final @Nullable T value) {
+        if (key.contains(".")) {
+            String[] parts = key.split("\\.");
+            ConfigSection current = this;
+            for (int i = 0; i < parts.length - 1; i++) {
+                current = current.getSection(parts[i]).orElse(current.createSection(parts[i]));
+            }
+            current.set(parts[parts.length - 1], value);
+            return this;
+        }
+
         unset(key);
         if (value == null) return this;