🚀 Add number format expression

src/main/java/ch/njol/skript/expressions/ExprFormatNumber.java

@@ -0,0 +1,132 @@
+/**
+ *   This file is part of Skript.
+ *
+ *  Skript is free software: you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation, either version 3 of the License, or
+ *  (at your option) any later version.
+ *
+ *  Skript is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with Skript.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Copyright Peter Güttinger, SkriptLang team and contributors
+ */
+package ch.njol.skript.expressions;
+
+import ch.njol.skript.Skript;
+import ch.njol.skript.doc.Description;
+import ch.njol.skript.doc.Examples;
+import ch.njol.skript.doc.Name;
+import ch.njol.skript.doc.Since;
+import ch.njol.skript.expressions.base.PropertyExpression;
+import ch.njol.skript.lang.Expression;
+import ch.njol.skript.lang.ExpressionType;
+import ch.njol.skript.lang.Literal;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.VariableString;
+import ch.njol.skript.util.Getter;
+import ch.njol.util.Kleenean;
+import org.bukkit.event.Event;
+import org.eclipse.jdt.annotation.Nullable;
+
+import java.text.DecimalFormat;
+
+@Name("Formatted Number")
+@Description(
+	"Converts numbers to human-readable format. By default, '###,###' (e.g. '123,456,789') will be used. For reference, see this "
+		+ "<a href=\"https://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html\" target=\"_blank\">article</a>."
+)
+@Examples({
+	"command /formatnumber <number>:",
+		"\taliases: fn",
+		"\ttrigger:",
+			"\t\tsend \"Formatted: %formatted arg-1%\" to sender"
+})
+@Since("INSERT VERSION")
+public class ExprFormatNumber extends PropertyExpression<Number, String> {
+
+	private static final DecimalFormat DEFAULT_FORMAT = new DecimalFormat("###,###");
+
+	static {
+		Skript.registerExpression(ExprFormatNumber.class, String.class, ExpressionType.PROPERTY,
+				"%numbers% formatted [human-readable] [(with|as) %-string%]",
+				"[human-readable] formatted %numbers% [(with|as) %-string%]");
+	}
+
+	@SuppressWarnings("NotNullFieldNotInitialized")
+	private DecimalFormat format;
+
+	@Nullable
+	private Expression<? extends String> customFormat;
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, ParseResult parseResult) {
+		setExpr((Expression<? extends Number>) exprs[0]);
+		customFormat = (Expression<? extends String>) exprs[1];
+
+		boolean isSimpleString = customFormat instanceof VariableString && ((VariableString) customFormat).isSimple();
+		// if literal or is simple variable string then we can get the value at init and check
+		if (customFormat instanceof Literal || isSimpleString) {
+			String customFormatValue;
+			if (isSimpleString) {
+				customFormatValue = ((VariableString) customFormat).toString(null);
+			} else {
+				customFormatValue = ((Literal<String>) customFormat).getSingle();
+			}
+
+			// try to use user provided format
+			if (customFormatValue != null) {
+				try {
+					format = new DecimalFormat(customFormatValue);
+				} catch (IllegalArgumentException e) {
+					Skript.error("Invalid number format: " + customFormatValue);
+					return false;
+				}
+			}
+		// if not set then assign default format
+		} else if (customFormat == null) {
+			format = DEFAULT_FORMAT;
+		}
+
+		return true;
+	}
+
+	@Override
+	protected String[] get(Event event, Number[] source) {
+		DecimalFormat format;
+		String formatString;
+
+		if (customFormat != null && this.format == null) { // customFormat is not Literal or VariableString
+			formatString = customFormat.getSingle(event);
+			if (formatString == null)
+				return new String[0];
+
+			try {
+				format = new DecimalFormat(formatString);
+			} catch (IllegalArgumentException e) {
+				return new String[0];
+			}
+		} else {
+			format = this.format;
+		}
+
+		return get(source, format::format);
+	}
+
+	@Override
+	public Class<? extends String> getReturnType() {
+		return String.class;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return getExpr().toString(event, debug) + " formatted as " + (customFormat != null ? customFormat.toString(event, debug) : DEFAULT_FORMAT.toPattern());
+	}
+
+}

src/test/skript/tests/regressions/4663-formatted numbers.sk

@@ -0,0 +1,17 @@
+test "formatted numbers":
+	set {_num1} to formatted 123456789
+	assert {_num1} = "123,456,789" with "default number format failed ##1"
+
+	set {_num2} to 1234567 formatted human-readable
+	assert {_num2} = "1,234,567" with "default number format failed ##2"
+
+	set {_num3} to formatted 12345678 as "##,##.00"
+	assert {_num3} = "1,2,3,4,5,6,7,8.00" with "custom number format failed ##1"
+
+	set {_cFormat} to "####,####"
+	set {_num4} to formatted 12345678 as {_cFormat}
+	assert {_num4} = "12,34,56,78" with "custom number format failed ##2"
+
+	set {_cFormat2} to "##,.##"
+	set {_num5} to formatted 12345678 as {_cFormat2}
+	assert {_num5} is not set with "custom number format failed ##3"