added METHOD and ANNOTATION_TYPE to properties annotation targets (#314)

rashtao · web-flow · commit 01aa8fbbb090 · 2024-08-19T10:52:21.000+02:00
diff --git a/src/main/java/com/arangodb/springframework/annotation/ArangoComputedValue.java b/src/main/java/com/arangodb/springframework/annotation/ArangoComputedValue.java
@@ -42,7 +42,7 @@
  * @see <a href="https://docs.arangodb.com/stable/concepts/data-structure/documents/computed-values">Reference Doc</a>
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ElementType.FIELD})
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface ArangoComputedValue {
 
     @AliasFor("expression")
diff --git a/src/main/java/com/arangodb/springframework/annotation/ArangoId.java b/src/main/java/com/arangodb/springframework/annotation/ArangoId.java
@@ -34,7 +34,7 @@
  * @author Mark Vollmary
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @ReadOnlyProperty
 public @interface ArangoId {
 
diff --git a/src/main/java/com/arangodb/springframework/annotation/Field.java b/src/main/java/com/arangodb/springframework/annotation/Field.java
@@ -32,12 +32,12 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface Field {
 
-	/**
-	 * The field-name to be used to store the field inside the document.
-	 */
-	String value() default "";
+    /**
+     * The field-name to be used to store the field inside the document.
+     */
+    String value() default "";
 
 }
diff --git a/src/main/java/com/arangodb/springframework/annotation/From.java b/src/main/java/com/arangodb/springframework/annotation/From.java
@@ -33,7 +33,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface From {
 
 	/**
diff --git a/src/main/java/com/arangodb/springframework/annotation/FulltextIndexed.java b/src/main/java/com/arangodb/springframework/annotation/FulltextIndexed.java
@@ -33,7 +33,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @Deprecated
 public @interface FulltextIndexed {
 
diff --git a/src/main/java/com/arangodb/springframework/annotation/GeoIndexed.java b/src/main/java/com/arangodb/springframework/annotation/GeoIndexed.java
@@ -32,7 +32,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface GeoIndexed {
 
 	/**
diff --git a/src/main/java/com/arangodb/springframework/annotation/PersistentIndexed.java b/src/main/java/com/arangodb/springframework/annotation/PersistentIndexed.java
@@ -32,7 +32,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface PersistentIndexed {
 
 	/**
diff --git a/src/main/java/com/arangodb/springframework/annotation/Ref.java b/src/main/java/com/arangodb/springframework/annotation/Ref.java
@@ -36,7 +36,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @Reference
 public @interface Ref {
 
diff --git a/src/main/java/com/arangodb/springframework/annotation/Relations.java b/src/main/java/com/arangodb/springframework/annotation/Relations.java
@@ -30,7 +30,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface Relations {
 
 	public enum Direction {
diff --git a/src/main/java/com/arangodb/springframework/annotation/Rev.java b/src/main/java/com/arangodb/springframework/annotation/Rev.java
@@ -33,7 +33,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface Rev {
 
 }
diff --git a/src/main/java/com/arangodb/springframework/annotation/To.java b/src/main/java/com/arangodb/springframework/annotation/To.java
@@ -33,7 +33,7 @@
  *
  */
 @Retention(RetentionPolicy.RUNTIME)
-@Target({ ElementType.FIELD })
+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 public @interface To {
 
 	/**
diff --git a/src/test/java/com/arangodb/springframework/core/mapping/GeneralMappingTest.java b/src/test/java/com/arangodb/springframework/core/mapping/GeneralMappingTest.java
@@ -23,7 +23,6 @@
 import com.arangodb.entity.DocumentEntity;
 import com.arangodb.model.AqlQueryOptions;
 import com.arangodb.springframework.AbstractArangoTest;
-import com.arangodb.springframework.ArangoTestConfiguration;
 import com.arangodb.springframework.AuditorProvider;
 import com.arangodb.springframework.annotation.*;
 import com.arangodb.springframework.core.convert.ArangoConverter;
@@ -42,10 +41,15 @@
 import org.junit.jupiter.api.Test;
 import org.skyscreamer.jsonassert.JSONAssert;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.core.annotation.AliasFor;
 import org.springframework.data.annotation.*;
 import org.springframework.data.geo.Point;
 import org.springframework.data.geo.Polygon;
 
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 import java.math.BigDecimal;
 import java.math.BigInteger;
 import java.sql.Timestamp;
@@ -86,23 +90,114 @@ public void supplementKey() {
         assertThat(result.get(0).getRev(), is(nullValue()));
     }
 
-    public static class FieldNameTestEntity extends BasicTestEntity {
+    public static class FieldNameTestEntityOnField extends BasicTestEntity {
         @Field("alt-test")
         private String test;
     }
 
     @Test
-    public void fieldNameAnnotation() {
-        final FieldNameTestEntity entity = new FieldNameTestEntity();
+    public void fieldNameAnnotationOnField() {
+        final FieldNameTestEntityOnField entity = new FieldNameTestEntityOnField();
         entity.test = "1234";
         final DocumentEntity res = template.insert(entity);
         String colName = res.getId().split("/")[0];
-        final ObjectNode slice = db
+        final FieldNameTestEntityOnField read = db
                 .collection(colName)
-                .getDocument(res.getKey(), ObjectNode.class);
-        assertThat(slice, is(notNullValue()));
-        assertThat(slice.get("alt-test").isTextual(), is(true));
-        assertThat(slice.get("alt-test").textValue(), is(entity.test));
+                .getDocument(res.getKey(), FieldNameTestEntityOnField.class);
+        assertThat(read, is(notNullValue()));
+        assertThat(read.test, is("1234"));
+    }
+
+    public static class FieldNameTestEntityOnGetter extends BasicTestEntity {
+        private String test;
+
+        @Field("alt-test")
+        public String getTest() {
+            return test;
+        }
+    }
+
+    @Test
+    public void fieldNameAnnotationOnGetter() {
+        final FieldNameTestEntityOnGetter entity = new FieldNameTestEntityOnGetter();
+        entity.test = "1234";
+        final DocumentEntity res = template.insert(entity);
+        String colName = res.getId().split("/")[0];
+        final FieldNameTestEntityOnGetter read = db
+                .collection(colName)
+                .getDocument(res.getKey(), FieldNameTestEntityOnGetter.class);
+        assertThat(read, is(notNullValue()));
+        assertThat(read.getTest(), is("1234"));
+    }
+
+    public static class FieldNameTestEntityOnSetter extends BasicTestEntity {
+        private String test;
+
+        @Field("alt-test")
+        public void setTest(String test) {
+            this.test = test;
+        }
+    }
+
+    @Test
+    public void fieldNameAnnotationOnSetter() {
+        final FieldNameTestEntityOnSetter entity = new FieldNameTestEntityOnSetter();
+        entity.setTest("1234");
+        final DocumentEntity res = template.insert(entity);
+        String colName = res.getId().split("/")[0];
+        final FieldNameTestEntityOnSetter read = db
+                .collection(colName)
+                .getDocument(res.getKey(), FieldNameTestEntityOnSetter.class);
+        assertThat(read, is(notNullValue()));
+        assertThat(read.test, is("1234"));
+    }
+
+    @Document
+    public record FieldNameTestOnRecordField(
+            @Id
+            String id,
+
+            @Field("alt-test")
+            String test
+    ) {
+    }
+
+    @Test
+    public void fieldNameAnnotationOnRecord() {
+        final FieldNameTestOnRecordField entity = new FieldNameTestOnRecordField("1234", "1234");
+        final DocumentEntity res = template.insert(entity);
+        String colName = res.getId().split("/")[0];
+        final FieldNameTestOnRecordField read = db
+                .collection(colName)
+                .getDocument(res.getKey(), FieldNameTestOnRecordField.class);
+        assertThat(read, is(notNullValue()));
+        assertThat(read.test, is("1234"));
+    }
+
+    @Field
+    @Retention(RetentionPolicy.RUNTIME)
+    @Target({ElementType.FIELD})
+    public @interface MyField {
+        @AliasFor(annotation = Field.class, attribute = "value")
+        String value() default "";
+    }
+
+    public static class FieldNameTestEntityOnFieldMeta extends BasicTestEntity {
+        @MyField("alt-test")
+        private String test;
+    }
+
+    @Test
+    public void fieldNameAnnotationOnFieldMeta() {
+        final FieldNameTestEntityOnFieldMeta entity = new FieldNameTestEntityOnFieldMeta();
+        entity.test = "1234";
+        final DocumentEntity res = template.insert(entity);
+        String colName = res.getId().split("/")[0];
+        final FieldNameTestEntityOnFieldMeta read = db
+                .collection(colName)
+                .getDocument(res.getKey(), FieldNameTestEntityOnFieldMeta.class);
+        assertThat(read, is(notNullValue()));
+        assertThat(read.test, is("1234"));
     }
 
     public static class ConstructorWithParamTestEntity extends BasicTestEntity {
@@ -173,6 +268,7 @@ public static class GeoTestEntity extends BasicTestEntity {
         private GeoJsonMultiPolygon geoJsonMultiPolygon;
     }
 
+    @SuppressWarnings("Json5StandardCompliance")
     @Test
     public void geoMapping() throws JSONException, JsonProcessingException {
         ArangoConverter converter = template.getConverter();
@@ -599,6 +695,7 @@ static class AuditingTestEntity {
     }
 
     @Autowired
+    @SuppressWarnings({"SpringJavaInjectionPointsAutowiringInspection"})
     AuditorProvider auditorProvider;
 
     @Test

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@`
`33`	`33`	`*`
`34`	`34`	`*/`
`35`	`35`	`@Retention(RetentionPolicy.RUNTIME)`
`36`		`-@Target({ ElementType.FIELD })`
	`36`	`+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})`
`37`	`37`	`public @interface From {`
`38`	`38`
`39`	`39`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@`
`32`	`32`	`*`
`33`	`33`	`*/`
`34`	`34`	`@Retention(RetentionPolicy.RUNTIME)`
`35`		`-@Target({ ElementType.FIELD })`
	`35`	`+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})`
`36`	`36`	`public @interface GeoIndexed {`
`37`	`37`
`38`	`38`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`	`*`
`37`	`37`	`*/`
`38`	`38`	`@Retention(RetentionPolicy.RUNTIME)`
`39`		`-@Target({ ElementType.FIELD })`
	`39`	`+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})`
`40`	`40`	`@Reference`
`41`	`41`	`public @interface Ref {`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`*`
`31`	`31`	`*/`
`32`	`32`	`@Retention(RetentionPolicy.RUNTIME)`
`33`		`-@Target({ ElementType.FIELD })`
	`33`	`+@Target({ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE})`
`34`	`34`	`public @interface Relations {`
`35`	`35`
`36`	`36`	`public enum Direction {`