Update from upstream template

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: gradle
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.github/workflows/gradle-build.yml

@@ -0,0 +1,25 @@
+name: Java CI with Gradle
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        java: [ '11', '17', '21' ]
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 1
+        show-progress: false
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: ${{ matrix.java }}
+    - name: ./gradlew build javadoc
+      run: ./gradlew build

.github/workflows/gradle-wrapper-validation.yml

@@ -0,0 +1,16 @@
+name: "Validate Gradle Wrapper"
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  validation:
+    name: "Validation"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+          show-progress: false
+      - uses: gradle/wrapper-validation-action@v1

.gitignore

@@ -1,12 +1,12 @@
-# Generated files
+# Gradle
 .gradle
 build
 
 # IntelliJ
 .idea
 *.iml
 
-# Emacs backups
+# Emacs
 *~
 
 # checker-qual

.travis.yml

@@ -3,6 +3,16 @@ install: true
 
 jdk:
   - openjdk8
+  - openjdk11
+  - openjdk17
 
 script:
   - ./gradlew build --stacktrace
+
+before_cache:
+  - rm -f  $HOME/.gradle/caches/modules-2/modules-2.lock
+  - rm -fr $HOME/.gradle/caches/*/plugin-resolution/
+cache:
+  directories:
+    - $HOME/.gradle/caches/
+    - $HOME/.gradle/wrapper/

README.md

@@ -1,4 +1,4 @@
-# What is this repository
+# This repository
 
 This repository contains a template for an abstract interpretation implementation
 assignment. You can find the full instructions for the assignment in `INSTRUCTIONS.md`
@@ -7,14 +7,18 @@ in this directory, or on your course webpage.
 The remainder of this README is the user-facing documentation for the analysis
 you will build.
 
-# What is the Divide By Zero Checker
+You should remove, from your version, everything above and including this line.
+
+
+# The Divide By Zero Checker
 
 A common problem when programming is division by zero.
 This results in a run-time exception.
 
-The Divide By Zero Checker should guarantee, at compile time, that your code will
+The Divide By Zero Checker guarantees, at compile time, that your code will
 not suffer that run-time exception.
 
+
 ## How to run the checker
 
 First, publish the checker to your local Maven repository by running
@@ -36,6 +40,27 @@ dependencies {
 Now, when you build your project, the Divide By Zero Checker will also run,
 informing you of any potential errors related to division by zero.
 
+
+## How to specify your code
+
+At compile time, the Divide By Zero Checker estimates what values the program
+may compute at run time.  It issues a warning if the program may
+perform a division by zero.
+It works via a technique called pluggable typechecking.
+
+You need to specify the contracts of methods and fields in your code --
+that is, their requirements and their guarantees.  The Divide By Zero Checker
+ensures that your code is consistent with the contracts, and that the
+contracts guarantee that the program never divides by zero.
+
+You specify your code by writing *qualifiers* such as `@YourQualifierNameHere`
+on types, to indicate more precisely what values the type represents.
+Here is a list of the type qualifiers that are supported by
+the Divide By Zero Checker, with an explanation of each one:
+
+TODO.
+
+
 ## How to build the checker
 
 Run these commands from the top-level directory.

build.gradle

@@ -1,97 +1,116 @@
 plugins {
-    id 'java'
-    id 'maven-publish'
+  id 'java'
+  id 'maven-publish'
 }
 
 repositories {
-    // Use jcenter for resolving your dependencies.
-    // You can declare any Maven/Ivy/file repository here.
-    mavenCentral()
+  // Use Maven Central for resolving your dependencies.
+  // You can declare any Maven/Ivy/file repository here.
+  mavenCentral()
 }
 
 configurations {
-    // for putting Error Prone javac in bootclasspath for running tests
-    errorproneJavac
+  // for putting Error Prone javac in bootclasspath for running tests
+  errorproneJavac
 }
 
 ext.versions = [
-        checkerFramework: "3.21.3",
+  checkerFramework: "3.43.0",
 ]
 
 
 sourceCompatibility = 1.8
 def checkerframework_local = false  // Set this variable to [true] while using local version of checker framework.
 
 dependencies {
-    // This dependency is found on compile classpath of this component and consumers.
-    if (checkerframework_local) {
-        implementation files('${CHECKERFRAMEWORK}/checker/dist/checker-qual.jar')
-        implementation files('${CHECKERFRAMEWORK}/checker/dist/checker.jar')
-    }
-    else {
-        implementation "org.checkerframework:checker:${versions.checkerFramework}"
-        implementation "org.checkerframework:checker-qual:${versions.checkerFramework}"
-    }
+  // This dependency is found on compile classpath of this component and consumers.
+  if (checkerframework_local) {
+    implementation files('${CHECKERFRAMEWORK}/checker/dist/checker-qual.jar')
+    implementation files('${CHECKERFRAMEWORK}/checker/dist/checker.jar')
+  }
+  else {
+    implementation "org.checkerframework:checker:${versions.checkerFramework}"
+    implementation "org.checkerframework:checker-qual:${versions.checkerFramework}"
+  }
 
-    compileOnly "com.google.errorprone:javac:9+181-r4173-1"
+  compileOnly "com.google.errorprone:javac:9+181-r4173-1"
 
-    // Testing
-    testImplementation 'junit:junit:4.13.2'
-    testImplementation "org.checkerframework:framework-test:${versions.checkerFramework}"
+  // Testing
+  testImplementation 'junit:junit:4.13.2'
+  testImplementation "org.checkerframework:framework-test:${versions.checkerFramework}"
 
-    errorproneJavac "com.google.errorprone:javac:9+181-r4173-1"
+  errorproneJavac "com.google.errorprone:javac:9+181-r4173-1"
 }
 
 tasks.withType(JavaCompile).all {
-    options.compilerArgs.add("-Xlint:all")
+  options.compilerArgs.add("-Xlint:all")
 }
 
 // Add `mavenLocal()` in `repositories`, then run `./gradlew publishToMavenLocal`
 // to publish your checker to your local Maven repository.
 publishing {
-    publications {
-        maven(MavenPublication) {
-            groupId = 'org.checkerframework'
-            artifactId = 'dividebyzero-checker'
-            version = '0.1-SNAPSHOT'
-
-            from components.java
-        }
+  publications {
+    maven(MavenPublication) {
+      groupId = 'org.checkerframework'
+      artifactId = 'dividebyzero-checker'
+      version = '0.1-SNAPSHOT'
+
+      from components.java
     }
+  }
 }
 
 test {
-    inputs.files("tests/dividebyzero")
-    if (!JavaVersion.current().java9Compatible) {
-        jvmArgs "-Xbootclasspath/p:${configurations.errorproneJavac.asPath}"
-    } else {
-        // A list of add-export and add-open arguments to be used when running the Checker Framework.
-        // Keep this list in sync with the list in the Checker Framework manual.
-        var compilerArgsForRunningCF = [
-                // These are required in Java 16+ because the --illegal-access option is set to deny
-                // by default.  None of these packages are accessed via reflection, so the module
-                // only needs to be exported, but not opened.
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
-                "--add-exports", "jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
-                // Required because the Checker Framework reflectively accesses private members in com.sun.tools.javac.comp.
-                "--add-opens", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
-        ]
-        jvmArgs += compilerArgsForRunningCF
-    }
-    testLogging {
-        showStandardStreams = true
-        // Show the found unexpected diagnostics and expected diagnostics not found.
-        exceptionFormat "full"
-        events "failed"
-    }
+  inputs.files("tests/dividebyzero")
+  if (!JavaVersion.current().java9Compatible) {
+    jvmArgs "-Xbootclasspath/p:${configurations.errorproneJavac.asPath}"
+  } else {
+    // A list of add-export and add-open arguments to be used when running the Checker Framework.
+    // Keep this list in sync with the list in the Checker Framework manual.
+    var compilerArgsForRunningCF = [
+        // These are required in Java 16+ because the --illegal-access option is set to deny
+        // by default.  None of these packages are accessed via reflection, so the module
+        // only needs to be exported, but not opened.
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
+        "--add-exports", "jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
+        // Required because the Checker Framework reflectively accesses private members in com.sun.tools.javac.comp.
+        "--add-opens", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
+    ]
+    jvmArgs += compilerArgsForRunningCF
+  }
+  testLogging {
+    showStandardStreams = true
+    // Show the found unexpected diagnostics and expected diagnostics not found.
+    exceptionFormat "full"
+    events "failed"
+  }
 }
 
 clean.doFirst {
-    delete "${rootDir}/tests/build/"
+  delete "${rootDir}/tests/build/"
+}
+
+task printClasspath {
+  description 'Prints the runtime classpath of the checker. ' +
+      'When typechecking, put the output of this task on either the ' +
+      'processor path or the classpath of the project being type-checed.'
+  doLast {
+    println sourceSets.main.runtimeClasspath.asPath
+  }
+}
+
+sourceSets {
+  main {
+    resources {
+      // ensures that any .stub files present in the same directory as
+      // the checker source code are copied into the distributed jar
+      srcDirs += ['src/main/java']
+    }
+  }
 }

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -55,7 +55,7 @@
 #       Darwin, MinGW, and NonStop.
 #
 #   (3) This script is generated from the Groovy template
-#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 #       within the Gradle project.
 #
 #       You can find Gradle at https://github.com/gradle/gradle/.
@@ -80,10 +80,10 @@ do
     esac
 done
 
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
@@ -143,12 +143,16 @@ fi
 if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
     case $MAX_FD in  #(
       '' | soft) :;; #(
       *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC3045 
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -205,6 +209,12 @@ set -- \
         org.gradle.wrapper.GradleWrapperMain \
         "$@"
 
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
 # Use "xargs" to parse quoted args.
 #
 # With -n1 it outputs one arg per line, with the quotes and backslashes removed.