Merge pull request #25 from appany/0.1.12

Move attemptedValues to extended details

README.md

@@ -15,7 +15,7 @@ This library is a rework of internal package inside @appany
 - Most of extensibility points is just a composable delegates
 - Fine-tuning of validation for each field: conditional validation skipping, multiple validators or error mappers per input
 - Strongly typed `ValidationStrategy<T>` support
-- Basic attribute-based support
+- First-class attribute-based approach support
 
 ## Docs
 
@@ -27,6 +27,7 @@ This library is a rework of internal package inside @appany
   - [Input validators](docs/examples/input-validators.md)
   - [Root validator segregation](docs/examples/root-validator-segregation.md)
   - [Argument level overrides](docs/examples/argument-level-overrides.md)
+  - [Attribute-based approach](docs/examples/attribute-based-approach.md)
 
 ## Usage
 
@@ -36,7 +37,8 @@ services.AddGraphQLServer()
   .AddFluentValidation();
 
 descriptor.Field(x => x.Example(default!))
-  // Explicit over implicit preferred, you have to add .UseFluentValidation() to all arguments requiring validation
+  // Explicit over implicit preferred
+  // You have to add .UseFluentValidation() to all arguments requiring validation
   .Argument("input", argument => argument.UseFluentValidation());
 
 ... Example([UseFluentValidation] ExampleInput input) { ... }
@@ -65,7 +67,7 @@ descriptor.Field(x => x.Example(default!))
       });
   }));
 
