Rename default method names for Parser and Validator attributes (graphql-dotnet#4056)

Author: gao-artur

docs2/site/docs/migrations/migration8.md

@@ -220,7 +220,7 @@ public class OutputClass1
     // use local private static method
     public static string Hello1([Parser(nameof(ParseHelloArgument))] string value) => value;
 
-    // use public static method from another class -- looks for ParserClass.Parser
+    // use public static method from another class -- looks for ParserClass.Parse
     public static string Hello2([Parser(typeof(ParserClass))] string value) => value;
 
     // use public static method from another class with a specific name

src/GraphQL.Tests/Attributes/ParserAttributeTests.cs

@@ -16,10 +16,10 @@ public void null_throws()
 
     [Theory]
     [InlineData(typeof(Class1), "Could not find method 'InvalidMethod' on CLR type 'Class1' while initializing argument 'value'. The method must have a single parameter of type object.")]
-    [InlineData(typeof(Class2), "Could not find method 'Parser' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
+    [InlineData(typeof(Class2), "Could not find method 'Parse' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class3), "Could not find method 'InvalidMethod' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class4), "Method 'InvalidMethod' on CLR type 'Class4' must have a return type of object.")]
-    [InlineData(typeof(Class5), "Method 'Parser' on CLR type 'Dummy2' must have a return type of object.")]
+    [InlineData(typeof(Class5), "Method 'Parse' on CLR type 'Dummy2' must have a return type of object.")]
     [InlineData(typeof(Class6), "Method 'InvalidMethod' on CLR type 'Dummy2' must have a return type of object.")]
     public void method_not_found_arguments(Type clrType, string expectedMessage)
     {
@@ -65,10 +65,10 @@ public class Class6
 
     [Theory]
     [InlineData(typeof(Class1b), "Could not find method 'InvalidMethod' on CLR type 'Class1b' while initializing 'Class1b.Hello'. The method must have a single parameter of type object.")]
-    [InlineData(typeof(Class2b), "Could not find method 'Parser' on CLR type 'Dummy' while initializing 'Class2b.Hello'. The method must have a single parameter of type object.")]
+    [InlineData(typeof(Class2b), "Could not find method 'Parse' on CLR type 'Dummy' while initializing 'Class2b.Hello'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class3b), "Could not find method 'InvalidMethod' on CLR type 'Dummy' while initializing 'Class3b.Hello'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class4b), "Method 'InvalidMethod' on CLR type 'Class4b' must have a return type of object.")]
-    [InlineData(typeof(Class5b), "Method 'Parser' on CLR type 'Dummy2' must have a return type of object.")]
+    [InlineData(typeof(Class5b), "Method 'Parse' on CLR type 'Dummy2' must have a return type of object.")]
     [InlineData(typeof(Class6b), "Method 'InvalidMethod' on CLR type 'Dummy2' must have a return type of object.")]
     public void method_not_found_input_fields(Type clrType, string expectedMessage)
     {
@@ -120,15 +120,15 @@ public class Class6b
 
     public class Dummy
     {
-        public object Parser(object value) => value; // not static
-        public static void Parser() { } // wrong signature
+        public object Parse(object value) => value; // not static
+        public static void Parse() { } // wrong signature
         public object InvalidMethod(object value) => value; // not static
         public static void InvalidMethod() { } // wrong signature
     }
 
     public class Dummy2
     {
-        public static string Parser(object value) => (string)value;
+        public static string Parse(object value) => (string)value;
         public static string InvalidMethod(object value) => (string)value;
     }
 
@@ -236,7 +236,7 @@ public class FieldTests
 
     public class ParserClass
     {
-        public static object Parser(object value) => (string)value + "test2";
+        public static object Parse(object value) => (string)value + "test2";
     }
 
     public class HelperClass

src/GraphQL.Tests/Attributes/ValidatorAttributeTests.cs

@@ -16,10 +16,10 @@ public void null_throws()
 
     [Theory]
     [InlineData(typeof(Class1), "Could not find method 'InvalidMethod' on CLR type 'Class1' while initializing argument 'value'. The method must have a single parameter of type object.")]
-    [InlineData(typeof(Class2), "Could not find method 'Validator' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
+    [InlineData(typeof(Class2), "Could not find method 'Validate' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class3), "Could not find method 'InvalidMethod' on CLR type 'Dummy' while initializing argument 'value'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class4), "Method 'InvalidMethod' on CLR type 'Class4' must have a void return type.")]
-    [InlineData(typeof(Class5), "Method 'Validator' on CLR type 'Dummy2' must have a void return type.")]
+    [InlineData(typeof(Class5), "Method 'Validate' on CLR type 'Dummy2' must have a void return type.")]
     [InlineData(typeof(Class6), "Method 'InvalidMethod' on CLR type 'Dummy2' must have a void return type.")]
     public void method_not_found_arguments(Type clrType, string expectedMessage)
     {
@@ -65,10 +65,10 @@ public class Class6
 
     [Theory]
     [InlineData(typeof(Class1b), "Could not find method 'InvalidMethod' on CLR type 'Class1b' while initializing 'Class1b.Hello'. The method must have a single parameter of type object.")]
-    [InlineData(typeof(Class2b), "Could not find method 'Validator' on CLR type 'Dummy' while initializing 'Class2b.Hello'. The method must have a single parameter of type object.")]
+    [InlineData(typeof(Class2b), "Could not find method 'Validate' on CLR type 'Dummy' while initializing 'Class2b.Hello'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class3b), "Could not find method 'InvalidMethod' on CLR type 'Dummy' while initializing 'Class3b.Hello'. The method must have a single parameter of type object.")]
     [InlineData(typeof(Class4b), "Method 'InvalidMethod' on CLR type 'Class4b' must have a void return type.")]
-    [InlineData(typeof(Class5b), "Method 'Validator' on CLR type 'Dummy2' must have a void return type.")]
+    [InlineData(typeof(Class5b), "Method 'Validate' on CLR type 'Dummy2' must have a void return type.")]
     [InlineData(typeof(Class6b), "Method 'InvalidMethod' on CLR type 'Dummy2' must have a void return type.")]
     public void method_not_found_input_fields(Type clrType, string expectedMessage)
     {
@@ -120,15 +120,15 @@ public class Class6b
 
     public class Dummy
     {
-        public void Validator(object value) { _ = value; } // not static
-        public static void Validator() { } // wrong signature
+        public void Validate(object value) { _ = value; } // not static
+        public static void Validate() { } // wrong signature
         public void InvalidMethod(object value) { _ = value; } // not static
         public static void InvalidMethod() { } // wrong signature
     }
 
     public class Dummy2
     {
-        public static string Validator(object value) => (string)value;
+        public static string Validate(object value) => (string)value;
         public static string InvalidMethod(object value) => (string)value;
     }
 
@@ -364,7 +364,7 @@ public class FieldTests
 
     public class ValidatorClass
     {
-        public static void Validator(object value) => throw new InvalidOperationException((string)value + "pass2");
+        public static void Validate(object value) => throw new InvalidOperationException((string)value + "pass2");
     }
 
     public class HelperClass

src/GraphQL/Attributes/ParserAttribute.cs

@@ -9,6 +9,8 @@ namespace GraphQL;
 [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Field)]
 public sealed class ParserAttribute : GraphQLAttribute
 {
+    private const string DEFAULT_METHOD_NAME = "Parse";
+
     [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)]
     private readonly Type? _parserType;
     private readonly string _parserMethodName;
@@ -27,17 +29,17 @@ public ParserAttribute(string parserMethodName)
     }
 
     /// <summary>
-    /// Specifies a custom parser method for a field of an input object in a GraphQL schema using the 'Parser' method from a specified type.
+    /// Specifies a custom parser method for a field of an input object in a GraphQL schema using the 'Parse' method from a specified type.
     /// The method must exist on the specified type and must be static and public.
-    /// The method must have the signature 'object Parser(object value)'.
+    /// The method must have the signature 'object Parse(object value)'.
     /// </summary>
     public ParserAttribute(
         [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)]
         Type parserType)
     {
         _parserType = parserType
             ?? throw new ArgumentNullException(nameof(parserType));
-        _parserMethodName = nameof(FieldType.Parser);
+        _parserMethodName = DEFAULT_METHOD_NAME;
     }
 
     /// <summary>

src/GraphQL/Attributes/ValidateArgumentsAttribute.cs

@@ -10,6 +10,8 @@ namespace GraphQL;
 [AttributeUsage(AttributeTargets.Method)]
 public sealed class ValidateArgumentsAttribute : GraphQLAttribute
 {
+    private const string DEFAULT_METHOD_NAME = "ValidateArguments";
+
     [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)]
     private readonly Type? _validationType;
     private readonly string _validationMethodName;
@@ -37,7 +39,7 @@ public ValidateArgumentsAttribute(
     {
         _validationType = validationType
             ?? throw new ArgumentNullException(nameof(validationType));
-        _validationMethodName = nameof(FieldType.ValidateArguments);
+        _validationMethodName = DEFAULT_METHOD_NAME;
     }
 
     /// <summary>

src/GraphQL/Attributes/ValidatorAttribute.cs

@@ -9,6 +9,8 @@ namespace GraphQL;
 [AttributeUsage(AttributeTargets.Parameter | AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = true)]
 public sealed class ValidatorAttribute : GraphQLAttribute
 {
+    private const string DEFAULT_METHOD_NAME = "Validate";
+
     [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)]
     private readonly Type? _validatorType;
     private readonly string _validatorMethodName;
@@ -27,17 +29,17 @@ public ValidatorAttribute(string validatorMethodName)
     }
 
     /// <summary>
-    /// Specifies a custom validator method for a field of an input object in a GraphQL schema using the 'Validator' method from a specified type.
+    /// Specifies a custom validator method for a field of an input object in a GraphQL schema using the 'Validate' method from a specified type.
     /// The method must exist on the specified type and must be static and public.
-    /// The method must have the signature 'void Validator(object value)'.
+    /// The method must have the signature 'void Validate(object value)'.
     /// </summary>
     public ValidatorAttribute(
         [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)]
         Type validatorType)
     {
         _validatorType = validatorType
             ?? throw new ArgumentNullException(nameof(validatorType));
-        _validatorMethodName = nameof(FieldType.Validator);
+        _validatorMethodName = DEFAULT_METHOD_NAME;
     }
 
     /// <summary>