[REFERENCE ONLY DO NOT REVIEW!!!] Implement Mojang WebAPI, common user root class, and playerheads

.github/workflows/ci.yml

@@ -70,3 +70,4 @@ jobs:
       with:
         name: failed-javadocs-options-file
         path: build/tmp/javadoc/javadoc.options
+

.gitignore

@@ -25,6 +25,7 @@ hs_err_pid*
 .gradle
 **/build/
 !src/**/build/
+**/resources/generated/
 
 # Ignore Gradle GUI config
 gradle-app.setting

CONTRIBUTING.md

@@ -6,7 +6,7 @@ This project is open for all developers for contribution, so it's important we e
 
 -   No pushing to master without opening a pull request (The only exceptions are small hotfixes, any new features or such MUST go in a new branch)
 -   Must be backwards compatible down to Java 11
--   Javadoc your code according to google's [Javadoc guidlines](https://google.github.io/styleguide/javaguide.html#s7-javadoc)
+-   Javadoc your code according to Google's [Javadoc guidlines](https://google.github.io/styleguide/javaguide.html#s7-javadoc)
 
 ## Pull Requests
 

build.gradle

@@ -14,19 +14,21 @@ jacoco {
 }
 
 group = 'com.dumbdogdiner'
-
-version = '2.1.0'
+version = '2.3.0'
 
 // License Plugin Options
 license {
     header = project.file('LICENSE_HEADER')
     ext.year = Calendar.getInstance().get(Calendar.YEAR)
     mapping("java", "SLASHSTAR_STYLE")
+    exclude("**/*.json")
 }
 
 tasks.withType(JavaCompile) {
     options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation" << "-XDignore.symbol.file"
+    options.encoding = "UTF-8"
 }
+
 // Run the license formatter before compiling the source code.
 tasks.compileJava.dependsOn licenseFormatMain, licenseFormatTest
 
@@ -39,6 +41,7 @@ configurations {
 repositories {
     mavenCentral()
     jcenter()
+    google()
 
     maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
     maven { url 'https://papermc.io/repo/repository/maven-public/' }
@@ -50,17 +53,34 @@ dependencies {
 
     compileOnly 'com.destroystokyo.paper:paper-api:1.16.5-R0.1-SNAPSHOT'
     compileOnly 'net.md-5:bungeecord-api:1.16-R0.5-SNAPSHOT'
+
     implementation 'org.jetbrains:annotations:20.1.0'
     implementation 'com.google.code.gson:gson:2.8.6'
     implementation 'io.github.classgraph:classgraph:4.8.100'
     implementation 'com.github.seancfoley:ipaddress:5.3.3'
+    implementation 'com.squareup.okhttp3:okhttp:4.9.0'
+    implementation 'commons-validator:commons-validator:1.7'
+    implementation 'com.google.guava:guava:30.1-jre'
 
     // Tests - JUnit 5
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")
 
     // Tests - Mocking Suite (eg. mocking Bukkit for tests)
     testImplementation("org.mockito:mockito-core:3.7.7")
+
+    // Tests - Mocked Bukkit Project (Has some additional features)
+    testImplementation 'com.github.seeseemelk:MockBukkit-v1.16:0.5.0'
+    testImplementation 'it.unimi.dsi:fastutil:8.4.4'
+}
+
+task downloadTextures(type: Download) {
+    sourceUrl = 'https://dumbdogdiner.github.io/mc-heads-resource/textures.json'
+    target = new File('src/main/resources/generated/textures.json')
+}
+
+task cleanGenerated(type: Delete){
+    delete('src/main/resources/generated')
 }
 
 test {
@@ -70,6 +90,7 @@ test {
         // Show System.out for code ran by tests
         showStandardStreams = true
 	}
+    //ignoreFailures = true
     finalizedBy jacocoTestReport // report is always generated after tests run
 }
 
@@ -86,15 +107,22 @@ task sources(type: Jar, dependsOn: classes) {
     from sourceSets.main.allSource
 }
 
+tasks.delombok.shouldRunAfter(sources)
+tasks.publish.dependsOn build
+tasks.build.shouldRunAfter(clean)
+tasks.javadoc.shouldRunAfter(clean)
+tasks.build.finalizedBy(sources)
+tasks.clean.dependsOn(cleanGenerated)
+tasks.processResources.dependsOn(downloadTextures)
 
 // Javadoc Fixes
 // Some environments (such as the builder image) do not use UTF-8 as the default encoding!
-// This sets UTF-8 as the encoding for the following tasks: delombok, compileJava, compileTestJava and javadoc.
-delombok.encoding = "UTF-8"
-
-compileJava.options.encoding = "UTF-8"
-compileTestJava.options.encoding = "UTF-8"
-javadoc.options.encoding = "UTF-8"
+delombok {
+    finalizedBy(javadoc)
+    print(true)
+    encoding = "UTF-8"
+    //verbose(true)
+}
 
 
 // Build Info
@@ -127,10 +155,35 @@ task processSourceTokens(type: Sync) {
 }
 // Use the filter task as the input for compileJava
 compileJava.source = processSourceTokens.outputs
+tasks.publish.dependsOn build, sources
+
+tasks.withType(JavaCompile) {
+    options.encoding = "UTF-8"
+}
+tasks.withType(Test) {
+    systemProperty "file.encoding", "UTF-8"
+}
 
+javadoc {
+    options.addBooleanOption('XDignore.symbol.file', true)
+    options.addBooleanOption('-frames', true)
+    options.addBooleanOption('private', true)
+    test.ignoreFailures true;
+    options.encoding = 'UTF-8'
+    dependsOn delombok
+}
 
-tasks.publish.dependsOn build, sources
+task browseJavadoc {
+    dependsOn javadoc
+    doLast {
+        java.awt.Desktop.desktop.browse new URI(("file:///" << System.getProperty("user.dir").replace('\\','/') << "/build/docs/javadoc/index.html").toString())
+    }
+}
 
+task rebuild {
+    dependsOn clean
+    finalizedBy build
+}
 
 
 
@@ -152,3 +205,16 @@ publishing {
         }
     }
 }
