Merge pull request #304 from andrewlalis/andrew/progress_bar

Added different text progress bar for help account

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/systems/help/commands/subcommands/HelpAccountSubcommand.java

@@ -88,7 +88,7 @@ private String formatExperience(Guild guild, HelpAccount account) {
 			double percentToGoalXp = (currentXp / goalXp) * 100.0;
 			sb.append(String.format("%.0f / %.0f XP (%.2f%%) until %s\n", currentXp, goalXp, percentToGoalXp, nextRoleAndXp.first().getAsMention()))
 					.append(String.format("%.0f Total XP\n", account.getExperience()))
-					.append(StringUtils.buildProgressBar(currentXp, goalXp, "\u2B1B", "\uD83D\uDFE5", 14));
+					.append(StringUtils.buildTextProgressBar(percentToGoalXp / 100.0, 12));
 		} else {
 			sb.append(String.format("%.0f Total XP (MAX. LEVEL)", account.getExperience()));
 		}

src/main/java/net/javadiscord/javabot/util/StringUtils.java

@@ -71,6 +71,34 @@ public static String buildProgressBar(double current, double max, String off, St
 		return on.repeat(onLength) + off.repeat(length - onLength);
 	}
 
+	/**
+	 * Builds a progress bar that uses block characters.
+	 * <p>
+	 *     For example: <pre>[███████    ]</pre>
+	 * </p>
+	 *
+	 * @param value The floating-point value. This should be between 0 and 1,
+	 *              inclusive. Any value outside that range will be truncated
+	 *              to either 0 or 1, depending on if it's positive or negative.
+	 * @param length The length of the progress bar string, including the
+	 *               brackets. It must be at least 5.
+	 * @return The progress bar string.
+	 */
+	public static String buildTextProgressBar(double value, int length) {
+		if (value < 0.0) value = 0.0;
+		if (value > 1.0) value = 1.0;
+		if (length < 5) throw new IllegalArgumentException("Length must be at least 5.");
+		StringBuilder sb = new StringBuilder(length);
+		sb.append('[');
+		int barElements = length - 2;
+		double elementsFilled = barElements * value;
+		int wholeElementsFilled = (int) Math.floor(elementsFilled);
+		sb.append("█".repeat(wholeElementsFilled));
+		sb.append(" ".repeat(barElements - wholeElementsFilled));
+		sb.append(']');
+		return sb.toString();
+	}
+
 	/**
 	 * Capitalizes the given word.
 	 *

src/test/java/net/javadiscord/javabot/util/StringUtilsTest.java

@@ -0,0 +1,33 @@
+package net.javadiscord.javabot.util;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+/**
+ * Tests for the {@link StringUtils} class.
+ */
+public class StringUtilsTest {
+
+	/**
+	 * Tests the {@link StringUtils#buildTextProgressBar(double, int)} method.
+	 */
+	@Test
+	public void testBuildTextProgressBar() {
+		assertThrows(IllegalArgumentException.class, () -> StringUtils.buildTextProgressBar(0.5, 4));
+		assertEquals("[   ]", StringUtils.buildTextProgressBar(0, 5));
+		assertEquals("[   ]", StringUtils.buildTextProgressBar(-100, 5));
+		assertEquals("[███]", StringUtils.buildTextProgressBar(1, 5));
+		assertEquals("[███]", StringUtils.buildTextProgressBar(3, 5));
+		assertEquals("[    ]", StringUtils.buildTextProgressBar(0.1, 6));
+		assertEquals("[    ]", StringUtils.buildTextProgressBar(0.24, 6));
+		assertEquals("[█   ]", StringUtils.buildTextProgressBar(0.25, 6));
+		assertEquals("[█   ]", StringUtils.buildTextProgressBar(0.45, 6));
+		assertEquals("[██  ]", StringUtils.buildTextProgressBar(0.5, 6));
+		assertEquals("[██  ]", StringUtils.buildTextProgressBar(0.65, 6));
+		assertEquals("[███ ]", StringUtils.buildTextProgressBar(0.75, 6));
+		assertEquals("[███ ]", StringUtils.buildTextProgressBar(0.95, 6));
+		assertEquals("[████]", StringUtils.buildTextProgressBar(1, 6));
+	}
+}