#141 Change CoreConfigurationBuilder to set appropriate source for files and resources (#147)

Author: rbygrave

avaje-config/src/main/java/io/avaje/config/CoreConfigurationBuilder.java

@@ -6,7 +6,6 @@
 import java.io.FileReader;
 import java.io.IOException;
 import java.io.UncheckedIOException;
-import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.Properties;
 import java.util.ServiceLoader;
@@ -18,7 +17,7 @@
 final class CoreConfigurationBuilder implements Configuration.Builder {
 
   private final Parsers parsers = new Parsers();
-  private final Map<String, String> sourceMap = new LinkedHashMap<>();
+  private final CoreEntry.CoreMap sourceMap = CoreEntry.newMap();
   private ResourceLoader resourceLoader = initialiseResourceLoader();
   private ModificationEventRunner eventRunner;
   private ConfigurationLog configurationLog;
@@ -47,7 +46,7 @@ public Configuration.Builder resourceLoader(ResourceLoader resourceLoader) {
   public Configuration.Builder put(String key, String value) {
     requireNonNull(key);
     requireNonNull(value);
-    sourceMap.put(key, value);
+    sourceMap.put(key, value, "initial");
     return this;
   }
 
@@ -56,7 +55,7 @@ public Configuration.Builder putAll(Map<String, ?> source) {
     requireNonNull(source);
     source.forEach((key, value) -> {
       if (key != null && value != null) {
-        put(key, value.toString());
+        sourceMap.put(key, value.toString(), "initial");
       }
     });
     return this;
@@ -67,7 +66,7 @@ public Configuration.Builder putAll(Properties source) {
     requireNonNull(source);
     source.forEach((key, value) -> {
       if (key != null && value != null) {
-        put(key.toString(), value.toString());
+        sourceMap.put(key.toString(), value.toString(), "initial");
       }
     });
     return this;
@@ -79,7 +78,8 @@ public Configuration.Builder load(String resource) {
     try {
       try (var inputStream = resourceLoader.getResourceAsStream(resource)) {
         if (inputStream != null) {
-          putAll(configParser.load(inputStream));
+          var source = "resource:" + resource;
+          configParser.load(inputStream).forEach((k, v) -> sourceMap.put(k, v, source));
         }
         return this;
       }
@@ -96,7 +96,8 @@ public Configuration.Builder load(File file) {
     final var configParser = parser(file.getName());
     try {
       try (var reader = new FileReader(file)) {
-        putAll(configParser.load(reader));
+        var source = "file:" + file.getName();
+        configParser.load(reader).forEach((k, v) -> sourceMap.put(k, v, source));
         return this;
       }
     } catch (IOException e) {
@@ -144,7 +145,7 @@ public Configuration build() {
 
   private CoreEntry.CoreMap initEntries() {
     final var entries = initEntryMap();
-    sourceMap.forEach((key, value) -> entries.put(key, value, "initial"));
+    entries.addAll(sourceMap);
     return CoreExpressionEval.evalFor(entries);
   }
 

avaje-config/src/main/java/io/avaje/config/CoreEntry.java

@@ -119,6 +119,13 @@ static class CoreMap {
       });
     }
 
+    /**
+     * Add all the entries from another source.
+     */
+    void addAll(CoreMap source) {
+      entryMap.putAll(source.entryMap);
+    }
+
     int size() {
       return entryMap.size();
     }

avaje-config/src/test/java/io/avaje/config/CoreConfigurationTest.java

@@ -181,6 +181,16 @@ void builder() {
     assertEquals(conf.get("myExtraOne"), "baz");
     assertEquals(conf.get("my.name"), "Nom");
     assertEquals(conf.get("hi.iAmInProps"), "There it is");
+    var entry = conf.entry("hi.iAmInProps");
+    assertThat(entry).isPresent().get().satisfies(e -> {
+      assertThat(e.source()).isEqualTo("resource:hi.properties");
+      assertThat(e.value()).isEqualTo("There it is");
+    });
+    var entryFile = conf.entry("my.name");
+    assertThat(entryFile).isPresent().get().satisfies(e -> {
+      assertThat(e.source()).isEqualTo("file:minimal.yaml");
+      assertThat(e.value()).isEqualTo("Nom");
+    });
 
     String userHome = System.getProperty("user.home");
     assertEquals(conf.get("myHome"), "my/" + userHome + "/home");