From a0b81ab0a195573fac6c76e890d3398bffed6cc2 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Thu, 7 Oct 2021 01:45:02 +0300 Subject: [PATCH 1/4] add JaCoCo --- build.gradle | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index bc0e549..b6f9925 100644 --- a/build.gradle +++ b/build.gradle @@ -1,5 +1,6 @@ plugins { id 'java' + id 'jacoco' } def publishScript = file(rootProject.getProjectDir().getPath() + '/publish.gradle') @@ -76,4 +77,12 @@ dependencies { test { useJUnitPlatform() -} \ No newline at end of file +} + +jacoco { + toolVersion = '0.8.5' +} + +jacocoTestReport { + dependsOn test +} From a7a1ca0efa46f71ecc144f5877af75dc6c8e5246 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Fri, 8 Oct 2021 10:13:20 +0300 Subject: [PATCH 2/4] =?UTF-8?q?=D0=B8=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD?= =?UTF-8?q?=D0=B8=D0=B5=20=D0=B8=D0=BD=D0=B8=D1=86=D0=B8=D0=B0=D0=BB=D0=B8?= =?UTF-8?q?=D0=B7=D0=B0=D1=86=D0=B8=D0=B8=20Messages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/java/ghast/Messages.java | 111 +++++++++++++++--------------- 1 file changed, 57 insertions(+), 54 deletions(-) diff --git a/src/main/java/ghast/Messages.java b/src/main/java/ghast/Messages.java index 9856f31..1f6e299 100644 --- a/src/main/java/ghast/Messages.java +++ b/src/main/java/ghast/Messages.java @@ -1,6 +1,7 @@ package ghast; -import lombok.experimental.UtilityClass; +import lombok.AccessLevel; +import lombok.RequiredArgsConstructor; import org.apache.commons.text.StringSubstitutor; import java.io.BufferedReader; @@ -9,57 +10,12 @@ import java.io.Reader; import java.util.HashMap; import java.util.Map; import java.util.Properties; +import java.util.stream.Collectors; -@UtilityClass +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) public class Messages { - private final Map MESSAGES_MAP = new HashMap<>(); - - //region Load messages - - /** - * Загрузка сообщений из {@link Properties} - * - * @param properties список сообщений и шаблонов - */ - public void load(Properties properties) { - MESSAGES_MAP.clear(); - properties.forEach((key, value) -> MESSAGES_MAP.put(key.toString().trim().toLowerCase(), value.toString().trim())); - } - - /** - * Загрузка сообщений из {@link Reader}. - *

- * Формат строк: {@code key=value} - *

- * - * @param reader {@link Reader} со списоком сообщений и шаблонов - */ - public void load(Reader reader) { - MESSAGES_MAP.clear(); - try { - BufferedReader bufferedReader = new BufferedReader(reader); - String line; - while ((line = bufferedReader.readLine()) != null) { - String[] split = line.split("=", 2); - MESSAGES_MAP.put(split[0].trim().toLowerCase(), split[1].trim()); - } - } catch (IOException e) { - //TODO заменить на специализированный Exception - throw new RuntimeException("Error load messages: " + e.getMessage(), e); - } - } - - /** - * Загрузка сообщений из {@link Map}<{@link String}, {@link String}>. - * - * @param messages список сообщений и шаблонов - */ - public void load(Map messages) { - MESSAGES_MAP.clear(); - MESSAGES_MAP.putAll(messages); - } - //endregion + private final Map messagesMap; //region Get messages /** @@ -70,7 +26,7 @@ public class Messages { */ public String get(String key) { String keyLc = key.toLowerCase(); - return MESSAGES_MAP.getOrDefault(keyLc, keyLc); + return messagesMap.getOrDefault(keyLc, keyLc); } /** @@ -83,8 +39,8 @@ public class Messages { public String get(String key, Map params) { String keyLc = key.toLowerCase(); - if (MESSAGES_MAP.containsKey(keyLc)) { - return format(MESSAGES_MAP.get(keyLc), params); + if (messagesMap.containsKey(keyLc)) { + return format(messagesMap.get(keyLc), params); } else { return keyLc; } @@ -100,8 +56,8 @@ public class Messages { public String get(String key, Object... params) { String keyLc = key.toLowerCase(); - if (MESSAGES_MAP.containsKey(keyLc)) { - return format(MESSAGES_MAP.get(keyLc), params); + if (messagesMap.containsKey(keyLc)) { + return format(messagesMap.get(keyLc), params); } else { return keyLc; } @@ -147,4 +103,51 @@ public class Messages { return map; } + + /** + * Загрузка сообщений из {@link Properties} + * + * @param properties список сообщений и шаблонов + * @return экземпляр {@link Messages} + */ + public static Messages load(Properties properties) { + Map map = properties.entrySet().stream().collect(Collectors.toMap( + entry -> (String) entry.getKey(), + entry -> (String) entry.getValue() + )); + + return new Messages(map); + } + + /** + * Загрузка сообщений из {@link Reader}. + *

+ * Формат строк: {@code key=value} + *

+ * + * @param reader {@link Reader} со списоком сообщений и шаблонов + */ + public static Messages load(Reader reader) { + try(BufferedReader bufferedReader = new BufferedReader(reader)) { + Map 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 список сообщений и шаблонов + */ + public static Messages load(Map messages) { + return new Messages(new HashMap<>(messages)); + } } From a2ff9725d57e17771b1e17e20f6b9b9fc58a1040 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Fri, 8 Oct 2021 10:14:04 +0300 Subject: [PATCH 3/4] =?UTF-8?q?=D0=B8=D0=B7=D0=BC=D0=B5=D0=BD=D0=B5=D0=BD?= =?UTF-8?q?=D0=B8=D0=B5=20=D0=B8=D0=BD=D0=B8=D1=86=D0=B8=D0=B0=D0=BB=D0=B8?= =?UTF-8?q?=D0=B7=D0=B0=D1=86=D0=B8=D0=B8=20Messages?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/java/ghast/Messages.java | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/java/ghast/Messages.java b/src/main/java/ghast/Messages.java index 1f6e299..716badc 100644 --- a/src/main/java/ghast/Messages.java +++ b/src/main/java/ghast/Messages.java @@ -126,6 +126,7 @@ public class Messages { *

* * @param reader {@link Reader} со списоком сообщений и шаблонов + * @return экземпляр {@link Messages} */ public static Messages load(Reader reader) { try(BufferedReader bufferedReader = new BufferedReader(reader)) { @@ -146,6 +147,7 @@ public class Messages { * Загрузка сообщений из {@link Map}<{@link String}, {@link String}>. * * @param messages список сообщений и шаблонов + * @return экземпляр {@link Messages} */ public static Messages load(Map messages) { return new Messages(new HashMap<>(messages)); From ce2f302d2e62d55222dd329cea2b9c4771b0eb35 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Fri, 8 Oct 2021 14:31:29 +0300 Subject: [PATCH 4/4] test: Messages --- build.gradle | 1 + src/main/java/ghast/Messages.java | 142 ++++++++++++---------- src/test/java/ghast/MessagesLoadTest.java | 59 +++++++++ src/test/java/ghast/MessagesTest.java | 91 ++++++++++++++ 4 files changed, 226 insertions(+), 67 deletions(-) create mode 100644 src/test/java/ghast/MessagesLoadTest.java create mode 100644 src/test/java/ghast/MessagesTest.java diff --git a/build.gradle b/build.gradle index 32ef767..cfd2d8a 100644 --- 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') diff --git a/src/main/java/ghast/Messages.java b/src/main/java/ghast/Messages.java index 716badc..6869b9b 100644 --- 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 messagesMap; + private static final Map 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}. + *

+ * Формат строк: {@code key=value} + *

+ * + * @param reader {@link Reader} со списоком сообщений и шаблонов + */ + public static void load(Reader reader) { + try(BufferedReader bufferedReader = new BufferedReader(reader)) { + Map 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 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 params) { + public static String get(String key, Map 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) 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 params) { + public static String format(String format, Map 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) params[0]); + } + return format(format, arrayParamsToMap(params)); } //endregion - private Map arrayParamsToMap(Object... params) { + private static Map 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 map = properties.entrySet().stream().collect(Collectors.toMap( - entry -> (String) entry.getKey(), - entry -> (String) entry.getValue() - )); - - return new Messages(map); - } - - /** - * Загрузка сообщений из {@link Reader}. - *

- * Формат строк: {@code key=value} - *

- * - * @param reader {@link Reader} со списоком сообщений и шаблонов - * @return экземпляр {@link Messages} - */ - public static Messages load(Reader reader) { - try(BufferedReader bufferedReader = new BufferedReader(reader)) { - Map 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 messages) { - return new Messages(new HashMap<>(messages)); - } } diff --git a/src/test/java/ghast/MessagesLoadTest.java b/src/test/java/ghast/MessagesLoadTest.java new file mode 100644 index 0000000..5f6cec1 --- /dev/null +++ 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 map; + + @BeforeEach + void before() { + map = new HashMap() {{ + 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()); + } +} \ No newline at end of file diff --git a/src/test/java/ghast/MessagesTest.java b/src/test/java/ghast/MessagesTest.java new file mode 100644 index 0000000..7b8a43a --- /dev/null +++ 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 map1 = new HashMap() {{ + 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 map1 = new HashMap() {{ + put("key1", "some message"); + }}; + String string = Messages.format("Arg1: {key1}", map1); + assertEquals("Arg1: some message", string); + + Map map2 = new HashMap() {{ + 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 map2 = new HashMap() {{ + put("key1", "some message"); + }}; + String string = Messages.get("parametrized-message", map2); + assertEquals("Arg1: some message", string); + + Map map3 = new HashMap() {{ + put("key1", "some message"); + }}; + string = Messages.get("parametrized-message", map3); + assertEquals("Arg1: some message", string); + } + + @Test + void getParametrizedMessageMapNotFound() { + Map map2 = new HashMap() {{ + 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); + } +} \ No newline at end of file