commit 706a22e6a1edb965aafae1ea46cee4c87307913b Author: William Date: Tue Aug 16 23:15:12 2022 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bf3e1b2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store +/.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..db0f234 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# PagineDown +[![Discord](https://img.shields.io/discord/818135932103557162?color=7289da&logo=discord)](https://discord.gg/tVYhJfyDWG) +[![](https://jitpack.io/v/net.william278/PagineDown.svg)](https://jitpack.io/#net.william278/PagineDown) + +PagineDown is a library for generating paginated [MineDown](https://github.com/Phoenix616/MineDown)-formatted chat menu lists. + +Requires Java 11+. PagineDown is a library that is intended to be used with MineDown (not standalone) -- your project will need to shade MineDown to use it. + +## Installation +PagineDown is available on JitPack. You can browse the Javadocs [here](https://javadoc.jitpack.io/net/william278/PagineDown/latest/javadoc/). + +### Maven +To use the library on Maven, in your `pom.xml` file, first add the JitPack repository: +```xml + + + jitpack.io + https://jitpack.io + + +``` + +Then, add the dependency in your `` section. Remember to replace `Tag` with the current Annotaml version. +```xml + + net.william278 + PagineDown + Tag + compile + +``` + +### Gradle & others +JitPack has a [handy guide](https://jitpack.io/#net.william278/PagineDown/#How_to) for how to use the dependency with other build platforms. + +## License +Annotaml is licensed under Apache-2.0. \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..e1f3d34 --- /dev/null +++ b/build.gradle @@ -0,0 +1,48 @@ +plugins { + id 'java' + id 'maven-publish' +} + +group 'net.william278' +version '1.0' + +repositories { + mavenCentral() + maven { url 'https://repo.minebench.de/' } +} + +dependencies { + compileOnly 'de.themoep:minedown:1.7.1-SNAPSHOT' + compileOnly 'org.jetbrains:annotations:23.0.0' + + testImplementation 'de.themoep:minedown:1.7.1-SNAPSHOT' + testImplementation 'net.md-5:bungeecord-chat:1.16-R0.4' + testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.0' + testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.0' +} + +compileJava.options.encoding = 'UTF-8' + +tasks.withType(JavaCompile) { + options.encoding = 'UTF-8' +} + +java { + withSourcesJar() + withJavadocJar() +} + +publishing { + publications { + shadow(MavenPublication) { publication -> + from components.java + } + } + repositories { + mavenLocal() + } +} + +test { + useJUnitPlatform() +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..41dfb87 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/jitpack.yml b/jitpack.yml new file mode 100644 index 0000000..2929398 --- /dev/null +++ b/jitpack.yml @@ -0,0 +1,5 @@ +# This file ensures jitpack builds PagineDown with Java 11 +jdk: + - 'openjdk11' +install: + - './gradlew clean publish' \ No newline at end of file diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..f18dabd --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'PagineDown' + diff --git a/src/main/java/net/william278/paginedown/ListOptions.java b/src/main/java/net/william278/paginedown/ListOptions.java new file mode 100644 index 0000000..a706df7 --- /dev/null +++ b/src/main/java/net/william278/paginedown/ListOptions.java @@ -0,0 +1,146 @@ +package net.william278.paginedown; + +import org.jetbrains.annotations.NotNull; + +import java.awt.*; + +/** + * Options, including placeholder strings, used to generate a {@link PaginatedList} of items + */ +public class ListOptions { + + @NotNull + protected String headerFormat = "[Viewing %topic%](%color%) [(%first_item_on_page_index%-%last_item_on_page_index% of](%color%) [%total_items%](%color% bold)[)](%color%)"; + @NotNull + protected String footerFormat = "%previous_page_button%Page [%current_page%](%color%)/[%total_pages%](%color%)%next_page_button% %page_jumpers%"; + @NotNull + protected String previousButtonFormat = "[◁](white show_text=%color%View previous page \\(%previous_page_index%\\) run_command=/%command% %previous_page_index%) "; + @NotNull + protected String nextButtonFormat = " [▷](white show_text=%color%View next page \\(%next_page_index%\\) run_command=/%command% %next_page_index%)"; + @NotNull + protected String pageJumpersFormat = "(%page_jump_buttons%)"; + @NotNull + protected String pageJumperPageSeparator = "|"; + @NotNull + protected String pageJumperGroupSeparator = "…"; + @NotNull + protected String pageJumperCurrentPageFormat = "[%page%](%color%)"; + @NotNull + protected String pageJumperPageFormat = "[%target_page_index%](show_text=&7Jump to page %target_page_index% run_command=/%command% %target_page_index%)"; + @NotNull + protected String topic = "List"; + @NotNull + protected String command = "example"; + @NotNull + protected Color themeColor = new Color(0x00fb9a); + protected boolean spaceAfterHeader = true; + protected boolean spaceBeforeFooter = true; + protected boolean escapeItemsMineDown = true; + @NotNull + protected String itemSeparator = "\n"; + protected int itemsPerPage = 10; + + private ListOptions() { + } + + @SuppressWarnings("unused") + public static class Builder { + @NotNull + private final ListOptions options = new ListOptions(); + + @NotNull + public Builder setHeaderFormat(@NotNull String headerFormat) { + options.headerFormat = headerFormat; + return this; + } + + @NotNull + public Builder setFooterFormat(@NotNull String footerFormat) { + options.footerFormat = footerFormat; + return this; + } + + @NotNull + public Builder setItemSeparator(@NotNull String itemSeparator) { + options.itemSeparator = itemSeparator; + return this; + } + + @NotNull + public Builder setThemeColor(@NotNull Color themeColor) { + options.themeColor = themeColor; + return this; + } + + @NotNull + public Builder setSpaceAfterHeader(final boolean spaceAfterHeader) { + options.spaceAfterHeader = spaceAfterHeader; + return this; + } + + @NotNull + public Builder setSpaceBeforeFooter(final boolean spaceBeforeFooter) { + options.spaceBeforeFooter = spaceBeforeFooter; + return this; + } + + @NotNull + public Builder setItemsPerPage(final int itemsPerPage) { + options.itemsPerPage = itemsPerPage; + return this; + } + + @NotNull + public Builder setTopic(@NotNull String topic) { + options.topic = topic; + return this; + } + + @NotNull + public Builder setCommand(@NotNull String command) { + options.command = command; + return this; + } + + @NotNull + public Builder setEscapeItemsMineDown(final boolean escapeItemsMineDown) { + options.escapeItemsMineDown = escapeItemsMineDown; + return this; + } + + @NotNull + public Builder setPageJumpersFormat(@NotNull String pageJumpersFormat) { + options.pageJumpersFormat = pageJumpersFormat; + return this; + } + + @NotNull + public Builder setPageJumperPageSeparator(@NotNull String pageJumperPageSeparator) { + options.pageJumperPageSeparator = pageJumperPageSeparator; + return this; + } + + @NotNull + public Builder setPageJumperPageFormat(@NotNull String pageJumperPageFormat) { + options.pageJumperPageFormat = pageJumperPageFormat; + return this; + } + + @NotNull + public Builder setPageJumperGroupSeparator(@NotNull String pageJumperGroupSeparator) { + options.pageJumperGroupSeparator = pageJumperGroupSeparator; + return this; + } + + @NotNull + public Builder setPageJumperCurrentPageFormat(@NotNull String pageJumperCurrentPageFormat) { + options.pageJumperCurrentPageFormat = pageJumperCurrentPageFormat; + return this; + } + + @NotNull + public ListOptions build() { + return options; + } + } +} diff --git a/src/main/java/net/william278/paginedown/PaginatedList.java b/src/main/java/net/william278/paginedown/PaginatedList.java new file mode 100644 index 0000000..bf846fd --- /dev/null +++ b/src/main/java/net/william278/paginedown/PaginatedList.java @@ -0,0 +1,275 @@ +package net.william278.paginedown; + + +import de.themoep.minedown.MineDown; +import org.jetbrains.annotations.NotNull; + +import java.util.List; +import java.util.StringJoiner; +import java.util.stream.Collectors; + +/** + * A class used to generate {@link MineDown} formatted chat menus of paginated list items. + *

