Now with a Documentation meta data

Author: bbakerman

readme.md

@@ -52,7 +52,7 @@ the `name` field must be at least 3 characters long and no more than 100 charact
 
 The boolean value must be false.
 
-- Example : `driver( isDrunk : Boolean @AssertFalse) : DriverDetails`
+- Example : `updateDriver( isDrunk : Boolean @AssertFalse) : DriverDetails`
 
 - Applies to : `Boolean`
 
@@ -65,7 +65,7 @@ The boolean value must be false.
 
 The boolean value must be true.
 
-- Example : `driver( hasLicence : Boolean @AssertTrue) : DriverDetails`
+- Example : `driveCar( hasLicence : Boolean @AssertTrue) : DriverDetails`
 
 - Applies to : `Boolean`
 
@@ -78,7 +78,7 @@ The boolean value must be true.
 
 The element must be a number whose value must be less than or equal to the specified maximum.
 
-- Example : `driver( bloodAlcoholLevel : Float @DecimalMax(value : "0.05") : DriverDetails`
+- Example : `driveCar( bloodAlcoholLevel : Float @DecimalMax(value : "0.05") : DriverDetails`
 
 - Applies to : `String`, `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -91,7 +91,7 @@ The element must be a number whose value must be less than or equal to the speci
 
 The element must be a number whose value must be greater than or equal to the specified minimum.
 
-- Example : `driver( carHorsePower : Float @DecimalMin(value : "300.50") : DriverDetails`
+- Example : `driveCar( carHorsePower : Float @DecimalMin(value : "300.50") : DriverDetails`
 
 - Applies to : `String`, `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -104,7 +104,7 @@ The element must be a number whose value must be greater than or equal to the sp
 
 The element must be a number inside the specified `integer` and `fraction` range.
 
-- Example : `driver( carCost : Float @Digits(integer : 5, fraction : 2) : DriverDetails`
+- Example : `buyCar( carCost : Float @Digits(integer : 5, fraction : 2) : DriverDetails`
 
 - Applies to : `String`, `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -117,7 +117,7 @@ The element must be a number inside the specified `integer` and `fraction` range
 
 The element must be a number whose value must be less than or equal to the specified maximum.
 
-- Example : `driver( horsePower : Float @Max(value : 1000) : DriverDetails`
+- Example : `driveCar( horsePower : Float @Max(value : 1000) : DriverDetails`
 
 - Applies to : `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -130,7 +130,7 @@ The element must be a number whose value must be less than or equal to the speci
 
 The element must be a number whose value must be greater than or equal to the specified minimum.
 
-- Example : `driver( age : Int @Min(value : 18) : DriverDetails`
+- Example : `driveCar( age : Int @Min(value : 18) : DriverDetails`
 
 - Applies to : `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -143,7 +143,7 @@ The element must be a number whose value must be greater than or equal to the sp
 
 The element must be a negative number.
 
-- Example : `driver( licencePoints : Int @Negative) : DriverDetails`
+- Example : `driveCar( lostLicencePoints : Int @Negative) : DriverDetails`
 
 - Applies to : `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -156,7 +156,7 @@ The element must be a negative number.
 
 The element must be a negative number or zero.
 
-- Example : `driver( licencePoints : Int @NegativeOrZero) : DriverDetails`
+- Example : `driveCar( lostLicencePoints : Int @NegativeOrZero) : DriverDetails`
 
 - Applies to : `Byte`, `Short`, `Int`, `Long`, `BigDecimal`, `BigInteger`, `Float`
 
@@ -247,10 +247,10 @@ The element range must be between the specified `min` and `max` boundaries (incl
 
 The element size must be between the specified `min` and `max` boundaries (inclusive).
 
-- Example : `updateDriver( drivingNote : String @Size( min : 1000, max : 100000)) : DriverDetails`
+- Example : `updateDrivingNotes( drivingNote : String @Size( min : 1000, max : 100000)) : DriverDetails`
 
 - Applies to : `String`, `Lists`, `Input Objects`
 
 - SDL : directive @Size(min : Int = 0, max : Int = 2147483647, message : String = "graphql.validation.Size.message") on ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION
 
-- Message : `graphql.validation.Size.message`
+- Message : `graphql.validation.Size.message`

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

@@ -4,6 +4,7 @@
 import graphql.GraphQLError;
 import graphql.PublicSpi;
 import graphql.Scalars;
+import graphql.execution.ExecutionPath;
 import graphql.schema.GraphQLArgument;
 import graphql.schema.GraphQLDirective;
 import graphql.schema.GraphQLFieldDefinition;
@@ -13,6 +14,7 @@
 import graphql.schema.GraphQLScalarType;
 import graphql.schema.GraphQLTypeUtil;
 import graphql.validation.rules.ValidationEnvironment;
+import graphql.validation.util.DirectivesAndTypeWalker;
 import graphql.validation.util.Util;
 
 import java.lang.reflect.Array;
@@ -46,8 +48,7 @@ public String getName() {
     }
 
 
-    @Override
-    public String getMessageTemplate() {
+    protected String getMessageTemplate() {
         return "graphql.validation." + getName() + ".message";
     }
 
@@ -191,16 +192,17 @@ 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
+     * @param validatedValue        the value being validated
+     * @param validationEnvironment the validation environment
+     * @param args                  must be an key / value array with String keys as the even params and values as then odd params
      *
      * @return a map of message parameters
      */
-    protected Map<String, Object> mkMessageParams(Object validatedValue, ValidationEnvironment ruleEnvironment, Object... args) {
+    protected Map<String, Object> mkMessageParams(Object validatedValue, ValidationEnvironment validationEnvironment, Object... args) {
         Map<String, Object> params = new LinkedHashMap<>();
         params.put("validatedValue", validatedValue);
         params.put("constraint", getName());
+        params.put("path", mkFieldOrArgPath(validationEnvironment));
 
         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) {
@@ -212,12 +214,20 @@ protected Map<String, Object> mkMessageParams(Object validatedValue, ValidationE
         return params;
     }
 
+    private Object mkFieldOrArgPath(ValidationEnvironment validationEnvironment) {
+        ExecutionPath executionPath = validationEnvironment.getExecutionPath();
+        ExecutionPath fieldOrArgumentPath = validationEnvironment.getFieldOrArgumentPath();
+
+        executionPath = Util.concatPaths(executionPath, fieldOrArgumentPath);
+        return executionPath == null ? "/" : executionPath.toString();
+    }
+
     /**
      * Creates  a new {@link graphql.GraphQLError}
      *
      * @param validationEnvironment the current validation environment
-     * @param directive       the directive being run
-     * @param msgParams       the map of parameters
+     * @param directive             the directive being run
+     * @param msgParams             the map of parameters
      *
      * @return a list of a single error
      */

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

@@ -18,29 +18,10 @@ public interface DirectiveConstraint extends ValidationRule {
      */
     String getName();
 
-    /**
-     * @return a description for documentation
-     */
-    String getDescription();
-
-    /**
-     * @return a description for documentation
-     */
-    String getExample();
-
-    /**
-     * @return the graphql SDL directive declaration syntax
-     */
-    String getDirectiveDeclarationSDL();
-
-    /**
-     * @return the message template name
-     */
-    String getMessageTemplate();
 
     /**
-     * @return a list of the names of applicable types
+     * @return documentation meta data about this constraint
      */
-    List<String> getApplicableTypeNames();
+    Documentation getDocumentation();
 
 }

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

@@ -31,8 +31,8 @@
 import graphql.validation.constraints.standard.PositiveOrZeroConstraint;
 import graphql.validation.constraints.standard.RangeConstraint;
 import graphql.validation.constraints.standard.SizeConstraint;
-import graphql.validation.rules.ValidationRule;
 import graphql.validation.rules.ValidationEnvironment;
+import graphql.validation.rules.ValidationRule;
 import graphql.validation.util.Util;
 
 import java.util.ArrayList;
@@ -42,10 +42,16 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * This contains a liszt of {@link graphql.validation.constraints.DirectiveConstraint}s and
+ * runs them as a group on a field and its argument values.
+ * <p>
+ * This ships with a set of standard constraints via {@link #STANDARD_CONSTRAINTS} but you can
+ * add your own implementations if you wish
+ */
 @PublicApi
 public class DirectiveConstraints implements ValidationRule {
 
-
     /**
      * These are the standard directive rules that come with the system
      */
@@ -82,10 +88,10 @@ public Map<String, DirectiveConstraint> getConstraints() {
         return constraints;
     }
 
-    public String getDirectivesDeclarationSDL() {
+    public String getDirectivesSDL() {
         StringBuilder sb = new StringBuilder();
-        for (DirectiveConstraint value : constraints.values()) {
-            sb.append("\n   ").append(value.getDirectiveDeclarationSDL()).append("\n");
+        for (DirectiveConstraint directiveConstraint : constraints.values()) {
+            sb.append("\n   ").append(directiveConstraint.getDocumentation().getDirectiveSDL()).append("\n");
         }
         return sb.toString();
     }

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

@@ -0,0 +1,89 @@
+package graphql.validation.constraints;
+
+import java.util.Arrays;
+import java.util.List;
+
+public class Documentation {
+
+    private final String description;
+    private final String example;
+    private final String directiveSDL;
+    private final String messageTemplate;
+    private final List<String> applicableTypeNames;
+
+    private Documentation(Builder builder) {
+        this.description = builder.description;
+        this.example = builder.example;
+        this.directiveSDL = builder.directiveSDL;
+        this.messageTemplate = builder.messageTemplate;
+        this.applicableTypeNames = builder.applicableTypeNames;
+    }
+
+    public static Builder newDocumentation() {
+        return new Builder();
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+    public String getExample() {
+        return example;
+    }
+
+    public String getDirectiveSDL() {
+        return directiveSDL;
+    }
+
+    public String getMessageTemplate() {
+        return messageTemplate;
+    }
+
+    public List<String> getApplicableTypeNames() {
+        return applicableTypeNames;
+    }
+
+    public static class Builder {
+        private String description;
+        private String example;
+        private String directiveSDL;
+        private String messageTemplate;
+        private List<String> applicableTypeNames;
+
+
+        public Builder description(String description) {
+            this.description = description;
+            return this;
+        }
+
+        public Builder example(String example) {
+            this.example = example;
+            return this;
+        }
+
+        public Builder directiveSDL(String format, Object... args) {
+            this.directiveSDL = String.format(format, args);
+            return this;
+        }
+
+        public Builder messageTemplate(String messageTemplate) {
+            this.messageTemplate = messageTemplate;
+            return this;
+        }
+
+        public Builder applicableTypeNames(List<String> applicableTypeNames) {
+            this.applicableTypeNames = applicableTypeNames;
+            return this;
+        }
+
+        public Builder applicableTypeNames(String... applicableTypeNames) {
+            this.applicableTypeNames = Arrays.asList(applicableTypeNames);
+            return this;
+        }
+
+        public Documentation build() {
+            return new Documentation(this);
+        }
+
+    }
+}

src/main/java/graphql/validation/constraints/standard/AbstractAssertConstraint.java

@@ -3,14 +3,11 @@
 import graphql.GraphQLError;
 import graphql.schema.GraphQLDirective;
 import graphql.schema.GraphQLInputType;
-import graphql.schema.GraphQLScalarType;
 import graphql.validation.constraints.AbstractDirectiveConstraint;
 import graphql.validation.rules.ValidationEnvironment;
 
 import java.util.Collections;
 import java.util.List;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 import static graphql.Scalars.GraphQLBoolean;
 
@@ -28,11 +25,6 @@ public boolean appliesToType(GraphQLInputType inputType) {
         );
     }
 
-    @Override
-    public List<String> getApplicableTypeNames() {
-        return Stream.of(GraphQLBoolean).map(GraphQLScalarType::getName).collect(Collectors.toList());
-    }
-
     @Override
     public List<GraphQLError> runValidation(ValidationEnvironment validationEnvironment) {
         Object validatedValue = validationEnvironment.getValidatedValue();

src/main/java/graphql/validation/constraints/standard/AbstractDecimalMinMaxConstraint.java

@@ -34,7 +34,6 @@ public boolean appliesToType(GraphQLInputType inputType) {
         );
     }
 
-    @Override
     public List<String> getApplicableTypeNames() {
         return Stream.of(Scalars.GraphQLString, // note we allow strings
                 Scalars.GraphQLByte,

src/main/java/graphql/validation/constraints/standard/AbstractMinMaxConstraint.java

@@ -34,7 +34,6 @@ public boolean appliesToType(GraphQLInputType inputType) {
         );
     }
 
-    @Override
     public List<String> getApplicableTypeNames() {
         return Stream.of(Scalars.GraphQLByte,
                 Scalars.GraphQLShort,

src/main/java/graphql/validation/constraints/standard/AbstractPositiveNegativeConstraint.java

@@ -34,7 +34,6 @@ public boolean appliesToType(GraphQLInputType inputType) {
         );
     }
 
-    @Override
     public List<String> getApplicableTypeNames() {
         return Stream.of(Scalars.GraphQLByte,
                 Scalars.GraphQLShort,