renamed the request handler to use case and added some xml documentation.

Author: lastunicorn

sources/RequestR.Demo/PresentProductsRequestHandler.cs renamed to sources/RequestR.Demo/PresentProductsUseCase.cs

@@ -18,9 +18,9 @@
 
 namespace DustInTheWind.RequestR.Demo
 {
-    internal class PresentProductsRequestHandler : IRequestHandler<PresentProductsRequest, List<Product>>
+    internal class PresentProductsUseCase : IUseCase<PresentProductsRequest, List<Product>>
     {
-        public List<Product> Handle(PresentProductsRequest request)
+        public List<Product> Execute(PresentProductsRequest request)
         {
             return new List<Product>
             {

sources/RequestR.Demo/Program.cs

@@ -25,7 +25,7 @@ private static void Main(string[] args)
         {
             // Setup request bus
             RequestBus requestBus = new RequestBus();
-            requestBus.RegisterHandler<PresentProductsRequestHandler>();
+            requestBus.RegisterUseCase<PresentProductsUseCase>();
 
             // Send request
             PresentProductsRequest request = new PresentProductsRequest();

sources/RequestR/AssemblyExtensions.cs

@@ -21,57 +21,83 @@
 
 namespace DustInTheWind.RequestR
 {
+    /// <summary>
+    /// Contains extension methods for the <see cref="Assembly"/> type.
+    /// </summary>
     public static class AssemblyExtensions
     {
-        public static IEnumerable<Type> GetAllRequestHandlersOrValidators(this Assembly assembly)
+        /// <summary>
+        /// Enumerates all the types that implement the one of the interfaces: <see cref="IUseCase{TRequest}"/>,
+        /// <see cref="IUseCase{TRequest, TResponse}"/>, <see cref="IUseCaseAsync{TRequest}"/>,
+        /// <see cref="IUseCaseAsync{TRequest, TResponse}"/> or <see cref="IRequestValidator{TRequest}"/>.
+        /// </summary>
+        /// <param name="assembly">The assembly to be searched.</param>
+        /// <returns>An enumeration of <see cref="Type"/> objects representing the use case and request validator classes.</returns>
+        public static IEnumerable<Type> GetAllUseCasesAndRequestValidators(this Assembly assembly)
         {
             if (assembly == null) throw new ArgumentNullException(nameof(assembly));
 
             Type[] handlerOrValidatorTypes = assembly.GetTypes()
                 .Where(x => x.IsClass && !x.IsAbstract)
-                .Where(x => x.GetInterfaces().Any(IsRequestHandlerOrValidatorInterface))
+                .Where(x => x.GetInterfaces().Any(IsUseCaseOrValidatorInterface))
                 .ToArray();
 
             foreach (Type handlerOrValidatorType in handlerOrValidatorTypes)
                 yield return handlerOrValidatorType;
         }
 
-        private static bool IsRequestHandlerOrValidatorInterface(Type type)
+        private static bool IsUseCaseOrValidatorInterface(Type type)
         {
             if (!type.IsGenericType)
                 return false;
 
             Type genericTypeDefinition = type.GetGenericTypeDefinition();
 
-            return genericTypeDefinition == typeof(IRequestHandler<,>) ||
-                   genericTypeDefinition == typeof(IRequestHandler<>) ||
+            return genericTypeDefinition == typeof(IUseCase<,>) ||
+                   genericTypeDefinition == typeof(IUseCase<>) ||
+                   genericTypeDefinition == typeof(IUseCaseAsync<,>) ||
+                   genericTypeDefinition == typeof(IUseCaseAsync<>) ||
                    genericTypeDefinition == typeof(IRequestValidator<>);
         }
 
-        public static IEnumerable<Type> GetAllRequestHandlers(this Assembly assembly)
+        /// <summary>
+        /// Enumerates all the types that implement the one of the interfaces: <see cref="IUseCase{TRequest}"/>,
+        /// <see cref="IUseCase{TRequest, TResponse}"/>, <see cref="IUseCaseAsync{TRequest}"/> or
+        /// <see cref="IUseCaseAsync{TRequest, TResponse}"/>.
+        /// </summary>
+        /// <param name="assembly">The assembly to be searched.</param>
+        /// <returns>An enumeration of <see cref="Type"/> objects representing the use case classes.</returns>
+        public static IEnumerable<Type> GetAllUseCases(this Assembly assembly)
         {
             if (assembly == null) throw new ArgumentNullException(nameof(assembly));
 
             Type[] handlerOrValidatorTypes = assembly.GetTypes()
                 .Where(x => x.IsClass && !x.IsAbstract)
-                .Where(x => x.GetInterfaces().Any(IsRequestHandlerInterface))
+                .Where(x => x.GetInterfaces().Any(IsUseCaseInterface))
                 .ToArray();
 
             foreach (Type handlerOrValidatorType in handlerOrValidatorTypes)
                 yield return handlerOrValidatorType;
         }
 
-        private static bool IsRequestHandlerInterface(Type type)
+        private static bool IsUseCaseInterface(Type type)
         {
             if (!type.IsGenericType)
                 return false;
 
             Type genericTypeDefinition = type.GetGenericTypeDefinition();
 
-            return genericTypeDefinition == typeof(IRequestHandler<,>) ||
-                   genericTypeDefinition == typeof(IRequestHandler<>);
+            return genericTypeDefinition == typeof(IUseCase<,>) ||
+                   genericTypeDefinition == typeof(IUseCase<>) ||
+                   genericTypeDefinition == typeof(IUseCaseAsync<,>) ||
+                   genericTypeDefinition == typeof(IUseCaseAsync<>);
         }
 
+        /// <summary>
+        /// Enumerates all the types that implement the <see cref="IRequestValidator{TRequest}"/> interface.
+        /// </summary>
+        /// <param name="assembly">The assembly to be searched.</param>
+        /// <returns>An enumeration of <see cref="Type"/> objects representing the request validator classes.</returns>
         public static IEnumerable<Type> GetAllRequestValidators(this Assembly assembly)
         {
             if (assembly == null) throw new ArgumentNullException(nameof(assembly));

sources/RequestR/ValidationException.cs renamed to sources/RequestR/DefaultUseCaseFactory.cs

@@ -18,11 +18,15 @@
 
 namespace DustInTheWind.RequestR
 {
-    public class ValidationException : Exception
+    /// <summary>
+    /// This default implementation uses the <see cref="Activator"/> class to create use case instances.
+    /// As a result it can create only use cases that provide a parameterless constructor.
+    /// </summary>
+    public class DefaultUseCaseFactory : UseCaseFactoryBase
     {
-        public ValidationException(string message)
-            : base(message)
+        protected override object CreateInternal(Type type)
         {
+            return Activator.CreateInstance(type);
         }
     }
 }