+
+class Download extends DefaultTask {
+    @Input
+    String sourceUrl
+
+    @OutputFile
+    File target
+
+    @TaskAction
+    void download() {
+        ant.get(src: sourceUrl, dest: target)
+    }
+}

gradle.properties

@@ -0,0 +1 @@
+systemProp.file.encoding=utf-8

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-compileJava.options.encoding=UTF-8

src/main/java/com/dumbdogdiner/stickyapi/StickyAPI.java

@@ -4,16 +4,18 @@
  */
 package com.dumbdogdiner.stickyapi;
 
+import lombok.Getter;
+import lombok.Setter;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.InputStream;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.logging.Logger;
 
-import lombok.Getter;
-import lombok.Setter;
-
 /**
  * <h1>StickyAPI</h1> Utility methods, classes and potentially
  * code-dupe-annihilating code for DDD plugins.
@@ -29,7 +31,16 @@ private StickyAPI() {
 
     @Getter
     @Setter
-    private static ExecutorService pool = Executors.newCachedThreadPool();
+    private static @NotNull ExecutorService pool = Executors.newCachedThreadPool();
+
+    /**
+     * Provides a wrapper for {@link java.lang.Class#getResourceAsStream(String)} (String)}
+     * @param resourceName The resource to get
+     * @return an {@link InputStream} to that resource
+     */
+    public static InputStream getResourceAsStream(@NotNull String resourceName){
+        return StickyAPI.class.getResourceAsStream(resourceName);
+    }
 
     // Build Info Start
 
