From 067860e159fa7e91aa2f52a473614ec62c1d82f7 Mon Sep 17 00:00:00 2001 From: William Date: Thu, 20 Apr 2023 17:18:36 +0100 Subject: [PATCH] Use builders for constructing, refactor, add new version check endpoints --- README.md | 13 +- build.gradle | 10 +- gradle/wrapper/gradle-wrapper.jar | Bin 59821 -> 59536 bytes gradle/wrapper/gradle-wrapper.properties | 2 +- gradlew | 10 +- .../william278/desertwell/UpdateChecker.java | 80 ------ .../desertwell/{ => about}/AboutMenu.java | 250 ++++++++++-------- .../desertwell/util/ThrowingConsumer.java | 19 ++ .../desertwell/util/UpdateChecker.java | 181 +++++++++++++ .../desertwell/{ => util}/Version.java | 24 +- .../desertwell/UpdateCheckerTests.java | 46 +++- .../william278/desertwell/VersionTests.java | 9 +- 12 files changed, 418 insertions(+), 226 deletions(-) delete mode 100644 src/main/java/net/william278/desertwell/UpdateChecker.java rename src/main/java/net/william278/desertwell/{ => about}/AboutMenu.java (69%) create mode 100644 src/main/java/net/william278/desertwell/util/ThrowingConsumer.java create mode 100644 src/main/java/net/william278/desertwell/util/UpdateChecker.java rename src/main/java/net/william278/desertwell/{ => util}/Version.java (85%) diff --git a/README.md b/README.md index 6e18bf7..e4c447c 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,9 @@ DesertWell is a simple library providing various utilities to aid Minecraft plug To create an about menu, use `AboutMenu#create(title)` with the resource name, then use the various builder methods to build out the menu. +
+Code snippet + ```java public class ExamplePlugin extends JavaPlugin { @@ -41,12 +44,16 @@ public class ExamplePlugin extends JavaPlugin { } ``` +
### Version `Version.class` provides a simple way to compare semantic plugin and Minecraft versions. `VersionChecker.class` provides a utility for querying Spigot resources for the latest version of a plugin and comparing with the current version in order to check for updates. +
+Code snippet + ```java public class ExamplePlugin extends JavaPlugin { @@ -65,13 +72,16 @@ public class ExamplePlugin extends JavaPlugin { } ``` +
## Installation DesertWell is available on JitPack. You can browse the Javadocs [here](https://javadoc.jitpack.io/net/william278/DesertWell/latest/javadoc/). Note that your plugin will also need to shade (or shade a library that includes) [MineDown](https://github.com/Phoenix616/MineDown). -### Maven +
+Maven + To include the library with Maven, in your `pom.xml` file, first add the JitPack repository: ```xml @@ -91,6 +101,7 @@ Then, add the dependency in your `` section. Remember to replace ` compile ``` +
### Gradle & others JitPack has a [handy guide](https://jitpack.io/#net.william278/DesertWell/#How_to) for how to use the dependency with other build platforms. diff --git a/build.gradle b/build.gradle index ae0e23d..992ff4b 100644 --- a/build.gradle +++ b/build.gradle @@ -1,11 +1,11 @@ plugins { id 'java' id 'maven-publish' - id 'com.github.johnrengelman.shadow' version '6.1.0' + id 'com.github.johnrengelman.shadow' version '8.1.1' } group 'net.william278' -version '1.1.1' +version '2.0' repositories { mavenCentral() @@ -13,7 +13,9 @@ repositories { } dependencies { - compileOnly 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT' + implementation 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT' + implementation 'org.json:json:20230227' + compileOnly 'net.kyori:adventure-api:4.13.1' compileOnly 'org.jetbrains:annotations:23.0.0' testImplementation 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT' @@ -24,7 +26,7 @@ dependencies { compileJava.options.encoding = 'UTF-8' -tasks.withType(JavaCompile) { +tasks.withType(JavaCompile).configureEach { options.encoding = 'UTF-8' } diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 41d9927a4d4fb3f96a785543079b8df6723c946b..7454180f2ae8848c63b8b4dea2cb829da983f2fa 100644 GIT binary patch delta 8722 zcmY*;Wn2_c*XJ;R(j_4+E#1=H-QC^YIm8gsFf@+D&?(ZAlF}t5odeR+{krb6yU*TF z|2X&D{M`@d*32TNOe20l5=0ho#^2I~pbD~q^aFzN{Rm#3zYeiL5N6aRiR|+XoxRvM znZSLLlAJDh@2J2?#n2A?qar%tzN-5NQO zL&|F{nGiQyzNJ+bM$Y`n=Lx^3wTG^o2bGB@cwr1eb+6c-1tN=U+Db;bc~eJ!hwM{SbI=#g?$!PjDB+) zPgU_2EIxocr*EOJG52-~!gml&|D|C2OQ3Y(zAhL}iae4-Ut0F*!z!VEdfw8#`LAi# zhJ_EM*~;S|FMV6y%-SduHjPOI3cFM(GpH|HES<}*=vqY+64%dJYc|k?n6Br7)D#~# zEqO(xepfaf2F{>{E2`xb=AO%A<7RtUq6kU_Iu0m?@0K(+<}u3gVw5fy=Y4CC*{IE3 zLP3YBJ7x+U(os5=&NT%gKi23bbaZ`@;%ln)wp4GpDUT$J8NtFDHJzIe_-t}{!HAsh zJ4<^WovY};)9IKAskSebdQiXv$y5}THuJZ}ouoElIZRui=6lrupV|_Jz=9^&;@HwL;J#@23k?A;k`0Bgf;ioO>W`IQ+4? z7A)eKoY4%+g%=w;=Vm8}H>@U*=*AWNtPqgWRqib#5RTGA@Q=43FrQn3J`GkTUV5yp0U`EOTqjfp+-9;0F8!dMEwwcK%(6`8sDD^aR04 zd6O5vh|Xk?&3dy4f|1QK&Ulf{h6Iq;d-&*ti#Ck>wZFG;GHwc?b;X~eBITx49>2d8 z4HcK&1&DvEGT6kXdzAm4oO8%c}8OBt~8H956_;YP-ss*uMf==a+%w~F>Qkm7r)IAuxuoX}h92$gHqbFUun#8m zWHdy`Zrm#=Pa98x8cO0vd@Tgkr*lm0{dky+Gocr0P8y%HGEI#c3qLqIRc`Oq_C%*; zG+QTr(#Q|yHKv6R@!DmLlwJQ3FAB)Yor-I4zyDyqM4yp5n2TrQH>gRt*Zw0+WI-Sj`EgmYHh=t9! zF6lz^xpqGGpo6!5`sc0a^FVhy_Uxq|@~(1@IIzV)nTpY9sY`CV!?8e&bB8=M&sYEb z2i}fvKdhp9Hs68Y-!QJ<=wE(iQ5+49tqt;Rh|jhYrI5VW-mIz|UY{h8E=rC5sh#DU z?wGgk-Tn!I?+Zer7pHlF_Z^!Kd1qkS3&lv#%s6-<5Y%jQL${cge5=G5Ab?D&|9$Y~ zf%rJC2+=2vg;y0-SJb3<@3%}BO$T$C66q$L_H33a`VUbgW~N(4B=v5(<=My|#|J7q z*Ox4wL4kbJd_~EjLTABSu4U7Jk#`y(6O*U6(k6XxM}CtGZB(H@3~kh*zaGRXM}Iwp zQ%xFk2>@wiZrVCV_G4G~v;NebCQ%T7{SDyPpSv&dT@Cn)Mx@IK*IdNrj{*4pkV4wv z)y0J538h>cpB7iPSzA~x24T`{dzNkpvGIqvt1Dvdq@o-`B=$hkczX8$yFMhsWNK-X zxr$kR$tMD0@W)Vxe1^t9qVmsg&K^F@u84)(n2dttIEAZFN6VD$&tskpG%SI7whGL3 z)DeRiwe&?8m7U{G`oW8!SCi*dM>oYL%UKQnKxV_0RXAEBQg1kStExGEUVwLJ0orGGwb7uv+kPDl7_E2*iD|J*=8A@;XCvwq0aw5oJYN*Yh&o=l} z2z8YKb-fIAH5spql4eXqp*)o2*b>#1@DSt?zZi{GPj0gH&Nm+EI<3^z0w%YTEV4xw zI6$+=Faa|Y4o5i0zm5lOg|&tmnJ806DBovU@Ll6XsA;NRrTK~t*AAJIAS=v-UZ%Pr z$oddI@NRir&erzCwq|)ciJemr-E061j{0Vc@Ys7K(mW|JYj*$+i1Q8XlIK8T?TYS(AXu$`2U zQ@fHxc=AVHl_}cRZQ)w0anMEoqRKKIvS^`<-aMf*FM`NsG&Uowneo+Ji$7DUDYc7*Hjg;-&aHM%3 zXO6cz$$G};Uqh+iY7Wpme>PHG4cu(q;xyskNLs$^uRRMfEg?8Cj~aE-ajM%CXkx0F z>C?g3tIA#9sBQOpe`J+04{q7^TqhFk^F1jFtk4JDRO*`d-fx`GYHb=&(JiaM1b?Y^ zO3Kj3sj76ieol|N$;>j@t#tKj=@*gP+mv}KwlTcPYgR$+)2(gk)2JNE=jSauPq!$< z<|?Sb%W)wS)b>b6i{8!x!^!xIdU3{CJFVnTcw0j{M%DUCF=_>eYYEUWnA-|B(+KYL z_W_`JI&&u^@t0})@DH^1LDuT0s3dMpCHIbYBgOT4Zh_4yHbSqRbtIKndeT4Q*Jg91 z@>rO!^t-G~*AIW;FQ$3J=b;oGg8?CTa~qNCb>&cgp@e;?0AqA&paz~(%PYO+QBo4( zp?}ZdSMWx0iJm7HVNk9A#^9Osa#GPJ!_pYEW}($8>&2}fbr@&ygZ?${A7_9?X$(&5 z#~-hxdPQwCNEpf=^+WH-3`2LxrrBMTa}~qJC9S;VzhG!On^JLyW6WkF{8aAE$sM+( zxr8xLW(KIjI`Rm(24r3OJBk<3GF=G!uSP0-G&AY32mLm8q=#Xom&Pqv=1C{d3>1^ zAjsmV@XZ%BKq^eUfBpa8KvO8ob|F3hAjJv*yo2Bhl0)KUus{qA9m8jf)KnOGGTa6~4>3@J_VzkL|vYPl*uL+Ot*Q7W!f5rJw5+AsjP_IfL+-S*2p| zB7!FhjvkUTxQkGWGSg{X;h~dK>gAJivW?88Nu!3o>ySDaABn$rAYt086#27fbjPQS zhq>55ASvm*60qRdVOY9=bU^+{Pi#!OaZwENN;zy5?EztOHK-Q5;rCuiFl}BSc1YaQ zC-S{=KsGDz@Ji9O5W;XxE0xI|@3o6(2~i4b8Ii9VT;^G$*dRw(V?=br)D&q^XkeBX z+gl~+R@rVD-Hwv@7RHV?Bip5KMI)aV^&snt?H<$Nt=OPx#VxF&BGi?2A2+lNOYywNUGMeGL;|(=UjGDtLG0sN&LpGx;|U;xa13s z;W_|SPk^G}!M9_^pO zA3bt3-tca%^42sHeDtfcC0S3w3H1ny!Bxpa=*k?XRPpx9Bb-gx1J9Yvx)4J(8cG+q z(iCPZ9dsf3#QVyZgD_MW#G#qgV)olu$59&3(PzQfw@%4uZ~<5J=ABvdY43(Qnp{;G zHg3>@T#>DbTuhFl3)fb3TFqdh)V2aq7!;&JOHseTWukvA7}(iGUq;v-{2J0iHSNHq z;+)h!p6Ok^+Sp8-jgL($n6Qu47xyE`cFO5SdZR6;R!FET`tm#0D37z339Suxjpv+s z*=%2-N$N?X&0?x_uut3erF@aBGj;9$k9?3FlbDO{RQa1_qtxrh4!4#fjp4x~akvdTp@ zos?^Q&XE;3N93s4rHQGPrV7+au1$$aB6$hLy*Yz_kN$~dweb9PcB!eYVQTGjFuJP> zZCEwBtb>TIgIO^qAzq@Bv-qud_ZD-2W<_at&ml-gv`tPt$@DF5`HlA zM>DmmMkpv&Zm-8)Y#0bLQf4MpD4_-7M8eu6rh(tL8dq8onHs#R9J~dGd2IaXXMC~h z91pKhnQa%Fsn29nAA1;x(%oC zhca~qQDJaMf?wFrl-Pj;e$bZMYmMF!Y3Lv&Sb?Sjn#!NVx&NDyc^$b4uYyo2OmERa zRz;yDGd@JTykzFLe|Wk-y7#3x`6$wt$zR8r48mdUvfbeL+4D|Z``~7$PrE@qc7rZe zVsIoIbCwzjLZ@_M1*bD{HaYn();Z1-q*-I{tEnTZ(}Zmk&%MXSNBX>o| z-u*RNkAyKC-Srp7c-=@5f)xMWg>o2WWl}j6j9=8+D8;T z>0*0q#;qw8%U8i;6s0fu#I*%(g*@@a2Er@@nyI}{=@W{Z-;`=wN4N~>6Xrh&z#g}l zN1g5}0-#(nHUTv_rl2{yUZ;h#t&Fd?tY!7L%ClY)>uH-Ny2ET$lW$S)IQiN79H)D^ zb&0AXYkupy0~w8)*>Sj_p9}4L?lGTq%VG|2p`nWGhnM^!g|j-|O{%9Q%swOq63|*W zw$(N_laI}`ilB+o!a-wl?er~;;3+)$_akSQ!8YO_&-e*SI7n^(QQ;X0ZE`{4f!gAl z5$d+9CKVNonM!NO_frREICIAxOv)wm>}-k?iRisM`R7;=lyo|E_YR~FpS&PS`Lg0f zl-ON<0S%Uix8J%#yZdkCz4YNhcec<|7*P(JsM#>-L>+tYg_71q9~70FAc^6KW5jql zw!crdgVLH1G_eET=|SEc977;)ezVC|{PJZfra|}@rD;0s&@61mTEBJtILllg{%{vN zfhb&lq0yChaLhnJ-Qb62MB7`>M;|_ceHKZAeeh@#8tbrK!ArP6oXIhMK;dhEJTY`@ z0Tq>MIe0`7tGv)N*F0IGYSJv0vN?Az8g+4K9S!pW2~9F4W(_U_T=jCZrzuZ3*|__T zONp_UWmyePv8C~rckc?Xji;Z5OEqg zC*Um)i;Wh4TEwqReQdVVbUKT^2>Tpi6z_^-uF*adUFug4i@JhzpWT^Sk&E>CyP2?H zWf6x}ehuTs6wvzCnTU&gYzT029Nz19(In1WC z`(1IGmi!O%2AR|BjQa4Q0~u)kM%}?xQyjWuQ16^Gp++;`vr7!k--UZWM*~7Zl|ceO@I3`OpaRhD;YoCuo5IC0uHx>9 z478hu@H|e0Zlo)Zj@01#;8BDs@991xe~^9uG2}UXLM(m7fa}AMwX*tjioBeV&Q8Gx zSq$6wZFkRBK`cMI>R(@W@+lo2t)L+4q-negWRLWZBz*|%=W4v62JrmzNuOtA*x)QE z5L%=OH#@KMdB%Jp^r?0tE}5-*6oP`-lO7Sf)0)n*e<{HA=&qhLR)oD8-+V}Z4=md) z+k9lKf64DB2hAT)UaCP~di?-V3~JBH7itYyk~L6hrnxM%?RKntqd`=!b|e7eFnAcu z3*V;g{xr7TSTm$}DY%~SMpl>m{Sj!We+WfxSEor?YeiAxYUy25pn(?T()E>ByP^c@ zipwvWrhIK((R((VU+;@LmOnDu)ZXB3YArzzin!Z^0;PyJWnlfflo|q8(QY;o1*5CO z##hnkO{uynTMdk`~DOC#1 zdiYxQoy}=@7(ke#A8$YZZVtk4wo$8x28&I;cY3Ro-|kW=*yiiHgCLZeAr)UtVx>Tu z|LvL0hq|1-jC0I4x#>&QZCfrVB=zT!nR|~Uz`9%~2 znl{uZ{VEszW`Fad^q_HB!K9*|U-stK%?~;g?&&+12A}Rq$z($Bzuk^2X(Y=hF?-dQ ztc3DsQKI;qhWIV`99Q#R3xnU0AvY!i*BECj-z9l74|%O=V@nlv|qqC^r^-~C?E zGW%c|uYgnfJ(gjsTm_cIqcv*mYM{+i+&@F@+69ZQOK&u#v4oxUSQJ=tvqQ3W=*m;| z>SkBi8LYb-qRY7Sthh*0%3XAC%$z1rhOJzuX=PkTOa=DlocZUpE#KxVNH5)_4n=T( zGi3YrH7e~sPNYVBd~Grcq#CF~rN{p9Zza-Ntnwfma@TB)=3g36*0lSZg#ixEjFe%+ zX=&LDZ5zqculZ`=RYc^ln(~;nN|Qh6gN=!6f9-N2h+3NWbIxYud&;4SX*tWf5slk4 z{q@@l71UAZgj~*6edXb57fBUxvAS7s(RI=X868JM0+^DCn2yC>;v%S;qPOjB>YVsz(Zx9a>>BK&M zIQK>7_n)4ud0X5YM}^i*keH{ehLsiy9@NvOpsFeQjdI6anLGvVbBw_*fU1TzdVS$i z*4j7z!I5RF#rSz|8ibi$;qE{4`aqWYik7QB5U&F5C*;TO_x+gtzPGpzNt!7~nsBT7)Ckc(K~%uv&{{6A`mmBJVAk-{s~52Vu|HbCH7_W1~ZCX^RflOakGg=jo2Z z<*s;5-J+2@^LRDZ-7EV&Pq+FTErw@pfFqvx^i%E7Fx#^n(E`m2(c>K-O5`M`Yek9el zzTGs5qD6*G;y#~xu3>qWuO?-amKYtvRA}I9z#UspEeM;wOERYeot_n_EUMJf$4_u?E!6X~?q)tPoZb^_;8Y_Ox2h1m<+Le-fsRd|T8db<8#$bqez zua^Z|>h%zdnuU^ww$#-dZ9NTM`FN+!IlLkz*FqWb!x^Z|C{KyGjZ+>G;;7Mb@LY|H zc+Gp`L((Dw7pnDlHNm&;SfHedhx*kad$I^uGz{`0BYelq0yEUHpNKSkvj$|dpvY3{7*YGyhXA^LP0&wOw9oNoC=QoVx1<2Dne8qqZL zm>nFh5DX(-RnQwvHCZQwn^#Z=E!SPVlaRJ78Bo@}!!9dRt^qZy?-*`Pt4WSmgucJv zV1yFkcjlEM^uz-;b#Q7ZCP@Lk)m}uPX={R4B=56k7WNh11BN~0T*vr@!!ow^B0hOR zQ)4)&(e%>bNNL%bm<&8H{*l_L7s0$2GUgX2Vd;=4d9Dm2v3TaL+;L>{K7h7 zV#k?xDPm(NDE31$ z<}|X)pEY6myjK+^gaIMk&Yj2~F0rSKemNqlsVm4c|N7mp_C*L01s;GNx#D-*&gk!qQr}^?_r@q!8fuXw!)fA7xkd} zb>vHvdx~H$5qqAWrow7}+8zBM65-JOt5z za=T6f7MK`XJuQog8kIEboPdhcaVJeHy)5z7EBLK5NRr()E|#K0L0N^JD@pUA^Czb` zbUZ_558y+vqAGeyHCbrvOvLD67Ph}06959VzQ_|>RrXQAqE+AQ(-AaKdxoWaF8hdt z{O3W@b^*o#-f1VuU>YMV03ELF7zkCN4Q&b#prz%3Nne0lSbRo@@ z^ihv%oIl~Qyl6Q;a#$*jOC%x0_;eis*)J7=f@Ct*)xF5 zo}u~@-I}2|$b%5L7>@+Z?4o+1r&v6ceIy+vroK&jCQ<4q&45HP2wCol4hVm3pZtjf zHz1D7oyaSKJ~T{Gx}7ONLA)D5k(%%`WswrDyzX*rn}i}}TB4^y#@mAwPzoC)`?rYv zHgx|trUN#mu*VzUV~8TnJM2Qh*ZM5B{x&y>5An`(M7=Z*Q>TdiH@j*2=moNuOtvpz z+G`@~-`%~+AgPKgke@XiRPgndh@bp*-HRsh;HTtz@-y_uhb%7ylVOTqG0#u?Vn5c5 zEp*XRo|8hcgG^$#{$O9CJ&NE;TrfRpSnLmes&MO{m=N%zc`}gb!eQ7odl$oy1%PI} z#AIxx%oRVy&{O~9xnK4$EY>(eQj}!HKIV$Fz*H=-=Kn)N0D6u`(;iO|VraI4fu_W` z;b5{7;Lyx4za}DU#+U7}=H0dAS#YJJ&g2!P@Htu-AL&w=-)*%P9h2{wR|@?Ff9~)b z^+e_3Hetq7W%ls{!?<6&Y$Z;NNB41pvrv)|MET6AZXFXJeFqbFW5@i5WGzl?bP+~? z*&_puH;wKv2)9T_d+P`bLvJFqX#j&xa*-;0nGBbQf0DC>o~=J_Wmtf*2SZQr?{i~X z9-IbRH8{iy?<0v9Ir1?$66+igy|yDQ5J~A9sFX@Pe<*kCY8+MwH?I z`P}zfQ6l^AO8ehZ=l^ZR;R%uu4;BK*=?W9t|0{+-at(MQZ(CtG=EJFNaFMlKCMXu30(gJUqj5+ z`GM|!keqcj;FKTa_qq;{*dHRXAq157hlB@kL#8%yAm2AgfU|*rDKX@FLlp=HL8ddv zAWLCHe@DcDeB2}fl7#=0+#<05c3=VqM*O3bkr@9X4nO|)q0hU;Gye{L8ZN*NH8Id@mP-u;Fmb8YuorjLrW&ndip8CN%_qp982r w1WEnz9^$&s1hkp_3#lPJQ~!HI7WYYjA7>z!`?f%npAh2%rB@vD|Lau$2O)#1n*aa+ delta 8958 zcmY+KWl$VIlZIh&f(Hri?gR<$?iyT!TL`X;1^2~W7YVSq1qtqM!JWlDxLm%}UESUM zndj}Uny%^UnjhVhFb!8V3s(a#fIy>`VW15{5nuy;_V&a5O#0S&!a4dSkUMz_VHu3S zGA@p9Q$T|Sj}tYGWdjH;Mpp8m&yu&YURcrt{K;R|kM~(*{v%QwrBJIUF+K1kX5ZmF zty3i{d`y0;DgE+de>vN@yYqFPe1Ud{!&G*Q?iUc^V=|H%4~2|N zW+DM)W!`b&V2mQ0Y4u_)uB=P@-2`v|Wm{>CxER1P^ z>c}ZPZ)xxdOCDu59{X^~2id7+6l6x)U}C4Em?H~F`uOxS1?}xMxTV|5@}PlN%Cg$( zwY6c}r60=z5ZA1L zTMe;84rLtYvcm?M(H~ZqU;6F7Evo{P7!LGcdwO|qf1w+)MsnvK5^c@Uzj<{ zUoej1>95tuSvDJ|5K6k%&UF*uE6kBn47QJw^yE&#G;u^Z9oYWrK(+oL97hBsUMc_^ z;-lmxebwlB`Er_kXp2$`&o+rPJAN<`WX3ws2K{q@qUp}XTfV{t%KrsZ5vM!Q#4{V& zq>iO$MCiLq#%wXj%`W$_%FRg_WR*quv65TdHhdpV&jlq<=K^K`&!Kl5mA6p4n~p3u zWE{20^hYpn1M}}VmSHBXl1*-)2MP=0_k)EPr#>EoZukiXFDz?Di1I>2@Z^P$pvaF+ zN+qUy63jek2m59;YG)`r^F3-O)0RDIXPhf)XOOdkmu`3SMMSW(g+`Ajt{=h1dt~ks ztrhhP|L4G%5x79N#kwAHh5N){@{fzE7n&%dnisCm65Za<8r_hKvfx4Bg*`%-*-Mvn zFvn~)VP@}1sAyD+B{{8l{EjD10Av&Mz9^Xff*t`lU=q=S#(|>ls520;n3<}X#pyh& z*{CJf7$*&~!9jMnw_D~ikUKJ2+UnXmN6qak{xx%W;BKuXt7@ky!LPI1qk?gDwG@@o zkY+BkIie>{{q==5)kXw(*t#I?__Kwi>`=+s?Gq6X+vtSsaAO&Tf+Bl$vKnzc&%BHM z=loWOQq~n}>l=EL(5&6((ESsQC3^@4jlO5Od{qN#sWV)vqXw}aA>*uvwZopNN(|-T zRTF%5Y_k1R$;(d-)n;hWex{;7b6KgdAVE@&0pd(*qDzBO#YZV%kh%pYt1`hnQ(Fa& zYiDrOTDqk5M7hzp9kI2h!PxNnuJ&xl*zF8sx6!67bA49R1bmUF5bpK&&{eI0U~cH}PM z3aW1$lRb|ItkG5~_eBNu$|I|vYIdAA9a!pVq<+UTx*M}fG`23zxXp&E=FfnY- zEzKj;Cu_s4v>leO7M2-mE(UzKHL4c$c`3dS*19OpLV^4NI*hWWnJQ9lvzP4c;c?do zqrcsKT*i~eIHl0D3r4N{)+RsB6XhrC^;sp2cf_Eq#6*CV;t8v=V!ISe>>9kPgh}NI z=1UZutslxcT$Ad;_P^;Oouoa(cs!Ctpvi>%aQ+Zp=1d|h{W9Wmf7JWxa(~<#tSZ?C%wu4_5F!fc!<@PIBeJ)Nr^$bB6!_Gic_7}c3J{QI~Gg5g5jTp9}V6KYgrgaX>pJt}7$!wOht&KO|+z{Iw@YL|@~D zMww}+lG}rm2^peNx>58ME||ZQxFQeVSX8iogHLq_vXb`>RnoEKaTWBF-$JD#Q4BMv zt2(2Qb*x-?ur1Y(NsW8AdtX0#rDB?O(Vs4_xA(u-o!-tBG03OI!pQD+2UytbL5>lG z*(F)KacHqMa4?dxa(Vcrw>IIAeB$3cx#;;5r2X;HE8|}eYdAgCw#tpXNy7C3w1q`9 zGxZ6;@1G%8shz9e+!K2MO*{_RjO}Jo6eL3{TSZ>nY7)Qs`Dhi5><@oh0r)gT7H-?3 zLDsd^@m%JvrS8sta5`QiZNs^*GT}Hiy^zjK2^Ni%`Z|ma)D2 zuyumbvw$M8$haCTI~6M%d4+P)uX%u{Sfg4Al+F7c6;O-*)DKI7E8izSOKB#FcV{M+ zEvY0FBkq!$J0EW$Cxl}3{JwV^ki-T?q6C30Y5e&p@8Rd?$ST-Ghn*-`tB{k54W<>F z5I)TFpUC!E9298=sk>m#FI4sUDy_!8?51FqqW!9LN1(zuDnB3$!pEUjL>N>RNgAG~-9Xm|1lqHseW(%v&6K(DZ3Pano(1-Qe?3%J&>0`~w^Q-p&@ zg@HjvhJk?*hpF7$9P|gkzz`zBz_5Z!C4_-%fCcAgiSilzFQef!@amHDrW!YZS@?7C zs2Y9~>yqO+rkih?kXztzvnB^6W=f52*iyuZPv$c42$WK7>PHb z6%MYIr5D32KPdwL1hJf{_#jn?`k(taW?mwmZVvrr=y~fNcV$`}v(8};o9AjOJumS4 z`889O91^pkF+|@$d9wVoZ3;^j;^sUs&Ubo_qD&MTL%O z&*SE0ujG~zm;?x)8TLC&ft))nyI zcg44@*Q{cYT+qGrA=In_X{NNCD+B0w#;@g)jvBU;_8od6U>;7HIo@F*=g8CQUo(u^ z3r4FJ7#<@)MXO&5+DgKE&^>^`r!loe7CWE*1k0*0wLFzSOV8jvlX~WOQ?$1v zk$Or}!;ix0g78^6W;+<=J>z@CBs!<<)HvF(Ls-&`matpesJ5kkjC)6nGB@b{ii6-Uoho$BT%iJgugTOeZ$5Xo4D7Pd< zC*LJh5V@2#5%aBZCgzlQi3@<_!VfiL07ywc)ZbwKPfcR|ElQoS(8x|a7#IR}7#Io= zwg4$8S{egr-NffD)Fg&X9bJSoM25pF&%hf>(T&9bI}=#dPQyNYz;ZZ7EZ=u1n701SWKkZ9n(-qU ztN`sdWL1uxQ1mKS@x11;O|@^AD9!NeoPx}?EKIr!2>1Qq4gjfGU)tr6?Z5l7JAS3j zZeq{vG{rb%DFE4%$szK}d2UzB{4>L?Tv+NAlE*&Nq6g+XauaSI+N2Y8PJLw+aNg1p zbxr|hI8wcMP&&+(Cu|%+Jq|r>+BHk@{AvfBXKiVldN)@}TBS0LdIpnANCVE26WL-} zV}HJ^?m&$Rkq;Zf*i-hoasnpJVyTH__dbGWrB_R55d*>pTyl6(?$EO@>RCmTX1Hzr zT2)rOng?D4FfZ_C49hjMV*UonG2DlG$^+k=Y%|?Dqae4}JOU=8=fgY4Uh!pa9eEqf zFX&WLPu!jArN*^(>|H>dj~g`ONZhaaD%h_HHrHkk%d~TR_RrX{&eM#P@3x=S^%_6h zh=A)A{id16$zEFq@-D7La;kTuE!oopx^9{uA3y<}9 z^bQ@U<&pJV6kq7LRF47&!UAvgkBx=)KS_X!NY28^gQr27P=gKh0+E>$aCx&^vj2uc}ycsfSEP zedhTgUwPx%?;+dESs!g1z}5q9EC+fol}tAH9#fhZQ?q1GjyIaR@}lGCSpM-014T~l zEwriqt~ftwz=@2tn$xP&-rJt?nn5sy8sJ5Roy;pavj@O+tm}d_qmAlvhG(&k>(arz z;e|SiTr+0<&6(-An0*4{7akwUk~Yf4M!!YKj^swp9WOa%al`%R>V7mi z+5+UodFAaPdi4(8_FO&O!Ymb#@yxkuVMrog(7gkj$G@FLA#ENMxG)4f<}S%Fn?Up$+C%{02AgMKa^ z4SFGWp6U>{Q6VRJV}yjxXT*e`1XaX}(dW1F&RNhpTzvCtzuu;LMhMfJ2LBEy?{^GHG!OF!! zDvs64TG)?MX&9NCE#H3(M0K>O>`ca0WT2YR>PTe&tn?~0FV!MRtdb@v?MAUG&Ef7v zW%7>H(;Mm)RJkt18GXv!&np z?RUxOrCfs;m{fBz5MVlq59idhov21di5>WXWD-594L-X5;|@kyWi@N+(jLuh=o+5l zGGTi~)nflP_G}Yg5Pi%pl88U4+^*ihDoMP&zA*^xJE_X*Ah!jODrijCqQ^{=&hD7& z^)qv3;cu?olaT3pc{)Kcy9jA2E8I)#Kn8qO>70SQ5P8YSCN=_+_&)qg)OYBg|-k^d3*@jRAeB?;yd-O1A0wJ z?K*RDm|wE<(PBz~+C%2CTtzCTUohxP2*1kE8Of~{KRAvMrO_}NN&@P7SUO{;zx0iK z@or9R8ydYOFZf(cHASCAatL%;62IL27~SmASr(7F&NMr+#gNw@z1VM z_ALFwo3)SoANEwRerBdRV`>y`t72#aF2ConmWQp(Xy|msN9$yxhZ1jAQ67lq{vbC5 zujj|MlGo`6Bfn0TfKgi(k=gq0`K~W+X(@GzYlPI4g0M;owH3yG14rhK>lG8lS{`!K z+Nc@glT-DGz?Ym?v#Hq|_mEdPAlHH5jZuh*6glq!+>Lk$S%ED2@+ea6CE@&1-9a?s znglt|fmIK}fg<9@XgHe4*q!aO<-;Xj$T?IzB-{&2`#eA6rdtCi80mpP&vw(Uytxu$#YzNI_cB>LS zmim>ys;ir;*Dzbr22ZDxO2s;671&J0U<9(n1yj)J zHFNz=ufPcQVEG+ePjB<5C;=H0{>Mi*xD>hQq8`Vi7TjJ$V04$`h3EZGL|}a07oQdR z?{cR(z+d>arn^AUug&voOzzi$ZqaS)blz-z3zr;10x;oP2)|Cyb^WtN2*wNn`YX!Y z+$Pji<7|!XyMCEw4so}xXLU)p)BA~2fl>y2Tt}o9*BPm?AXA8UE8a;>rOgyCwZBFa zyl42y`bc3}+hiZL_|L_LY29vVerM+BVE@YxK>TGm@dHi@Uw*7AIq?QA9?THL603J% zIBJ4y3n8OFzsOI;NH%DZ!MDwMl<#$)d9eVVeqVl(5ZX$PPbt*p_(_9VSXhaUPa9Qu z7)q4vqYKX7ieVSjOmVEbLj4VYtnDpe*0Y&+>0dS^bJ<8s*eHq3tjRAw^+Mu4W^-E= z4;&namG4G;3pVDyPkUw#0kWEO1;HI6M51(1<0|*pa(I!sj}F^)avrE`ShVMKBz}nE zzKgOPMSEp6M>hJzyTHHcjV%W*;Tdb}1xJjCP#=iQuBk_Eho6yCRVp&e!}4IBJ&?ksVc&u#g3+G$oNlJ?mWfADjeBS-Ph3`DKk-~Z70XugH8sq2eba@4 zIC1H_J$`9b$K`J)sGX3d!&>OmC@@rx1TL~NinQOYy72Q_+^&Mg>Ku(fTgaXdr$p_V z#gav1o{k~c>#)u3r@~6v^o)Lf=C{rAlL@!s457pq)pO;Cojx7U{urO4cvXP|E>+dV zmr2?!-5)tk-&*ap^D^2x7NG6nOop2zNFQ9v8-EZ{WCz-h36C)<^|f{V#R_WE^@(T0+d-at5hXX{U?zak*ac-XnyINo+yBD~~3O1I=a z99|CI>502&s-Qi5bv>^2#cQ%ut<4d7KgQ^kE|=%6#VlGiY8$rdJUH{sra;P~cyb_i zeX(kS%w0C?mjhJl9TZp8RS;N~y3(EXEz13oPhOSE4WaTljGkVXWd~|#)vsG6_76I)Kb z8ro?;{j^lxNsaxE-cfP;g(e;mhh3)&ba}li?woV2#7ByioiD>s%L_D;?#;C#z;a(N z-_WY<=SH42m9bFQ>Nb z@4K$@4l8pD7AKxCR>t0%`Qoy9=hA?<<^Vcj8;-E+oBe3ReW1`el8np8E$k{LgFQ}2 z2t8a`wOXFdJ9!5$&mEfD1CnJ)TB+RJih88-Zos9@HZ# zL#{qfbF0ARTXkR@G{lwlOH~nnL)1jcyu!qv2`57S&%oKz0}r{~l9U_UHaJ5!8#nrs z?2FrL`mxnzu&{bweD&62)ilz*?pYIvt`T!XFVVA78})p1YEy7 z8fK#s?b~Yo$n7&_a?EBdXH-_W)Z44?!;DFx6pZ?~RArtBI*Qm4~6nX6Z_T*i$bQPE;Qz?DAPstpGSqr-AJ zo%m9cA`oDDm?&dTaoh_>@F>a?!y4qt_;NGN9Z<%SS;fX-cSu|>+Pba22`CRb#|HZa z;{)yHE>M-pc1C0mrnT~80!u&dvVTYFV8xTQ#g;6{c<9d!FDqU%TK5T6h*w*p980D~ zUyCb`y3{-?(mJFP)0*-Nt;mI$-gc4VQumh|rs&j_^R{sgTPF`1Xja2YWstsKFuQ(d zmZMxV$p$|qQUXchu&8%J(9|)B?`~rIx&)LqDS>ob5%gTeTP#Sbny#y*rnJ&?(l=!( zoV~}LJ1DPLnF8oyM(2ScrQ0{Q4m4-BWnS4wilgCW-~~;}pw=&<+HggRD_3c@3RQIr z9+-%!%}u_{`YS=&>h%kPO3ce}>y!d-zqiniNR-b5r97u;+K6HA2tS>Z#cV{+eFI`* zd8RMGAUtX1KWfPV;q<-5JAykS+2sY$2~UX+4461a(%{P#{rwFPu0xpIuYlbgD{C7C z=U{FUarVTYX6ZUq3wE@G^QT4H2Re;n$Fz9cJ>hABl)9T8pozqbA1)H-%1=WKm^QMu zjnUZ&Pu>q+X&6Co*y#@pxc-4waKMInEPGmE_>3@Ym3S*dedSradmc5mlJn`i0vMW6 zhBnGQD^Z;&S0lnS0curqDO@({J7kTtRE+Ra?nl^HP9<)W&C>~`!258f$XDbyQOQXG zP8hhySnarOpgu8xv8@WlXnm(Uk~)_3$Sg0vTbU3 z{W!5B(L3{Yy3K5PN<@jEarAtja`}@KYva&zFRF*s+_%jIXh$T(S=an8?=Ry3H*NRqWgsM`&!#|@kf1>=4q%bFw7^Rhz!z5I zyI^zU8_R1WN9`88Z=n>pIZQ`Ixr~_9G%Q}@A7rd#*%y7G zXl^Id=^ZL?Rx}}gWXCqzj9C6;x(~mAH|$JteXa1MH<6UQig@!Hf~t}B%tP0I|H&;y zO6N0}svOa1a^PyP9N5?4W6VF%=Bj{qHUgc8@siw4bafT=UPFSoQqKgyUX>sXTBZ=x zOh^Ad!{kOM9v{%5y}`-8u*T&C7Vq6mD%GR}UeU(*epO&qgC-CkD;%=l)ZuinSzHM` z{@`j&_vC6dDe{Yb9k@1zeV_K6!l(@=6ucoI=R^cH=6{i71%4W3$J-?<8Qn#$-DMtA z6Qqi)t?4ifrt%3jSA#6ji#{f(($KBL-iQh-xrC||3U3lq`9>r)>X%oLvtimuHW-)} zy}>9~|M>w4eES`g7;iBM%Se5-OP%1U6gNWp3AZqT8C6OlFFfQ$|7LL;tBV)(qlp4K zruar^K8FnJN3@_}B;G`a~H`t|3+6d>q3#`ctTkE-D^1#d9NalQ04lH*qUW2!V zhk7#z8OwHhSl8w14;KctfO8ubZJ4$dEdpXE78wABz=n5*=q9ex3S}`e7x~~V-jmHOhtX2*n+pBslo3uosdE7xABK=V#-t{1Hd~?i z{i~%Bw6NYF+F$aK$M`r#xe=NxhA5=p%i7!$);sd>Q}#`G?Q~fygrMXmZw?0#5#17W}6Tj+&kFexG{!mYl5FoA99}3G9l;3lVQ^ z48^~gsVppE*x91WheqI(A%F0Z#$#1UJP1R12Mj9r)y(A?a+iquX+d8WD4WAQJ_!oq z9rTISr7bPd(GTP57xm$}C}&kjMivi;zi^Y9g3&X0A;ovdJ?{%_wHgt%%9P&N4H z^XzV(uNA4 zAP`hgP6BEN5`YXh|DF~6Pud?~gWfhUKoPX4>z|}0aocC&K+AoV%|SX*N!wGq3|y< zg4lP(04XIPmt6}$N!dTk+pZv>u;MTB{L4hp9uXk7>aS!6jqM2lVr%{)H3$O127TSZ z0x9hi0k-P?nWFdQ0K`pykqUIT&jD~B0tHP{ffS(}fZ(aW$oBWTSfHO!A^><6v getLatestVersion() { - return CompletableFuture.supplyAsync(() -> { - try (final InputStreamReader inputStreamReader = new InputStreamReader( - new URL(SPIGOT_API_ENDPOINT + resourceId).openConnection().getInputStream())) { - return Version.fromString(new BufferedReader(inputStreamReader).readLine()); - } catch (IOException e) { - throw new IllegalStateException("Unable to fetch latest version", e); - } - }).exceptionally(throwable -> { - throwable.printStackTrace(); - return new Version(); - }); - } - - /** - * Check if the current plugin {@link Version} is outdated compared to {@link #getLatestVersion()} - * - * @return A {@link CompletableFuture} containing true if the current plugin {@link Version} is outdated - */ - public CompletableFuture isUpToDate() { - return getLatestVersion().thenApply(latestVersion -> currentVersion.compareTo(latestVersion) >= 0); - } - -} \ No newline at end of file diff --git a/src/main/java/net/william278/desertwell/AboutMenu.java b/src/main/java/net/william278/desertwell/about/AboutMenu.java similarity index 69% rename from src/main/java/net/william278/desertwell/AboutMenu.java rename to src/main/java/net/william278/desertwell/about/AboutMenu.java index adc5ddd..0523425 100644 --- a/src/main/java/net/william278/desertwell/AboutMenu.java +++ b/src/main/java/net/william278/desertwell/about/AboutMenu.java @@ -1,7 +1,9 @@ -package net.william278.desertwell; +package net.william278.desertwell.about; import de.themoep.minedown.adventure.MineDown; import de.themoep.minedown.adventure.Util; +import net.kyori.adventure.text.Component; +import net.william278.desertwell.util.Version; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -12,89 +14,24 @@ import java.util.*; */ @SuppressWarnings("unused") public class AboutMenu { - @NotNull private final String title; - @Nullable - private Version version; - @Nullable - private String description; - @NotNull + private final Version version; + private final String description; private final Map> attributions; - @NotNull private final List buttons; - private AboutMenu() { - this.title = ""; - this.buttons = new ArrayList<>(); - this.attributions = new LinkedHashMap<>(); - } - - private AboutMenu(@NotNull String title) { + private AboutMenu(@NotNull String title, @Nullable Version version, @Nullable String description, + @NotNull Map> attributions, @NotNull List buttons) { this.title = title; - this.buttons = new ArrayList<>(); - this.attributions = new LinkedHashMap<>(); - } - - /** - * Create an about menu - * - * @param title The title of the menu (resource title) - * @return The {@link AboutMenu} - */ - @NotNull - public static AboutMenu create(@NotNull String title) { - return new AboutMenu(title); - } - - /** - * Set the description of the resource to display on the menu - * - * @param description The resource description - * @return The {@link AboutMenu} - */ - @NotNull - public AboutMenu withDescription(@Nullable String description) { - this.description = description; - return this; - } - - /** - * Set the {@link Version} of the resource to display on the menu - * - * @param version The resource version - * @return The {@link AboutMenu} - */ - @NotNull - public AboutMenu withVersion(@NotNull Version version) { this.version = version; - return this; - } - - /** - * Add an attribution to the menu - * - * @param category The attribution category (e.g. {@code "Author"}) - * @param credits {@link Credit}s to add - * @return The {@link AboutMenu} - */ - @NotNull - public AboutMenu addAttribution(@NotNull String category, @NotNull Credit... credits) { - final List creditList = new ArrayList<>(Arrays.asList(credits)); - attributions.putIfAbsent(category, new ArrayList<>()); - attributions.get(category).addAll(creditList); - return this; + this.description = description; + this.attributions = attributions; + this.buttons = buttons; } - /** - * Add linked buttons to the menu - * - * @param links {@link Link}s to add - * @return The {@link AboutMenu} - */ @NotNull - public AboutMenu addButtons(@NotNull Link... links) { - buttons.addAll(Arrays.asList(links)); - return this; + public static Builder builder() { + return new Builder(); } /** @@ -103,7 +40,7 @@ public class AboutMenu { * @return The {@link MineDown} menu */ @NotNull - public MineDown toMineDown() { + public MineDown asMineDown() { final StringJoiner menu = new StringJoiner("\n") .add("[" + escapeMineDown(title) + "](#00fb9a bold)" + (version != null ? " [| v" + escapeMineDown(version.toString()) + "](#00fb9a)" : "")); @@ -141,14 +78,18 @@ public class AboutMenu { return new MineDown(menu.toString()).replace(); } + @NotNull + public Component asComponent() { + return asMineDown().toComponent(); + } + /** - * Return the plaintext string formatted menu. Use this for displaying to console + * Return the plaintext string formatted menu. * * @return The plaintext menu as a string */ - @Override @NotNull - public String toString() { + public String asString() { final StringJoiner menu = new StringJoiner("\n") .add(title + (version != null ? " | Version " + version : "")); if (description != null) { @@ -179,6 +120,121 @@ public class AboutMenu { return menu.toString(); } + /** + * Escape a string from {@link MineDown} formatting for use in a MineDown-formatted locale + *

