Merge pull request #8 from footaku/compatible-with-jdk21

Compatible with jdk21
footaku · Dec 1, 2023 · a83ccfa · a83ccfa
2 parents 74cbc71 + 4ee30ab
commit a83ccfa
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # erai(Extra Rules of Architecture Inspection)
 erai is extra rules for Java inspecting architecture constraint, using ArchUnit.
+- 0.0.x: Compatible with JDK 17
+- 0.1.x: Compatible with JDK 21
 
 ## Implemented
 - Inspect return values have nullability annotation
@@ -13,13 +15,19 @@ build.gradle
 ```groovy
 plugins {
     ...
-    id "com.societegenerale.commons.arch-unit-gradle-plugin" version "3.0.0"
+    // For JDK 17
+    id "com.societegenerale.commons.arch-unit-gradle-plugin" version "3.1.0"
+    // For JDK 21
+    id "com.societegenerale.commons.arch-unit-gradle-plugin" version "4.0.0"
     ...
 }
 
 dependencies {
     ...
+    // For JDK 17
     archUnitExtraLib('io.github.footaku:erai:0.0.7')
+    // For JDK 21
+    archUnitExtraLib('io.github.footaku:erai:0.1.0')
     ...
 }
 

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,16 +4,16 @@ plugins {
 }
 
 group = "io.github.footaku"
-version = "0.0.7"
+version = "0.1.0"
 
 repositories {
     mavenLocal()
     mavenCentral()
 }
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_17
-    targetCompatibility = JavaVersion.VERSION_17
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
 }
 
 sourceSets {
@@ -30,8 +30,8 @@ sourceSets {
 }
 
 dependencies {
-    implementation("com.societegenerale.commons:arch-unit-build-plugin-core:3.1.0")
-    implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.15.2")
+    implementation("com.societegenerale.commons:arch-unit-build-plugin-core:4.0.0")
+    implementation("com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:2.16.0")
 
     testImplementation("jakarta.annotation:jakarta.annotation-api:2.1.1")
     testImplementation("org.springframework:spring-core:6.0.9")
@@ -73,7 +73,7 @@ publishing {
         create<MavenPublication>("mavenJava") {
             groupId = "io.github.footaku"
             artifactId = "erai"
-            version = "0.0.7"
+            version = "0.1.0"
 
             pom {
                 name.set("erai")

diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 networkTimeout=10000
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/src/main/java/io/github/footaku/erai/configuration/Nullability.java b/src/main/java/io/github/footaku/erai/configuration/Nullability.java
@@ -5,6 +5,8 @@
 
 /**
  * Nullability settings.
+ *
+ * @param returnValue return value settings
  */
 public record Nullability(ReturnValue returnValue) {
     private static final List<String> DEFAULT_AVAILABLE_ANNOTATIONS = List.of(
@@ -43,6 +45,11 @@ public List<String> excludeClasses() {
 
     /**
      * Return value settings.
+     *
+     * @param availableAnnotations available annotations for return values
+     *                             (default: {@link #DEFAULT_AVAILABLE_ANNOTATIONS})
+     * @param excludeClasses       excluded classes from inspection
+     *                             (default: empty)
      */
     public record ReturnValue(
         List<String> availableAnnotations,

diff --git a/src/main/java/io/github/footaku/erai/configuration/Setting.java b/src/main/java/io/github/footaku/erai/configuration/Setting.java
@@ -2,6 +2,8 @@
 
 /**
  * Setting for erai.
+ *
+ * @param nullability nullability setting
  */
 public record Setting(Nullability nullability) {
 }
diff --git a/src/main/java/io/github/footaku/erai/rule/ShouldBeIndicateReturnValueNullability.java b/src/main/java/io/github/footaku/erai/rule/ShouldBeIndicateReturnValueNullability.java
@@ -23,6 +23,11 @@ public class ShouldBeIndicateReturnValueNullability implements ArchRuleTest {
     private final List<String> availableAnnotations = Erai.getSetting().nullability().availableAnnotations();
     private final List<String> excludeClasses = Erai.getSetting().nullability().excludeClasses();
 
+    /**
+     * Default Constructor
+     */
+    public ShouldBeIndicateReturnValueNullability() {}
+
     @Override
     public void execute(String packagePath, ScopePathProvider scopePathProvider, Collection<String> excludedPaths) {
         var rule = ArchRuleDefinition.methods()