-... Example([UseFluentValidation(typeof(ExampleInputValidator))] ExampleInput input) { ... }
+... Example([UseFluentValidation, UseValidator((typeof(ExampleInputValidator))] ExampleInput input) { ... }
 ```
 
 ## Benchmarks

docs/examples/attribute-based-approach.md

@@ -0,0 +1,73 @@
+# Attribute-based approach
+
+Use default input validator
+
+```cs
+... Example([UseFluentValidation] ExampleInput input) { ... }
+```
+
+Use single validator type for single validator
+
+```cs
+... Example([UseFluentValidation, UseValidator(typeof(ExampleInputValidator))] ExampleInput input) { ... }
+```
+
+Use single validator type for multiple validators
+
+```cs
+... Example([UseFluentValidation, UseValidators(typeof(IValidator<ExampleInput>))] ExampleInput input) { ... }
+```
+
+Use validator with custom [validation strategy](validation-strategies.md)
+
+```cs
+... Example([
+  UseFluentValidation,
+  UseValidator(
+    typeof(ExampleInputValidator),
+    IncludeProperties=new[]{"ExampleProperty"},
+    IncludeRuleSets=new[]{"FastValidation"})
+  ] ExampleInput input) { ... }
+```
+
+Use validators with custom [validation strategy](validation-strategies.md)
+
+```cs
+... Example([
+  UseFluentValidation,
+  UseValidators(
+    typeof(ExampleInputValidator),
+    IncludeAllRuleSets=true,
+    IncludeRulesNotInRuleSet=true)
+  ] ExampleInput input) { ... }
+```
+
+Use default [input validator](input-validators.md)
+
+```cs
+... Example([UseFluentValidation, UseDefaultInputValidator)] ExampleInput input) { ... }
+```
+
+Use default [error mapper](error-mappers.md)
+
+```cs
+... Example([UseFluentValidation, UseDefaultErrorMapper)] ExampleInput input) { ... }
+```
+
+Use default [error mapper](error-mappers.md) with details
+
+```cs
+... Example([UseFluentValidation, UseDefaultErrorMapperWithDetails)] ExampleInput input) { ... }
+```
+
+Use default [error mapper](error-mappers.md) with extended details
+
+```cs
+... Example([UseFluentValidation, UseDefaultErrorMapperWithExtendedDetails)] ExampleInput input) { ... }
+```
+
+Skip validation
+
+```cs
+... Example([UseFluentValidation, SkipValidation)] ExampleInput input) { ... }
+```

docs/examples/error-mappers.md

@@ -39,10 +39,10 @@
       "extensions": {
         "code": "ValidationFailed",
         "validator": "NotEmptyValidator",
+        "field": "createUser",
         "argument": "input",
         "property": "Name",
-        "severity": "Error",
-        "attemptedValue": ""
+        "severity": "Error"
       }
     }
   ],
@@ -65,6 +65,7 @@
       "extensions": {
         "code": "ValidationFailed",
         "validator": "NotEmptyValidator",
+        "field": "createUser",
         "argument": "input",
         "property": "Name",
         "severity": "Error",

src/AppAny.HotChocolate.FluentValidation.csproj

@@ -3,7 +3,7 @@
 	<PropertyGroup>
 		<TargetFramework>netstandard2.0</TargetFramework>
 		<Nullable>enable</Nullable>
-		<Version>0.1.11</Version>
+		<Version>0.1.12</Version>
 		<LangVersion>9</LangVersion>
 		<EmbedUntrackedSources>true</EmbedUntrackedSources>
 		<IncludeSymbols>true</IncludeSymbols>
@@ -24,7 +24,7 @@
 	</PropertyGroup>
 
 	<ItemGroup Label="Packages">
-		<PackageReference Include="FluentValidation" Version="9.5.0" />
+		<PackageReference Include="FluentValidation" Version="9.5.1" />
 		<PackageReference Include="HotChocolate.Execution" Version="11.0.9" />
 	</ItemGroup>
 

src/Attributes/BaseUseValidatorAttribute.cs

@@ -0,0 +1,56 @@
+using System;
+using FluentValidation.Internal;
+
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public abstract class BaseUseValidatorAttribute : FluentValidationAttribute
+	{
+		protected BaseUseValidatorAttribute(Type validatorType)
+		{
+			ValidatorType = validatorType;
+		}
+
+		public Type ValidatorType { get; }
+
+		public string[]? IncludeProperties { get; set; }
+		public string[]? IncludeRuleSets { get; set; }
+		public bool IncludeAllRuleSets { get; set; }
+		public bool IncludeRulesNotInRuleSet { get; set; }
+
+		protected Action<ValidationStrategy<object>>? TryGetValidationStrategy()
+		{
+			var shouldUseValidationStrategy = IncludeProperties is not null
+				|| IncludeRuleSets is not null
+				|| IncludeAllRuleSets
+				|| IncludeRulesNotInRuleSet;
+
+			if (shouldUseValidationStrategy)
+			{
+				return strategy =>
+				{
+					if (IncludeProperties is not null)
+					{
+						strategy.IncludeProperties(IncludeProperties);
+					}
+
+					if (IncludeRuleSets is not null)
+					{
+						strategy.IncludeRuleSets(IncludeRuleSets);
+					}
+
+					if (IncludeAllRuleSets)
+					{
+						strategy.IncludeAllRuleSets();
+					}
+
+					if (IncludeRulesNotInRuleSet)
+					{
+						strategy.IncludeRulesNotInRuleSet();
+					}
+				};
+			}
+
+			return null;
+		}
+	}
+}

src/Attributes/FluentValidationAttribute.cs

@@ -0,0 +1,9 @@
+using System;
+
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public abstract class FluentValidationAttribute : Attribute
+	{
+		public abstract void Configure(ArgumentValidationBuilder builder);
+	}
+}

src/Attributes/SkipValidationAttribute.cs

@@ -0,0 +1,10 @@
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class SkipValidationAttribute : FluentValidationAttribute
+	{
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			builder.SkipValidation();
+		}
+	}
+}

src/Attributes/UseDefaultErrorMapperAttribute.cs

@@ -0,0 +1,10 @@
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseDefaultErrorMapperAttribute : FluentValidationAttribute
+	{
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			builder.UseDefaultErrorMapper();
+		}
+	}
+}

src/Attributes/UseDefaultErrorMapperWithDetailsAttribute.cs

@@ -0,0 +1,10 @@
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseDefaultErrorMapperWithDetailsAttribute : FluentValidationAttribute
+	{
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			builder.UseDefaultErrorMapperWithDetails();
+		}
+	}
+}

src/Attributes/UseDefaultErrorMapperWithExtendedDetailsAttribute.cs

@@ -0,0 +1,10 @@
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseDefaultErrorMapperWithExtendedDetailsAttribute : FluentValidationAttribute
+	{
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			builder.UseDefaultErrorMapperWithExtendedDetails();
+		}
+	}
+}

src/Attributes/UseDefaultInputValidatorAttribute.cs

@@ -0,0 +1,10 @@
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseDefaultInputValidatorAttribute : FluentValidationAttribute
+	{
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			builder.UseDefaultInputValidator();
+		}
+	}
+}

src/UseFluentValidationAttribute.cs → src/Attributes/UseFluentValidationAttribute.cs

@@ -12,23 +12,18 @@ namespace AppAny.HotChocolate.FluentValidation
 	[AttributeUsage(AttributeTargets.Parameter)]
 	public sealed class UseFluentValidationAttribute : ArgumentDescriptorAttribute
 	{
-		private readonly Type[] validators;
-
-		public UseFluentValidationAttribute(params Type[] validators)
-		{
-			this.validators = validators;
-		}
-
 		public override void OnConfigure(
 			IDescriptorContext context,
 			IArgumentDescriptor descriptor,
 			ParameterInfo parameter)
 		{
+			var fluentValidationAttributes = parameter.GetCustomAttributes<FluentValidationAttribute>();
+
 			descriptor.UseFluentValidation(options =>
 			{
-				foreach (var validator in validators)
+				foreach (var fluentValidationAttribute in fluentValidationAttributes)
 				{
-					options.UseValidator(validator);
+					fluentValidationAttribute.Configure(options);
 				}
 			});
 		}

src/Attributes/UseValidatorAttribute.cs

@@ -0,0 +1,26 @@
+using System;
+
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseValidatorAttribute : BaseUseValidatorAttribute
+	{
+		public UseValidatorAttribute(Type validatorType)
+			: base(validatorType)
+		{
+		}
+
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			var validationStrategy = TryGetValidationStrategy();
+
+			if (validationStrategy is null)
+			{
+				builder.UseValidator(ValidatorType);
+			}
+			else
+			{
+				builder.UseValidator(ValidatorType, validationStrategy);
+			}
+		}
+	}
+}

src/Attributes/UseValidatorsAttribute.cs

@@ -0,0 +1,26 @@
+using System;
+
+namespace AppAny.HotChocolate.FluentValidation
+{
+	public sealed class UseValidatorsAttribute : BaseUseValidatorAttribute
+	{
+		public UseValidatorsAttribute(Type validatorType)
+			: base(validatorType)
+		{
+		}
+
+		public override void Configure(ArgumentValidationBuilder builder)
+		{
+			var validationStrategy = TryGetValidationStrategy();
+
+			if (validationStrategy is null)
+			{
+				builder.UseValidators(ValidatorType);
+			}
+			else
+			{
+				builder.UseValidators(ValidatorType, validationStrategy);
+			}
+		}
+	}
+}