diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
index bf1bc10f3..cfd23f546 100644
--- a/.github/workflows/gradle.yml
+++ b/.github/workflows/gradle.yml
@@ -33,6 +33,20 @@ jobs:
- name: Test and Build with Gradle Wrapper
run: ./gradlew build
+ update-pages:
+ needs: test
+ # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+ permissions:
+ contents: write
+ pages: write
+ id-token: write
+ # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+ # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+ concurrency:
+ group: "pages"
+ cancel-in-progress: false
+ uses: ./.github/workflows/pages.yml
+
jacoco:
needs: test
runs-on: ubuntu-latest
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
new file mode 100644
index 000000000..5142a863a
--- /dev/null
+++ b/.github/workflows/pages.yml
@@ -0,0 +1,49 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+ workflow_call:
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+jobs:
+ # Single deploy job since we're just deploying
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Setup Pages
+ uses: actions/configure-pages@v5
+
+ - name: Set up JDK
+ uses: actions/setup-java@v4
+ with:
+ java-version: '8'
+ distribution: 'temurin'
+
+ - name: Setup Gradle
+ uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5
+
+ - name: Generate Javadoc
+ run: ./gradlew aggregateJavaDoc
+
+ - name: Generate Coverage
+ run: |-
+ ./gradlew testCodeCoverageReport
+ mv build/reports/jacoco/testCodeCoverageReport/html html/coverage
+
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ # Upload from html
+ path: './html/'
+
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
diff --git a/build.gradle b/build.gradle
index 82ca2f5fe..eb335ef90 100644
--- a/build.gradle
+++ b/build.gradle
@@ -143,7 +143,7 @@ allprojects {
legacy_version = minecraftVersion
obsolete_version = minecraftVersion
- subprojects.findAll { it.path.contains("bukkit") }.each {dependsOn "${it.path}:test" }
+ subprojects.findAll { it.path.contains("bukkit") }.each { dependsOn "${it.path}:test" }
}
tasks.register('sourcesJar', Jar) {
@@ -184,6 +184,13 @@ allprojects {
}
}
+tasks.register("aggregateJavaDoc") {
+ allprojects.forEach { dependsOn "${it.path}:javadoc" }
+ doLast {
+ JavaDocUtils.aggregateJavaDoc("html/docs", rootProject.name, rootProject.version, TEST_MODULE)
+ }
+}
+
testCodeCoverageReport {
dependsOn test
reports {
diff --git a/buildSrc/build.gradle b/buildSrc/build.gradle
new file mode 100644
index 000000000..c93826763
--- /dev/null
+++ b/buildSrc/build.gradle
@@ -0,0 +1,23 @@
+plugins {
+ id 'java'
+}
+
+repositories {
+ mavenCentral()
+ maven {
+ name = "Fulminazzo repository"
+ url = "https://repo.fulminazzo.it/releases"
+ }
+}
+
+dependencies {
+ testImplementation platform(libs.junit.platform)
+ testImplementation 'org.junit.jupiter:junit-jupiter'
+ testImplementation 'org.junit.jupiter:junit-jupiter-params'
+
+ testImplementation libs.yamlparser
+}
+
+test {
+ useJUnitPlatform()
+}
\ No newline at end of file
diff --git a/buildSrc/settings.gradle b/buildSrc/settings.gradle
new file mode 100644
index 000000000..7018d7b43
--- /dev/null
+++ b/buildSrc/settings.gradle
@@ -0,0 +1,7 @@
+dependencyResolutionManagement {
+ versionCatalogs {
+ libs {
+ from(files("../gradle/libs.versions.toml"))
+ }
+ }
+}
\ No newline at end of file
diff --git a/buildSrc/src/main/groovy/JavaDocUtils.groovy b/buildSrc/src/main/groovy/JavaDocUtils.groovy
new file mode 100644
index 000000000..331cbdaf9
--- /dev/null
+++ b/buildSrc/src/main/groovy/JavaDocUtils.groovy
@@ -0,0 +1,158 @@
+import groovy.transform.CompileDynamic
+
+import java.nio.file.Files
+import java.nio.file.StandardCopyOption
+
+/**
+ * A collection of utilities to aggregate Javadocs
+ */
+@CompileDynamic
+class JavaDocUtils {
+ private static final String DOCS_DIR = 'javadoc'
+ private static final String[] IGNORE_DIRS = [ 'main', 'java', 'groovy', 'html', 'src', 'buildSrc', 'resources' ]
+ private static final String[] RESOURCES = [ 'index.html', 'javadoc-stylesheet.css' ]
+ private static final String MODULE_PLACEHOLDER = '%modules%'
+ private static final String MODULE_FORMAT_FILE = 'module-format.html'
+
+ /**
+ * Aggregates the javadoc of all the root and subprojects into a single directory
+ *
+ * @param output the output directory
+ * @param ignoreDirs the directories (modules) to be ignore
+ */
+ static aggregateJavaDoc(String output, String name, String version, String... ignoreDirs) {
+ def current = new File(System.getProperty('user.dir'))
+ if (current.name == 'buildSrc') current = current.parentFile
+ def outputDir = new File(current, output)
+
+ if (outputDir.exists() && !outputDir.deleteDir())
+ throw new IllegalStateException("Could not delete previous directory ${output}")
+ if (!outputDir.mkdirs()) throw new IllegalStateException("Could not create directory ${output}")
+
+ aggregateJavaDocRec(current, outputDir, ignoreDirs)
+ createModulesPage(name, version, outputDir)
+ }
+
+ /**
+ * Copies the given file.
+ *
+ * @param src the source (copied) file
+ * @param dst the destination (copy) file
+ */
+ static copyDirectory(File src, File dst) {
+ if (src.directory) {
+ def files = src.listFiles()
+ dst.mkdirs()
+ if (files != null)
+ files*.name.each { copyDirectory(new File(src, it), new File(dst, it)) }
+ } else Files.copy(src.toPath(), dst.toPath(), StandardCopyOption.REPLACE_EXISTING)
+ }
+
+ /**
+ * Finds the most common path between the two given files
+ *
+ * @param file1 the first file
+ * @param file2 the second file
+ * @return the common path
+ */
+ static commonPath(File file1, File file2) {
+ def path1 = file1.absolutePath
+ def path2 = file2.absolutePath
+ def result = ''
+
+ for (i in 0..Math.min(path1.length(), path2.length())) {
+ def c1 = path1[i]
+ def c2 = path2[i]
+ if (c1 != c2) break
+ else result += c1
+ }
+
+ return result
+ }
+
+ /**
+ * Gets the given resource.
+ *
+ * @param name the name
+ * @return the resource
+ */
+ static getResource(String name) {
+ while (name.startsWith('/')) name = name.substring(1)
+ def resource = JavaDocUtils.getResourceAsStream(name)
+ if (resource == null) resource = JavaDocUtils.getResourceAsStream("/${name}")
+ if (resource == null) throw new IllegalArgumentException("Could not find resource '${name}'")
+ return resource
+ }
+
+ private static aggregateJavaDocRec(File current, File output, String... ignoreDirs) {
+ if (!current.directory) return
+
+ def files = current.listFiles()
+ if (files == null)
+ throw new IllegalArgumentException("Could not list files of ${current.path}")
+
+ files.findAll { f -> f.directory }
+ .findAll { f -> !IGNORE_DIRS.any { d -> d == f.name } }
+ .findAll { f -> !ignoreDirs.any { d -> d == f.name } }
+ .each { f ->
+ if (f.name == DOCS_DIR) {
+ def dest = getDestinationFromModule(output, f)
+ def out = new File(output, dest)
+ copyDirectory(f, out)
+ } else aggregateJavaDocRec(f, output)
+ }
+ }
+
+ private static createModulesPage(String name, String version, File file) {
+ if (!file.directory) return
+ def files = file.listFiles()
+ if (files == null) return
+ if (files.any { it.name.contains('.html') }) return
+
+ RESOURCES.each { parseResource(file, it, name, version, files) }
+
+ files.each { createModulesPage(it.name, version, it) }
+ }
+
+ private static parseResource(File parentFile, String resource, String name, String version, File[] files) {
+ getResource("${resource}").withReader { reader ->
+ new File(parentFile, resource).withWriter { writer ->
+ String line
+ while ((line = reader.readLine()) != null) {
+ line = line.replace('%module_name%', name)
+ .replace('%module_version%', version)
+ if (line.contains(MODULE_PLACEHOLDER))
+ line = parseModulesPlaceholder(line, files)
+ writer.write(line)
+ writer.write('\n')
+ }
+ }
+ }
+ }
+
+ private static parseModulesPlaceholder(String line, File[] files) {
+ String output = ''
+ files*.name.each { n ->
+ getResource("/${MODULE_FORMAT_FILE}").withReader { r ->
+ String l
+ while ((l = r.readLine()) != null)
+ output += l.replace('%submodule_name%', n)
+ .replace('%submodule_path%', "${n}${File.separator}index.html")
+ }
+ }
+ line.replace(MODULE_PLACEHOLDER, output)
+ }
+
+ private static getDestinationFromModule(File output, File file) {
+ def parent = new File(commonPath(output, file))
+ def module = new File(file, '')
+ while (module.parentFile.parentFile != parent)
+ module = module.parentFile
+ def moduleName = module.name
+
+ def dst = "${module.parentFile.name}"
+ if (moduleName != 'build') dst += "${File.separator}${module.name}"
+ return dst
+ }
+
+}
diff --git a/buildSrc/src/main/resources/index.html b/buildSrc/src/main/resources/index.html
new file mode 100644
index 000000000..7a55e1a92
--- /dev/null
+++ b/buildSrc/src/main/resources/index.html
@@ -0,0 +1,79 @@
+
+
+
+ Overview (%module_name% %module_version% API)
+
+
+
+
+
+
+ - Overview
+ - Package
+ - Class
+ - Tree
+ - Deprecated
+ - Index
+ - Help
+
+
+
+ Submodules
+
+ | Submodule |
+ Description |
+
+
+ %modules%
+
+
+
+
+ - Overview
+ - Package
+ - Class
+ - Tree
+ - Deprecated
+ - Index
+ - Help
+
+
+ | %submodule_name% |
+ |
+
\ No newline at end of file
diff --git a/buildSrc/src/test/java/JavaDocUtilsTest.java b/buildSrc/src/test/java/JavaDocUtilsTest.java
new file mode 100644
index 000000000..bdedd090c
--- /dev/null
+++ b/buildSrc/src/test/java/JavaDocUtilsTest.java
@@ -0,0 +1,67 @@
+import it.fulminazzo.yamlparser.utils.FileUtils;
+import org.junit.jupiter.api.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class JavaDocUtilsTest {
+
+ @Test
+ void testCopy() throws IOException {
+ File parent = new File("build/resources/test");
+ if (parent.exists()) FileUtils.deleteFolder(parent);
+ FileUtils.createFolder(parent);
+ // Setup
+ File dir1 = new File(parent, "dir1");
+ dir1.mkdir();
+ File file1 = new File(dir1, "file1");
+ file1.createNewFile();
+ FileUtils.writeToFile(file1, "Hello");
+ File file2 = new File(dir1, "file2");
+ file2.createNewFile();
+ FileUtils.writeToFile(file2, "World");
+
+ // Copy
+ File dir2 = new File(parent, "dir2");
+ JavaDocUtils.copyDirectory(dir1, dir2);
+
+ // Verify
+ assertTrue(dir2.isDirectory(), String.format("No directory %s", dir2.getAbsolutePath()));
+
+ file1 = new File(dir2, "file1");
+ assertTrue(file1.exists(), String.format("No file %s", file1.getAbsolutePath()));
+ assertEquals("Hello", FileUtils.readFileToString(file1));
+
+ file2 = new File(dir2, "file2");
+ assertTrue(file2.exists(), String.format("No file %s", file2.getAbsolutePath()));
+ assertEquals("World", FileUtils.readFileToString(file2));
+ }
+
+ @Test
+ void testCommonPaths() {
+ String expected = System.getProperty("user.dir") + "/this/path/is/expected/";
+ File path1 = new File(expected, "this/is/not");
+ File path2 = new File(expected, "me/neither");
+
+ Object actual = JavaDocUtils.commonPath(path1, path2);
+ assertEquals(expected, actual);
+ }
+
+ @Test
+ void testGetResource() throws IOException {
+ InputStream stream = (InputStream) JavaDocUtils.getResource("mock.txt");
+ assertNotNull(stream);
+ StringBuilder builder = new StringBuilder();
+ while (stream.available() > 0) builder.append((char) stream.read());
+ assertEquals("Hello world", builder.toString());
+ }
+
+ @Test
+ void testInvalidResource() {
+ assertThrowsExactly(IllegalArgumentException.class, () -> JavaDocUtils.getResource("invalid"));
+ }
+
+}
\ No newline at end of file
diff --git a/buildSrc/src/test/resources/mock.txt b/buildSrc/src/test/resources/mock.txt
new file mode 100644
index 000000000..70c379b63
--- /dev/null
+++ b/buildSrc/src/test/resources/mock.txt
@@ -0,0 +1 @@
+Hello world
\ No newline at end of file