1
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2026-06-04 18:48:20 +08:00

Compare commits

...

12 Commits

Author SHA1 Message Date
carm 70a3b893a6 chore(text): Add missing text functions 2025-03-21 03:30:47 +08:00
carm c32a941906 docs: Edit logo size 2025-03-21 02:32:33 +08:00
carm 8b597d10f9 feat: Optimized ContentHandler with Replacer & Inserter. 2025-03-21 02:31:04 +08:00
carm cedfcfd262 docs: Update banners and icons 2025-03-21 02:30:35 +08:00
carm 12add75232 feat: Enhanced text content replacer 2025-03-20 20:28:33 +08:00
carm 4d29a24768 docs: Edited readme 2025-03-20 17:16:33 +08:00
carm 8626b86961 chore: Change logo 2025-03-20 16:08:17 +08:00
carm 754dc1de1f feat: Change logo 2025-03-20 16:04:50 +08:00
carm 3d1d4ca609 chore: Add logo & icon. 2025-03-20 15:32:27 +08:00
carm 990b10b6f0 chore: Add logo & icon. 2025-03-20 15:30:34 +08:00
carm 7462cd720e chore: Optimize code format & functions. 2025-03-19 18:36:08 +08:00
carm 6bc83eb3b3 chore: Optimize code format & functions. 2025-03-19 18:35:45 +08:00
40 changed files with 740 additions and 179 deletions
Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 112 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 23 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 21 KiB

Before

Width:  |  Height:  |  Size: 99 KiB

After

Width:  |  Height:  |  Size: 99 KiB

+2 -1
View File
@@ -1,3 +1,4 @@
.idea/
.idea/*
!.idea/icon.svg
**/target/
**.iml
+36
View File
File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 23 KiB

