Merge branch 'dev' of https://github.com/Bram-Hub/LEGUP into sudoku

.github/workflows/gradle.yml

@@ -8,30 +8,82 @@ on:
   pull_request:
 
 jobs:
-  build:
+  build-ubuntu:
 
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 21
+          distribution: temurin
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
       - name: Build with Gradle
         run: ./gradlew build -x test
+      - name: JPackage
+        run: ./gradlew copyInstaller
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Ubuntu-Artifact
+          path: installer
+
+  build-windows:
+
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+          distribution: temurin
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+      - name: JPackage
+        run: ./gradlew copyInstaller
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Windows-Artifact
+          path: installer
+
+  build-macos:
+
+    runs-on: macos-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+          distribution: temurin
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+      - name: JPackage
+        run: ./gradlew copyInstaller
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Mac Artifact
+          path: installer
 
   checkstyle:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 21
+          distribution: temurin
       - name: gradlew executable
         run: chmod +x gradlew
       - name: Run checkstyle

.github/workflows/java-autoformat.yml

@@ -0,0 +1,93 @@
+name: Java Code Auto Format
+on: pull_request
+
+jobs:
+  format_dev:
+    if: |
+      github.event.pull_request.head.ref == 'dev' && 
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Run spotless
+        run: ./gradlew :spotlessApply
+
+      - name: Check for modified files
+        id: git-check
+        run: echo "modified=$(if [[ -n $(git status -s) ]]; then echo "true"; else echo "false"; fi)" >> $GITHUB_OUTPUT
+
+      - name: Create temporary branch and pull request
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          git config --global user.name 'Bram van Heuveln'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          branch_name="auto-format-code-$(date +%s)"
+          git checkout -b $branch_name
+          ./gradlew :spotlessApply
+          git add .
+          git commit -am "Automated Java code formatting changes"
+          git push --set-upstream origin $branch_name
+          gh pr create -B dev -H $branch_name --title 'Automated Java code formatting changes' --body 'This pull request contains automated code formatting changes.' --reviewer ${{ github.actor }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Must approve auto-format pull request
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          echo "Please review and approve the appropriate auto-format-code pull request."
+          exit 1
+
+  format_pull_request_to_dev:
+    if: |
+      github.event.pull_request.base.ref == 'dev' && 
+      github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v1
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Set up JDK 21
+        uses: actions/setup-java@v1
+        with:
+          java-version: 21
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Build with Gradle
+        run: ./gradlew build -x test
+
+      - name: Run spotless
+        run: ./gradlew :spotlessApply
+
+      - name: Check for modified files
+        id: git-check
+        run: echo "modified=$(if [[ -n $(git status -s) ]]; then echo "true"; else echo "false"; fi)" >> $GITHUB_OUTPUT
+
+      - name: Push changes
+        if: steps.git-check.outputs.modified == 'true'
+        run: |
+          git config --global user.name 'Bram van Heuveln'
+          git config --global user.email '[email protected]'
+          git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
+          git add .
+          git commit -am "Automated Java code formatting changes"
+          git push

.github/workflows/publish-javadoc.yml

@@ -18,6 +18,7 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           javadoc-branch: javadoc
-          java-version: 11
+          java-version: 21
+          distribution: temurin
           target-folder: docs
           project: gradle

.github/workflows/run-tests.yml

@@ -18,10 +18,11 @@ jobs:
       - name: Check Out Code
         uses: actions/checkout@v2
 
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 21
+          distribution: temurin
 
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
@@ -40,10 +41,11 @@ jobs:
       - name: Check Out Code
         uses: actions/checkout@v2
 
-      - name: Set up JDK 11
+      - name: Set up JDK 21
         uses: actions/setup-java@v1
         with:
-          java-version: 11
+          java-version: 21
+          distribution: temurin
 
       - name: Grant execute permission for gradlew
         run: chmod +x gradlew
@@ -65,8 +67,8 @@ jobs:
       - name: Set up JDK and Gradle on Windows
         uses: actions/setup-java@v2
         with:
-          java-version: 11
-          distribution: 'adopt'
+          java-version: 21
+          distribution: temurin
 
       - name: Run JUnit Tests on Windows
         run: |

bin/main/edu/rpi/legup/legup/config

@@ -38,6 +38,6 @@
 	    <puzzle name="Skyscrapers"
 	        qualifiedClassName="edu.rpi.legup.puzzle.skyscrapers.Skyscrapers"
 	        fileType=".xml"
-	        fileCreationDisabled="true"/>
+	        fileCreationDisabled="false"/>
     </puzzles>
 </Legup>

build.gradle

@@ -2,16 +2,50 @@ plugins {
     id 'java'
     id 'edu.sc.seis.launch4j' version '2.5.3'
     id 'kr.motd.sphinx' version '2.10.0'
+    id 'com.diffplug.spotless' version '6.25.0'
 }
 
-version '2.0.0'
+version '6.0.0'
 
 apply plugin: 'java'
 apply plugin: 'application'
+
+spotless {
+    enforceCheck false
+
+    format 'misc', {
+        // define the files to apply `misc` to
+        target '*.gradle', '*.md', '.gitignore'
+
+        // define the steps to apply to those files
+        trimTrailingWhitespace()
+        indentWithSpaces() // or spaces. Takes an integer argument if you don't like 4
+        endWithNewline()
+    }
+
+    java {
+        // Use the default importOrder configuration
+        importOrder()
+
+        // Cleanthat will refactor your code, but it may break your style: apply it before your formatter
+        cleanthat()
+
+        googleJavaFormat('1.19.2').aosp()
+
+        formatAnnotations()
+    }
+}
+
 apply plugin: 'checkstyle'
-mainClassName = 'edu.rpi.legup.Legup'
 
-sourceCompatibility = 11
+application {
+    mainClass.set('edu.rpi.legup.Legup')
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
+}
 
 dependencies {
     implementation 'org.jetbrains:annotations:20.1.0'
@@ -70,42 +104,37 @@ jar {
     archiveFileName = 'Legup.jar'
 }
 
-/*
- * CREATES NATIVE WINDOWS EXECUTABLE
- * Launches launch4j to create an executable (.exe) file wrapping the jar
- * THIS IS NOT THE INSTALLER
- * Add "icon = 'path/to/icon.ico'" to set an icon for the executable
- */
-createExe() {
-    mainClassName = 'edu.rpi.legup.Legup'
-    outputDir = '../native/windows'
-    outfile = 'bin/Legup.exe'
-    bundledJrePath = 'jre'
-    bundledJre64Bit = true
-    jdkPreference = 'preferJre'
-    jreMinVersion = '11'
-    jreRuntimeBits = '64/32'
+repositories {
+    mavenCentral()
 }
 
-/*
- * CREATES NATIVE WINDOWS INSTALLER -- ONLY RUNS ON WINDOWS
- * Runs the shipped version of Inno Setup (6.2) to compile the installer
- * Modify the setup settings in native/windows/legup_inno_setup.iss
- *
- * Modifications are likely required to run the setup script on your computer:
- * Edit the "CHANGE ME" line in native/windows/legup_inno_setup.iss to reflect
- * the path to the Java installation you want to ship inside the executable.
- */
-task buildNativeWindows(type: Exec, dependsOn: 'createExe') {
-    jar
-    createExe
-
-    workingDir = "${buildDir}/../native/windows"
-    commandLine 'cmd', '/c', 'make_windows_installer.bat'
+tasks.register("jpackage") {
+    group("jpackage")
+    doLast {
+        var operatingSystem = System.getProperty("os.name").toLowerCase()
+        if (operatingSystem.contains("windows")) {
+            exec {
+                commandLine 'cmd', '/c', 'jpackage', '--input', 'build/libs', '--main-jar', 'Legup.jar', '--win-dir-chooser', '--win-shortcut-prompt', '--win-shortcut', '--dest', 'build/installer', '-n', "LEGUP", '--app-version', "${project.version}", '--icon', "src/main/resources/edu/rpi/legup/images/Legup/logo.ico"
+            }
+        } else if (operatingSystem.contains("linux")) {
+            exec {
+                commandLine 'sh', '-c', "jpackage --input build/libs --main-jar Legup.jar --dest build/installer -n LEGUP --icon src/main/resources/edu/rpi/legup/images/Legup/logo.ico --app-version ${project.version}"
+            }
+        } else if (operatingSystem.contains("mac")) {
+            exec {
+                commandLine 'bash', '-c', "jpackage --input build/libs --main-jar Legup.jar --dest build/installer -n \"LEGUP\" --icon src/main/resources/edu/rpi/legup/images/Legup/logo.ico --app-version ${project.version}"
+            }
+        } else {
+            println("JPackage task is not set up for " + System.getProperty("os.name"))
+        }
+    }
 }
 
-
-repositories {
-    mavenCentral()
+tasks.register('copyInstaller', Sync) {
+    group("jpackage")
+    from ("build/installer/")
+    into("installer")
+    rename("LEGUP-${project.version}", "LEGUP-installer-${project.version}")
 }
-targetCompatibility = JavaVersion.VERSION_11
+
+copyInstaller.dependsOn(jpackage)

config/checkstyle/checkstyle.xml

@@ -7,12 +7,6 @@
 <module name="Checker">
     <module name="TreeWalker">
         <property name="tabWidth" value="4"/>
-        <module name="LeftCurly"/>
-        <module name="RightCurly">
-            <property name="option" value="alone"/>
-            <property name="tokens"
-                      value="LITERAL_IF, LITERAL_ELSE, LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_WHILE, LITERAL_DO, LITERAL_FOR, METHOD_DEF"/>
-        </module>
         <module name="NeedBraces">
             <property name="allowSingleLineStatement" value="true"/>
         </module>

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
+zipStorePath=wrapper/dists