+ * Although MineDown provides {@link MineDown#escape(String)}, that method fails to escape events + * properly when using the escaped string in a replacement, so this is used instead + * + * @param string The string to escape + * @return The escaped string + */ + @NotNull + private static String escapeMineDown(@NotNull String string) { + final StringBuilder value = new StringBuilder(); + for (int i = 0; i < string.length(); ++i) { + char c = string.charAt(i); + boolean isEscape = c == '\\'; + boolean isColorCode = i + 1 < string.length() && (c == 167 || c == '&'); + boolean isEvent = c == '[' || c == ']' || c == '(' || c == ')'; + boolean isFormatting = (c == '_' || c == '*' || c == '~' || c == '?' || c == '#') && Util.isDouble(string, i); + if (isEscape || isColorCode || isEvent || isFormatting) { + value.append('\\'); + } + + value.append(c); + } + return value.toString(); + } + + public static class Builder { + private String title; + private Version version; + private String description; + private final Map> attributions = new LinkedHashMap<>(); + private final List buttons = new ArrayList<>(); + + private Builder() { + } + + /** + * Set the title of the resource to display on the menu + * + * @param title The resource title + * @return The {@link Builder} + */ + @NotNull + public Builder title(@NotNull String title) { + this.title = title; + return this; + } + + /** + * Set the description of the resource to display on the menu + * + * @param description The resource description + * @return The {@link Builder} + */ + @NotNull + public Builder description(@Nullable String description) { + this.description = description; + return this; + } + + /** + * Set the {@link Version} of the resource to display on the menu + * + * @param version The resource version + * @return The {@link Builder} + */ + @NotNull + public Builder version(@NotNull Version version) { + this.version = version; + return this; + } + + /** + * Add an attribution to the menu + * + * @param category The attribution category (e.g. {@code "Author"}) + * @param credits {@link Credit}s to add + * @return The {@link Builder} + */ + @NotNull + public Builder credits(@NotNull String category, @NotNull Credit... credits) { + final List creditList = new ArrayList<>(Arrays.asList(credits)); + attributions.putIfAbsent(category, new ArrayList<>()); + attributions.get(category).addAll(creditList); + return this; + } + + /** + * Add linked buttons to the menu + * + * @param links {@link Link}s to add + * @return The {@link Builder} + */ + @NotNull + public Builder buttons(@NotNull Link... links) { + buttons.addAll(Arrays.asList(links)); + return this; + } + + /** + * Build the {@link AboutMenu} + * + * @return The {@link Builder} + */ + @NotNull + public AboutMenu build() { + if (title == null) { + throw new IllegalStateException("Title must be set"); + } + return new AboutMenu(title, version, description, attributions, buttons); + } + + } + /** * Represents a link related to the resource */ @@ -274,7 +330,8 @@ public class AboutMenu { * @param description The description of the credit (what they did) * @return The {@link Credit} */ - public Credit withDescription(@Nullable String description) { + @NotNull + public Credit description(@Nullable String description) { this.description = description; return this; } @@ -285,7 +342,8 @@ public class AboutMenu { * @param url The URL of the credit (i.e. their website) * @return The {@link Credit} */ - public Credit withUrl(@Nullable String url) { + @NotNull + public Credit url(@Nullable String url) { this.url = url; return this; } @@ -296,38 +354,12 @@ public class AboutMenu { * @param color The color of the credit * @return The {@link Credit} */ - public Credit withColor(@NotNull String color) { + @NotNull + public Credit color(@NotNull String color) { this.color = color; return this; } } - /** - * Escape a string from {@link MineDown} formatting for use in a MineDown-formatted locale - *

- * Although MineDown provides {@link MineDown#escape(String)}, that method fails to escape events - * properly when using the escaped string in a replacement, so this is used instead - * - * @param string The string to escape - * @return The escaped string - */ - @NotNull - private static String escapeMineDown(@NotNull String string) { - final StringBuilder value = new StringBuilder(); - for (int i = 0; i < string.length(); ++i) { - char c = string.charAt(i); - boolean isEscape = c == '\\'; - boolean isColorCode = i + 1 < string.length() && (c == 167 || c == '&'); - boolean isEvent = c == '[' || c == ']' || c == '(' || c == ')'; - boolean isFormatting = (c == '_' || c == '*' || c == '~' || c == '?' || c == '#') && Util.isDouble(string, i); - if (isEscape || isColorCode || isEvent || isFormatting) { - value.append('\\'); - } - - value.append(c); - } - return value.toString(); - } - } diff --git a/src/main/java/net/william278/desertwell/util/ThrowingConsumer.java b/src/main/java/net/william278/desertwell/util/ThrowingConsumer.java new file mode 100644 index 0000000..0af8ceb --- /dev/null +++ b/src/main/java/net/william278/desertwell/util/ThrowingConsumer.java @@ -0,0 +1,19 @@ +package net.william278.desertwell.util; + +import java.util.function.Consumer; + +@FunctionalInterface +public interface ThrowingConsumer extends Consumer { + + @Override + default void accept(final T elem) { + try { + acceptThrows(elem); + } catch (final Exception e) { + throw new RuntimeException(e); + } + } + + void acceptThrows(T elem) throws Exception; + +} \ No newline at end of file diff --git a/src/main/java/net/william278/desertwell/util/UpdateChecker.java b/src/main/java/net/william278/desertwell/util/UpdateChecker.java new file mode 100644 index 0000000..afb787d --- /dev/null +++ b/src/main/java/net/william278/desertwell/util/UpdateChecker.java @@ -0,0 +1,181 @@ +package net.william278.desertwell.util; + +import org.jetbrains.annotations.NotNull; +import org.json.JSONArray; +import org.json.JSONObject; + +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStreamReader; +import java.net.URL; +import java.util.concurrent.CompletableFuture; +import java.util.function.Function; +import java.util.regex.Pattern; + +/** + * Utility for comparing a {@link Version} against the latest version on various {@link Endpoint}s + */ +@SuppressWarnings("unused") +public class UpdateChecker { + private final Endpoint endpoint; + private final Version currentVersion; + private final String versionMetaDelimiter; + private final String resource; + + private UpdateChecker(@NotNull Endpoint endpoint, @NotNull Version currentVersion, + @NotNull String versionMetaDelimiter, @NotNull String resource) { + this.endpoint = endpoint; + this.currentVersion = currentVersion; + this.versionMetaDelimiter = versionMetaDelimiter; + this.resource = resource; + } + + @NotNull + public static Builder builder() { + return new Builder(); + } + + /** + * Query SpigotMC for the latest {@link Version} of the plugin + * + * @return A {@link CompletableFuture} containing the latest {@link Version} of the plugin + */ + public CompletableFuture check() { + return CompletableFuture + .supplyAsync(() -> new Completed(this, Version.fromString(endpoint.query(resource), versionMetaDelimiter))) + .exceptionally(throwable -> new Completed(this, currentVersion)); + } + + public static class Builder { + private Endpoint endpoint = Endpoint.SPIGOT; + private Version currentVersion; + private String versionMetaDelimiter = Version.META_DELIMITER; + private String resource; + + private Builder() { + } + + @NotNull + public Builder endpoint(@NotNull Endpoint endpoint) { + this.endpoint = endpoint; + return this; + } + + @NotNull + public Builder currentVersion(@NotNull Version currentVersion) { + this.currentVersion = currentVersion; + return this; + } + + @NotNull + public Builder versionMetaDelimiter(@NotNull String versionMetaDelimiter) { + this.versionMetaDelimiter = versionMetaDelimiter; + return this; + } + + @NotNull + public Builder resource(@NotNull String resource) { + this.resource = resource; + return this; + } + + @NotNull + public UpdateChecker build() { + if (currentVersion == null) { + throw new IllegalStateException("Current version is not set"); + } + if (resource == null) { + throw new IllegalStateException("Resource is not set"); + } + return new UpdateChecker(endpoint, currentVersion, versionMetaDelimiter, resource); + } + + } + + /** + * Represents endpoints from which the latest version can be queried + */ + public enum Endpoint { + SPIGOT((resource -> { + final String url = formatId("https://api.spigotmc.org/legacy/update.php?resource={id}", resource); + try (final InputStreamReader reader = new InputStreamReader(new URL(url).openConnection().getInputStream())) { + return new BufferedReader(reader).readLine(); + } catch (IOException e) { + throw new IllegalStateException("Unable to fetch latest version", e); + } + })), + POLYMART((resource -> { + final String url = formatId("https://api.polymart.org/v1/getResourceInfoSimple/?resource_id={id}&key=version", resource); + try (final InputStreamReader reader = new InputStreamReader(new URL(url).openConnection().getInputStream())) { + return new BufferedReader(reader).readLine(); + } catch (IOException e) { + throw new IllegalStateException("Unable to fetch latest version", e); + } + })), + MODRINTH((resource -> { + final String url = formatId("https://api.modrinth.com/v2/project/{id}/version", resource); + try (final InputStreamReader reader = new InputStreamReader(new URL(url).openConnection().getInputStream())) { + final JSONArray array = new JSONArray(new BufferedReader(reader).readLine()); + for (int i = 0; i < array.length(); i++) { + final JSONObject object = array.getJSONObject(i); + if (object.getString("version_type").equals("release")) { + return object.getString("version_number"); + } + } + throw new IllegalStateException("No versions found"); + } catch (IOException e) { + throw new IllegalStateException("Unable to fetch latest version", e); + } + })), + GITHUB((resource -> { + final String url = formatId("https://api.github.com/repos/{id}/releases/latest", resource); + try (final InputStreamReader reader = new InputStreamReader(new URL(url).openConnection().getInputStream())) { + return new JSONObject(new BufferedReader(reader).readLine()).getString("tag_name"); + } catch (IOException e) { + throw new IllegalStateException("Unable to fetch latest version", e); + } + })); + + private final Function queryFunction; + + Endpoint(@NotNull Function queryFunction) { + this.queryFunction = queryFunction; + } + + @NotNull + public String query(@NotNull String resource) { + return queryFunction.apply(resource); + } + + @NotNull + private static String formatId(@NotNull String endpoint, @NotNull String resource) { + return endpoint.replaceAll(Pattern.quote("{id}"), resource); + } + } + + public static class Completed { + private final UpdateChecker checker; + private final Version latestVersion; + + private Completed(@NotNull UpdateChecker checker, @NotNull Version latestVersion) { + this.checker = checker; + this.latestVersion = latestVersion; + } + + @NotNull + public Version getLatestVersion() { + return latestVersion; + } + + @NotNull + public Version getCurrentVersion() { + return checker.currentVersion; + } + + public boolean isUpToDate() { + return checker.currentVersion.compareTo(latestVersion) >= 0; + } + + } + +} \ No newline at end of file diff --git a/src/main/java/net/william278/desertwell/Version.java b/src/main/java/net/william278/desertwell/util/Version.java similarity index 85% rename from src/main/java/net/william278/desertwell/Version.java rename to src/main/java/net/william278/desertwell/util/Version.java index d607b1c..e8d4d9b 100644 --- a/src/main/java/net/william278/desertwell/Version.java +++ b/src/main/java/net/william278/desertwell/util/Version.java @@ -1,4 +1,4 @@ -package net.william278.desertwell; +package net.william278.desertwell.util; import org.jetbrains.annotations.NotNull; @@ -11,9 +11,9 @@ import java.util.regex.Pattern; */ @SuppressWarnings("unused") public class Version implements Comparable { - private final String VERSION_DELIMITER = "."; - private static final String MINECRAFT_META_DELIMITER = "-"; - private static final String PLUGIN_META_DELIMITER = "+"; + public final String VERSION_DELIMITER = "."; + public static final String META_DELIMITER = "-"; + // Major, minor and patch version numbers private int[] versions = new int[]{}; @NotNull @@ -46,23 +46,11 @@ public class Version implements Comparable { * * @param versionString The version string to parse * @return The {@link Version} - * @implNote The default meta delimiter that will be used is {@link #PLUGIN_META_DELIMITER} + * @implNote The default meta delimiter that will be used is {@link #META_DELIMITER} */ @NotNull public static Version fromString(@NotNull String versionString) { - return new Version(versionString, PLUGIN_META_DELIMITER); - } - - /** - * Create a new {@link Version} by parsing a Minecraft string - * - * @param versionString The Minecraft version string to parse - * @return The {@link Version} - * @implNote The meta delimiter that will be used is {@link #MINECRAFT_META_DELIMITER} - */ - @NotNull - public static Version fromMinecraftVersionString(@NotNull String versionString) { - return new Version(versionString, MINECRAFT_META_DELIMITER); + return new Version(versionString, META_DELIMITER); } /** diff --git a/src/test/java/net/william278/desertwell/UpdateCheckerTests.java b/src/test/java/net/william278/desertwell/UpdateCheckerTests.java index 5efa054..a0547c3 100644 --- a/src/test/java/net/william278/desertwell/UpdateCheckerTests.java +++ b/src/test/java/net/william278/desertwell/UpdateCheckerTests.java @@ -1,15 +1,53 @@ package net.william278.desertwell; +import net.william278.desertwell.util.UpdateChecker; +import net.william278.desertwell.util.Version; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; public class UpdateCheckerTests { @Test - public void testUpdateChecker() { - // Tests against the HuskSync resource ID - final UpdateChecker updateChecker = UpdateChecker.create(Version.fromString("1.0.0"), 97144); - Assertions.assertFalse(updateChecker.isUpToDate().join()); + public void testSpigotEndpoint() { + final UpdateChecker updateChecker = UpdateChecker.builder() + .currentVersion(Version.fromString("1.0.0")) + .resource("97144") + .build(); + + Assertions.assertFalse(updateChecker.check().join().isUpToDate()); + } + + @Test + public void testGitHubEndpoint() { + final UpdateChecker updateChecker = UpdateChecker.builder() + .currentVersion(Version.fromString("1.0.0")) + .endpoint(UpdateChecker.Endpoint.GITHUB) + .resource("WiIIiam278/HuskHomes2") + .build(); + + Assertions.assertFalse(updateChecker.check().join().isUpToDate()); + } + + @Test + public void testModrinthEndpoint() { + final UpdateChecker updateChecker = UpdateChecker.builder() + .currentVersion(Version.fromString("1.0.0")) + .endpoint(UpdateChecker.Endpoint.MODRINTH) + .resource("huskhomes") + .build(); + + Assertions.assertFalse(updateChecker.check().join().isUpToDate()); + } + + @Test + public void testPolymartEndpoint() { + final UpdateChecker updateChecker = UpdateChecker.builder() + .currentVersion(Version.fromString("1.0.0")) + .endpoint(UpdateChecker.Endpoint.POLYMART) + .resource("284") + .build(); + + Assertions.assertFalse(updateChecker.check().join().isUpToDate()); } } diff --git a/src/test/java/net/william278/desertwell/VersionTests.java b/src/test/java/net/william278/desertwell/VersionTests.java index 0324544..45b8e19 100644 --- a/src/test/java/net/william278/desertwell/VersionTests.java +++ b/src/test/java/net/william278/desertwell/VersionTests.java @@ -1,5 +1,6 @@ package net.william278.desertwell; +import net.william278.desertwell.util.Version; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; @@ -23,15 +24,15 @@ public class VersionTests { } @Test - public void testVersionComparingWithMetadata() { - final Version oldVersion = Version.fromString("1.0.0+dev"); - final Version newVersion = Version.fromString("1.0.1+snapshot-123"); + public void testVersionComparingWithMetaDelimiter() { + final Version oldVersion = Version.fromString("1.0.0+dev", "+"); + final Version newVersion = Version.fromString("1.0.1+snapshot-123", "+"); Assertions.assertTrue(oldVersion.compareTo(newVersion) < 0); } @Test public void testParsingMinecraftVersion() { - final Version version = Version.fromMinecraftVersionString("1.2.3-SNAPSHOT"); + final Version version = Version.fromString("1.2.3-SNAPSHOT"); Assertions.assertEquals(1, version.getMajor()); Assertions.assertEquals(2, version.getMinor()); Assertions.assertEquals(3, version.getPatch());