0

Merge branch 'dev/messages' into rc/1.13

# Conflicts:
#	build.gradle
This commit is contained in:
2021-10-08 14:45:52 +03:00
4 changed files with 191 additions and 27 deletions

View File

@@ -39,6 +39,7 @@ dependencies {
testImplementation("org.junit.jupiter:junit-jupiter-api:$junitVersion") testImplementation("org.junit.jupiter:junit-jupiter-api:$junitVersion")
testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion") testImplementation("org.junit.jupiter:junit-jupiter-engine:$junitVersion")
testImplementation('org.mockito:mockito-core:3.12.4') testImplementation('org.mockito:mockito-core:3.12.4')
testImplementation('org.jooq:joor-java-8:0.9.13')
testImplementation("org.bukkit:bukkit:$bukkitVersion") { testImplementation("org.bukkit:bukkit:$bukkitVersion") {
exclude(module: 'gson') exclude(module: 'gson')
exclude(module: 'json-simple') exclude(module: 'json-simple')

View File

@@ -1,6 +1,7 @@
package ghast; package ghast;
import lombok.experimental.UtilityClass; import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.apache.commons.text.StringSubstitutor; import org.apache.commons.text.StringSubstitutor;
import java.io.BufferedReader; import java.io.BufferedReader;
@@ -9,22 +10,24 @@ import java.io.Reader;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.Properties; import java.util.Properties;
import java.util.stream.Collectors;
@UtilityClass @NoArgsConstructor(access = AccessLevel.PRIVATE)
public class Messages { public final class Messages {
private final Map<String/*Key*/, String/*Template|Message*/> MESSAGES_MAP = new HashMap<>(); private static final Map<String/*Key*/, String/*Template|Message*/> MESSAGES_MAP = new HashMap<>();
//region Load messages //region Load messages
/** /**
* Загрузка сообщений из {@link Properties} * Загрузка сообщений из {@link Properties}
* *
* @param properties список сообщений и шаблонов * @param properties список сообщений и шаблонов
*/ */
public void load(Properties properties) { public static void load(Properties properties) {
MESSAGES_MAP.clear(); load(properties.entrySet().stream().collect(Collectors.toMap(
properties.forEach((key, value) -> MESSAGES_MAP.put(key.toString().trim().toLowerCase(), value.toString().trim())); entry -> (String) entry.getKey(),
entry -> (String) entry.getValue()
)));
} }
/** /**
@@ -35,15 +38,15 @@ public class Messages {
* *
* @param reader {@link Reader} со списоком сообщений и шаблонов * @param reader {@link Reader} со списоком сообщений и шаблонов
*/ */
public void load(Reader reader) { public static void load(Reader reader) {
MESSAGES_MAP.clear(); try(BufferedReader bufferedReader = new BufferedReader(reader)) {
try { Map<String, String> map = bufferedReader.lines()
BufferedReader bufferedReader = new BufferedReader(reader); .map(line -> line.split("=", 2))
String line; .collect(Collectors.toMap(
while ((line = bufferedReader.readLine()) != null) { pair -> pair[0].trim().toLowerCase(),
String[] split = line.split("=", 2); pair -> pair[1].trim()
MESSAGES_MAP.put(split[0].trim().toLowerCase(), split[1].trim()); ));
} load(map);
} catch (IOException e) { } catch (IOException e) {
//TODO заменить на специализированный Exception //TODO заменить на специализированный Exception
throw new RuntimeException("Error load messages: " + e.getMessage(), e); throw new RuntimeException("Error load messages: " + e.getMessage(), e);
@@ -55,7 +58,7 @@ public class Messages {
* *
* @param messages список сообщений и шаблонов * @param messages список сообщений и шаблонов
*/ */
public void load(Map<String, String> messages) { public static void load(Map<String, String> messages) {
MESSAGES_MAP.clear(); MESSAGES_MAP.clear();
MESSAGES_MAP.putAll(messages); MESSAGES_MAP.putAll(messages);
} }
@@ -66,9 +69,9 @@ public class Messages {
* Получить обычное сообщение по ключу/коду. * Получить обычное сообщение по ключу/коду.
* *
* @param key ключ/код * @param key ключ/код
* @return сообщение, если таковое задано. Иначе - ключ * @return Сообщение, если таковое задано. Иначе - ключ
*/ */
public String get(String key) { public static String get(String key) {
String keyLc = key.toLowerCase(); String keyLc = key.toLowerCase();
return MESSAGES_MAP.getOrDefault(keyLc, keyLc); return MESSAGES_MAP.getOrDefault(keyLc, keyLc);
} }
@@ -78,9 +81,9 @@ public class Messages {
* *
* @param key ключ/код * @param key ключ/код
* @param params список параметров * @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(); String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) { if (MESSAGES_MAP.containsKey(keyLc)) {
@@ -95,9 +98,14 @@ public class Messages {
* *
* @param key ключ/код * @param key ключ/код
* @param params чередующийся по парный список параметров: {@link String (str)param_name}, {@link Object (obj)param_value} и т.д. * @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(); String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) { if (MESSAGES_MAP.containsKey(keyLc)) {
@@ -116,7 +124,7 @@ public class Messages {
* @param params параметры * @param params параметры
* @return сообщение * @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, "{", "}"); return StringSubstitutor.replace(format, params, "{", "}");
} }
@@ -127,12 +135,17 @@ public class Messages {
* @param params параметры * @param params параметры
* @return сообщение * @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)); return format(format, arrayParamsToMap(params));
} }
//endregion //endregion
private Map<String, Object> arrayParamsToMap(Object... params) { private static Map<String, Object> arrayParamsToMap(Object... params) {
int len; int len;
if ((params.length % 2) == 1) { if ((params.length % 2) == 1) {
len = params.length - 1; len = params.length - 1;

View File

@@ -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());
}
}

View File

@@ -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);
}
}