test: Messages

2021-10-08 14:31:29 +03:00
parent 482aae7417
commit ce2f302d2e
4 changed files with 226 additions and 67 deletions
--- a/build.gradle
+++ b/build.gradle
@@ -38,6 +38,7 @@ dependencies {
    testImplementation("org.junit.jupiter:junit-jupiter-api:$junitVersion")
    testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
    testImplementation('org.mockito:mockito-core:3.12.4')
+    testImplementation('org.jooq:joor-java-8:0.9.13')
    testImplementation('org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT') {
        exclude(module: 'gson')
        exclude(module: 'json-simple')
--- a/src/main/java/ghast/Messages.java
+++ b/src/main/java/ghast/Messages.java
@@ -1,7 +1,7 @@
 package ghast;

 import lombok.AccessLevel;
-import lombok.RequiredArgsConstructor;
+import lombok.NoArgsConstructor;
 import org.apache.commons.text.StringSubstitutor;

 import java.io.BufferedReader;
@@ -12,21 +12,68 @@ import java.util.Map;
 import java.util.Properties;
 import java.util.stream.Collectors;

-@RequiredArgsConstructor(access = AccessLevel.PRIVATE)
-public class Messages {
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class Messages {

-	private final Map<String/*Key*/, String/*Template|Message*/> messagesMap;
+	private static final Map<String/*Key*/, String/*Template|Message*/> MESSAGES_MAP = new HashMap<>();
+
+	//region Load messages
+	/**
+	 * Загрузка сообщений из {@link Properties}
+	 *
+	 * @param properties список сообщений и шаблонов
+	 */
+	public static void load(Properties properties) {
+		load(properties.entrySet().stream().collect(Collectors.toMap(
+				entry -> (String) entry.getKey(),
+				entry -> (String) entry.getValue()
+		)));
+	}
+
+	/**
+	 * Загрузка сообщений из {@link Reader}.
+	 * <p>
+	 * Формат строк: {@code key=value}
+	 * </p>
+	 *
+	 * @param reader {@link Reader} со списоком сообщений и шаблонов
+	 */
+	public static void load(Reader reader) {
+		try(BufferedReader bufferedReader = new BufferedReader(reader)) {
+			Map<String, String> map = bufferedReader.lines()
+					.map(line -> line.split("=", 2))
+					.collect(Collectors.toMap(
+							pair -> pair[0].trim().toLowerCase(),
+							pair -> pair[1].trim()
+					));
+			load(map);
+		} catch (IOException e) {
+			//TODO заменить на специализированный Exception
+			throw new RuntimeException("Error load messages: " + e.getMessage(), e);
+		}
+	}
+
+	/**
+	 * Загрузка сообщений из {@link Map}<{@link String}, {@link String}>.
+	 *
+	 * @param messages список сообщений и шаблонов
+	 */
+	public static void load(Map<String, String> messages) {
+		MESSAGES_MAP.clear();
+		MESSAGES_MAP.putAll(messages);
+	}
+	//endregion

 	//region Get messages
 	/**
 	 * Получить обычное сообщение по ключу/коду.
 	 *
 	 * @param key ключ/код
-	 * @return сообщение, если таковое задано. Иначе - ключ
+	 * @return Сообщение, если таковое задано. Иначе - ключ
 	 */
-	public String get(String key) {
+	public static String get(String key) {
 		String keyLc = key.toLowerCase();
-		return messagesMap.getOrDefault(keyLc, keyLc);
+		return MESSAGES_MAP.getOrDefault(keyLc, keyLc);
 	}

 	/**
@@ -34,13 +81,13 @@ public class Messages {
 	 *
 	 * @param key    ключ/код
 	 * @param params список параметров
-	 * @return сообщение, если таковое задано. Иначе - ключ
+	 * @return Сообщение, если таковое задано. Иначе - ключ
 	 */
-	public String get(String key, Map<String, Object> params) {
+	public static String get(String key, Map<String, Object> params) {
 		String keyLc = key.toLowerCase();

-		if (messagesMap.containsKey(keyLc)) {
-			return format(messagesMap.get(keyLc), params);
+		if (MESSAGES_MAP.containsKey(keyLc)) {
+			return format(MESSAGES_MAP.get(keyLc), params);
 		} else {
 			return keyLc;
 		}
@@ -51,13 +98,18 @@ public class Messages {
 	 *
 	 * @param key    ключ/код
 	 * @param params чередующийся по парный список параметров: {@link String (str)param_name}, {@link Object (obj)param_value} и т.д.
-	 * @return сообщение, если таковое задано. Иначе - ключ
+	 * @return Сообщение, если таковое задано. Иначе - ключ
 	 */
-	public String get(String key, Object... params) {
+	@SuppressWarnings("unchecked")
+	public static String get(String key, Object... params) {
+		if (params.length == 1 && params[0] instanceof Map) {
+			return get(key, (Map<String, Object>) params[0]);
+		}
+
 		String keyLc = key.toLowerCase();

-		if (messagesMap.containsKey(keyLc)) {
-			return format(messagesMap.get(keyLc), params);
+		if (MESSAGES_MAP.containsKey(keyLc)) {
+			return format(MESSAGES_MAP.get(keyLc), params);
 		} else {
 			return keyLc;
 		}
@@ -72,7 +124,7 @@ public class Messages {
 	 * @param params параметры
 	 * @return сообщение
 	 */
-	public String format(String format, Map<String, Object> params) {
+	public static String format(String format, Map<String, Object> params) {
 		return StringSubstitutor.replace(format, params, "{", "}");
 	}

@@ -83,12 +135,17 @@ public class Messages {
 	 * @param params параметры
 	 * @return сообщение
 	 */
-	public String format(String format, Object... params) {
+	@SuppressWarnings("unchecked")
+	public static String format(String format, Object... params) {
+		if (params.length == 1 && params[0] instanceof Map) {
+			return format(format, (Map<String, Object>) params[0]);
+		}
+
 		return format(format, arrayParamsToMap(params));
 	}
 	//endregion

-	private Map<String, Object> arrayParamsToMap(Object... params) {
+	private static Map<String, Object> arrayParamsToMap(Object... params) {
 		int len;
 		if ((params.length % 2) == 1) {
 			len = params.length - 1;
@@ -103,53 +160,4 @@ public class Messages {

 		return map;
 	}
-
-	/**
-	 * Загрузка сообщений из {@link Properties}
-	 *
-	 * @param properties список сообщений и шаблонов
-	 * @return экземпляр {@link Messages}
-	 */
-	public static Messages load(Properties properties) {
-		Map<String, String> map = properties.entrySet().stream().collect(Collectors.toMap(
-				entry -> (String) entry.getKey(),
-				entry -> (String) entry.getValue()
-		));
-
-		return new Messages(map);
-	}
-
-	/**
-	 * Загрузка сообщений из {@link Reader}.
-	 * <p>
-	 * Формат строк: {@code key=value}
-	 * </p>
-	 *
-	 * @param reader {@link Reader} со списоком сообщений и шаблонов
-	 * @return экземпляр {@link Messages}
-	 */
-	public static Messages load(Reader reader) {
-		try(BufferedReader bufferedReader = new BufferedReader(reader)) {
-			Map<String, String> map = bufferedReader.lines()
-					.map(line -> line.split("=", 2))
-					.collect(Collectors.toMap(
-							pair -> pair[0].trim().toLowerCase(),
-							pair -> pair[1].trim()
-					));
-			return new Messages(map);
-		} catch (IOException e) {
-			//TODO заменить на специализированный Exception
-			throw new RuntimeException("Error load messages: " + e.getMessage(), e);
-		}
-	}
-
-	/**
-	 * Загрузка сообщений из {@link Map}<{@link String}, {@link String}>.
-	 *
-	 * @param messages список сообщений и шаблонов
-	 * @return экземпляр {@link Messages}
-	 */
-	public static Messages load(Map<String, String> messages) {
-		return new Messages(new HashMap<>(messages));
-	}
 }
--- a/src/test/java/ghast/MessagesLoadTest.java
+++ b/src/test/java/ghast/MessagesLoadTest.java
@@ -0,0 +1,59 @@
+package ghast;
+
+import org.joor.Reflect;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.StringReader;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
+import java.util.stream.Collectors;
+
+import static org.joor.Reflect.onClass;
+import static org.junit.jupiter.api.Assertions.assertIterableEquals;
+
+class MessagesLoadTest {
+
+    Map<String, String> map;
+
+    @BeforeEach
+    void before() {
+        map = new HashMap<String, String>() {{
+            put("key1", "value1");
+            put("key2", "value2");
+        }};
+    }
+
+    @Test
+    void loadMap() {
+        Messages.load(map);
+
+        Reflect reflectMessagesMap = onClass(Messages.class).field("MESSAGES_MAP");
+        assertIterableEquals(map.entrySet(), reflectMessagesMap.as(Map.class).entrySet());
+    }
+
+    @Test
+    void loadReader() {
+        String lines = map.entrySet().stream()
+                .map(entry -> entry.getKey() + "=" + entry.getValue())
+                .collect(Collectors.joining("\n"));
+        StringReader reader = new StringReader(lines);
+
+        Messages.load(reader);
+
+        Reflect reflectMessagesMap = onClass(Messages.class).field("MESSAGES_MAP");
+        assertIterableEquals(map.entrySet(), reflectMessagesMap.as(Map.class).entrySet());
+    }
+
+    @Test
+    void loadProperties() {
+        Properties properties = new Properties();
+        properties.putAll(map);
+
+        Messages.load(properties);
+
+        Reflect reflectMessagesMap = onClass(Messages.class).field("MESSAGES_MAP");
+        assertIterableEquals(map.entrySet(), reflectMessagesMap.as(Map.class).entrySet());
+    }
+}
--- a/src/test/java/ghast/MessagesTest.java
+++ b/src/test/java/ghast/MessagesTest.java
@@ -0,0 +1,91 @@
+package ghast;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class MessagesTest {
+
+    @BeforeEach
+    void before() {
+        Map<String, String> map1 = new HashMap<String, String>() {{
+            put("simple-message", "some message");
+            put("parametrized-message", "Arg1: {key1}");
+        }};
+        Messages.load(map1);
+    }
+
+    @Test
+    void getSimpleMessage() {
+        String string = Messages.get("simple-message");
+        assertEquals("some message", string);
+    }
+
+    @Test
+    void getSimpleMessageNotFound() {
+        String string = Messages.get("non-exists-key");
+        assertEquals("non-exists-key", string);
+    }
+
+    @Test
+    void formatMap() {
+        Map<String, Object> map1 = new HashMap<String, Object>() {{
+            put("key1", "some message");
+        }};
+        String string = Messages.format("Arg1: {key1}", map1);
+        assertEquals("Arg1: some message", string);
+
+        Map<String, String> map2 = new HashMap<String, String>() {{
+            put("key1", "some message");
+        }};
+        string = Messages.format("Arg1: {key1}", map2);
+        assertEquals("Arg1: some message", string);
+    }
+
+    @Test
+    void formatArray() {
+        String string = Messages.format("Arg1: {key1}", "key1", "some message");
+        assertEquals("Arg1: some message", string);
+    }
+
+    @Test
+    void getParametrizedMessageMap() {
+        Map<String, Object> map2 = new HashMap<String, Object>() {{
+            put("key1", "some message");
+        }};
+        String string = Messages.get("parametrized-message", map2);
+        assertEquals("Arg1: some message", string);
+
+        Map<String, String> map3 = new HashMap<String, String>() {{
+            put("key1", "some message");
+        }};
+        string = Messages.get("parametrized-message", map3);
+        assertEquals("Arg1: some message", string);
+    }
+
+    @Test
+    void getParametrizedMessageMapNotFound() {
+        Map<String, Object> map2 = new HashMap<String, Object>() {{
+            put("key1", "some message");
+        }};
+
+        String string = Messages.get("non-exists-key", map2);
+        assertEquals("non-exists-key", string);
+    }
+
+    @Test
+    void getParametrizedMessageArray() {
+        String string = Messages.get("parametrized-message", "key1", "some message");
+        assertEquals("Arg1: some message", string);
+    }
+
+    @Test
+    void getParametrizedMessageArrayNotFound() {
+        String string = Messages.get("non-exists-key", "key1", "some message");
+        assertEquals("non-exists-key", string);
+    }
+}