Merge pull request #4 from footaku/exclude-enum-methods

Exclude enum methods

README.md

@@ -19,7 +19,7 @@ plugins {
 
 dependencies {
     ...
-    archUnitExtraLib('io.github.footaku:erai:0.0.3')
+    archUnitExtraLib('io.github.footaku:erai:0.0.4')
     ...
 }
 

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 }
 
 group = "io.github.footaku"
-version = "0.0.3"
+version = "0.0.4"
 
 repositories {
     mavenLocal()
@@ -73,7 +73,7 @@ publishing {
         create<MavenPublication>("mavenJava") {
             groupId = "io.github.footaku"
             artifactId = "erai"
-            version = "0.0.3"
+            version = "0.0.4"
 
             pom {
                 name.set("erai")

src/main/java/io/github/footaku/erai/rule/ShouldBeIndicateReturnValueNullability.java

@@ -28,6 +28,7 @@ public void execute(String packagePath, ScopePathProvider scopePathProvider, Col
             .that(isNotExcludedClass)
             .and(hasReturnValue)
             .and(isReturnBoxingType)
+            .and(isNotEnumBasicMethod)
             .and(isNotGeneratedCode)
             .and(isNotOverrideBasicMethod)
             .should(beAnnotatedWith)
@@ -63,6 +64,20 @@ public boolean test(JavaMethod input) {
             }
         };
 
+    DescribedPredicate<JavaMethod> isNotEnumBasicMethod =
+        new DescribedPredicate<>("is not Enum basic methods") {
+            private final static List<String> BASIC_METHODS = List.of("$values", "values", "valueOf");
+
+            @Override
+            public boolean test(JavaMethod input) {
+                if (!BASIC_METHODS.contains(input.getName())) {
+                    return true;
+                }
+
+                return !input.getOwner().isEnum();
+            }
+        };
+
     DescribedPredicate<JavaMethod> isNotGeneratedCode =
         new DescribedPredicate<>("is not generated code") {
             private final static List<String> GENERATED_ANNOTATION_NAMES = List.of(

src/test/java/com/example/footaku/EnumClass.java

@@ -0,0 +1,24 @@
+package com.example.footaku;
+
+import java.util.Arrays;
+
+public enum EnumClass {
+    NONE(0),
+    ONE(1),
+    TWO(2);
+
+    private final int id;
+
+    EnumClass(int id) {
+        this.id = id;
+    }
+
+    public int id() {
+        return id;
+    }
+
+    @lombok.NonNull
+    public static EnumClass from(int id) {
+        return Arrays.stream(EnumClass.values()).filter(v -> v.id == id).findFirst().orElseThrow();
+    }
+}