Renamed most things - directive rules are not Constraints

Author: bbakerman

build.gradle

@@ -39,12 +39,14 @@ repositories {
 
 dependencies {
     compile "com.graphql-java:graphql-java:13.0"
+    compile 'org.slf4j:slf4j-api:1.7.25'
     compile "javax.validation:validation-api:2.0.1.Final"
-    //compile "org.hibernate.validator:hibernate-validator:6.0.17.Final"
-    compile "org.hibernate.validator:hibernate-validator:6.1.0.Alpha5"
+    compile "org.hibernate.validator:hibernate-validator:6.0.17.Final"
+    //compile "org.hibernate.validator:hibernate-validator:6.1.0.Alpha5"
     compile "javax.el:javax.el-api:3.0.0"
     compile "org.glassfish:javax.el:3.0.0"
 
+    testCompile 'org.slf4j:slf4j-simple:1.7.25'
     testCompile 'org.spockframework:spock-core:1.1-groovy-2.4'
     testCompile 'org.codehaus.groovy:groovy-all:2.5.7'
 }

src/main/java/graphql/validation/directives/AbstractDirectiveValidationRule.java renamed to src/main/java/graphql/validation/constraints/AbstractDirectiveConstraint.java

@@ -1,4 +1,4 @@
-package graphql.validation.directives;
+package graphql.validation.constraints;
 
 import graphql.Assert;
 import graphql.GraphQLError;
@@ -12,7 +12,7 @@
 import graphql.schema.GraphQLInputType;
 import graphql.schema.GraphQLScalarType;
 import graphql.schema.GraphQLTypeUtil;
-import graphql.validation.rules.ValidationRuleEnvironment;
+import graphql.validation.rules.ValidationEnvironment;
 import graphql.validation.util.Util;
 
 import java.lang.reflect.Array;
@@ -26,19 +26,31 @@
 import static java.util.Collections.singletonList;
 
 @PublicSpi
-public abstract class AbstractDirectiveValidationRule implements DirectiveValidationRule {
+public abstract class AbstractDirectiveConstraint implements DirectiveConstraint {
 
     private final String name;
 
-    public AbstractDirectiveValidationRule(String name) {
+    public AbstractDirectiveConstraint(String name) {
         this.name = name;
     }
 
+
+    @Override
+    public String toString() {
+        return "@" + name;
+    }
+
     @Override
     public String getName() {
         return name;
     }
 
+
+    @Override
+    public String getMessageTemplate() {
+        return "graphql.validation." + getName() + ".message";
+    }
+
     @Override
     public boolean appliesTo(GraphQLFieldDefinition fieldDefinition, GraphQLFieldsContainer fieldsContainer) {
         return false;
@@ -179,35 +191,39 @@ protected String getMessageTemplate(GraphQLDirective directive) {
     /**
      * Creates a map of named parameters for message interpolation
      *
+     * @param validatedValue the value being validated
+     * @param ruleEnvironment  the rule environment
      * @param args must be even with a String as even params and values as odd params
      *
      * @return a map of message parameters
      */
-    protected Map<String, Object> mkMessageParams(Object... args) {
-        Assert.assertTrue(args.length % 2 == 0, "You MUST pass in an even number of arguments");
+    protected Map<String, Object> mkMessageParams(Object validatedValue, ValidationEnvironment ruleEnvironment, Object... args) {
         Map<String, Object> params = new LinkedHashMap<>();
+        params.put("validatedValue", validatedValue);
+        params.put("constraint", getName());
+
+        Assert.assertTrue(args.length % 2 == 0, "You MUST pass in an even number of arguments");
         for (int ix = 0; ix < args.length; ix = ix + 2) {
             Object key = args[ix];
-            Assert.assertTrue(key instanceof String, "You MUST pass in a string key");
+            Assert.assertTrue(key instanceof String, "You MUST pass in a message param string key");
             Object val = args[ix + 1];
             params.put(String.valueOf(key), val);
         }
-
         return params;
     }
 
     /**
      * Creates  a new {@link graphql.GraphQLError}
      *
-     * @param ruleEnvironment the current rules environment
+     * @param validationEnvironment the current validation environment
      * @param directive       the directive being run
      * @param msgParams       the map of parameters
      *
      * @return a list of a single error
      */
-    protected List<GraphQLError> mkError(ValidationRuleEnvironment ruleEnvironment, GraphQLDirective directive, Map<String, Object> msgParams) {
+    protected List<GraphQLError> mkError(ValidationEnvironment validationEnvironment, GraphQLDirective directive, Map<String, Object> msgParams) {
         String messageTemplate = getMessageTemplate(directive);
-        GraphQLError error = ruleEnvironment.getInterpolator().interpolate(messageTemplate, msgParams, ruleEnvironment);
+        GraphQLError error = validationEnvironment.getInterpolator().interpolate(messageTemplate, msgParams, validationEnvironment);
         return singletonList(error);
     }
 
@@ -228,6 +244,8 @@ protected boolean isStringOrListOrMap(GraphQLInputType inputType) {
     /**
      * Casts the object as a Map with an assertion of it is not one
      *
+     * @param value the object to turn into a map
+     *
      * @return a Map
      */
     @SuppressWarnings("ConstantConditions")
@@ -239,6 +257,8 @@ protected Map asMap(Object value) {
     /**
      * Makes the object a BigDecimal with an assertion if we have no conversion of it
      *
+     * @param value the object to turn into a BigDecimal
+     *
      * @return a BigDecimal
      */
     protected BigDecimal asBigDecimal(Object value) throws NumberFormatException {
@@ -262,6 +282,8 @@ protected BigDecimal asBigDecimal(Object value) throws NumberFormatException {
     /**
      * Makes the object a boolean with an assertion if we have no conversion of it
      *
+     * @param value the boolean object
+     *
      * @return a boolean
      */
     protected boolean asBoolean(Object value) {

src/main/java/graphql/validation/constraints/DirectiveConstraint.java

@@ -0,0 +1,26 @@
+package graphql.validation.constraints;
+
+import graphql.PublicSpi;
+import graphql.validation.rules.ValidationRule;
+
+import java.util.List;
+
+/**
+ * A DirectiveConstraint is a specialised form of validation rule
+ * that assumes it is backed by a SDL directive on fields, field arguments
+ * or input type fields.
+ */
+@PublicSpi
+public interface DirectiveConstraint extends ValidationRule {
+
+    String getName();
+
+    String getDescription();
+
+    String getDirectiveDeclarationSDL();
+
+    String getMessageTemplate();
+
+    List<String> getApplicableTypeNames();
+
+}