From 53a3ae43f342a6e402f291940e9aba056cf0b4f6 Mon Sep 17 00:00:00 2001
From: jzitnik-dev <email@jzitnik.dev>
Date: Sun, 16 Mar 2025 20:37:24 +0100
Subject: [PATCH] test(annotations): New @RequireAnnotation

New annotation @RequireAnnotation can be used on annotations so that all
classes with that specific annotation must also have another annotation.
If this is not true, test will not pass. This annotation takes array of
annotations.
---
 .idea/misc.xml                                |  5 ++
 .../game/annotations/BlockDropPercentage.java |  1 +
 .../game/annotations/BreakableByWater.java    |  1 +
 .../game/annotations/BreaksByPlace.java       |  1 +
 .../game/annotations/BreaksFalling.java       |  1 +
 .../jzitnik/game/annotations/CustomDrop.java  |  1 +
 .../cz/jzitnik/game/annotations/Fuel.java     |  1 +
 .../game/annotations/PlaceOnSolid.java        |  1 +
 .../annotations/PlaceOnSolidNoHandler.java    |  1 +
 .../game/annotations/RequireAnnotation.java   |  9 ++
 .../game/annotations/ResetDataOnMine.java     |  1 +
 .../cz/jzitnik/game/annotations/Sapling.java  |  1 +
 .../jzitnik/game/annotations/Smeltable.java   |  1 +
 .../recipes/dyes/MagentaDyeRecipe.java        |  2 +-
 .../game/handlers/place/PlaceHandlerTest.java | 87 ++++++++++---------
 15 files changed, 72 insertions(+), 42 deletions(-)
 create mode 100644 src/main/java/cz/jzitnik/game/annotations/RequireAnnotation.java

diff --git a/.idea/misc.xml b/.idea/misc.xml
index e122dea..b08c9c1 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -1,5 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
+  <component name="EntryPointsManager">
+    <writeAnnotations>
+      <writeAnnotation name="cz.jzitnik.game.annotations.AutoTransient" />
+    </writeAnnotations>
+  </component>
   <component name="ExternalStorageConfigurationManager" enabled="true" />
   <component name="MavenProjectsManager">
     <option name="originalFiles">
