Skip to content
Draft
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
5972a00
Initial work on heads (cherrypick + new!)
aakatz3 Dec 17, 2020
b8a5bf6
Beta of the mojang api stuff
aakatz3 Dec 20, 2020
8dae48a
Bump classgraph from 4.8.92 to 4.8.98
dependabot-preview[bot] Dec 24, 2020
7d74d10
Merge branch 'master' into feat/heads-mojangapi-users
aakatz3 Dec 25, 2020
3db73ff
Merge remote-tracking branch 'origin/master' into feat/heads-mojangap…
aakatz3 Dec 25, 2020
004fbf0
Fixed the stupidity of textures as enums and wrote some fun stuff
aakatz3 Dec 26, 2020
b014f6b
force gradle to uff-8
aakatz3 Dec 26, 2020
329515f
Test the enums so coverage isnt mad
aakatz3 Dec 26, 2020
ab69d97
more api work before changing pc
aakatz3 Dec 28, 2020
67a9c4b
More tests, use MHF, Start skullbuilder refactor
aakatz3 Dec 29, 2020
680655b
Allow generating frames for javadoc
aakatz3 Dec 30, 2020
8c113ec
Test updates (mocked bukkit); javadoc frames
aakatz3 Dec 30, 2020
ac010e4
typo
aakatz3 Dec 30, 2020
0b15f04
More test work
aakatz3 Dec 30, 2020
b6f0496
Add javadoc to ci
aakatz3 Dec 30, 2020
6d4bcec
javadoc
aakatz3 Dec 31, 2020
c4a023e
update licence, start on zach comments
aakatz3 Jan 2, 2021
0fb226b
Minor refactor, javadoc
aakatz3 Jan 4, 2021
c44992f
Refactor Texture validation to it's own class
aakatz3 Jan 4, 2021
b278a81
Bump mockito-core from 3.6.28 to 3.7.0
dependabot-preview[bot] Jan 5, 2021
8c6b7b5
Little more work before back to phone for a while?
aakatz3 Jan 5, 2021
786590d
try to fix docs
aakatz3 Jan 6, 2021
cacaefb
Finish javadoc
aakatz3 Jan 9, 2021
ade9f94
Merge branch 'master' into dependabot/gradle/io.github.classgraph-cla…
aakatz3 Jan 9, 2021
223a6f9
Merge remote-tracking branch 'origin/dependabot/gradle/org.mockito-mo…
aakatz3 Jan 9, 2021
84c0b3b
Merge remote-tracking branch 'origin/dependabot/gradle/io.github.clas…
aakatz3 Jan 9, 2021
6b4316f
Add mocked bukkit stuff, remove extra old enums
aakatz3 Jan 9, 2021
42b1739
PlayerSelector & better math util
kokumaji Jan 11, 2021
d16c439
Merge remote-tracking branch 'origin/yeen-cherrypick' into feat/heads…
aakatz3 Jan 11, 2021
3aaa25b
Add lots of javadoc
aakatz3 Jan 11, 2021
6fc4385
Infer Nullity
aakatz3 Jan 11, 2021
263164b
Prepare for new tests, add docs
aakatz3 Jan 16, 2021
26c8415
Bug fixups
aakatz3 Jan 22, 2021
614816b
javadoc 1
aakatz3 Jan 29, 2021
e6a97e1
Merge master
aakatz3 Jan 31, 2021
94683c6
Fix licence after merge
aakatz3 Feb 2, 2021
aa23150
Change how textures are implemented to a json we generate
aakatz3 Feb 8, 2021
7f2cab7
Cleanup
aakatz3 Feb 8, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,25 @@ jobs:
run: chmod +x gradlew
- name: Run the license formatter checker
run: ./gradlew licenseMain licenseTest
docs-test:
runs-on: ubuntu-latest
container:
image: jcxldn/openjdk-alpine:11-jdk
steps:
- uses: actions/checkout@v2
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Generate javadocs
run: ./gradlew javadoc
- name: Save docs artifact
uses: actions/upload-artifact@v2
with:
name: javadocs
path: build/docs/*
- name: Save failed javadocs options
if: ${{ failure() }}
uses: actions/upload-artifact@v2
with:
name: javadocs-opts
path: build/*

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 DumbDogDiner
Copyright (c) 2021 DumbDogDiner

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
57 changes: 52 additions & 5 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ plugins {
id "com.github.hierynomus.license" version "0.15.0"
}



jacoco {
// Use JaCoCo 0.8.6 for (experimental) support for Java 15 class files.
toolVersion = "0.8.6"
Expand All @@ -25,6 +27,7 @@ license {
tasks.withType(JavaCompile) {
options.compilerArgs << "-Xlint:unchecked" << "-Xlint:deprecation" << "-XDignore.symbol.file"
}

// Run the license formatter before compiling the source code.
tasks.compileJava.dependsOn licenseFormatMain, licenseFormatTest

Expand All @@ -37,6 +40,7 @@ configurations {
repositories {
mavenCentral()
jcenter()
google()

maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
maven { url 'https://papermc.io/repo/repository/maven-public/' }
Expand All @@ -48,30 +52,38 @@ dependencies {

compileOnly 'com.destroystokyo.paper:paper-api:1.16.4-R0.1-SNAPSHOT'
compileOnly 'net.md-5:bungeecord-api:1.16-R0.4-SNAPSHOT'

implementation 'org.jetbrains:annotations:20.1.0'
implementation 'com.google.code.gson:gson:2.8.6'
implementation 'io.github.classgraph:classgraph:4.8.92'
implementation 'io.github.classgraph:classgraph:4.8.98'
implementation 'com.github.seancfoley:ipaddress:5.3.3'
implementation 'com.squareup.okhttp3:okhttp:4.9.0'
implementation 'commons-validator:commons-validator:1.7'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Guava's preconditions rather than shading in deps to StickyAPI.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please explain

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the JavaDocs for preconditions. This is included in both bukkit and bungee so will work at runtime. No need to shade in extra dependencies.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless you're intending to use this for a completely different reason.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validator is used primarily to check url formatting for validity, and determine if a URL is validly formatted (and I think it also checks if it's resolvable). There are a couple other ways I plan to use it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also theoretically call the minimize() function to reduce jar size

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Validator is used primarily to check url formatting for validity, and determine if a URL is validly formatted (and I think it also checks if it's resolvable). There are a couple other ways I plan to use it.

Google preconditions does thissssss - just include a URL regex.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also theoretically call the minimize() function to reduce jar size

This has side effects, we've already tried it.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need to validate the URL ourselves? OkHttp should throw an exception when unable to parse a URL, and if we don't want to use OkHttp, a regular expression will do for URL validity

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also probably test URL validity by attempting to construct a URL object using the string and seeing if a MalformedURLException is thrown

implementation 'com.google.guava:guava:30.1-jre'

// JUnit 5 Testing
testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.0")
testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0")
testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'

// Mocking
testImplementation("org.powermock:powermock-module-junit4:2.0.9")
testImplementation("org.powermock:powermock-api-mockito2:2.0.9")
testImplementation("org.powermock:powermock-module-junit4-rule:2.0.9")
testImplementation("org.powermock:powermock-classloading-xstream:2.0.9")
testImplementation("org.mockito:mockito-core:3.6.28")
testImplementation("org.mockito:mockito-core:3.7.0")
testImplementation 'com.github.seeseemelk:MockBukkit-v1.16:0.5.0'
testImplementation 'it.unimi.dsi:fastutil:8.4.4'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we start adding comments for depends so we know why they're added so I don't have to ask like this later...

}


test {
useJUnitPlatform()
testLogging {
events "passed", "skipped", "failed"
// Show System.out for code ran by tests
showStandardStreams = true
}
//ignoreFailures = true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this line if it's commented.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its there for testing. I will try to fold into a new task

finalizedBy jacocoTestReport // report is always generated after tests run
}

Expand All @@ -88,9 +100,44 @@ 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little hesitant to have javadoc and build run after clean...

@NotZachery thoughts?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how this could become an issue so I'm fine by it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are set to run after as should, not forced. This prevents (if you did, say, ./gradlew build clean javadoc it from building then deleting the build.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah okay - thanks!

tasks.build.finalizedBy(sources)

delombok {
finalizedBy(javadoc)
print(true)
//verbose(true)
}

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 build, clean
}



Expand Down
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
systemProp.file.encoding=utf-8
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
systemProp.file.encoding=utf-8
systemProp.file.encoding=utf-8

3 changes: 1 addition & 2 deletions gradle/wrapper/gradle-wrapper.properties
Original file line number Diff line number Diff line change
@@ -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.7.1-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
compileJava.options.encoding=UTF-8
20 changes: 16 additions & 4 deletions src/main/java/com/dumbdogdiner/stickyapi/StickyAPI.java
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi;

import lombok.Getter;
import lombok.Setter;

import java.io.InputStream;
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.
Expand All @@ -25,4 +26,15 @@ public class StickyAPI {
@Getter
@Setter
private static 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(String resourceName){
return StickyAPI.class.getResourceAsStream(resourceName);
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? Also, where are the annotations?


private StickyAPI() {}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.annotation;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.command;
Expand Down Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,36 +1,27 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.command;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.concurrent.FutureTask;

import com.dumbdogdiner.stickyapi.StickyAPI;
import com.dumbdogdiner.stickyapi.bukkit.util.SoundUtil;
import com.dumbdogdiner.stickyapi.common.ServerVersion;
import com.dumbdogdiner.stickyapi.common.arguments.Arguments;
import com.dumbdogdiner.stickyapi.common.command.CommandBuilder;
import com.dumbdogdiner.stickyapi.common.command.ExitCode;
import com.dumbdogdiner.stickyapi.common.ServerVersion;
import com.dumbdogdiner.stickyapi.common.util.NotificationType;
import com.dumbdogdiner.stickyapi.common.util.ReflectionUtil;
import com.dumbdogdiner.stickyapi.common.util.StringUtil;
import com.google.common.collect.ImmutableList;

import org.bukkit.command.Command;
import org.bukkit.command.CommandExecutor;
import org.bukkit.command.CommandMap;
import org.bukkit.command.CommandSender;
import org.bukkit.command.TabCompleter;
import org.bukkit.command.*;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No wild card imports.

import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;

import java.util.*;
import java.util.concurrent.FutureTask;

/**
* CommandBuilder for avoiding bukkit's terrible command API and making creating
* new commands as simple as possible
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.command;
Expand All @@ -10,8 +10,8 @@
* Enum based exit codes for StickyAPI command classes.
*
* @deprecated use {@link com.dumbdogdiner.stickyapi.common.command.ExitCode} as
* this will be removed in the next release
* @see {@link com.dumbdogdiner.stickyapi.common.command.ExitCode}
* this will be removed in a future release
* @see com.dumbdogdiner.stickyapi.common.command.ExitCode
*/
@Deprecated
public enum ExitCode {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.command;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.generator;

import java.util.Random;

import org.bukkit.World;
import org.bukkit.generator.ChunkGenerator;
import org.jetbrains.annotations.NotNull;

import java.util.Random;

/**
* A class for generating empty void worlds
*/
@SuppressWarnings("unused")
public class VoidGenerator extends ChunkGenerator {

@Override
public ChunkData generateChunkData(@NotNull World world, Random random, int x, int z, BiomeGrid biome) {
public @NotNull ChunkData generateChunkData(@NotNull World world, @NotNull Random random, int x, int z, @NotNull BiomeGrid biome) {
return createChunkData(world);
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2020 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Copyright (c) 2021 DumbDogDiner <dumbdogdiner.com>. All rights reserved.
* Licensed under the MIT license, see LICENSE for more information...
*/
package com.dumbdogdiner.stickyapi.bukkit.gui;
Expand Down
Loading