+7 -5
View File
@@ -11,12 +11,14 @@
README LANGUAGES [ [**English**](README.md) | [中文](README_CN.md) ]
</div>
# configured (config-framework)
# configured _(config framework)_
_**"Once set, Simple get."**_
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
A simple, easy-to-use and universal solution for managing, loading, reading,
and updating configuration files.
_**"Once set, Simple get."**_
A simple, easy-to-use and universal solution for managing, loading, reading,
and updating configuration files.
Supported **JSON**, **YAML**, **Hocon**, **TOML**, **SQL**, **MongoDB**... and much more!
@@ -37,7 +39,7 @@ For the latest JavaDoc release, [CLICK HERE](https://CarmJos.github.io/configure
For a detailed development guide, [CLICK HERE](.doc/README.md).
### Code Samples
### Preview
To quickly demonstrate the applicability of the project, here are a few practical demonstrations:
+3 -1
View File
@@ -12,7 +12,9 @@ README LANGUAGES [ [English](README.md) | [**中文**](README_CN.md) ]
</div>
# configured (config-framework)
# configured _(配置文件框架)_
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
**一次配置,轻松读取!**
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<properties>
@@ -55,16 +55,20 @@ public class ValueAdapter<TYPE>
@Override
public @Nullable Object serialize(
@NotNull ConfigurationHolder<?> holder, @NotNull ValueType<? super TYPE> type,
@NotNull TYPE value) throws Exception {
@NotNull ConfigurationHolder<?> holder,
@NotNull ValueType<? super TYPE> type,
@NotNull TYPE value
) throws Exception {
if (serializer == null) throw new UnsupportedOperationException("Serializer is not supported");
return serializer.serialize(holder, type, value);
}
@Override
public @Nullable TYPE parse(
@NotNull ConfigurationHolder<?> holder, @NotNull ValueType<? super TYPE> type,
@NotNull Object value) throws Exception {
@NotNull ConfigurationHolder<?> holder,
@NotNull ValueType<? super TYPE> type,
@NotNull Object value
) throws Exception {
if (deserializer == null) throw new UnsupportedOperationException("Deserializer is not supported");
return deserializer.parse(holder, type, value);
}
@@ -2,7 +2,6 @@ package cc.carm.lib.configuration.adapter;
import cc.carm.lib.configuration.function.DataFunction;
import cc.carm.lib.configuration.source.ConfigurationHolder;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -84,7 +83,9 @@ public class ValueAdapterRegistry {
@SuppressWarnings("unchecked")
public <T> @Nullable ValueAdapter<T> adapterOf(@NotNull ValueType<T> type) {
ValueAdapter<?> matched = adapters.stream().filter(adapter -> adapter.type().equals(type)).findFirst().orElse(null);
ValueAdapter<?> matched = adapters.stream()
.filter(adapter -> adapter.type().equals(type))
.findFirst().orElse(null);
if (matched != null) return (ValueAdapter<T>) matched;
// If no adapter found, try to find the adapter for the super type
@@ -101,12 +102,10 @@ public class ValueAdapterRegistry {
return adapterOf(ValueType.of(type));
}
@Contract("_,_,null -> null")
public <T> T deserialize(@NotNull ConfigurationHolder<?> holder, @NotNull Class<T> type, @Nullable Object source) throws Exception {
return deserialize(holder, ValueType.of(type), source);
}
@Contract("_,_,null -> null")
public <T> T deserialize(@NotNull ConfigurationHolder<?> holder, @NotNull ValueType<T> type, @Nullable Object source) throws Exception {
if (source == null) return null; // Null check
if (type.isInstance(source)) return type.cast(source); // Not required to deserialize
@@ -115,7 +114,7 @@ public class ValueAdapterRegistry {
return adapter.parse(holder, type, source);
}
@Contract("_,null -> null")
@Nullable
public <T> Object serialize(@NotNull ConfigurationHolder<?> holder, @Nullable T value) throws Exception {
if (value == null) return null; // Null check
ValueType<T> type = ValueType.of(value);
@@ -5,7 +5,6 @@ import org.jetbrains.annotations.NotNull;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
@@ -56,10 +55,14 @@ public abstract class ValueType<T> {
};
}
public static <T> ValueType<T> of(final Class<T> clazz) {
public static <T> ValueType<T> of(final @NotNull Class<T> clazz) {
return of((Type) clazz);
}
public static <T> ValueType<List<T>> ofList(final @NotNull Class<T> paramType) {
return of(List.class, paramType);
}
/**
* Get the generic type of the complex type.
*
@@ -1,7 +0,0 @@
package cc.carm.lib.configuration.function;
public interface ValueSupplier {
}
@@ -13,7 +13,6 @@ import cc.carm.lib.configuration.source.option.ConfigurationOptionHolder;
import cc.carm.lib.configuration.source.section.ConfigureSource;
import cc.carm.lib.configuration.value.ConfigValue;
import cc.carm.lib.configuration.value.ValueManifest;
import org.jetbrains.annotations.Contract;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.UnmodifiableView;
@@ -87,7 +86,7 @@ public abstract class ConfigurationHolder<SOURCE extends ConfigureSource<?, ?, S
@NotNull
@UnmodifiableView
public <M> Map<String, M> extractMetadata(@NotNull ConfigurationMetadata<M> type, @NotNull Predicate<M> filter) {
public <M> Map<String, M> extractMetadata(@NotNull ConfigurationMetadata<M> type, @NotNull Predicate<@Nullable M> filter) {
Map<String, M> metas = new LinkedHashMap<>();
for (Map.Entry<String, ConfigurationMetaHolder> entry : this.metadata.entrySet()) {
M data = entry.getValue().get(type);
@@ -110,17 +109,17 @@ public abstract class ConfigurationHolder<SOURCE extends ConfigureSource<?, ?, S
return initializer;
}
@Contract("_,null -> null")
@Nullable
public <T> T deserialize(@NotNull Class<T> type, @Nullable Object source) throws Exception {
return adapters().deserialize(this, type, source);
}
@Contract("_,null -> null")
@Nullable
public <T> T deserialize(@NotNull ValueType<T> type, @Nullable Object source) throws Exception {
return adapters().deserialize(this, type, source);
}
@Contract("null -> null")
@Nullable
public <T> Object serialize(@Nullable T value) throws Exception {
return adapters().serialize(this, value);
}
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<properties>
@@ -33,11 +33,11 @@ public class ItemStack {
return amount;
}
public String getName() {
public @Nullable String getName() {
return name;
}
public List<String> getLore() {
public @Nullable List<String> getLore() {
return lore;
}
@@ -49,11 +49,11 @@ public class ItemStack {
this.amount = amount;
}
public void setName(String name) {
public void setName(@Nullable String name) {
this.name = name;
}
public void setLore(List<String> lore) {
public void setLore(@Nullable List<String> lore) {
this.lore = lore;
}
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
@@ -166,12 +166,12 @@ public class ImmutableSection implements ConfigureSection {
}
@Override
public <T> @Nullable T get(@NotNull String path, @Nullable T defaults, @NotNull Class<T> clazz) {
public <T> @Nullable T get(@NotNull String path, T defaults, @NotNull Class<T> clazz) {
return raw().get(path, defaults, clazz);
}
@Override
public <T> @Nullable T get(@NotNull String path, @Nullable T defaultValue, @NotNull DataFunction<Object, T> parser) {
public <T> @Nullable T get(@NotNull String path, T defaultValue, @NotNull DataFunction<Object, T> parser) {
return raw().get(path, defaultValue, parser);
}
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
@@ -7,7 +7,6 @@ import cc.carm.lib.configuration.source.ConfigurationHolder;
import cc.carm.lib.configuration.value.ValueManifest;
import cc.carm.lib.configuration.value.standard.ConfiguredValue;
import cc.carm.lib.configuration.value.text.data.TextContents;
import cc.carm.lib.configuration.value.text.function.TextDispatcher;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
@@ -50,7 +49,7 @@ public class ConfiguredText<MSG, RECEIVER> extends ConfiguredValue<TextContents>
this.params = params;
}
public TextDispatcher<MSG, RECEIVER, ?> prepare(@NotNull Object... values) {
public PreparedText<MSG, RECEIVER> prepare(@NotNull Object... values) {
return new PreparedText<MSG, RECEIVER>(resolve(), this.params)
.parser(this.parser).compiler(this.compiler)
.dispatcher(this.dispatcher).placeholders(values);
@@ -1,52 +1,27 @@
package cc.carm.lib.configuration.value.text.function;
import cc.carm.lib.configuration.value.text.data.TextContents;
import cc.carm.lib.configuration.value.text.function.common.AppendLineInserter;
import cc.carm.lib.configuration.value.text.function.common.OptionalLineInserter;
import cc.carm.lib.configuration.value.text.function.common.ParamReplacer;
import cc.carm.lib.configuration.value.text.function.inserter.ContentInserter;
import cc.carm.lib.configuration.value.text.function.inserter.Insertable;
import cc.carm.lib.configuration.value.text.function.replacer.ContentReplacer;
import cc.carm.lib.configuration.value.text.function.replacer.Replaceable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.*;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.UnaryOperator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.IntStream;
public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEIVER, SELF>> {
/**
* Used to match the message insertion.
* <p>
* format:
* <br>- to insert parsed line {prefix}#content-id#{offset-above,offset-down}
* <br>- to insert original line {prefix}@content-id@{offset-above,offset-down}
* <br> original lines will not be parsed
* <br> example:
* <ul>
* <li>{- }#content-id#{1,1}</li>
* <li>@content-id@{1,1}</li>
* </ul>
*/
public static final @NotNull Pattern INSERT_PATTERN = Pattern.compile(
"^(?:\\{(?<prefix>.*)})?(?<type>[#@])(?<id>.*)[#@](?:\\{(?<above>-?\\d+)(?:,(?<down>-?\\d+))?})?$"
);
/**
* Used to match the message which can be inserted
* <p>
* format:
* <br>- ?[id]Message content
* <br> example:
* <ul>
* <li>?[click]Click to use this item!</li>
* </ul>
*/
public static final @NotNull Pattern ENABLE_PATTERN = Pattern.compile(
"^\\?\\[(?<id>.+)](?<content>.*)$"
);
public static final @NotNull UnaryOperator<String> DEFAULT_PARAM_BUILDER = s -> "%(" + s + ")";
public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEIVER, SELF>>
implements Replaceable<RECEIVER, SELF>, Insertable<RECEIVER, SELF> {
protected BiFunction<RECEIVER, String, String> parser = (receiver, value) -> value;
protected String lineSeparator = System.lineSeparator();
@@ -54,16 +29,24 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
/**
* Used to store the placeholders of the message
*/
protected @NotNull Map<String, Object> placeholders = new HashMap<>();
protected @NotNull UnaryOperator<String> paramFormatter = DEFAULT_PARAM_BUILDER;
protected @NotNull ParamReplacer<RECEIVER> paramReplacer = ParamReplacer.defaults();
protected @NotNull String[] params;
protected @NotNull List<ContentReplacer<RECEIVER>> replacers = new ArrayList<>();
protected @NotNull List<ContentInserter<RECEIVER>> inserters = new ArrayList<>();
/**
* Used to store the insertion of the message
*/
protected @NotNull Map<String, @Nullable Function<RECEIVER, List<String>>> insertion = new HashMap<>();
protected final @NotNull Map<String, @Nullable Function<RECEIVER, List<String>>> insertion = new HashMap<>();
protected boolean disableInsertion = false;
public ContentHandler() {
inserters.add(new AppendLineInserter<>(0));
inserters.add(new OptionalLineInserter<>(0));
}
public abstract SELF self();
/**
@@ -87,6 +70,11 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
return self();
}
@Override
public boolean noneInsertion() {
return this.insertion.isEmpty();
}
/**
* Set the line separator for the text.
*
@@ -106,7 +94,7 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
* @return the current {@link ContentHandler} instance
*/
public SELF placeholders(@NotNull Map<String, Object> placeholders) {
this.placeholders = placeholders;
this.paramReplacer.set(placeholders);
return self();
}
@@ -117,7 +105,7 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
* @return the current {@link ContentHandler} instance
*/
public SELF placeholders(@NotNull Consumer<Map<String, Object>> consumer) {
consumer.accept(this.placeholders);
consumer.accept(this.paramReplacer.placeholders());
return self();
}
@@ -128,7 +116,8 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
* @return the current {@link ContentHandler} instance
*/
public SELF placeholders(@Nullable Object... values) {
return placeholders(map -> map.putAll(buildParams(this.paramFormatter, this.params, values)));
this.paramReplacer.putAll(this.params, values);
return self();
}
/**
@@ -139,7 +128,7 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
* @return the current {@link ContentHandler} instance
*/
public SELF placeholder(@NotNull String key, @Nullable Object value) {
this.placeholders.put(paramFormatter.apply(key), value);
this.paramReplacer.put(key, value);
return self();
}
@@ -155,49 +144,57 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
return self();
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @return the current {@link ContentHandler} instance
*/
public SELF insert(@NotNull String id) {
this.insertion.put(id, null);
@Override
public List<ContentReplacer<RECEIVER>> replacers() {
return this.replacers;
}
@Override
public SELF replacer(@NotNull ContentReplacer<RECEIVER> replacer) {
this.replacers.add(replacer);
this.replacers.sort(ContentReplacer::compareTo);
return self();
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param linesSupplier to supply the lines to insert
* @return the current {@link ContentHandler} instance
*/
public SELF insert(@NotNull String id, @NotNull Function<RECEIVER, List<String>> linesSupplier) {
this.insertion.put(id, linesSupplier);
public SELF paramReplacer(@NotNull ParamReplacer<RECEIVER> paramReplacer) {
this.paramReplacer = paramReplacer;
return self();
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param lines the lines to insert
* @return the current {@link ContentHandler} instance
*/
public SELF insert(@NotNull String id, @NotNull String... lines) {
return insert(id, Arrays.asList(lines));
@Override
public List<ContentInserter<RECEIVER>> inserters() {
return this.inserters;
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param lines the lines to insert
* @return the current {@link ContentHandler} instance
*/
public SELF insert(@NotNull String id, @NotNull List<String> lines) {
return insert(id, receiver -> lines);
@Override
public SELF inserter(@NotNull ContentInserter<RECEIVER> inserter) {
this.inserters.add(inserter);
this.inserters.sort(ContentInserter::compareTo);
return self();
}
@Override
public SELF insert(@NotNull String id, @Nullable Function<RECEIVER, List<String>> supplier) {
this.insertion.put(id, supplier);
return self();
}
@Override
public boolean inserting(@NotNull String id) {
return this.insertion.keySet().stream().anyMatch(key -> key.equalsIgnoreCase(id));
}
@Override
public @Nullable List<String> getInsertion(@NotNull String id, @Nullable RECEIVER receiver) {
Function<RECEIVER, List<String>> function = this.insertion.get(id);
if (function == null) return null;
return function.apply(receiver);
}
@Override
public SELF removeInsert(@NotNull String id) {
this.insertion.remove(id);
return self();
}
/**
@@ -219,63 +216,41 @@ public abstract class ContentHandler<RECEIVER, SELF extends ContentHandler<RECEI
* @return the parsed text
*/
protected @Nullable String parse(@Nullable RECEIVER receiver, @NotNull String text) {
return this.parser.apply(receiver, setPlaceholders(text, this.placeholders));
text = applyReplacements(receiver, text); // First, apply the custom replacements
text = this.paramReplacer.replace(text, receiver); // Then, apply the static placeholders
return this.parser.apply(receiver, text); // Finally, parse the text
}
public void handle(@NotNull TextContents contents, @Nullable RECEIVER receiver,
@NotNull Consumer<String> lineConsumer) {
if (contents.isEmpty()) return; // Nothing to parse
if (this.disableInsertion) {
if (this.disableInsertion || noneInsertion()) {
contents.lines().forEach(line -> lineConsumer.accept(parse(receiver, line)));
return; // Simple parsed
}
// Set the default insertion of the text
for (Map.Entry<String, @Nullable Function<RECEIVER, List<String>>> entry : this.insertion.entrySet()) {
if (entry.getValue() != null) continue;
List<String> lines = contents.optionalLines().get(entry.getKey());
if (lines == null) continue;
entry.setValue(r -> lines);
}
lines:
for (String line : contents.lines()) {
Matcher insertMatcher = INSERT_PATTERN.matcher(line);
if (insertMatcher.matches()) {
doInsert(insertMatcher, receiver, lineConsumer);
continue;
}
Matcher enableMatcher = ENABLE_PATTERN.matcher(line);
if (enableMatcher.matches()) {
if (this.insertion.containsKey(enableMatcher.group("id"))) {
lineConsumer.accept(parse(receiver, enableMatcher.group("content")));
for (ContentInserter<RECEIVER> inserter : inserters) {
List<String> inserted = inserter.handle(receiver, line, this);
if (inserted != null) { // Found the insertion
inserted.forEach(l -> lineConsumer.accept(parse(receiver, l)));
continue lines; // Go to the next line
}
continue;
}
lineConsumer.accept(parse(receiver, line));
}
}
private void doInsert(Matcher matcher, @Nullable RECEIVER receiver,
@NotNull Consumer<String> lineConsumer) {
String id = matcher.group("id");
List<String> values = Optional.ofNullable(this.insertion.get(id))
.map(f -> f.apply(receiver))
.orElse(null);
if (values == null || values.isEmpty()) return; // No values to insert
String prefix = matcher.group("prefix");
String type = matcher.group("type");
boolean original = type.equals("@");
int offsetAbove = Optional.ofNullable(matcher.group("above"))
.map(Integer::parseInt).orElse(0);
int offsetDown = Optional.ofNullable(matcher.group("down"))
.map(Integer::parseInt).orElse(offsetAbove); // If offsetDown is not set, use offsetAbove
IntStream.range(0, Math.max(0, offsetAbove)).mapToObj(i -> "").forEach(lineConsumer);
String prefixContent = Optional.ofNullable(prefix).map(p -> parse(receiver, p)).orElse("");
if (original) {
values.stream().map(value -> prefixContent + value).forEach(lineConsumer);
} else {
values.stream().map(value -> prefixContent + parse(receiver, value)).forEach(lineConsumer);
}
IntStream.range(0, Math.max(0, offsetDown)).mapToObj(i -> "").forEach(lineConsumer);
}
public static String setPlaceholders(@NotNull String messages,
@NotNull Map<String, Object> placeholders) {
if (messages.isEmpty()) return messages;
@@ -0,0 +1,67 @@
package cc.carm.lib.configuration.value.text.function.common;
import cc.carm.lib.configuration.value.text.function.inserter.ContentInserter;
import cc.carm.lib.configuration.value.text.function.inserter.Insertable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.IntStream;
public class AppendLineInserter<RECEIVER> extends ContentInserter<RECEIVER> {
/**
* Used to match the message insertion.
* <p>
* format:
* <br>- to insert parsed line {prefix}#content-id#{offset-above,offset-down}
* <br>- to insert original line {prefix}@content-id@{offset-above,offset-down}
* <br> original lines will not be parsed
* <br> example:
* <ul>
* <li>{- }#content-id#{1,1}</li>
* <li>@content-id@{1,1}</li>
* </ul>
*/
public static final @NotNull Pattern APPEND_PATTERN = Pattern.compile(
"^(?:\\{(?<prefix>.*)})?#(?<id>.*)#(?:\\{(?<above>-?\\d+)(?:,(?<down>-?\\d+))?})?$"
);
public AppendLineInserter(int priority) {
super(priority, APPEND_PATTERN);
}
@Override
protected @Nullable String extractID(@NotNull Matcher matcher) {
return matcher.group("id");
}
@Override
protected @NotNull List<String> get(@Nullable RECEIVER receiver, @NotNull Matcher matcher,
@NotNull Insertable<RECEIVER, ?> insertion) {
String id = extractID(matcher);
List<String> values = insertion.getInsertion(id, receiver);
if (values == null || values.isEmpty()) return Collections.emptyList(); // No values to insert
String prefix = Optional.ofNullable(matcher.group("prefix")).orElse("");
int offsetAbove = Optional.ofNullable(matcher.group("above"))
.map(Integer::parseInt).orElse(0);
int offsetDown = Optional.ofNullable(matcher.group("down"))
.map(Integer::parseInt).orElse(offsetAbove); // If offsetDown is not set, use offsetAbove
List<String> contents = new ArrayList<>();
IntStream.range(0, Math.max(0, offsetAbove)).mapToObj(i -> "").forEach(contents::add);
values.stream().map(value -> prefix + value).forEach(contents::add);
IntStream.range(0, Math.max(0, offsetDown)).mapToObj(i -> "").forEach(contents::add);
return contents;
}
}
@@ -0,0 +1,46 @@
package cc.carm.lib.configuration.value.text.function.common;
import cc.carm.lib.configuration.value.text.function.inserter.ContentInserter;
import cc.carm.lib.configuration.value.text.function.inserter.Insertable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class OptionalLineInserter<RECEIVER> extends ContentInserter<RECEIVER> {
/**
* Used to match the message which can be inserted
* <p>
* format:
* <br>- ?[id]Message content
* <br> example:
* <ul>
* <li>?[click]Click to use this item!</li>
* </ul>
*/
public static final @NotNull Pattern OPTIONAL_PATTERN = Pattern.compile(
"^\\?\\[(?<id>.+)](?<content>.*)$"
);
public OptionalLineInserter(int priority) {
super(priority, OPTIONAL_PATTERN);
}
@Override
protected @Nullable String extractID(@NotNull Matcher matcher) {
return matcher.group("id");
}
@Override
protected @NotNull List<String> get(@Nullable RECEIVER receiver, @NotNull Matcher matcher,
@NotNull Insertable<RECEIVER, ?> insertion) {
String content = matcher.group("content");
if (content == null) return Collections.emptyList();
return Collections.singletonList(content);
}
}
@@ -0,0 +1,71 @@
package cc.carm.lib.configuration.value.text.function.common;
import cc.carm.lib.configuration.value.text.function.replacer.ContentReplacer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class ParamReplacer<RECEIVER> extends ContentReplacer<RECEIVER> {
public static final @NotNull Pattern DEFAULT_PARAM_PATTERN = Pattern.compile("%\\((?<id>[^)]+)\\)");
public static <R> ParamReplacer<R> defaults() {
return create(DEFAULT_PARAM_PATTERN, m -> m.group("id"));
}
public static <R> ParamReplacer<R> create(@NotNull Pattern pattern, @NotNull Function<Matcher, String> extractor) {
return new ParamReplacer<>(0, pattern, extractor);
}
protected final @NotNull Function<Matcher, @Nullable String> extractor;
protected @NotNull Map<String, Object> placeholders = new HashMap<>();
public ParamReplacer(int priority, @NotNull Pattern pattern, @NotNull Function<Matcher, String> extractor) {
super(priority, pattern);
this.extractor = extractor;
}
public @NotNull Map<String, Object> placeholders() {
return placeholders;
}
@Override
protected @Nullable String get(@NotNull RECEIVER receiver, @NotNull Matcher matcher) {
@Nullable String id = extractor.apply(matcher);
if (id == null) return null;
Object value = placeholders.get(id);
if (value == null) return null;
return value.toString();
}
public void set(@NotNull Map<String, Object> placeholders) {
this.placeholders = placeholders;
}
public void put(@NotNull String id, @Nullable Object value) {
placeholders.put(id, value);
}
public void remove(@NotNull String id) {
placeholders.remove(id);
}
public void putAll(@NotNull Map<String, Object> placeholders) {
this.placeholders.putAll(placeholders);
}
public void putAll(@NotNull String[] params, @NotNull Object[] values) {
for (int i = 0; i < params.length; i++) {
placeholders.put(params[i], (values != null && values.length > i) ? values[i] : "?");
}
}
public void clear() {
placeholders.clear();
}
}
@@ -0,0 +1,51 @@
package cc.carm.lib.configuration.value.text.function.inserter;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Collections;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public abstract class ContentInserter<RECEIVER> implements Comparable<ContentInserter<RECEIVER>> {
protected final int priority;
protected @NotNull Pattern pattern;
public ContentInserter(int priority, @NotNull Pattern pattern) {
this.priority = priority;
this.pattern = pattern;
}
public int priority() {
return priority;
}
public void setPattern(@NotNull Pattern pattern) {
this.pattern = pattern;
}
public @NotNull Matcher matcher(@NotNull String text) {
return pattern.matcher(text);
}
protected abstract @Nullable String extractID(@NotNull Matcher matcher);
protected abstract @NotNull List<String> get(@Nullable RECEIVER receiver, @NotNull Matcher matcher,
@NotNull Insertable<RECEIVER, ?> insertions);
public @Nullable List<String> handle(@Nullable RECEIVER receiver, @NotNull String line,
@NotNull Insertable<RECEIVER, ?> insertions) {
Matcher matcher = matcher(line);
if (!matcher.matches()) return null;
if (!insertions.inserting(extractID(matcher))) return Collections.emptyList();
return get(receiver, matcher, insertions);
}
@Override
public int compareTo(@NotNull ContentInserter<RECEIVER> o) {
return Integer.compare(o.priority, priority);
}
}
@@ -0,0 +1,66 @@
package cc.carm.lib.configuration.value.text.function.inserter;
import cc.carm.lib.configuration.value.text.function.ContentHandler;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.Arrays;
import java.util.List;
import java.util.function.Function;
public interface Insertable<RECEIVER, SELF> {
List<ContentInserter<RECEIVER>> inserters();
SELF inserter(@NotNull ContentInserter<RECEIVER> inserter);
boolean noneInsertion();
boolean inserting(@NotNull String id);
@Nullable List<String> getInsertion(@NotNull String id, @Nullable RECEIVER receiver);
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param supplier to supply the lines to insert
* @return the current {@link ContentHandler} instance
*/
SELF insert(@NotNull String id, @Nullable Function<RECEIVER, List<String>> supplier);
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @return the current {@link ContentHandler} instance
*/
default SELF insert(@NotNull String id) {
return insert(id, (Function<RECEIVER, List<String>>) null);
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param contents the lines to insert
* @return the current {@link ContentHandler} instance
*/
default SELF insert(@NotNull String id, @NotNull List<String> contents) {
return insert(id, receiver -> contents);
}
/**
* Insert the specific contents by the id.
*
* @param id the id of the insertion text
* @param contents the lines to insert
* @return the current {@link ContentHandler} instance
*/
default SELF insert(@NotNull String id, @NotNull String... contents) {
return insert(id, Arrays.asList(contents));
}
SELF removeInsert(@NotNull String id);
}
@@ -0,0 +1,105 @@
package cc.carm.lib.configuration.value.text.function.replacer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public abstract class ContentReplacer<RECEIVER> implements Comparable<ContentReplacer<RECEIVER>> {
public static <R> ContentReplacer.Builder<R> match(@NotNull Pattern pattern) {
return new Builder<>(pattern);
}
public static <R> ContentReplacer.Builder<R> match(@NotNull String pattern) {
return match(Pattern.compile(pattern));
}
public static <R> ContentReplacer.Builder<R> replace(@NotNull String text) {
return match(Pattern.quote(text));
}
protected final int priority;
protected @NotNull Pattern pattern;
public ContentReplacer(int priority, @NotNull Pattern pattern) {
this.priority = priority;
this.pattern = pattern;
}
public int priority() {
return priority;
}
public void pattern(@NotNull Pattern pattern) {
this.pattern = pattern;
}
public @NotNull Matcher matcher(@NotNull String text) {
return pattern.matcher(text);
}
public String replace(@NotNull String text, @Nullable RECEIVER receiver) {
Matcher matcher = matcher(text);
StringBuffer sb = new StringBuffer();
while (matcher.find()) {
String replaced = get(receiver, matcher);
matcher.appendReplacement(sb, replaced == null ? "" : replaced);
}
matcher.appendTail(sb);
return sb.toString();
}
protected abstract @Nullable String get(@Nullable RECEIVER receiver, @NotNull Matcher matcher);
@Override
public int compareTo(@NotNull ContentReplacer<RECEIVER> o) {
return Integer.compare(o.priority, this.priority);
}
public static class Builder<R> {
protected final @NotNull Pattern pattern;
protected int priority = 0;
public Builder(@NotNull Pattern pattern) {
this.pattern = pattern;
}
public @NotNull Builder<R> priority(int priority) {
this.priority = priority;
return this;
}
public @NotNull ContentReplacer<R> to(BiFunction<@Nullable R, @NotNull Matcher, @Nullable String> supplier) {
return new ContentReplacer<R>(this.priority, this.pattern) {
@Override
protected @Nullable String get(@NotNull R receiver, @NotNull Matcher matcher) {
return supplier.apply(receiver, matcher);
}
};
}
public @NotNull ContentReplacer<R> to(Function<@Nullable R, @Nullable String> supplier) {
return to((receiver, matchedParam) -> supplier.apply(receiver));
}
public @NotNull ContentReplacer<R> to(Supplier<@Nullable String> supplier) {
return to((receiver, matchedParam) -> supplier.get());
}
public @NotNull ContentReplacer<R> to(@NotNull String content) {
return to(() -> content);
}
}
@FunctionalInterface
public interface Constructor<R> extends Function<ContentReplacer.Builder<R>, ContentReplacer<R>> {
}
}
@@ -0,0 +1,63 @@
package cc.carm.lib.configuration.value.text.function.replacer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
import java.util.function.BiFunction;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public interface Replaceable<RECEIVER, SELF> {
List<ContentReplacer<RECEIVER>> replacers();
default String applyReplacements(@Nullable RECEIVER receiver, @NotNull String text) {
for (ContentReplacer<RECEIVER> replacer : replacers()) {
text = replacer.replace(text, receiver);
}
return text;
}
SELF replacer(@NotNull ContentReplacer<RECEIVER> replacer);
default SELF replacer(@NotNull Pattern pattern, @NotNull ContentReplacer.Constructor<RECEIVER> constructor) {
ContentReplacer.Builder<RECEIVER> builder = ContentReplacer.match(pattern);
return replacer(constructor.apply(builder));
}
default SELF replace(@NotNull Pattern pattern,
@NotNull BiFunction<@Nullable RECEIVER, @NotNull Matcher, @Nullable String> supplier) {
return replacer(pattern, builder -> builder.to(supplier));
}
default SELF replace(@NotNull Pattern pattern,
@NotNull Function<@Nullable RECEIVER, @Nullable String> supplier) {
return replacer(pattern, builder -> builder.to(supplier));
}
default SELF replace(@NotNull Pattern pattern,
@NotNull Supplier<@Nullable String> supplier) {
return replacer(pattern, builder -> builder.to(supplier));
}
default SELF replace(@NotNull Pattern pattern, @NotNull String replacement) {
return replacer(pattern, builder -> builder.to(replacement));
}
default SELF replace(@NotNull String text, @NotNull String replacement) {
return replacer(Pattern.compile(Pattern.quote(text)), builder -> builder.to(replacement));
}
default SELF replace(@NotNull String text, @NotNull Supplier<@Nullable String> supplier) {
return replacer(Pattern.compile(Pattern.quote(text)), builder -> builder.to(supplier));
}
default SELF replace(@NotNull String text,
@NotNull Function<@Nullable RECEIVER, @Nullable String> supplier) {
return replacer(Pattern.compile(Pattern.quote(text)), builder -> builder.to(supplier));
}
}
@@ -7,17 +7,16 @@ import cc.carm.lib.configuration.value.text.tests.conf.AppMessages;
import org.junit.Test;
import java.io.File;
import java.util.List;
public class ConfigTest {
public static final String[] WEBSITES = new String[]{
"https://carm.cc",
"https://www.baidu.com",
"https://www.google.com"
};
@Test
public void test() {
@@ -27,11 +26,11 @@ public class ConfigTest {
System.out.println("--------------------------");
AppMessages.WELCOME.prepare()
List<String> str = AppMessages.WELCOME.prepare()
.placeholders("Carm")
.insert("guidance")
.insert("websites", WEBSITES)
.to(System.out);
.compile(System.out);
System.out.println("--------------------------");
@@ -7,6 +7,7 @@ import org.junit.Test;
import java.io.PrintStream;
import java.util.*;
public class ParseTest {
@@ -18,14 +19,15 @@ public class ParseTest {
lines.add("#more-creating#{1}");
lines.add("This is a test message");
lines.add("#guidance#");
lines.add("{- }#websites#{0,1}");
lines.add("{ - }#websites#{0,1}");
lines.add("Thanks for your reading!");
lines.add("uuid: $UUID$");
lines.add("?[click]");
lines.add("?[click]Click to see more!");
lines.add("?[hidden]This entry should be hidden!");
Map<String, List<String>> optional = new HashMap<>();
optional.put("guidance", Arrays.asList("To get more information for %(name), see:"));
optional.put("guidance", Arrays.asList("To get more information for %(name),", " see:"));
optional.put("websites", Arrays.asList("https://www.baidu.com", "https://www.google.com"));
TextContents textContents = new TextContents(lines, optional);
@@ -33,13 +35,17 @@ public class ParseTest {
PreparedText<String, PrintStream> msg = new PreparedText<String, PrintStream>(textContents)
.dispatcher((p, s) -> s.forEach(p::println))
.parser((p, s) -> s)
.compiler((p, s) -> s);
.compiler((p, s) -> s)
.replace( // Custom replacer, replace $UUID$ with Random UUID
"$UUID$", () -> UUID.randomUUID().toString()
);
msg.placeholder("name", "Carm")
.insert("guidance")
.insert("click")
.insert("websites", "Baidu", "Bilibili", "Google");
System.out.println("----------------------------");
msg.to(System.out);
System.out.println("----------------------------");
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -15,7 +15,7 @@
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<packaging>pom</packaging>
<version>4.1.1</version>
<version>4.1.3</version>
<modules>
<module>core</module>
<module>features/section</module>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<groupId>cc.carm.lib</groupId>
<artifactId>configured-parent</artifactId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>
+1 -1
View File
@@ -6,7 +6,7 @@
<parent>
<artifactId>configured-parent</artifactId>
<groupId>cc.carm.lib</groupId>
<version>4.1.1</version>
<version>4.1.3</version>
<relativePath>../../pom.xml</relativePath>
</parent>
<properties>