diff --git a/src/main/java/cz/jzitnik/game/annotations/BlockDropPercentage.java b/src/main/java/cz/jzitnik/game/annotations/BlockDropPercentage.java
index 71a4a18..bfbc0e5 100644
--- a/src/main/java/cz/jzitnik/game/annotations/BlockDropPercentage.java
+++ b/src/main/java/cz/jzitnik/game/annotations/BlockDropPercentage.java
@@ -7,6 +7,7 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(BlockRegistry.class)
 public @interface BlockDropPercentage {
     int value();
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/BreakableByWater.java b/src/main/java/cz/jzitnik/game/annotations/BreakableByWater.java
index cd25e2e..07587c5 100644
--- a/src/main/java/cz/jzitnik/game/annotations/BreakableByWater.java
+++ b/src/main/java/cz/jzitnik/game/annotations/BreakableByWater.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
+@RequireAnnotation(BlockRegistry.class)
 public @interface BreakableByWater {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/BreaksByPlace.java b/src/main/java/cz/jzitnik/game/annotations/BreaksByPlace.java
index 4699958..6608249 100644
--- a/src/main/java/cz/jzitnik/game/annotations/BreaksByPlace.java
+++ b/src/main/java/cz/jzitnik/game/annotations/BreaksByPlace.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(BlockRegistry.class)
 public @interface BreaksByPlace {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/BreaksFalling.java b/src/main/java/cz/jzitnik/game/annotations/BreaksFalling.java
index 1a627bd..2ad75fb 100644
--- a/src/main/java/cz/jzitnik/game/annotations/BreaksFalling.java
+++ b/src/main/java/cz/jzitnik/game/annotations/BreaksFalling.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(BlockRegistry.class)
 public @interface BreaksFalling {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/CustomDrop.java b/src/main/java/cz/jzitnik/game/annotations/CustomDrop.java
index 57beff2..37c80fb 100644
--- a/src/main/java/cz/jzitnik/game/annotations/CustomDrop.java
+++ b/src/main/java/cz/jzitnik/game/annotations/CustomDrop.java
@@ -5,6 +5,7 @@ import java.lang.annotation.*;
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 @Repeatable(CustomDrops.class)
+@RequireAnnotation(BlockRegistry.class)
 public @interface CustomDrop {
     String tool();
     String drops();
diff --git a/src/main/java/cz/jzitnik/game/annotations/Fuel.java b/src/main/java/cz/jzitnik/game/annotations/Fuel.java
index deb7839..6faf6c4 100644
--- a/src/main/java/cz/jzitnik/game/annotations/Fuel.java
+++ b/src/main/java/cz/jzitnik/game/annotations/Fuel.java
@@ -7,6 +7,7 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(ItemRegistry.class)
 public @interface Fuel {
     double value();
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolid.java b/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolid.java
index 8fe27b8..02b71ea 100644
--- a/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolid.java
+++ b/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolid.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
+@RequireAnnotation(BlockRegistry.class)
 public @interface PlaceOnSolid {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolidNoHandler.java b/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolidNoHandler.java
index cc064c5..6a31f2d 100644
--- a/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolidNoHandler.java
+++ b/src/main/java/cz/jzitnik/game/annotations/PlaceOnSolidNoHandler.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
+@RequireAnnotation(BlockRegistry.class)
 public @interface PlaceOnSolidNoHandler {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/RequireAnnotation.java b/src/main/java/cz/jzitnik/game/annotations/RequireAnnotation.java
new file mode 100644
index 0000000..f4c627b
--- /dev/null
+++ b/src/main/java/cz/jzitnik/game/annotations/RequireAnnotation.java
@@ -0,0 +1,9 @@
+package cz.jzitnik.game.annotations;
+
+import java.lang.annotation.*;
+
+@Target(ElementType.ANNOTATION_TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface RequireAnnotation {
+    Class<? extends Annotation>[] value();
+}
diff --git a/src/main/java/cz/jzitnik/game/annotations/ResetDataOnMine.java b/src/main/java/cz/jzitnik/game/annotations/ResetDataOnMine.java
index 6765d80..6cf4e25 100644
--- a/src/main/java/cz/jzitnik/game/annotations/ResetDataOnMine.java
+++ b/src/main/java/cz/jzitnik/game/annotations/ResetDataOnMine.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
+@RequireAnnotation(BlockRegistry.class)
 public @interface ResetDataOnMine {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/Sapling.java b/src/main/java/cz/jzitnik/game/annotations/Sapling.java
index 0d28a56..4272858 100644
--- a/src/main/java/cz/jzitnik/game/annotations/Sapling.java
+++ b/src/main/java/cz/jzitnik/game/annotations/Sapling.java
@@ -7,5 +7,6 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(BlockRegistry.class)
 public @interface Sapling {
 }
diff --git a/src/main/java/cz/jzitnik/game/annotations/Smeltable.java b/src/main/java/cz/jzitnik/game/annotations/Smeltable.java
index c49828c..0f52dbf 100644
--- a/src/main/java/cz/jzitnik/game/annotations/Smeltable.java
+++ b/src/main/java/cz/jzitnik/game/annotations/Smeltable.java
@@ -7,6 +7,7 @@ import java.lang.annotation.ElementType;
 
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
+@RequireAnnotation(ItemRegistry.class)
 public @interface Smeltable {
     String value();
 }
diff --git a/src/main/java/cz/jzitnik/game/crafting/recipes/dyes/MagentaDyeRecipe.java b/src/main/java/cz/jzitnik/game/crafting/recipes/dyes/MagentaDyeRecipe.java
index 0c05b8d..b244a73 100644
--- a/src/main/java/cz/jzitnik/game/crafting/recipes/dyes/MagentaDyeRecipe.java
+++ b/src/main/java/cz/jzitnik/game/crafting/recipes/dyes/MagentaDyeRecipe.java
@@ -4,7 +4,7 @@ import cz.jzitnik.game.annotations.CraftingRecipeRegistry;
 
 @CraftingRecipeRegistry(
         recipe = {
-                "Allium", "_", "_",
+                "allium", "_", "_",
                 "_", "_", "_",
                 "_", "_", "_"
         },
diff --git a/src/test/java/cz/jzitnik/game/handlers/place/PlaceHandlerTest.java b/src/test/java/cz/jzitnik/game/handlers/place/PlaceHandlerTest.java
index ad3c863..fdd221c 100644
--- a/src/test/java/cz/jzitnik/game/handlers/place/PlaceHandlerTest.java
+++ b/src/test/java/cz/jzitnik/game/handlers/place/PlaceHandlerTest.java
@@ -1,14 +1,12 @@
 package cz.jzitnik.game.handlers.place;
 
-import cz.jzitnik.game.annotations.BlockDropPercentage;
-import cz.jzitnik.game.annotations.BlockRegistry;
-import cz.jzitnik.game.annotations.PlaceOnSolid;
-import cz.jzitnik.game.annotations.ResetDataOnMine;
+import cz.jzitnik.game.annotations.*;
 import cz.jzitnik.game.entities.items.ItemBlockSupplier;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.reflections.Reflections;
 
+import java.lang.annotation.Annotation;
 import java.util.Arrays;
 import java.util.Set;
 
@@ -27,7 +25,6 @@ class PlaceHandlerTest {
         }
     }
 
-
     @Test
     @DisplayName("All blocks in annotation @PlaceHandler must exist")
     void allBlocksMustExist() {
@@ -43,47 +40,55 @@ class PlaceHandlerTest {
         }
     }
 
-    @Test
-    @DisplayName("All blocks annotated with @PlaceOnSolid must be also annotated with @BlockRegistry")
-    void placeOnSolidTest() {
-        Reflections reflections = new Reflections("cz.jzitnik.game.entities.items.registry.blocks");
-        Set<Class<?>> handlerClasses = reflections
-                .getTypesAnnotatedWith(PlaceOnSolid.class);
+    /*@Test
+    @DisplayName("All blocks must be annotated with @BlockRegistry if they are annotated with certain other annotations")
+    void checkAnnotationsWithBlockRegistry() {
+        // Define annotations and their names
+        Object[][] annotationsToCheck = {
+                {PlaceOnSolid.class, "@PlaceOnSolid"},
+                {ResetDataOnMine.class, "@ResetDataOnMine"},
+                {BlockDropPercentage.class, "@BlockDropPercentage"},
+                {BreakableByWater.class, "@BreakableByWater"},
+                {BreaksByPlace.class, "@BreaksByPlace"},
+                {BreaksFalling.class, "@BreaksFalling"},
+                {Fuel.class, "@Fuel"},
+                {Smeltable.class, "@Smeltable"},
+        };
 
-        for (Class<?> clazz : handlerClasses) {
-            boolean hasAnnotation = clazz.isAnnotationPresent(BlockRegistry.class);
-            assertTrue(hasAnnotation, "Class " + clazz.getName() + " is annotated with @PlaceOnSolid but does not have annotation @BlockRegistry");
+        // Loop through each annotation and check for @BlockRegistry
+        for (Object[] annotationData : annotationsToCheck) {
+            Class<?> annotationClass = (Class<?>) annotationData[0];
+            String annotationName = (String) annotationData[1];
+            checkBlockRegistryAnnotationForClassesWithAnnotation(annotationClass, annotationName);
+        }
+    }*/
+
+    @Test
+    void checkAnnotationValidity() {
+        Reflections reflections = new Reflections("cz.jzitnik.game");
+
+        Set<Class<?>> annotations = reflections.getTypesAnnotatedWith(RequireAnnotation.class);
+
+        for (Class<?> annotation : annotations) {
+            if (!annotation.isAnnotation()) {
+                continue;
+            }
+
+            Set<Class<?>> classes = reflections.getTypesAnnotatedWith((Class<? extends Annotation>) annotation);
+            var anot = annotation.getAnnotation(RequireAnnotation.class);
+
+            for (Class<?> clazz : classes) {
+                for (Class<? extends Annotation> annotationRequired : anot.value()) {
+                    if (!clazz.isAnnotationPresent(annotationRequired)) {
+                        fail("All classes annotated with @" + annotation.getSimpleName() + " must be also annotated with @" + annotationRequired.getSimpleName() + " but class " + clazz.getName() + " isn't.");
+                    }
+                }
+            }
         }
     }
 
     @Test
-    @DisplayName("All blocks annotated with @ResetDataOnMine must be also annotated with @BlockRegistry")
-    void resetDataOnMineTest() {
-        Reflections reflections = new Reflections("cz.jzitnik.game.entities.items.registry.blocks");
-        Set<Class<?>> handlerClasses = reflections
-                .getTypesAnnotatedWith(ResetDataOnMine.class);
-
-        for (Class<?> clazz : handlerClasses) {
-            boolean hasAnnotation = clazz.isAnnotationPresent(BlockRegistry.class);
-            assertTrue(hasAnnotation, "Class " + clazz.getName() + " is annotated with @ResetDataOnMine but does not have annotation @BlockRegistry");
-        }
-    }
-
-    @Test
-    @DisplayName("All blocks annotated with @BlockDropPercentage must be also annotated with @BlockRegistry")
-    void blockDropPercentageTest() {
-        Reflections reflections = new Reflections("cz.jzitnik.game.entities.items.registry.blocks");
-        Set<Class<?>> handlerClasses = reflections
-                .getTypesAnnotatedWith(BlockDropPercentage.class);
-
-        for (Class<?> clazz : handlerClasses) {
-            boolean hasAnnotation = clazz.isAnnotationPresent(BlockRegistry.class);
-            assertTrue(hasAnnotation, "Class " + clazz.getName() + " is annotated with @BlockDropPercentage but does not have annotation @BlockRegistry");
-        }
-    }
-
-    @Test
-    @DisplayName("All blocks annotated with @ResetDataOnMine must have data class with default constructor")
+    @DisplayName("All blocks annotated with @ResetDataOnMine must have data class.")
     void dataOnMineHasDataTest() {
         Reflections reflections = new Reflections("cz.jzitnik.game.entities.items.registry.blocks");
         Set<Class<?>> handlerClasses = reflections