Move classes

alaugks · Apr 15, 2024 · 700f43c · 700f43c
1 parent 91dc5c6
commit 700f43c
Show file tree

Hide file tree

Showing 17 changed files with 128 additions and 165 deletions.
diff --git a/...main/java/io/github/alaugks/spring/messagesource/xliff/XliffTranslationMessageSource.java b/...main/java/io/github/alaugks/spring/messagesource/xliff/XliffTranslationMessageSource.java
@@ -2,7 +2,7 @@
 
 import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogBuilder;
 import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogHandler;
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffIdentifierInterface;
+import io.github.alaugks.spring.messagesource.xliff.catalog.XliffVersionInterface.XliffIdentifierInterface;
 import io.github.alaugks.spring.messagesource.xliff.ressources.ResourcesLoader;
 import java.text.MessageFormat;
 import java.util.HashSet;

diff --git a/src/main/java/io/github/alaugks/spring/messagesource/xliff/catalog/CatalogBuilder.java b/src/main/java/io/github/alaugks/spring/messagesource/xliff/catalog/CatalogBuilder.java
@@ -1,10 +1,5 @@
 package io.github.alaugks.spring.messagesource.xliff.catalog;
 
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffDocument;
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffIdentifierInterface;
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffVersion12;
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffVersion2;
-import io.github.alaugks.spring.messagesource.xliff.catalog.xliff.XliffVersionInterface;
 import io.github.alaugks.spring.messagesource.xliff.exception.SaxErrorHandler;
 import io.github.alaugks.spring.messagesource.xliff.exception.XliffMessageSourceRuntimeException;
 import io.github.alaugks.spring.messagesource.xliff.exception.XliffMessageSourceVersionSupportException;
