remove directiveannotation and merge with graphqldirectivedefinition

yarinvak · yarinvak · commit c9030fbdf395 · 2019-09-21T14:09:02.000+03:00
diff --git a/src/main/java/graphql/annotations/annotationTypes/directives/activation/Directive.java b/src/main/java/graphql/annotations/annotationTypes/directives/activation/Directive.java
@@ -12,13 +12,17 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  */
-package graphql.annotations.directives;
+package graphql.annotations.annotationTypes.directives.activation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+
+/**
+ * A way of activating a graphql directive - put this annotation on top of the graphql field/argument and determine which directive you wish to use
+ */
 @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Directive {
diff --git a/src/main/java/graphql/annotations/annotationTypes/directives/activation/GraphQLDirectives.java b/src/main/java/graphql/annotations/annotationTypes/directives/activation/GraphQLDirectives.java
@@ -12,15 +12,17 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  */
-package graphql.annotations.annotationTypes;
-
-import graphql.annotations.directives.Directive;
+package graphql.annotations.annotationTypes.directives.activation;
 
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/**
+ * Put in on a graphql field / other graphql type in order to activate directives on it
+ */
+
 @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface GraphQLDirectives {
diff --git a/src/main/java/graphql/annotations/annotationTypes/directives/definition/DirectiveLocations.java b/src/main/java/graphql/annotations/annotationTypes/directives/definition/DirectiveLocations.java
@@ -12,7 +12,7 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  */
-package graphql.annotations.directives.creation;
+package graphql.annotations.annotationTypes.directives.definition;
 
 import graphql.introspection.Introspection;
 
diff --git a/src/main/java/graphql/annotations/annotationTypes/directives/definition/DirectiveWiring.java b/src/main/java/graphql/annotations/annotationTypes/directives/definition/DirectiveWiring.java
@@ -1,4 +1,4 @@
-package graphql.annotations.directives.creation;
+package graphql.annotations.annotationTypes.directives.definition;
 
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
 import graphql.introspection.Introspection;
diff --git a/src/main/java/graphql/annotations/annotationTypes/directives/definition/GraphQLDirectiveDefinition.java b/src/main/java/graphql/annotations/annotationTypes/directives/definition/GraphQLDirectiveDefinition.java
@@ -1,4 +1,4 @@
-package graphql.annotations.annotationTypes;
+package graphql.annotations.annotationTypes.directives.definition;
 
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
 
@@ -7,7 +7,11 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-@Target({ElementType.METHOD})
+
+/**
+ * You should put this annotation on top of a directive method you created, or a directive java annotation you created
+ */
+@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
 @Retention(RetentionPolicy.RUNTIME)
 public @interface GraphQLDirectiveDefinition {
     Class<? extends AnnotationsDirectiveWiring> wiring();
diff --git a/src/main/java/graphql/annotations/directives/DirectiveWiringMapRetriever.java b/src/main/java/graphql/annotations/directives/DirectiveWiringMapRetriever.java
@@ -14,7 +14,7 @@
  */
 package graphql.annotations.directives;
 
-import graphql.annotations.annotationTypes.GraphQLDirectives;
+import graphql.annotations.annotationTypes.directives.activation.GraphQLDirectives;
 import graphql.annotations.processor.DirectiveAndWiring;
 import graphql.annotations.processor.ProcessingElementsContainer;
 import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
diff --git a/src/main/java/graphql/annotations/directives/creation/DirectiveAnnotation.java b/src/main/java/graphql/annotations/directives/creation/DirectiveAnnotation.java
diff --git a/src/main/java/graphql/annotations/processor/GraphQLAnnotations.java b/src/main/java/graphql/annotations/processor/GraphQLAnnotations.java
@@ -14,10 +14,9 @@
  */
 package graphql.annotations.processor;
 
-import graphql.annotations.annotationTypes.GraphQLDirectiveDefinition;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
 import graphql.annotations.annotationTypes.GraphQLName;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
-import graphql.annotations.directives.creation.DirectiveWiring;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveWiring;
 import graphql.annotations.processor.directives.CommonPropertiesCreator;
 import graphql.annotations.processor.directives.DirectiveArgumentCreator;
 import graphql.annotations.processor.directives.DirectiveCreator;
@@ -162,11 +161,11 @@ public GraphQLDirective directive(Class<?> object) throws GraphQLAnnotationsExce
     public GraphQLDirective directiveViaAnnotation(Class<?> annotationClass) {
         try {
             GraphQLDirective directive = this.directiveCreator.getDirective(annotationClass);
-            DirectiveAnnotation annotation = annotationClass.getAnnotation(DirectiveAnnotation.class);
+            GraphQLDirectiveDefinition annotation = annotationClass.getAnnotation(GraphQLDirectiveDefinition.class);
             if (annotation==null){
                 throw new GraphQLAnnotationsException(String.format("No wiring is provided to directive class %s", annotationClass.getSimpleName()), null);
             }
-            this.getContainer().getDirectiveRegistry().put(directive.getName(), new DirectiveAndWiring(directive, annotation.value()));
+            this.getContainer().getDirectiveRegistry().put(directive.getName(), new DirectiveAndWiring(directive, annotation.wiring()));
             return directive;
         } catch (GraphQLAnnotationsException e) {
             this.getContainer().getProcessing().clear();
diff --git a/src/main/java/graphql/annotations/processor/directives/DirectiveCreator.java b/src/main/java/graphql/annotations/processor/directives/DirectiveCreator.java
@@ -14,10 +14,9 @@
  */
 package graphql.annotations.processor.directives;
 
-import graphql.annotations.annotationTypes.GraphQLDirectiveDefinition;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
-import graphql.annotations.directives.creation.DirectiveLocations;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
 import graphql.annotations.processor.DirectiveAndWiring;
 import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
 import graphql.introspection.Introspection;
@@ -74,7 +73,7 @@ public DirectiveAndWiring getDirective(Method directiveMethod){
     }
 
     private void buildArguments(GraphQLDirective.Builder builder, Class<?> annotatedClass) {
-        if (annotatedClass.isAnnotationPresent(DirectiveAnnotation.class)){
+        if (annotatedClass.isAnnotationPresent(GraphQLDirectiveDefinition.class)){
             Arrays.stream(annotatedClass.getDeclaredMethods())
                     .filter(method -> !method.isSynthetic())
                     .forEach(method -> builder.argument(directiveArgumentCreator.getArgument(method)));
diff --git a/src/main/java/graphql/annotations/processor/retrievers/fieldBuilders/DirectivesBuilder.java b/src/main/java/graphql/annotations/processor/retrievers/fieldBuilders/DirectivesBuilder.java
@@ -14,20 +14,16 @@
  */
 package graphql.annotations.processor.retrievers.fieldBuilders;
 
-import graphql.annotations.annotationTypes.GraphQLDirectives;
-import graphql.annotations.annotationTypes.GraphQLName;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
+import graphql.annotations.annotationTypes.directives.activation.GraphQLDirectives;
 import graphql.annotations.processor.ProcessingElementsContainer;
 import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
-import graphql.annotations.processor.retrievers.fieldBuilders.field.FieldNameBuilder;
 import graphql.annotations.processor.util.DirectiveJavaAnnotationUtil;
 import graphql.schema.GraphQLArgument;
 import graphql.schema.GraphQLDirective;
 import graphql.schema.GraphQLScalarType;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedElement;
-import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
 import java.util.Arrays;
diff --git a/src/main/java/graphql/annotations/processor/util/DirectiveJavaAnnotationUtil.java b/src/main/java/graphql/annotations/processor/util/DirectiveJavaAnnotationUtil.java
@@ -1,7 +1,7 @@
 package graphql.annotations.processor.util;
 
 import graphql.annotations.annotationTypes.GraphQLName;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
 
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AnnotatedElement;
@@ -14,7 +14,7 @@ public static Stream<Annotation> getDirectiveAnnotations(AnnotatedElement annota
         if (annotatedElement==null){
             throw new NullPointerException("supplied element is null");
         }
-        return Arrays.stream(annotatedElement.getDeclaredAnnotations()).filter(annotation -> annotation.annotationType().isAnnotationPresent(DirectiveAnnotation.class));
+        return Arrays.stream(annotatedElement.getDeclaredAnnotations()).filter(annotation -> annotation.annotationType().isAnnotationPresent(GraphQLDirectiveDefinition.class));
     }
 
     public static String getName(Annotation annotation){
diff --git a/src/test/java/graphql/annotations/AnnotationsSchemaCreatorTest.java b/src/test/java/graphql/annotations/AnnotationsSchemaCreatorTest.java
@@ -19,8 +19,8 @@
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
 import graphql.annotations.directives.AnnotationsWiringEnvironment;
-import graphql.annotations.directives.creation.DirectiveLocations;
-import graphql.annotations.directives.creation.DirectiveWiring;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveWiring;
 import graphql.annotations.processor.GraphQLAnnotations;
 import graphql.introspection.Introspection;
 import graphql.schema.GraphQLDirective;
diff --git a/src/test/java/graphql/annotations/GraphQLDirectiveCreationTest.java b/src/test/java/graphql/annotations/GraphQLDirectiveCreationTest.java
@@ -15,12 +15,11 @@
 package graphql.annotations;
 
 import graphql.annotations.annotationTypes.GraphQLDescription;
-import graphql.annotations.annotationTypes.GraphQLDirectiveDefinition;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
-import graphql.annotations.directives.creation.DirectiveLocations;
-import graphql.annotations.directives.creation.DirectiveWiring;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveWiring;
 import graphql.annotations.processor.GraphQLAnnotations;
 import graphql.introspection.Introspection;
 import graphql.schema.GraphQLArgument;
@@ -150,7 +149,7 @@ public void directive_suppliedDirectiveMethodContainer_returnCorrectDirective()
 
     @GraphQLName("upper")
     @GraphQLDescription("the upper")
-    @DirectiveAnnotation(Wiring.class)
+    @GraphQLDirectiveDefinition(wiring = Wiring.class)
     @DirectiveLocations({Introspection.DirectiveLocation.FIELD_DEFINITION, Introspection.DirectiveLocation.INTERFACE})
     @interface UpperAnnotation {
         @GraphQLName("isActive")
@@ -180,4 +179,22 @@ public void directive_suppliedDirectiveAnnotation_returnCorrectDirective() {
         assertEquals(true,isActive.getDefaultValue());
     }
 
+    @Test
+    public void directive_suppliedNoDirectiveAnnotation_returnNull() {
+        // Act
+        GraphQLDirective upper = this.graphQLAnnotations.directiveViaAnnotation(NoDirectiveAnnotation.class);
+
+        // Assert
+        assertEquals(upper.getName(), "upper");
+        assertEquals(upper.getDescription(), "the upper");
+        assertArrayEquals(upper.validLocations().toArray(), new Introspection.DirectiveLocation[]{Introspection.DirectiveLocation.FIELD_DEFINITION,
+                Introspection.DirectiveLocation.INTERFACE});
+        GraphQLArgument isActive = upper.getArgument("isActive");
+        assertNotNull(isActive);
+        assertEquals(isActive.getName(), "isActive");
+        assertEquals(isActive.getType(), GraphQLBoolean);
+        assertEquals(true,isActive.getDefaultValue());
+    }
+
+
 }
diff --git a/src/test/java/graphql/annotations/GraphQLDirectivesTest.java b/src/test/java/graphql/annotations/GraphQLDirectivesTest.java
@@ -16,16 +16,15 @@
 
 import graphql.ExecutionResult;
 import graphql.GraphQL;
-import graphql.annotations.annotationTypes.GraphQLDirectiveDefinition;
-import graphql.annotations.annotationTypes.GraphQLDirectives;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
+import graphql.annotations.annotationTypes.directives.activation.GraphQLDirectives;
 import graphql.annotations.annotationTypes.GraphQLField;
 import graphql.annotations.annotationTypes.GraphQLName;
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
 import graphql.annotations.directives.AnnotationsWiringEnvironment;
-import graphql.annotations.directives.Directive;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
-import graphql.annotations.directives.creation.DirectiveLocations;
-import graphql.annotations.directives.creation.DirectiveWiring;
+import graphql.annotations.annotationTypes.directives.activation.Directive;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveWiring;
 import graphql.annotations.processor.DirectiveAndWiring;
 import graphql.annotations.processor.GraphQLAnnotations;
 import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
@@ -189,7 +188,7 @@ public static String name() {
 
     @Target({ElementType.TYPE, ElementType.METHOD})
     @Retention(RetentionPolicy.RUNTIME)
-    @DirectiveAnnotation(UpperWiring.class)
+    @GraphQLDirectiveDefinition(wiring = UpperWiring.class)
     @DirectiveLocations(Introspection.DirectiveLocation.FIELD_DEFINITION)
     @GraphQLName("upper")
     public @interface ToUpperCase{
diff --git a/src/test/java/graphql/annotations/directives/DirectiveWiringMapRetrieverTest.java b/src/test/java/graphql/annotations/directives/DirectiveWiringMapRetrieverTest.java
@@ -14,7 +14,8 @@
  */
 package graphql.annotations.directives;
 
-import graphql.annotations.annotationTypes.GraphQLDirectives;
+import graphql.annotations.annotationTypes.directives.activation.Directive;
+import graphql.annotations.annotationTypes.directives.activation.GraphQLDirectives;
 import graphql.annotations.processor.DirectiveAndWiring;
 import graphql.annotations.processor.ProcessingElementsContainer;
 import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
diff --git a/src/test/java/graphql/annotations/directives/creation/DirectiveCreatorTest.java b/src/test/java/graphql/annotations/directives/creation/DirectiveCreatorTest.java
@@ -16,6 +16,7 @@
 
 import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLName;
+import graphql.annotations.annotationTypes.directives.definition.DirectiveLocations;
 import graphql.annotations.processor.directives.CommonPropertiesCreator;
 import graphql.annotations.processor.directives.DirectiveArgumentCreator;
 import graphql.annotations.processor.directives.DirectiveCreator;
diff --git a/src/test/java/graphql/annotations/processor/retrievers/fieldBuilders/DirectivesBuilderTest.java b/src/test/java/graphql/annotations/processor/retrievers/fieldBuilders/DirectivesBuilderTest.java
@@ -14,9 +14,9 @@
 // */
 //package graphql.annotations.processor.retrievers.fieldBuilders;
 //
-//import graphql.annotations.annotationTypes.GraphQLDirectives;
+//import graphql.annotations.annotationTypes.directives.activation.GraphQLDirectives;
 //import graphql.annotations.directives.AnnotationsDirectiveWiring;
-//import graphql.annotations.directives.Directive;
+//import graphql.annotations.annotationTypes.directives.activation.Directive;
 //import graphql.annotations.processor.ProcessingElementsContainer;
 //import graphql.annotations.processor.exceptions.GraphQLAnnotationsException;
 //import graphql.schema.GraphQLDirective;
diff --git a/src/test/java/graphql/annotations/processor/util/DirectiveJavaAnnotationUtilTest.java b/src/test/java/graphql/annotations/processor/util/DirectiveJavaAnnotationUtilTest.java
@@ -2,8 +2,8 @@
 
 import graphql.annotations.annotationTypes.GraphQLDescription;
 import graphql.annotations.annotationTypes.GraphQLName;
+import graphql.annotations.annotationTypes.directives.definition.GraphQLDirectiveDefinition;
 import graphql.annotations.directives.AnnotationsDirectiveWiring;
-import graphql.annotations.directives.creation.DirectiveAnnotation;
 import org.testng.annotations.Test;
 
 import java.lang.annotation.*;
@@ -25,34 +25,37 @@ static class Wiring implements AnnotationsDirectiveWiring {
 
     }
 
-    @DirectiveAnnotation(Wiring.class)
+    @GraphQLDirectiveDefinition(wiring = Wiring.class)
     @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE})
     @Retention(RetentionPolicy.RUNTIME)
     @GraphQLName("sample")
-    @interface DirectiveAnnotationSample{
+    @interface DirectiveAnnotationSample {
 
     }
 
-    @DirectiveAnnotation(Wiring.class)
+    @GraphQLDirectiveDefinition(wiring = Wiring.class)
     @Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE})
     @Retention(RetentionPolicy.RUNTIME)
-    @interface DirectiveAnnotationSample2{
+    @interface DirectiveAnnotationSample2 {
 
     }
 
 
-    static class Container{
+    static class Container {
 
         @DirectiveAnnotationSample
         @DirectiveAnnotationSample2
         @GraphQLName("blabla")
-        public void fieldAnnotatedWithMultipleAnnotationsIncludingDirective(){}
+        public void fieldAnnotatedWithMultipleAnnotationsIncludingDirective() {
+        }
 
         @GraphQLName("bbb")
         @GraphQLDescription("asdfasdf")
-        public void fieldAnnotatedWithMultipleAnnotationsWithoutDirective(){}
+        public void fieldAnnotatedWithMultipleAnnotationsWithoutDirective() {
+        }
 
-        public void fieldNotAnnotated(){}
+        public void fieldNotAnnotated() {
+        }
 
     }
 
@@ -95,7 +98,7 @@ public void getDirectiveAnnotations_elementNotAnnotated_returnEmptyList() throws
     }
 
     @Test(expectedExceptions = NullPointerException.class)
-    public void getName_nullElement_throwNullPointerException(){
+    public void getName_nullElement_throwNullPointerException() {
         String name = DirectiveJavaAnnotationUtil.getName(null);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package graphql.annotations.directives.creation;`
	`1`	`+package graphql.annotations.annotationTypes.directives.definition;`
`2`	`2`
`3`	`3`	`import graphql.annotations.directives.AnnotationsDirectiveWiring;`
`4`	`4`	`import graphql.introspection.Introspection;`