0

14 Commits

Author SHA1 Message Date
0b74f104f2 update version 2021-01-08 17:07:15 +03:00
6e54a16067 Merge branch 'develop' 2021-01-08 17:05:46 +03:00
d34e418dcc update version 2021-01-05 19:04:28 +03:00
bcca590741 Merge branch 'develop' 2021-01-05 19:03:32 +03:00
2fc1bf36c1 update version 2021-01-03 00:24:06 +03:00
eb5396b891 Merge branch 'develop' 2021-01-03 00:23:40 +03:00
e12d005a25 update version 2021-01-02 14:39:35 +03:00
6e50fc278e Merge branch 'develop' 2021-01-02 14:39:18 +03:00
c8866af418 update version 2021-01-02 02:52:42 +03:00
359dbba09a Merge branch 'develop' 2021-01-02 02:52:19 +03:00
e4b1b40104 update version 2021-01-02 01:46:21 +03:00
73f044ab8b Merge branch 'develop' 2021-01-02 01:45:58 +03:00
32b868df22 update version 2021-01-01 22:08:31 +03:00
3a66dffa10 Merge branch 'develop' 2021-01-01 22:08:17 +03:00
26 changed files with 1111 additions and 1274 deletions

119
README.MD
View File

@@ -1,6 +1,6 @@
# GHAST TOOLS # GHAST TOOLS
![version: 1.9](https://img.shields.io/badge/version-1.9-0a0.svg?style=flat) ![version: 1.11](https://img.shields.io/badge/version-1.11-0a0.svg?style=flat)
![bukkit-api: 1.12](https://img.shields.io/badge/bukkit--api-1.12-d50.svg?style=flat) ![bukkit-api: 1.12](https://img.shields.io/badge/bukkit--api-1.12-d50.svg?style=flat)
Набор вспомогательных инструментов для Bukkit API. Набор вспомогательных инструментов для Bukkit API.
@@ -18,7 +18,7 @@ _Основан на версии Bukkit API 1.12._
8. [JdbcTemplate](#jdbctemplate) 8. [JdbcTemplate](#jdbctemplate)
9. [ScheduleManager](#schedulemanager) 9. [ScheduleManager](#schedulemanager)
10. [ScheduleTask](#scheduletask) 10. [ScheduleTask](#scheduletask)
11. [Messages](#messages) 11. [I18n](#i18n)
12. [XLog](#xlog) 12. [XLog](#xlog)
13. [Подключение](#подключение) 13. [Подключение](#подключение)
1. [Gradle](#gradle) 1. [Gradle](#gradle)
@@ -532,110 +532,91 @@ ScheduleTask scheduleTask = ...;
scheduleTask.cancel(); scheduleTask.cancel();
``` ```
## Messages ## I18n
Инструмент для работы с параметизированными сообщениями или просто сообщениями, которые храняться в отдельном файле. Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
Параметизированные сообщения имеют следующий вид: `Привет, {player}!`. Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
### load ### loadMessages
Загрузка сообщений в инструмент. Загрузка сообщений в инструмент.
Есть три варианта: через `Properties` Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
```java ```java
Properties properties = ...; Map<String, String> messagesMap = ...;
Messages.load(properties); I18n.loadMessages(messagesMap);
``` ```
через `Map<String, String>`
```java ```java
Map<String, String> map = ...; Reader reader = AssetsManager.getAsReader("messages.properties");
Messages.load(map); I18n.loadMessages(reader);
``` ```
через `Reader` В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
```java ```java
Reader reader = ...; Map<String, String> enMessagesMap = ...;
Messages.load(reader); Map<String, String> ruMessagesMap = ...;
I18n.loadMessages("en", enMessagesMap);
I18n.loadMessages("ru", ruMessagesMap);
``` ```
Следует учесть, про при работе через `Reader`, **Messages** ожидает там обнаружить список строк в формате `key=value`. ```java
Reader readerEn = AssetsManager.getAsReader("messages.properties");
Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
I18n.loadMessages("en", readerEn);
I18n.loadMessages("ru", readerRu);
```
### get ### get
Получение обычноего или параметизированного сообщения. Получение сообщения по его ключу.
Для примера, пусть у нас будут такие сообщения:
```properties
simple=Простое сообщение
welcome=Приветствуем, {player}!
```
Для получения простого сообщения, просто указываем его ключ:
```java ```java
String message = Messages.get("simple"); String msg = I18n.get("player.join.msg");
// Простое сообщение
``` ```
Для получения параметизированного сообщения, нужно помимо ключа передать параметры. Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
Есть два способа: через `Map<String, Object>`
```java ```java
Map<String, Object> = map = new HashMap<>(1); Map<String, String> messagesMap = new HashMap<>();
map.put("player", "David"); messagesMap.put("player.join.msg", "Привет, {player}!");
String message = Messages.get("welcome", map); I18n.loadMessages(messagesMap);
// Приветствуем, David!
Map<String, String> params = new HashMap<>();
params.put("player", event.getPlayer().getName());
String msg = I18n.get("player.join.msg", params);
``` ```
через попарное перечисление параметров Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
```java ```java
String message = Messages.get("welcome", "player", "David"); String msg = I18n.get("player.join.msg", I18n.paramBuilder()
// Приветствуем, David! .add("player", event.getPlayer().getName())
.build());
``` ```
Если по указанному ключу сообщение отсутствует, то **Messages** вернёт значение самого ключа Можно первым параметром указать код языка.
```java ```java
String message = Messages.get("not_exists_key"); String msg = I18n.get("ru", "player.join.msg");
// not_exists_key
message = Messages.get("not_exists_key", "player", "David");
// not_exists_key
``` ```
Если параметр, который указан в шаблоне не был указан/определён, то параметр останется как есть ### paramBuilder
Инструмент для параметизирования шаблонов сообщений.
```java ```java
String message = Messages.get("welcome"); Map<String, Object> params = I18n.paramBuilder()
// Приветствуем, {player}! .add("player", event.getPlayer().getName())
.build();
message = Messages.get("welcome", "unknown_param_key", 123); String msg = I18n.get("player.join.msg", params);
// Приветствуем, {player}!
```
### format
**Messages** можно использовать и просто для форматирования параметизированных шаблонов:
```java
Map<String, Object> = map = new HashMap<>(1);
map.put("player", "David");
String message = Messages.format("Приветствуем, {player}!", map);
// Приветствуем, David!
```
```java
String message = Messages.foramt("Приветствуем, {player}!", "player", "David");
// Приветствуем, David!
``` ```
## XLog ## XLog
@@ -673,7 +654,7 @@ repositories {
``` ```
```groovy ```groovy
implementation group: 'ghast', name: 'ghast-tools', version: '1.9' implementation group: 'ghast', name: 'ghast-tools', version: '1.11'
``` ```
### Maven ### Maven
@@ -692,7 +673,7 @@ implementation group: 'ghast', name: 'ghast-tools', version: '1.9'
<dependency> <dependency>
<groupId>ghast</groupId> <groupId>ghast</groupId>
<artifactId>ghast-tools</artifactId> <artifactId>ghast-tools</artifactId>
<version>1.9</version> <version>1.11</version>
</dependency> </dependency>
</dependencies> </dependencies>
``` ```

View File

@@ -1,3 +1,3 @@
projectGroup=ghast projectGroup=ghast
projectName=ghast-tools projectName=ghast-tools
projectVersion=1.4 projectVersion=1.11

View File

@@ -16,10 +16,16 @@ public class GhastTools {
private static WeakReference<Plugin> refPlugin; private static WeakReference<Plugin> refPlugin;
@SuppressWarnings("java:S2696")
public void setPlugin(Plugin plugin) { public void setPlugin(Plugin plugin) {
refPlugin = plugin == null ? null : new WeakReference<>(plugin); if (plugin == null) {
refPlugin = null;
} else {
refPlugin = new WeakReference<>(plugin);
}
} }
@SuppressWarnings("java:S112")
public Plugin getPlugin() { public Plugin getPlugin() {
if (refPlugin == null) { if (refPlugin == null) {
throw new RuntimeException("Plugin not set."); throw new RuntimeException("Plugin not set.");
@@ -33,6 +39,7 @@ public class GhastTools {
return plugin; return plugin;
} }
@SuppressWarnings("java:S112")
public YamlConfiguration loadConfig(boolean saveDefault) { public YamlConfiguration loadConfig(boolean saveDefault) {
if (saveDefault) { if (saveDefault) {
getPlugin().saveDefaultConfig(); getPlugin().saveDefaultConfig();

View File

@@ -14,18 +14,15 @@ import java.io.Reader;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
/**
* @deprecated use {@link Messages}
*/
@UtilityClass @UtilityClass
@SuppressWarnings("unused") @SuppressWarnings("unused")
@Deprecated
public class I18n { public class I18n {
private final String DEFAULT_LANG = "en"; private final String DEFAULT_LANG = "en";
private final Table<String/*Lang*/, String/*Key*/, String/*Template|Message*/> messagesMap = HashBasedTable.create(); private final Table<String/*Lang*/, String/*Key*/, String/*Template|Message*/> messagesMap = HashBasedTable.create();
//region Load messages //region Load messages
@SuppressWarnings("java:S112")
public void loadMessages(String lang, Reader reader) { public void loadMessages(String lang, Reader reader) {
Map<String, String> map = messagesMap.row(lang.toLowerCase()); Map<String, String> map = messagesMap.row(lang.toLowerCase());

View File

@@ -1,150 +0,0 @@
package ghast;
import lombok.experimental.UtilityClass;
import org.apache.commons.text.StringSubstitutor;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
@UtilityClass
public class Messages {
private final Map<String/*Key*/, String/*Template|Message*/> 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}.
* <p>
* Формат строк: {@code key=value}
* </p>
*
* @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<String, String> messages) {
MESSAGES_MAP.clear();
MESSAGES_MAP.putAll(messages);
}
//endregion
//region Get messages
/**
* Получить обычное сообщение по ключу/коду.
*
* @param key ключ/код
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key) {
String keyLc = key.toLowerCase();
return MESSAGES_MAP.getOrDefault(keyLc, keyLc);
}
/**
* Получить параметизированное сообщение по ключу/коду.
*
* @param key ключ/код
* @param params список параметров
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key, Map<String, Object> params) {
String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) {
return format(MESSAGES_MAP.get(keyLc), params);
} else {
return keyLc;
}
}
/**
* Получить параметизированное сообщение по ключу/коду.
*
* @param key ключ/код
* @param params чередующийся по парный список параметров: {@link String (str)param_name}, {@link Object (obj)param_value} и т.д.
* @return сообщение, если таковое задано. Иначе - ключ
*/
public String get(String key, Object... params) {
String keyLc = key.toLowerCase();
if (MESSAGES_MAP.containsKey(keyLc)) {
return format(MESSAGES_MAP.get(keyLc), params);
} else {
return keyLc;
}
}
//endregion
//region Format message
/**
* Получить сообщение по формату.
*
* @param format параметизированное сообщение
* @param params параметры
* @return сообщение
*/
public String format(String format, Map<String, Object> params) {
return StringSubstitutor.replace(format, params, "{", "}");
}
/**
* Получить сообщение по формату.
*
* @param format параметизированное сообщение
* @param params параметры
* @return сообщение
*/
public String format(String format, Object... params) {
return format(format, arrayParamsToMap(params));
}
//endregion
private Map<String, Object> arrayParamsToMap(Object... params) {
int len;
if ((params.length % 2) == 1) {
len = params.length - 1;
} else {
len = params.length;
}
Map<String, Object> map = new HashMap<>(len / 2);
for (int i = 0; i < len; i = i + 2) {
map.put((String) params[i], params[i + 1]);
}
return map;
}
}

View File

@@ -46,6 +46,7 @@ class CommandWrapper extends BukkitCommand {
} }
@Override @Override
@SuppressWarnings("java:S1066")
public boolean execute(CommandSender commandSender, String commandName, String[] args) { public boolean execute(CommandSender commandSender, String commandName, String[] args) {
if (Boolean.TRUE.equals(onlyPlayer)) { if (Boolean.TRUE.equals(onlyPlayer)) {
if (!(commandSender instanceof Player)) { if (!(commandSender instanceof Player)) {

View File

@@ -2,6 +2,7 @@ package ghast.database;
import lombok.Getter; import lombok.Getter;
@SuppressWarnings("java:S1165")
@Getter @Getter
public class DataAccessException extends RuntimeException { public class DataAccessException extends RuntimeException {