+ * A paginated list contains the following elements: + *

+ * You can supply {@link ListOptions} to modify the format of each element, including shortcuts for modifying a theme color. + * Once you have created a {@link PaginatedList} object using the static {@code get(items, options)}, + * you can easily generate a {@link MineDown} formatted chat menu for a given page using the {@code getPage()} methods. + * + * @author William278 + * @see ListOptions + */ +@SuppressWarnings("unused") +public class PaginatedList { + + /** + * {@link ListOptions} to be used for generating the list + */ + @NotNull + private final ListOptions options; + + /** + * A list of items to be paginated; can be MineDown formatted + */ + @NotNull + private final List items; + + /** + * Private constructor used by {@code #get(List, ListOptions)} + * + * @param items a list of items to be paginated + * @param options {@link ListOptions} to be used for generating list pages + */ + private PaginatedList(@NotNull List items, @NotNull ListOptions options) { + this.items = items; + this.options = options; + } + + /** + * Create a new {@link PaginatedList} from a {@link List} of items + * + * @param items The {@link List} of items to paginate + * @return A new {@link PaginatedList} + */ + @NotNull + public static PaginatedList of(@NotNull List items) { + return new PaginatedList(items, new ListOptions.Builder().build()); + } + + /** + * Create a new {@link PaginatedList} from a {@link List} of items + * + * @param items The {@link List} of items to paginate + * @param options The {@link ListOptions} to use for generating list pages + * @return A new {@link PaginatedList} + */ + @NotNull + public static PaginatedList of(@NotNull List items, @NotNull ListOptions options) { + return new PaginatedList(items, options); + } + + + /** + * Returns a {@link MineDown} formatted message to be sent to a player of the paginated list for the nearest specified page that exists + *

List formats and options from the {@link ListOptions} are applied to generate list pages. + *

{@code #getNearestValidPage()} will return the nearest valid page (i.e. values below 0 will be set to 0, values above the maximum page will be set to the maximum page) + * + * @param page The page number to get + * @return A {@link MineDown} object, for formatting the list + */ + @NotNull + public MineDown getNearestValidPage(final int page) { + return getPage(Math.max(0, Math.min(getTotalPages(), page))); + } + + /** + * Returns a {@link MineDown} formatted message to be sent to a player of the paginated list for the specified page + *

List formats and options from the {@link ListOptions} are applied to generate the list. + * + * @param page The page number to get + * @return A {@link MineDown} object, for formatting the list + * @throws PaginationException If the page number is out of bounds + */ + public MineDown getPage(final int page) throws PaginationException { + return new MineDown(getRawPage(page)); + } + + /** + * Generates a raw string of pre-{@link MineDown}-formatted text that when formatted will create the page menu. + *

List formats and options from the {@link ListOptions} are applied to generate the list. + * + * @param page The page number to get + * @return A raw string of pre-MineDown-formatted text, representing the page menu. + * @throws PaginationException If the page number is out of bounds + */ + @NotNull + public String getRawPage(final int page) throws PaginationException { + if (page < 1) { + throw new PaginationException("Page index must be >= 1"); + } + if (page > getTotalPages()) { + throw new PaginationException("Page index must be <= the total number of pages (" + getTotalPages() + ")"); + } + + final StringJoiner menuJoiner = new StringJoiner("\n"); + if (!options.headerFormat.isBlank()) { + menuJoiner.add(formatPageString(options.headerFormat, page)); + if (options.spaceAfterHeader) { + menuJoiner.add(""); + } + } + + if (options.escapeItemsMineDown) { + menuJoiner.add(getItemsForPage(page).stream().map(MineDown::escape) + .collect(Collectors.joining(options.itemSeparator))); + } else { + menuJoiner.add(String.join(options.itemSeparator, getItemsForPage(page))); + } + + if (!options.footerFormat.isBlank()) { + if (options.spaceBeforeFooter) { + menuJoiner.add(""); + } + menuJoiner.add(formatPageString(options.footerFormat, page)); + } + return menuJoiner.toString(); + } + + /** + * Returns the total number of pages + * + * @return The total number of pages + */ + public int getTotalPages() { + return (int) Math.ceil((double) items.size() / options.itemsPerPage); + } + + /** + * Returns the items to be displayed on the specified page + * + * @param page The page number to get + * @return The sub-list of items to be shown on a given page + */ + @NotNull + private List getItemsForPage(final int page) { + return items.subList((page - 1) * options.itemsPerPage, Math.min(items.size(), page * options.itemsPerPage)); + } + + /** + * Formats a ListOption placeholder format with values + * + * @param format The format string + * @param page The page number + * @return The formatted page string + */ + @NotNull + private String formatPageString(@NotNull String format, int page) { + final StringBuilder convertedFormat = new StringBuilder(); + StringBuilder currentPlaceholder = new StringBuilder(); + boolean readingPlaceholder = false; + for (char c : format.toCharArray()) { + if (c == '%') { + if (readingPlaceholder) { + switch (currentPlaceholder.toString().toLowerCase()) { + case "topic": + convertedFormat.append(formatPageString(options.topic, page)); + break; + case "color": + convertedFormat.append(String.format("#%02x%02x%02x", options.themeColor.getRed(), options.themeColor.getGreen(), options.themeColor.getBlue())); + break; + case "first_item_on_page_index": + convertedFormat.append(((page - 1) * options.itemsPerPage) + 1); + break; + case "last_item_on_page_index": + convertedFormat.append(((page - 1) * options.itemsPerPage) + getItemsForPage(page).size()); + break; + case "total_items": + convertedFormat.append(items.size()); + break; + case "current_page": + convertedFormat.append(page); + break; + case "total_pages": + convertedFormat.append(getTotalPages()); + break; + case "previous_page_button": + if (page > 1) { + convertedFormat.append(formatPageString(options.previousButtonFormat, page)); + } + break; + case "next_page_button": + if (page < getTotalPages()) { + convertedFormat.append(formatPageString(options.nextButtonFormat, page)); + } + break; + case "next_page_index": + convertedFormat.append(page + 1); + break; + case "previous_page_index": + convertedFormat.append(page - 1); + break; + case "command": + convertedFormat.append(options.command); + break; + case "page_jumpers": + if (getTotalPages() > 2) { + convertedFormat.append(formatPageString(options.pageJumpersFormat, page)); + } + break; + case "page_jump_buttons": { + final StringJoiner pageGroups = new StringJoiner(options.pageJumperGroupSeparator); + StringJoiner pages = new StringJoiner(options.pageJumperPageSeparator); + + for (int i = 1; i <= getTotalPages(); i++) { + int startCutOff = (page <= 3 ? page - 1 : 3); + int endCutOff = (page > getTotalPages() - 3 ? page + 1 : getTotalPages() - 3); + if (i == startCutOff + 1 || i == endCutOff) { + pageGroups.add(pages.toString()); + pages = new StringJoiner(options.pageJumperPageSeparator); + } + if ((i <= startCutOff) || (i > endCutOff)) { + pages.add(formatPageString(formatPageJumper(i), i)); + } else if (i == page) { + pages.add(formatPageString(options.pageJumperCurrentPageFormat, i)); + } + } + if (!pages.toString().isBlank()) { + pageGroups.add(pages.toString()); + } + convertedFormat.append(pageGroups); + break; + } + } + } else { + currentPlaceholder = new StringBuilder(); + } + readingPlaceholder = !readingPlaceholder; + continue; + } + if (readingPlaceholder) { + currentPlaceholder.append(c); + } else { + convertedFormat.append(c); + } + } + return convertedFormat.toString(); + } + + /** + * Formats a page jumper format with values + * + * @param page The page number of the jumper to format + * @return The formatted page jumper + */ + @NotNull + private String formatPageJumper(final int page) { + return formatPageString(options.pageJumperPageFormat.replaceAll("%target_page_index%", + Integer.toString(page)), page); + } + +} diff --git a/src/main/java/net/william278/paginedown/PaginationException.java b/src/main/java/net/william278/paginedown/PaginationException.java new file mode 100644 index 0000000..a10ef65 --- /dev/null +++ b/src/main/java/net/william278/paginedown/PaginationException.java @@ -0,0 +1,9 @@ +package net.william278.paginedown; + +public class PaginationException extends RuntimeException { + + public PaginationException(String message) { + super(message); + } + +} diff --git a/src/test/java/net/william278/paginedown/PaginatedListTests.java b/src/test/java/net/william278/paginedown/PaginatedListTests.java new file mode 100644 index 0000000..11f89e2 --- /dev/null +++ b/src/test/java/net/william278/paginedown/PaginatedListTests.java @@ -0,0 +1,35 @@ +package net.william278.paginedown; + +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.Test; + +import java.util.ArrayList; +import java.util.List; + +public class PaginatedListTests { + + // Generates dummy list data for testing + private List generateListData(final int size, final String format) { + final ArrayList dummyData = new ArrayList<>(); + for (int i = 0; i < size; i++) { + dummyData.add(format.replaceAll("#", String.valueOf(i + 1))); + } + return dummyData; + } + + @Test + public void testListPagination() { + final String listPage = PaginatedList.of(generateListData(100, "Element #")).getRawPage(3); + Assertions.assertNotNull(listPage); + } + + @Test + public void testPageItemDividing() { + final int pageCount = PaginatedList.of(generateListData(40, "Item #"), + new ListOptions.Builder() + .setItemsPerPage(10) + .build() + ).getTotalPages(); + Assertions.assertEquals(4, pageCount); + } +}