Add missing .as methods for clarity

enofex · Oct 20, 2024 · 8af2ad7 · 8af2ad7
1 parent ff57515
commit 8af2ad7
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 11 deletions.
diff --git a/src/main/java/com/enofex/taikai/java/JavaConfigurer.java b/src/main/java/com/enofex/taikai/java/JavaConfigurer.java
@@ -53,7 +53,8 @@ public JavaConfigurer utilityClassesShouldBeFinalAndHavePrivateConstructor(
       Configuration configuration) {
     return addRule(TaikaiRule.of(utilityClasses()
         .should(beFinal())
-        .andShould(havePrivateConstructor()), configuration));
+        .andShould(havePrivateConstructor())
+        .as("Utility classes should be final and have a private constructor"), configuration));
   }
 
   public JavaConfigurer methodsShouldNotDeclareGenericExceptions() {
@@ -147,7 +148,9 @@ public JavaConfigurer noUsageOfDeprecatedAPIs() {
   }
 
   public JavaConfigurer noUsageOfDeprecatedAPIs(Configuration configuration) {
-    return addRule(TaikaiRule.of(classes().should(notUseDeprecatedAPIs()), configuration));
+    return addRule(TaikaiRule.of(classes()
+        .should(notUseDeprecatedAPIs())
+        .as("Classes should not use deprecated APIs"), configuration));
   }
 
   public JavaConfigurer classesShouldResideInPackage(String packageIdentifier) {
@@ -297,7 +300,8 @@ public JavaConfigurer classesShouldImplementHashCodeAndEquals() {
 
   public JavaConfigurer classesShouldImplementHashCodeAndEquals(Configuration configuration) {
     return addRule(TaikaiRule.of(classes()
-        .should(implementHashCodeAndEquals()), configuration));
+        .should(implementHashCodeAndEquals())
+        .as("Classes should implement hashCode and equals"), configuration));
   }
 
   public JavaConfigurer classesShouldBeAssignableTo(String regex, Class<?> clazz) {
@@ -350,7 +354,8 @@ public JavaConfigurer fieldsShouldNotBePublic() {
 
   public JavaConfigurer fieldsShouldNotBePublic(Configuration configuration) {
     return addRule(TaikaiRule.of(fields()
-        .should(notBePublicButNotStatic()), configuration));
+        .should(notBePublicButNotStatic())
+        .as("Fields should not be public unless they are static"), configuration));
   }
 
   public JavaConfigurer fieldsShouldHaveModifiers(String regex,
@@ -420,7 +425,8 @@ public JavaConfigurer noUsageOfSystemOutOrErr() {
 
   public JavaConfigurer noUsageOfSystemOutOrErr(Configuration configuration) {
     return addRule(TaikaiRule.of(classes()
-        .should(notUseSystemOutOrErr()), configuration));
+        .should(notUseSystemOutOrErr())
+        .as("Classes should not use System.out or System.err"), configuration));
   }
 
   public JavaConfigurer finalClassesShouldNotHaveProtectedMembers() {

diff --git a/src/main/java/com/enofex/taikai/logging/LoggingConfigurer.java b/src/main/java/com/enofex/taikai/logging/LoggingConfigurer.java
@@ -36,8 +36,11 @@ public LoggingConfigurer classesShouldUseLogger(Class<?> clazz, String regex,
   public LoggingConfigurer classesShouldUseLogger(String typeName, String regex,
       Configuration configuration) {
     return addRule(TaikaiRule.of(classes()
-        .that().haveNameMatching(regex)
-        .should(haveFieldOfType(typeName)), configuration));
+            .that().haveNameMatching(regex)
+            .should(haveFieldOfType(typeName))
+            .as("Classes with names matching %s should use a logger of type %s".formatted(regex,
+                typeName)),
+        configuration));
   }
 
   public LoggingConfigurer loggersShouldFollowConventions(String typeName, String regex) {
@@ -84,7 +87,10 @@ public LoggingConfigurer loggersShouldFollowConventions(Class<?> clazz, String r
   public LoggingConfigurer loggersShouldFollowConventions(String typeName, String regex,
       Collection<JavaModifier> requiredModifiers, Configuration configuration) {
     return addRule(TaikaiRule.of(classes()
-        .should(followLoggerConventions(typeName, regex, requiredModifiers)), configuration));
+            .should(followLoggerConventions(typeName, regex, requiredModifiers))
+            .as("Loggers in classes matching %s should follow conventions and be of type %s with required modifiers %s".formatted(
+                regex, typeName, requiredModifiers)),
+        configuration));
   }
 
   public static final class Disableable extends LoggingConfigurer implements DisableableConfigurer {

diff --git a/src/main/java/com/enofex/taikai/test/JUnit5Configurer.java b/src/main/java/com/enofex/taikai/test/JUnit5Configurer.java
@@ -95,10 +95,14 @@ public JUnit5Configurer methodsShouldContainAssertionsOrVerifications() {
     return methodsShouldContainAssertionsOrVerifications(CONFIGURATION);
   }
 
-  public JUnit5Configurer methodsShouldContainAssertionsOrVerifications(Configuration configuration) {
+  public JUnit5Configurer methodsShouldContainAssertionsOrVerifications(
+      Configuration configuration) {
     return addRule(TaikaiRule.of(methods()
-        .that(are(annotatedWithTestOrParameterizedTest(true)))
-        .should(containAssertionsOrVerifications()), configuration));
+            .that(are(annotatedWithTestOrParameterizedTest(true)))
+            .should(containAssertionsOrVerifications())
+            .as("Methods annotated with %s or %s should contain assertions or verifications".formatted(
+                ANNOTATION_TEST, ANNOTATION_PARAMETRIZED_TEST)),
+        configuration));
   }
 
   public JUnit5Configurer classesShouldNotBeAnnotatedWithDisabled() {