@@ -38,8 +49,8 @@ private StickyAPI() {
      * 
      * @since TBA
      * @return {@link String} version
-     * 
      */
+    @SuppressWarnings("JavaDoc")
     @Getter
     private static final String version = "@BUILDINFO_VERSION";
 
@@ -55,6 +66,7 @@ private StickyAPI() {
      * @since TBA
      * @return {@link String} commit id
      */
+    @SuppressWarnings("JavaDoc")
     @Getter
     private static final String commit = "@BUILDINFO_COMMIT@";
 
@@ -64,6 +76,7 @@ private StickyAPI() {
      * @since TBA
      * @return {@link String} branch name
      */
+    @SuppressWarnings("JavaDoc")
     @Getter
     private static final String branch = "@BUILDINFO_BRANCH@";
 
@@ -80,8 +93,7 @@ private StickyAPI() {
     public static Date getTimestamp() {
         SimpleDateFormat formatter = new SimpleDateFormat(dateFormat);
         try {
-            Date date = formatter.parse(timestamp);
-            return date;
+            return formatter.parse(timestamp);
         } catch (ParseException e) {
             e.printStackTrace();
             return null;
@@ -106,6 +118,7 @@ public static String getSha() {
      * @since TBA
      * @return {@link Boolean} isDirty
      */
+    @SuppressWarnings("ConstantConditions")
     public static Boolean getIsDirty() {
         return Boolean.parseBoolean(isDirty);
     }

src/main/java/com/dumbdogdiner/stickyapi/annotation/DoNotCall.java

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2020-2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
+ * Licensed under the MIT license, see LICENSE for more information...
+ */
+package com.dumbdogdiner.stickyapi.annotation;
+
+import java.lang.annotation.Documented;
+
+
+/**
+ * Do not call a method annotated with this, it will do bad things
+ */
+@Documented
+public @interface DoNotCall {
+
+}

src/main/java/com/dumbdogdiner/stickyapi/bukkit/command/AsyncCommand.java

@@ -30,7 +30,7 @@
  * 
  * @deprecated Use
  *             {@link com.dumbdogdiner.stickyapi.bukkit.command.BukkitCommandBuilder}
- *             as this will be removed in the next release
+ *             as this will be removed in a future release
  */
 @Deprecated
 public abstract class AsyncCommand extends Command implements PluginIdentifiableCommand {
@@ -43,7 +43,7 @@ public abstract class AsyncCommand extends Command implements PluginIdentifiable
      * @param commandName The name of the command the user will execute
      * @param owner       The plugin that owns this command.
      */
-    public AsyncCommand(String commandName, Plugin owner) {
+    public AsyncCommand(@NotNull String commandName, Plugin owner) {
         super(commandName);
         this.owner = owner;
     }
@@ -60,7 +60,7 @@ public AsyncCommand(String commandName, Plugin owner) {
     // public abstract int executeCommand(Sender sender, String commandLabel,
     // String[] args);
 
-    public abstract ExitCode executeCommand(CommandSender sender, String commandLabel, String[] args);
+    public abstract @NotNull ExitCode executeCommand(CommandSender sender, String commandLabel, String[] args);
 
     /**
      * This is a vastly simplified command class. We only check if the plugin is
@@ -77,17 +77,17 @@ public AsyncCommand(String commandName, Plugin owner) {
      * @return {@link ExitCode}
      */
     @Override
-    public final boolean execute(CommandSender sender, String commandLabel, String[] args) {
+    public final boolean execute(@NotNull CommandSender sender, String commandLabel, String[] args) {
         if (!this.owner.isEnabled())
             throw new CommandException(String.format("Cannot execute command \"%s\" in plugin %s - plugin is disabled.",
                     commandLabel, this.owner.getDescription().getFullName()));
 
-        AsyncCommand self = this;
-        FutureTask<Boolean> t = new FutureTask<>(new Callable<Boolean>() {
+        @NotNull AsyncCommand self = this;
+        @NotNull FutureTask<Boolean> t = new FutureTask<>(new Callable<Boolean>() {
             @Override
-            public Boolean call() {
+            public @NotNull Boolean call() {
                 try {
-                    ExitCode resultingExitCode = self.executeCommand(sender, commandLabel, args);
+                    @NotNull ExitCode resultingExitCode = self.executeCommand(sender, commandLabel, args);
 
                     if (resultingExitCode == null) {
                         throw new IllegalArgumentException("A null exit code was returned");
@@ -116,7 +116,7 @@ public Boolean call() {
      * @return Plugin that owns this command
      */
     @Override
-    public Plugin getPlugin() {
+    public @NotNull Plugin getPlugin() {
         return this.owner;
     }
 
@@ -181,16 +181,16 @@ public void setTabCompleter(TabCompleter completer) {
      */
     @Override
     public java.util.@NotNull List<String> tabComplete(@NotNull CommandSender sender, @NotNull String alias,
-            String[] args) throws CommandException, IllegalArgumentException {
+            String @org.jetbrains.annotations.Nullable [] args) throws CommandException, IllegalArgumentException {
         if (args == null)
             throw new NullPointerException("arguments to tabComplete cannot be null");
 
-        List<String> completions = null;
+        @org.jetbrains.annotations.Nullable List<String> completions = null;
         try {
             if (completer != null)
                 completions = completer.onTabComplete(sender, this, alias, args);
         } catch (Throwable ex) {
-            StringBuilder message = new StringBuilder();
+            @NotNull StringBuilder message = new StringBuilder();
             message.append("Unhandled exception during tab completion for command '/").append(alias).append(' ');
             for (String arg : args)
                 message.append(arg).append(' ');
@@ -212,8 +212,8 @@ public void setTabCompleter(TabCompleter completer) {
      * @return the human readable name of the class
      */
     @Override
-    public String toString() {
-        StringBuilder stringBuilder = new StringBuilder(super.toString());
+    public @NotNull String toString() {
+        @NotNull StringBuilder stringBuilder = new StringBuilder(super.toString());
         stringBuilder.deleteCharAt(stringBuilder.length() - 1);
         stringBuilder.append(", ").append(owner.getDescription().getFullName()).append(')');
         return stringBuilder.toString();