@@ -24,7 +19,7 @@ public final class CatalogBuilder {
 
     private final ResourcesLoader resourceLoader;
     private Catalog catalog;
-    private final List<XliffIdentifierInterface> transUnitIdentifier;
+    private final List<XliffVersionInterface.XliffIdentifierInterface> transUnitIdentifier;
     List<XliffVersionInterface> supportedVersions = List.of(
         new XliffVersion12(),
         new XliffVersion2()
@@ -42,13 +37,14 @@ public static Builder builder(ResourcesLoader resourceLoader) {
     public static final class Builder {
 
         private final ResourcesLoader resourceLoader;
-        private List<XliffIdentifierInterface> transUnitIdentifier;
+        private List<XliffVersionInterface.XliffIdentifierInterface> transUnitIdentifier;
 
         private Builder(ResourcesLoader resourceLoader) {
             this.resourceLoader = resourceLoader;
         }
 
-        public Builder transUnitIdentifier(List<XliffIdentifierInterface> translationUnitIdentifiers) {
+        public Builder transUnitIdentifier(
+            List<XliffVersionInterface.XliffIdentifierInterface> translationUnitIdentifiers) {
             if (translationUnitIdentifiers != null) {
                 this.transUnitIdentifier = translationUnitIdentifiers;
             }

diff --git a/...ce/xliff/catalog/xliff/XliffDocument.java → ...gesource/xliff/catalog/XliffDocument.java b/...ce/xliff/catalog/xliff/XliffDocument.java → ...gesource/xliff/catalog/XliffDocument.java
@@ -1,4 +1,4 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
 import java.util.HashSet;
 import java.util.List;

diff --git a/...e/xliff/catalog/xliff/XliffVersion12.java → ...esource/xliff/catalog/XliffVersion12.java b/...e/xliff/catalog/xliff/XliffVersion12.java → ...esource/xliff/catalog/XliffVersion12.java
@@ -1,6 +1,5 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
-import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogInterface;
 import java.util.List;
 import java.util.Locale;
 
@@ -9,7 +8,7 @@ public final class XliffVersion12 implements XliffVersionInterface {
     private XliffIdentifierInterface transUnitIdentifier;
 
     public XliffVersion12() {
-        this.transUnitIdentifier = new Xliff12XliffIdentifier();
+        this.transUnitIdentifier = new Identifier();
     }
 
     @Override
@@ -29,4 +28,21 @@ public void read(CatalogInterface catalog, XliffDocument document, String domain
         );
     }
 
+    public static final class Identifier implements XliffIdentifierInterface {
+
+        // https://docs.oasis-open.org/xliff/v1.2/xliff-profile-html/xliff-profile-html-1.2.html#General_Identifiers
+        private List<String> unitIdentifiers = List.of("resname", "id");
+
+        public Identifier() {
+        }
+
+        public Identifier(List<String> unitIdentifiers) {
+            this.unitIdentifiers = unitIdentifiers;
+        }
+
+        @Override
+        public List<String> getList() {
+            return this.unitIdentifiers;
+        }
+    }
 }
diff --git a/...ce/xliff/catalog/xliff/XliffVersion2.java → ...gesource/xliff/catalog/XliffVersion2.java b/...ce/xliff/catalog/xliff/XliffVersion2.java → ...gesource/xliff/catalog/XliffVersion2.java
@@ -1,6 +1,5 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
-import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogInterface;
 import java.util.List;
 import java.util.Locale;
 
@@ -9,7 +8,7 @@ public final class XliffVersion2 implements XliffVersionInterface {
     private XliffIdentifierInterface transUnitIdentifier;
 
     public XliffVersion2() {
-        this.transUnitIdentifier = new Xliff2XliffIdentifier();
+        this.transUnitIdentifier = new Identifier();
     }
 
     @Override
@@ -29,4 +28,22 @@ public void read(CatalogInterface catalog, XliffDocument document, String domain
         );
     }
 
+    public static final class Identifier implements XliffIdentifierInterface {
+
+        // https://docs.oasis-open.org/xliff/xliff-core/v2.0/csprd01/xliff-core-v2.0-csprd01.html#segment
+        // https://docs.oasis-open.org/xliff/xliff-core/v2.1/os/xliff-core-v2.1-os.html#segment
+        private List<String> unitIdentifiers = List.of("id");
+
+        public Identifier() {
+        }
+
+        public Identifier(List<String> unitIdentifiers) {
+            this.unitIdentifiers = unitIdentifiers;
+        }
+
+        @Override
+        public List<String> getList() {
+            return this.unitIdentifiers;
+        }
+    }
 }
diff --git a/...main/java/io/github/alaugks/spring/messagesource/xliff/catalog/XliffVersionInterface.java b/...main/java/io/github/alaugks/spring/messagesource/xliff/catalog/XliffVersionInterface.java
@@ -0,0 +1,30 @@
+package io.github.alaugks.spring.messagesource.xliff.catalog;
+
+import java.util.List;
+import java.util.Locale;
+
+public interface XliffVersionInterface {
+
+    boolean support(String version);
+
+    void setTransUnitIdentifier(List<XliffIdentifierInterface> unitIdentifiers);
+
+    void read(CatalogInterface catalog, XliffDocument document, String domain, Locale locale);
+
+    interface XliffIdentifierInterface {
+
+        List<String> getList();
+
+        default XliffIdentifierInterface getEqualsClass(List<XliffIdentifierInterface> unitIdentifiers) {
+            if (unitIdentifiers != null) {
+                return unitIdentifiers
+                    .stream()
+                    .filter(u -> u.getClass() == this.getClass())
+                    .findFirst()
+                    .orElse(this);
+            }
+
+            return this;
+        }
+    }
+}
diff --git a/...va/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/Xliff12XliffIdentifier.java b/...va/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/Xliff12XliffIdentifier.java
diff --git a/...ava/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/Xliff2XliffIdentifier.java b/...ava/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/Xliff2XliffIdentifier.java
diff --git a/.../io/github/alaugks/spring/messagesource/xliff/catalog/xliff/XliffIdentifierInterface.java b/.../io/github/alaugks/spring/messagesource/xliff/catalog/xliff/XliffIdentifierInterface.java
diff --git a/...ava/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/XliffVersionInterface.java b/...ava/io/github/alaugks/spring/messagesource/xliff/catalog/xliff/XliffVersionInterface.java
diff --git a/...iff/catalog/xliff/CatalogBuilderTest.java → ...rce/xliff/catalog/CatalogBuilderTest.java b/...iff/catalog/xliff/CatalogBuilderTest.java → ...rce/xliff/catalog/CatalogBuilderTest.java
@@ -1,14 +1,11 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertInstanceOf;
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
 import io.github.alaugks.spring.messagesource.xliff.TestUtilities;
-import io.github.alaugks.spring.messagesource.xliff.catalog.Catalog;
-import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogBuilder;
-import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogInterface;
 import io.github.alaugks.spring.messagesource.xliff.exception.XliffMessageSourceSAXParseException;
 import io.github.alaugks.spring.messagesource.xliff.exception.XliffMessageSourceSAXParseFatalErrorException;
 import io.github.alaugks.spring.messagesource.xliff.exception.XliffMessageSourceVersionSupportException;

diff --git a/...liff/catalog/xliff/XliffDocumentTest.java → ...urce/xliff/catalog/XliffDocumentTest.java b/...liff/catalog/xliff/XliffDocumentTest.java → ...urce/xliff/catalog/XliffDocumentTest.java
@@ -1,4 +1,4 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
@@ -7,6 +7,7 @@
 
 import io.github.alaugks.spring.messagesource.xliff.TestUtilities;
 import io.github.alaugks.spring.messagesource.xliff.XliffTranslationMessageSource;
+import io.github.alaugks.spring.messagesource.xliff.catalog.XliffVersion2.Identifier;
 import java.io.IOException;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -57,7 +58,8 @@ void test_getElementValue_getCharacterDataFromElement_TextNode()
 
     @ParameterizedTest(name = "{index} => translationUnitIdentifiers={0}, code={1}, expected={2}, value={3}")
     @MethodSource("dataProvider_setTranslationUnitIdentifiersOrdering")
-    void test_setTranslationUnitIdentifiersOrdering(List<XliffIdentifierInterface> translationUnitIdentifiers,
+    void test_setTranslationUnitIdentifiersOrdering(
+        List<XliffVersionInterface.XliffIdentifierInterface> translationUnitIdentifiers,
         String code, String expected) {
         var messageSource = XliffTranslationMessageSource
             .builder(TestUtilities.getCache())
@@ -82,51 +84,51 @@ void test_setTranslationUnitIdentifiersOrdering(List<XliffIdentifierInterface> t
     private static Stream<Arguments> dataProvider_setTranslationUnitIdentifiersOrdering() {
         return Stream.of(
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("resname")),
-                    new Xliff12XliffIdentifier(List.of("resname"))),
+                Arrays.asList(new Identifier(List.of("resname")),
+                    new XliffVersion12.Identifier(List.of("resname"))),
                 "identifierv1.code-resname-a",
                 "Target A"
             ),
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("id")), new Xliff12XliffIdentifier(List.of("id"))),
+                Arrays.asList(new Identifier(List.of("id")), new XliffVersion12.Identifier(List.of("id"))),
                 "identifierv1.code-id-a",
                 "Target A"
             ),
 
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("resname", "id")),
-                    new Xliff12XliffIdentifier(List.of("resname", "id"))),
+                Arrays.asList(new Identifier(List.of("resname", "id")),
+                    new XliffVersion12.Identifier(List.of("resname", "id"))),
                 "identifierv1.code-id-b",
                 "Target B"
             ),
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("id", "resname")),
-                    new Xliff12XliffIdentifier(List.of("id", "resname"))),
+                Arrays.asList(new Identifier(List.of("id", "resname")),
+                    new XliffVersion12.Identifier(List.of("id", "resname"))),
                 "identifierv1.code-resname-c",
                 "Target C"
             ),
 
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("resname")),
-                    new Xliff12XliffIdentifier(List.of("resname"))),
+                Arrays.asList(new Identifier(List.of("resname")),
+                    new XliffVersion12.Identifier(List.of("resname"))),
                 "identifierv2.code-resname-a",
                 "Target A"
             ),
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("id")), new Xliff12XliffIdentifier(List.of("id"))),
+                Arrays.asList(new Identifier(List.of("id")), new XliffVersion12.Identifier(List.of("id"))),
                 "identifierv2.code-id-a",
                 "Target A"
             ),
 
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("resname", "id")),
-                    new Xliff12XliffIdentifier(List.of("resname", "id"))),
+                Arrays.asList(new Identifier(List.of("resname", "id")),
+                    new XliffVersion12.Identifier(List.of("resname", "id"))),
                 "identifierv2.code-id-b",
                 "Target B"
             ),
             Arguments.of(
-                Arrays.asList(new Xliff2XliffIdentifier(List.of("id", "resname")),
-                    new Xliff12XliffIdentifier(List.of("id", "resname"))),
+                Arrays.asList(new Identifier(List.of("id", "resname")),
+                    new XliffVersion12.Identifier(List.of("id", "resname"))),
                 "identifierv2.code-resname-c",
                 "Target C"
             )

