Merge #419 from '381-setreplaceUsingFilemapKeyset' of https://github.com/metafacture/metafacture-core

Author: dr0i

metafacture-commons/src/main/java/org/metafacture/commons/tries/SetReplacer.java

@@ -54,8 +54,8 @@ public void addReplacement(final String toReplace, final String replacement) {
      * @param replacements the Map of Strings to be replaced
      */
     public void addReplacements(final Map<String, String> replacements) {
-        for (final Entry<String, String> entry : replacements.entrySet()) {
-            addReplacement(entry.getKey(), entry.getValue());
+        for (final String k : replacements.keySet()) {
+            addReplacement(k, replacements.get(k));
         }
     }
 

metamorph-api/src/main/java/org/metafacture/metamorph/api/helpers/AbstractReadOnlyMap.java

@@ -21,8 +21,9 @@
 import java.util.Set;
 
 /**
- * Base class for maps which are read only and do not allow access to their
- * full contents.
+ * Base class for maps which are read only. Allows access to the key set. It's
+ * up to the extending class when overriding {@link #keySet()} to return an
+ * {@link java.util.Collections#unmodifiableSet(Set)}.
  *
  * @param <K> type of keys
  * @param <V> type of values
@@ -41,7 +42,7 @@ public final boolean isEmpty() {
     }
 
     @Override
-    public final boolean containsKey(final Object key) {
+    public boolean containsKey(final Object key) {
         return get(key) != null;
     }
 
@@ -71,8 +72,12 @@ public final void clear() {
         throw new UnsupportedOperationException();
     }
 
+    /**
+     * It's up to the extending class to return an
+     * {@link java.util.Collections#unmodifiableSet(Set)} when overriding.
+     */
     @Override
-    public final Set<K> keySet() {
+    public Set<K> keySet() {
         throw new UnsupportedOperationException();
     }
 

metamorph/src/main/java/org/metafacture/metamorph/maps/FileMap.java

@@ -29,9 +29,11 @@
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import java.util.regex.Pattern;
 
 /**
@@ -148,4 +150,9 @@ public String get(final Object key) {
         return map.get(key);
     }
 
+    @Override
+    public Set<String> keySet() {
+        return Collections.unmodifiableSet(map.keySet());
+    }
+
 }

metamorph/src/test/java/org/metafacture/metamorph/maps/FileMapTest.java

@@ -39,17 +39,20 @@ public final class FileMapTest {
     @Mock
     private StreamReceiver receiver;
 
+    private static String MORPH =
+        "<rules>" +
+        "  <data source='1'>" +
+        "    <%s='map1' />" +
+        "  </data>" +
+        "</rules>" +
+        "<maps>" +
+        "  <filemap name='map1' files='org/metafacture/metamorph/maps/" +
+        "file-map-test.txt' />" +
+        "</maps>";
+
     @Test
     public void shouldLookupValuesInFileBasedMap() {
-        assertMorph(receiver,
-                "<rules>" +
-                "  <data source='1'>" +
-                "    <lookup in='map1' />" +
-                "  </data>" +
-                "</rules>" +
-                "<maps>" +
-                "  <filemap name='map1' files='org/metafacture/metamorph/maps/file-map-test.txt' />" +
-                "</maps>",
+        assertMorph(receiver, String.format(MORPH, "lookup in"),
                 i -> {
                     i.startRecord("1");
                     i.literal("1", "gw");
@@ -67,15 +70,7 @@ public void shouldLookupValuesInFileBasedMap() {
 
     @Test
     public void shouldWhitelistValuesInFileBasedMap() {
-        assertMorph(receiver,
-                "<rules>" +
-                "  <data source='1'>" +
-                "    <whitelist map='map1' />" +
-                "  </data>" +
-                "</rules>" +
-                "<maps>" +
-                "  <filemap name='map1' files='org/metafacture/metamorph/maps/file-map-test.txt' />" +
-                "</maps>",
+        assertMorph(receiver, String.format(MORPH, "whitelist map"),
                 i -> {
                     i.startRecord("1");
                     i.literal("1", "gw");
@@ -92,4 +87,22 @@ public void shouldWhitelistValuesInFileBasedMap() {
         );
     }
 
+    @Test
+    public void shouldReplaceValuesUsingFileBasedMap() {
+        assertMorph(receiver, String.format(MORPH, "setreplace map"),
+                i -> {
+                    i.startRecord("1");
+                    i.literal("1", "gw-fj: 1:1");
+                    i.literal("1", "fj-gw: 0:0");
+                    i.endRecord();
+                },
+                o -> {
+                    o.get().startRecord("1");
+                    o.get().literal("1", "Germany-Fiji: 1:1");
+                    o.get().literal("1", "Fiji-Germany: 0:0");
+                    o.get().endRecord();
+                }
+        );
+    }
+
 }