Merge pull request #6 from footaku/repair-to-load-setting-file

Repair to load setting file
footaku · Nov 9, 2023 · fb03c2a · fb03c2a
2 parents 3c68474 + 0e9886c
commit fb03c2a
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ plugins {
 
 dependencies {
     ...
-    archUnitExtraLib('io.github.footaku:erai:0.0.5')
+    archUnitExtraLib('io.github.footaku:erai:0.0.6')
     ...
 }
 
@@ -32,7 +32,7 @@ archUnit {
 
 ## Settings
 In The default settings, executes all rules.  
-If you only want to apply certain rules, create 'erai.yaml' in the classpath root.  
+If you only want to apply certain rules, create 'erai.yaml' in the project root.  
 The configuration values are as follows.
 ```yaml
 # Presence of Nullability annotation

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,7 +4,7 @@ plugins {
 }
 
 group = "io.github.footaku"
-version = "0.0.5"
+version = "0.0.6"
 
 repositories {
     mavenLocal()
@@ -73,7 +73,7 @@ publishing {
         create<MavenPublication>("mavenJava") {
             groupId = "io.github.footaku"
             artifactId = "erai"
-            version = "0.0.5"
+            version = "0.0.6"
 
             pom {
                 name.set("erai")

diff --git a/src/main/java/io/github/footaku/erai/Erai.java b/src/main/java/io/github/footaku/erai/Erai.java
@@ -5,6 +5,7 @@
 import io.github.footaku.erai.configuration.Nullability;
 import io.github.footaku.erai.configuration.Setting;
 
+import java.nio.file.Path;
 import java.util.List;
 
 /**
@@ -25,8 +26,9 @@ public static synchronized Setting getSetting() {
         if (setting == null) {
             var mapper = new ObjectMapper(new YAMLFactory());
             try {
-                // TODO fallback erai.yml
-                setting = mapper.readValue(ClassLoader.getSystemResource("erai.yaml"), Setting.class);
+                // TODO fallback another yaml file name
+                var path = Path.of("erai.yaml");
+                setting = mapper.readValue(path.toFile(), Setting.class);
             } catch (Exception e) {
                 // TODO Logger
                 setting = new Setting(

diff --git a/src/main/java/io/github/footaku/erai/configuration/Nullability.java b/src/main/java/io/github/footaku/erai/configuration/Nullability.java
@@ -34,19 +34,19 @@ public List<String> availableAnnotations() {
      *
      * @return enable
      */
-    public List<String> excludedClasses() {
-        if (Objects.isNull(returnValue.excludedClasses) || returnValue.excludedClasses.isEmpty()) {
+    public List<String> excludeClasses() {
+        if (Objects.isNull(returnValue.excludeClasses) || returnValue.excludeClasses.isEmpty()) {
             return List.of();
         }
-        return returnValue.excludedClasses;
+        return returnValue.excludeClasses;
     }
 
     /**
      * Return value settings.
      */
     public record ReturnValue(
         List<String> availableAnnotations,
-        List<String> excludedClasses
+        List<String> excludeClasses
     ) {
     }
 }
diff --git a/src/main/java/io/github/footaku/erai/rule/ShouldBeIndicateReturnValueNullability.java b/src/main/java/io/github/footaku/erai/rule/ShouldBeIndicateReturnValueNullability.java
@@ -21,7 +21,7 @@
 public class ShouldBeIndicateReturnValueNullability implements ArchRuleTest {
 
     private final List<String> availableAnnotations = Erai.getSetting().nullability().availableAnnotations();
-    private final List<String> excludedClasses = Erai.getSetting().nullability().excludedClasses();
+    private final List<String> excludeClasses = Erai.getSetting().nullability().excludeClasses();
 
     @Override
     public void execute(String packagePath, ScopePathProvider scopePathProvider, Collection<String> excludedPaths) {
@@ -43,7 +43,7 @@ public void execute(String packagePath, ScopePathProvider scopePathProvider, Col
         new DescribedPredicate<>("is not excluded classes") {
             @Override
             public boolean test(JavaMethod javaMethod) {
-                return !excludedClasses.contains(javaMethod.getOwner().getName());
+                return !excludeClasses.contains(javaMethod.getOwner().getName());
             }
         };
 

diff --git a/src/test/java/io/github/footaku/erai/ShouldBeIndicateReturnValueNullabilityTest.java b/src/test/java/io/github/footaku/erai/ShouldBeIndicateReturnValueNullabilityTest.java
@@ -22,7 +22,7 @@ public void defaultSettingTestShouldThrowViolations() {
 
         var th = Assertions.catchThrowable(() -> {
             var sut = new ShouldBeIndicateReturnValueNullability();
-            addExcludedClasses(sut);
+            addexcludeClasses(sut);
 
             sut.execute(testTargetPath, new TestScopeProvider(), Collections.emptySet());
         });
@@ -36,7 +36,7 @@ public void specifiedAnnotationTestShouldThrowViolations() {
 
         var th = Assertions.catchThrowable(() -> {
             var sut = new ShouldBeIndicateReturnValueNullability();
-            addExcludedClasses(sut);
+            addexcludeClasses(sut);
             addAvailableAnnotations(sut);
 
             sut.execute(testTargetPath, new TestScopeProvider(), Collections.emptySet());
@@ -45,9 +45,9 @@ public void specifiedAnnotationTestShouldThrowViolations() {
         Assertions.assertThat(th).isInstanceOf(AssertionError.class).hasMessageContaining("was violated (10 times)");
     }
 
-    private void addExcludedClasses(Object sut) {
+    private void addexcludeClasses(Object sut) {
         try {
-            var field = ShouldBeIndicateReturnValueNullability.class.getDeclaredField("excludedClasses");
+            var field = ShouldBeIndicateReturnValueNullability.class.getDeclaredField("excludeClasses");
             field.setAccessible(true);
             field.set(sut, List.of("com.example.footaku.NotInspectionClass"));
         } catch (Exception e) {