Merge pull request #19 from briancorbinxyz/feature/packaging

Feature/packaging

Author: briancorbinxyz

.vscode/launch.json

@@ -14,35 +14,35 @@
             "type": "java",
             "name": "SecureConnectionTest$Server",
             "request": "launch",
-            "mainClass": "org.example.SecureConnectionTest$Server",
+            "mainClass": "org.xxdc.oss.example.SecureConnectionTest$Server",
             "projectName": "app"
         },
         {
             "type": "java",
             "name": "SecureConnectionTest$Client",
             "request": "launch",
-            "mainClass": "org.example.SecureConnectionTest$Client",
+            "mainClass": "org.xxdc.oss.example.SecureConnectionTest$Client",
             "projectName": "app"
         },
         {
             "type": "java",
             "name": "SecureConnection$Client",
             "request": "launch",
-            "mainClass": "org.example.SecureConnection$Client",
+            "mainClass": "org.xxdc.oss.example.SecureConnection$Client",
             "projectName": "app"
         },
         {
             "type": "java",
             "name": "SecureConnection$Server",
             "request": "launch",
-            "mainClass": "org.example.SecureConnection$Server",
+            "mainClass": "org.xxdc.oss.example.SecureConnection$Server",
             "projectName": "app"
         },
         {
             "type": "java",
             "name": "SecureConnection",
             "request": "launch",
-            "mainClass": "org.example.SecureConnection",
+            "mainClass": "org.xxdc.oss.example.SecureConnection",
             "projectName": "app"
         },
         {
@@ -82,7 +82,7 @@
             "type": "java",
             "name": "App",
             "request": "launch",
-            "mainClass": "org.example.App",
+            "mainClass": "org.xxdc.oss.example.App",
             "projectName": "app",
             "env": {
                 "LIB_PATH": "${workspaceFolder}/app/build/cargo/debug",
@@ -95,7 +95,7 @@
             "type": "java",
             "name": "GameClient",
             "request": "launch",
-            "mainClass": "org.example.GameClient",
+            "mainClass": "org.xxdc.oss.example.GameClient",
             "projectName": "app",
             "env": {
                 "LIB_PATH": "${workspaceFolder}/app/build/cargo/debug",
@@ -109,7 +109,7 @@
             "name": "GameClient (on ZGC)",
             "request": "launch",
             "vmArgs": "-XX:+UseZGC",
-            "mainClass": "org.example.GameClient",
+            "mainClass": "org.xxdc.oss.example.GameClient",
             "projectName": "app",
             "env": {
                 "LIB_PATH": "${workspaceFolder}/app/build/cargo/debug",
@@ -122,7 +122,7 @@
             "type": "java",
             "name": "GameServer",
             "request": "launch",
-            "mainClass": "org.example.GameServer",
+            "mainClass": "org.xxdc.oss.example.GameServer",
             "projectName": "app",
             "env": {
                 "LIB_PATH": "${workspaceFolder}/app/build/cargo/debug",
@@ -136,7 +136,7 @@
             "name": "GameServer (on ZGC)",
             "request": "launch",
             "vmArgs": "-XX:+UseZGC",
-            "mainClass": "org.example.GameServer",
+            "mainClass": "org.xxdc.oss.example.GameServer",
             "projectName": "app",
             "env": {
                 "LIB_PATH": "${workspaceFolder}/app/build/cargo/debug",

.vscode/settings.json

@@ -29,4 +29,5 @@
         "org"
     ],
     "java.configuration.updateBuildConfiguration": "automatic",
+    "java.dependency.packagePresentation": "hierarchical",
 }

README.md

@@ -57,11 +57,18 @@ https://openjdk.org/projects/jdk/17/
 
 ### Algorithms
 
-The following algorithms are used by the AI BOT in this project:
+The following algorithms are used by the AI BOT in this project (For a detailed discussion see [Road to JDK 25 - An Algorithmic Interlude](https://briancorbinxyz.medium.com/over-engineering-tic-tac-toe-an-algorithmic-interlude-8af3aa13173a):
 
 - [Random](https://en.wikipedia.org/wiki/Randomness) See: [Random.java](app/src/main/java/org/example/bot/Random.java)
 - [Minimax](https://en.wikipedia.org/wiki/Minimax) See: [Minimax.java](app/src/main/java/org/example/bot/Minimax.java)
-- [Alpha-Beta](https://en.wikipedia.org/wiki/Alpha-beta_pruning) See: [AlphaBeta.java](app/src/main/java/org/example/bot/AlphaBeta.java)
+- [Minimax w. Alpha-Beta](https://en.wikipedia.org/wiki/Alpha-beta_pruning) See: [AlphaBeta.java](app/src/main/java/org/example/bot/AlphaBeta.java)
 - [MaxN](https://en.wikipedia.org/wiki/Maxn_algorithm) See: [MaxN.java](app/src/main/java/org/example/bot/MaxN.java)
 - [Paranoid](https://en.wikipedia.org/wiki/Paranoid_AI) See: [Paranoid.java](app/src/main/java/org/example/bot/Paranoid.java)
-- [Monte Carlo](https://en.wikipedia.org/wiki/Monte_Carlo_method) See [MonteCarlo.java](app/src/main/java/org/example/bot/MonteCarloTreeSearch.java)
+- [Monte Carlo Tree Search](https://en.wikipedia.org/wiki/Monte_Carlo_method) See [MonteCarloTreeSearch.java](app/src/main/java/org/example/bot/MonteCarloTreeSearch.java)
+
+
+---
+
+### Quick Start
+
+- To run the single game application, use the following command: `./gradlew run`

app/build.gradle.kts

@@ -5,6 +5,7 @@ plugins {
     application
     id("org.graalvm.buildtools.native") version "0.10.2"
     id("com.diffplug.spotless") version "7.0.0.BETA1"
+    `maven-publish`
 }
 
 repositories {
@@ -13,6 +14,8 @@ repositories {
     gradlePluginPortal()
 }
 
+val jdkVersion = "22"
+
 // JDK22: Foreign Function Interface (FFI)
 // Support building native Rust library using Cargo:
 // https://doc.rust-lang.org/cargo/getting-started/installation.html
@@ -103,7 +106,7 @@ dependencies {
 tasks.register<JavaExec>("jmh") {
     mainClass.set("org.openjdk.jmh.Main")
     classpath = sourceSets["main"].runtimeClasspath
-    args = listOf("org.example.interop.benchmark.PlayerIdsBenchmark")
+    args = listOf("org.xxdc.oss.example.interop.benchmark.PlayerIdsBenchmark")
 }
 
 testing {
@@ -119,8 +122,10 @@ testing {
 // Apply a specific Java toolchain to ease working on different environments.
 java {
     toolchain {
-        languageVersion = JavaLanguageVersion.of(23)
+        languageVersion = JavaLanguageVersion.of(jdkVersion)
     }
+    withJavadocJar()
+    withSourcesJar()
 }
 
 // Code formatting (./gradlew spotlessApply)
@@ -138,7 +143,7 @@ graalvmNative {
             javaLauncher = javaToolchains.launcherFor {
                 // NB: On MacOS ARM ARCH the native-image implementation is not available
                 // for the versions of GRAAL_VM Community edition - selecting Oracle
-                languageVersion = JavaLanguageVersion.of(23)
+                languageVersion = JavaLanguageVersion.of(jdkVersion)
                 vendor = JvmVendorSpec.matching("Oracle")
                 // languageVersion = JavaLanguageVersion.of(17)
                 // vendor = JvmVendorSpec.GRAAL_VM
@@ -149,11 +154,11 @@ graalvmNative {
 
 application {
     // Define the main class for the application.
-    mainClass = "org.example.App"
+    mainClass = "org.xxdc.oss.example.App"
     // JDK22: Foreign Function Interface (FFI)
     // Resolves Warning:
     // WARNING: A restricted method in java.lang.foreign.SymbolLookup has been called
-    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.example.GameBoardNativeImpl in an unnamed module
+    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.xxdc.oss.example.GameBoardNativeImpl in an unnamed module
     // WARNING: Use --enable-native-access=ALL-UNNAMED to avoid a warning for callers in this module
     // WARNING: Restricted methods will be blocked in a future release unless native access is enabled
     applicationDefaultJvmArgs = listOf("--enable-native-access=ALL-UNNAMED", "-XX:+UseZGC")
@@ -164,6 +169,53 @@ tasks.run.configure {
     standardInput = System.`in`
 }
 
+// https://docs.gradle.org/current/userguide/publishing_maven.html
+publishing {
+    repositories {
+        // Publish to GitHub Packages
+        // https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-java-packages-with-gradle
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/briancorbinxyz/overengineering-tictactoe")
+            credentials {
+                username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
+                password = project.findProperty("gpr.key") as String? ?: System.getenv("GITHUB_TOKEN")
+            }
+        }
+    }
+    publications {
+        create<MavenPublication>("maven") {
+            groupId = "org.xxdc.oss.example"
+            artifactId = "tictactoe"
+            version = "1.0.0-jdk$jdkVersion"
+            from(components["java"])
+            pom {
+                name.set("tictactoe")
+                description.set("An Over-Engineered Tic Tac Toe game")
+                url.set("https://github.com/briancorbinxyz/overengineering-tictactoe")
+                licenses {
+                    license {
+                        name.set("MIT License")
+                        url.set("https://opensource.org/licenses/MIT")
+                    }
+                    developers {
+                        developer {
+                            id.set("briancorbinxyz")
+                            name.set("Brian Corbin")
+                            email.set("mail@briancorbin.xyz")
+                        }
+                    }
+                }
+                scm {
+                    connection.set("scm:git:git://github.com/briancorbinxyz/overengineering-tictactoe.git")
+                    developerConnection.set("scm:git:ssh://github.com/briancorbinxyz/overengineering-tictactoe.git")
+                    url.set("https://github.com/briancorbinxyz/overengineering-tictactoe")
+                }
+            }
+        }
+    }
+}
+
 tasks.withType<Test>().all {
     systemProperty(
         "java.library.path", libPath 
@@ -172,7 +224,7 @@ tasks.withType<Test>().all {
     // JDK22: Foreign Function Interface (FFI)
     // Resolves Warning:
     // WARNING: A restricted method in java.lang.foreign.SymbolLookup has been called
-    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.example.GameBoardNativeImpl in an unnamed module
+    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.xxdc.oss.example.GameBoardNativeImpl in an unnamed module
     // WARNING: Use --enable-native-access=ALL-UNNAMED to avoid a warning for callers in this module
     // WARNING: Restricted methods will be blocked in a future release unless native access is enabled
     jvmArgs = listOf("--enable-native-access=ALL-UNNAMED", "-XX:+UseZGC")
@@ -189,7 +241,7 @@ tasks.named<JavaExec>("run") {
     // JDK22: Foreign Function Interface (FFI)
     // Resolves Warning:
     // WARNING: A restricted method in java.lang.foreign.SymbolLookup has been called
-    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.example.GameBoardNativeImpl in an unnamed module
+    // WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.xxdc.oss.example.GameBoardNativeImpl in an unnamed module
     // WARNING: Use --enable-native-access=ALL-UNNAMED to avoid a warning for callers in this module
     // WARNING: Restricted methods will be blocked in a future release unless native access is enabled
     jvmArgs = listOf("--enable-native-access=ALL-UNNAMED", "-XX:+UseZGC")

app/src/main/java/org/example/App.java renamed to app/src/main/java/org/xxdc/oss/example/App.java

@@ -1,13 +1,13 @@
 /*
  * This source file was generated by the Gradle 'init' task
  */
-package org.example;
+package org.xxdc.oss.example;
 
 import java.io.File;
 import java.lang.System.Logger;
 import java.lang.System.Logger.Level;
-import org.example.bot.BotStrategy;
-import org.example.bot.BotStrategyConfig;
+import org.xxdc.oss.example.bot.BotStrategy;
+import org.xxdc.oss.example.bot.BotStrategyConfig;
 
 /** A simple java tic-tac-toe game. */
 public class App {

app/src/main/java/org/example/BotPlayer.java renamed to app/src/main/java/org/xxdc/oss/example/BotPlayer.java

@@ -1,8 +1,8 @@
-package org.example;
+package org.xxdc.oss.example;
 
 import java.io.Serializable;
 import java.util.function.ToIntFunction;
-import org.example.bot.BotStrategy;
+import org.xxdc.oss.example.bot.BotStrategy;
 
 /**
  * Represents a bot player in the game. The bot player uses a random number generator to make moves

app/src/main/java/org/example/Game.java renamed to app/src/main/java/org/xxdc/oss/example/Game.java

@@ -1,4 +1,4 @@
-package org.example;
+package org.xxdc.oss.example;
 
 import java.io.File;
 import java.io.IOException;

app/src/main/java/org/example/GameBoard.java renamed to app/src/main/java/org/xxdc/oss/example/GameBoard.java

@@ -1,4 +1,4 @@
-package org.example;
+package org.xxdc.oss.example;
 
 import java.util.ArrayList;
 import java.util.List;

app/src/main/java/org/example/GameBoardDefaultImpl.java renamed to app/src/main/java/org/xxdc/oss/example/GameBoardDefaultImpl.java

@@ -1,4 +1,4 @@
-package org.example;
+package org.xxdc.oss.example;
 
 import java.io.Serializable;
 import java.util.Arrays;

app/src/main/java/org/example/GameBoardNativeImpl.java renamed to app/src/main/java/org/xxdc/oss/example/GameBoardNativeImpl.java

@@ -1,8 +1,8 @@
-package org.example;
+package org.xxdc.oss.example;
 
 import java.lang.System.Logger;
 import java.lang.invoke.MethodHandles;
-import org.example.interop.TicTacToeLibrary;
+import org.xxdc.oss.example.interop.TicTacToeLibrary;
 
 /**
  * Implements the GameBoard interface using a native library. This class manages the lifetime of the