diff --git a/...iff/catalog/xliff/XliffVersion12Test.java → ...rce/xliff/catalog/XliffVersion12Test.java b/...iff/catalog/xliff/XliffVersion12Test.java → ...rce/xliff/catalog/XliffVersion12Test.java
@@ -1,11 +1,12 @@
-package io.github.alaugks.spring.messagesource.xliff.catalog.xliff;
+package io.github.alaugks.spring.messagesource.xliff.catalog;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import io.github.alaugks.spring.messagesource.xliff.TestUtilities;
-import io.github.alaugks.spring.messagesource.xliff.catalog.Catalog;
-import io.github.alaugks.spring.messagesource.xliff.catalog.CatalogInterface;
+import io.github.alaugks.spring.messagesource.xliff.catalog.XliffVersion12.Identifier;
 import java.io.IOException;
+import java.util.Arrays;
+import java.util.List;
 import java.util.Locale;
 import javax.xml.parsers.ParserConfigurationException;
 import org.junit.jupiter.api.Test;
@@ -23,4 +24,17 @@ void test_readXliffFile() throws ParserConfigurationException, IOException, SAXE
 
         assertEquals("Hello World (Xliff Version 1.2)", catalog.get(locale, "domain.code-1"));
     }
+
+
+    @Test
+    void test_default_identifier() {
+        var identifier = new Identifier();
+        assertEquals(Arrays.asList("resname", "id"), identifier.getList());
+    }
+
+    @Test
+    void test_custom_identifier() {
+        var identifier = new Identifier(List.of("id"));
+        assertEquals(List.of("id"), identifier.getList());
+    }
 }