From 939ef0b283cced9da044cd185c3a5982330a5528 Mon Sep 17 00:00:00 2001
From: marhali <me@marhali.de>
Date: Wed, 12 Jan 2022 09:04:06 +0100
Subject: [PATCH] introduce improved key path representation models

---
 .../de/marhali/easyi18n/model/KeyPath.java    | 30 ++++++++
 .../easyi18n/model/KeyPathConverter.java      | 69 +++++++++++++++++++
 .../de/marhali/easyi18n/util/PathUtil.java    |  2 +
 .../easyi18n/KeyPathConverterTest.java        | 53 ++++++++++++++
 4 files changed, 154 insertions(+)
 create mode 100644 src/main/java/de/marhali/easyi18n/model/KeyPath.java
 create mode 100644 src/main/java/de/marhali/easyi18n/model/KeyPathConverter.java
 create mode 100644 src/test/java/de/marhali/easyi18n/KeyPathConverterTest.java

diff --git a/src/main/java/de/marhali/easyi18n/model/KeyPath.java b/src/main/java/de/marhali/easyi18n/model/KeyPath.java
new file mode 100644
index 0000000..9091539
--- /dev/null
+++ b/src/main/java/de/marhali/easyi18n/model/KeyPath.java
@@ -0,0 +1,30 @@
+package de.marhali.easyi18n.model;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Represents a full translation key with all sections.
+ * Implementations can use single section or variable section length variants.
+ * The respective layer (io, presentation) is responsible for using the correct mapping mechanism.
+ * @author marhali
+ */
+public class KeyPath extends ArrayList<String> {
+
+    public static final String DELIMITER = ".";
+
+    public static KeyPath of(String... path) {
+        return new KeyPath(List.of(path));
+    }
+
+    public KeyPath() {
+        super();
+    }
+
+    public KeyPath(@NotNull Collection<? extends String> c) {
+        super(c);
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/de/marhali/easyi18n/model/KeyPathConverter.java b/src/main/java/de/marhali/easyi18n/model/KeyPathConverter.java
new file mode 100644
index 0000000..c5b0ecd
--- /dev/null
+++ b/src/main/java/de/marhali/easyi18n/model/KeyPathConverter.java
@@ -0,0 +1,69 @@
+package de.marhali.easyi18n.model;
+
+import com.intellij.openapi.project.Project;
+
+import de.marhali.easyi18n.service.SettingsService;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.regex.Pattern;
+
+/**
+ * Responsible for mapping {@link KeyPath} into single string and backwards.
+ * If nesting is enabled the delimiter within a section is escaped otherwise the delimiter between the key sections.
+ * @author marhali
+ */
+public class KeyPathConverter {
+
+    private final boolean nestKeys;
+
+    public KeyPathConverter(boolean nestKeys) {
+        this.nestKeys = nestKeys;
+    }
+
+    public KeyPathConverter(@NotNull Project project) {
+        this(SettingsService.getInstance(project).getState().isNestedKeys());
+    }
+
+    public @NotNull String concat(@NotNull KeyPath path) {
+        StringBuilder builder = new StringBuilder();
+
+        for(String section : path) {
+            if(builder.length() > 0) {
+                if(!this.nestKeys) {
+                    builder.append("\\\\");
+                }
+
+                builder.append(KeyPath.DELIMITER);
+            }
+
+            if(this.nestKeys) {
+                builder.append(section.replace(KeyPath.DELIMITER, "\\\\" + KeyPath.DELIMITER));
+            } else {
+                builder.append(section);
+            }
+        }
+
+        return builder.toString();
+    }
+
+    public @NotNull KeyPath split(@NotNull String concatPath) {
+        String[] sections = concatPath.split(this.nestKeys ?
+                "(?<!\\\\)" + Pattern.quote(KeyPath.DELIMITER) : Pattern.quote("\\\\" + KeyPath.DELIMITER));
+
+        KeyPath path = new KeyPath();
+
+        for(String section : sections) {
+            path.add(section.replace("\\\\" + KeyPath.DELIMITER, KeyPath.DELIMITER));
+        }
+
+        return path;
+    }
+
+    @Override
+    public String toString() {
+        return "KeyPathConverter{" +
+                "nestKeys=" + nestKeys +
+                '}';
+    }
+}
\ No newline at end of file
diff --git a/src/main/java/de/marhali/easyi18n/util/PathUtil.java b/src/main/java/de/marhali/easyi18n/util/PathUtil.java
index a507531..25ac7e8 100644
--- a/src/main/java/de/marhali/easyi18n/util/PathUtil.java
+++ b/src/main/java/de/marhali/easyi18n/util/PathUtil.java
@@ -16,7 +16,9 @@ import java.util.regex.Pattern;
  * Some i18n implementations require to NOT nest the translation keys.
  * This util takes care of this and checks the configured setting for this case.
  * @author marhali
+ * @deprecated Replaced by KeyPathConverter
  */
+@Deprecated
 public class PathUtil {
 
     public static final String DELIMITER = ".";
diff --git a/src/test/java/de/marhali/easyi18n/KeyPathConverterTest.java b/src/test/java/de/marhali/easyi18n/KeyPathConverterTest.java
new file mode 100644
index 0000000..9b18a32
--- /dev/null
+++ b/src/test/java/de/marhali/easyi18n/KeyPathConverterTest.java
@@ -0,0 +1,53 @@
+package de.marhali.easyi18n;
+
+import de.marhali.easyi18n.model.KeyPath;
+import de.marhali.easyi18n.model.KeyPathConverter;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+/**
+ * Unit tests for {@link KeyPathConverter}.
+ * @author marhali
+ */
+public class KeyPathConverterTest {
+
+    private final KeyPathConverter deepMapper = new KeyPathConverter(true);
+    private final KeyPathConverter flatMapper = new KeyPathConverter(false);
+
+    @Test
+    public void testNestedConcat() {
+        Assert.assertEquals("first\\\\.section.second.third",
+                deepMapper.concat(KeyPath.of("first.section", "second", "third")));
+
+        Assert.assertEquals("first.second.third",
+                deepMapper.concat(KeyPath.of("first", "second", "third")));
+    }
+
+    @Test
+    public void testNestedSplit() {
+        Assert.assertEquals(KeyPath.of("first.section", "second", "third"),
+                deepMapper.split("first\\\\.section.second.third"));
+
+        Assert.assertEquals(KeyPath.of("first", "second", "third"),
+                deepMapper.split("first.second.third"));
+    }
+
+    @Test
+    public void testNonNestedConcat() {
+        Assert.assertEquals("flat.map\\\\.deeper",
+                flatMapper.concat(KeyPath.of("flat.map", "deeper")));
+
+        Assert.assertEquals("flat.map.keys",
+                flatMapper.concat(KeyPath.of("flat.map.keys")));
+    }
+
+    @Test
+    public void testNonNestedSplit() {
+        Assert.assertEquals(KeyPath.of("flat.keys.with", "deep.section"),
+                flatMapper.split("flat.keys.with\\\\.deep.section"));
+
+        Assert.assertEquals(KeyPath.of("flat.keys.only"),
+                flatMapper.split("flat.keys.only"));
+    }
+}
\ No newline at end of file