Added view component descriptor cache (#66)

Author: ivaylokenov

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/Caching/ControllerActionDescriptorCache.cs

@@ -15,7 +15,7 @@ public class ControllerActionDescriptorCache : IControllerActionDescriptorCache
     {
         private static readonly ConcurrentDictionary<MethodInfo, ControllerActionDescriptor> Cache =
             new ConcurrentDictionary<MethodInfo, ControllerActionDescriptor>();
-
+        
         /// <summary>
         /// Initializes a new instance of the <see cref="ControllerActionDescriptorCache"/> class.
         /// </summary>
@@ -25,16 +25,12 @@ public ControllerActionDescriptorCache(IActionDescriptorCollectionProvider provi
             this.PrepareCache(provider);
         }
 
-        /// <summary>
-        /// Gets the controller action descriptor for the provided method info.
-        /// </summary>
-        /// <param name="methodInfo">Method info of the controller action descriptor to get.</param>
-        /// <returns>Controller action descriptor.</returns>
+        /// <inheritdoc />
         public ControllerActionDescriptor GetActionDescriptor(MethodInfo methodInfo)
         {
             if (!Cache.Any())
             {
-                throw new InvalidOperationException("Controller actions could not be found by the MVC application. Controllers may need to be added as services by calling 'AddMvc().AddControllersAsServices()' or 'AddMvcControllersAsServices()' on the service collection.");
+                throw new InvalidOperationException("Controller actions could not be found by the MVC application. Controllers may need to be added as services by calling 'AddMvc().AddControllersAsServices()' on the service collection. You may also add the external controllers assembly as an application part by calling 'AddMvc().AddApplicationPart()'.");
             }
 
             return this.TryGetActionDescriptor(methodInfo);

src/MyTested.AspNetCore.Mvc.Abstractions/Internal/Contracts/IControllerActionDescriptorCache.cs

@@ -4,7 +4,7 @@
     using Microsoft.AspNetCore.Mvc.Controllers;
 
     /// <summary>
-    /// Caches controller action descriptors by MethodInfo.
+    /// Caches controller action descriptors by <see cref="MethodInfo"/>.
     /// </summary>
     public interface IControllerActionDescriptorCache
     {

src/MyTested.AspNetCore.Mvc.ViewComponents/Builders/Contracts/Invocations/IViewComponentResultTestBuilder.cs

@@ -0,0 +1,6 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Contracts.Invocations
+{
+    public interface IViewComponentResultTestBuilder<TInvocationResult>
+    {
+    }
+}

src/MyTested.AspNetCore.Mvc.ViewComponents/Builders/Invocations/ViewComponentResultTestBuilder.cs

@@ -0,0 +1,15 @@
+namespace MyTested.AspNetCore.Mvc.Builders.Invocations
+{
+    using Base;
+    using Contracts.Invocations;
+    using Internal.TestContexts;
+
+    public class ViewComponentResultTestBuilder<TInvocationResult> : BaseTestBuilderWithViewComponent, 
+        IViewComponentResultTestBuilder<TInvocationResult>
+    {
+        public ViewComponentResultTestBuilder(ViewComponentTestContext testContext)
+            : base(testContext)
+        {
+        }
+    }
+}

src/MyTested.AspNetCore.Mvc.ViewComponents/Builders/ViewComponents/ViewComponentInvocationBuilder.cs

@@ -1,10 +1,28 @@
 namespace MyTested.AspNetCore.Mvc.Builders.ViewComponents
 {
+    using System;
     using System.Linq.Expressions;
     using System.Reflection;
+    using System.Threading.Tasks;
+    using Contracts.Invocations;
+    using Invocations;
 
     public partial class ViewComponentBuilder<TViewComponent>
     {
+        /// <inheritdoc />
+        public IViewComponentResultTestBuilder<TActionResult> InvokedWith<TActionResult>(Expression<Func<TViewComponent, TActionResult>> actionCall)
+        {
+            this.Invoke(actionCall);
+            return new ViewComponentResultTestBuilder<TActionResult>(this.TestContext);
+        }
+
+        /// <inheritdoc />
+        public IViewComponentResultTestBuilder<TActionResult> InvokedWith<TActionResult>(Expression<Func<TViewComponent, Task<TActionResult>>> actionCall)
+        {
+            this.Invoke(actionCall);
+            return new ViewComponentResultTestBuilder<TActionResult>(this.TestContext);
+        }
+
         protected override void ProcessAndValidateMethod(LambdaExpression methodCall, MethodInfo methodInfo)
         {
         }

src/MyTested.AspNetCore.Mvc.ViewComponents/Internal/Caching/ViewComponentDescriptorCache.cs

@@ -0,0 +1,53 @@
+namespace MyTested.AspNetCore.Mvc.Internal.Caching
+{
+    using System;
+    using System.Collections.Concurrent;
+    using System.Linq;
+    using System.Reflection;
+    using Contracts;
+    using Microsoft.AspNetCore.Mvc.ViewComponents;
+
+    /// <summary>
+    /// Caches view component descriptors by <see cref="MethodInfo"/>.
+    /// </summary>
+    public class ViewComponentDescriptorCache : IViewComponentDescriptorCache
+    {
+        private static readonly ConcurrentDictionary<MethodInfo, ViewComponentDescriptor> Cache =
+            new ConcurrentDictionary<MethodInfo, ViewComponentDescriptor>();
+        
+        public ViewComponentDescriptorCache(IViewComponentDescriptorCollectionProvider provider)
+        {
+            this.PrepareCache(provider);
+        }
+
+        /// <inheritdoc />
+        public ViewComponentDescriptor GetViewComponentDescriptor(MethodInfo methodInfo)
+        {
+            if (!Cache.Any())
+            {
+                throw new InvalidOperationException("View components could not be found by the MVC application. View components may need to be added as services by calling 'AddMvc().AddViewComponentsAsServices()' on the service collection. You may also add the external view components assembly as an application part by calling 'AddMvc().AddApplicationPart()'.");
+            }
+
+            return this.TryGetViewComponentDescriptor(methodInfo);
+        }
+
+        /// <inheritdoc />
+        public ViewComponentDescriptor TryGetViewComponentDescriptor(MethodInfo methodInfo)
+        {
+            ViewComponentDescriptor viewComponentDescriptor = null;
+            Cache.TryGetValue(methodInfo, out viewComponentDescriptor);
+
+            return viewComponentDescriptor;
+        }
+
+        private void PrepareCache(IViewComponentDescriptorCollectionProvider provider)
+        {
+            var viewComponentDescriptors = provider.ViewComponents.Items;
+
+            foreach (var descriptor in viewComponentDescriptors)
+            {
+                Cache.TryAdd(descriptor.MethodInfo, descriptor);
+            }
+        }
+    }
+}

src/MyTested.AspNetCore.Mvc.ViewComponents/Internal/Contracts/IViewComponentDescriptorCache.cs

@@ -0,0 +1,20 @@
+namespace MyTested.AspNetCore.Mvc.Internal.Contracts
+{
+    using Microsoft.AspNetCore.Mvc.ViewComponents;
+    using System.Reflection;
+
+    /// <summary>
+    /// Caches view component descriptors by <see cref="MethodInfo"/>.
+    /// </summary>
+    public interface IViewComponentDescriptorCache
+    {
+        /// <summary>
+        /// Gets the view component descriptor for the provided method info.
+        /// </summary>
+        /// <param name="methodInfo">Method info of the view component descriptor to get.</param>
+        /// <returns>View component descriptor.</returns>
+        ViewComponentDescriptor GetViewComponentDescriptor(MethodInfo methodInfo);
+
+        ViewComponentDescriptor TryGetViewComponentDescriptor(MethodInfo methodInfo);
+    }
+}

src/MyTested.AspNetCore.Mvc.ViewComponents/ServiceCollectionViewComponentsExtensions.cs

@@ -1,5 +1,6 @@
 namespace MyTested.AspNetCore.Mvc
 {
+    using Internal.Caching;
     using Internal.Contracts;
     using Internal.ViewComponents;
     using Microsoft.Extensions.DependencyInjection;
@@ -13,6 +14,7 @@ public static IServiceCollection AddViewComponentsTesting(this IServiceCollectio
             CommonValidator.CheckForNullReference(serviceCollection, nameof(serviceCollection));
 
             serviceCollection.TryAddSingleton<IViewComponentPropertyActivator, ViewComponentPropertyActivator>();
+            serviceCollection.TryAddSingleton<IViewComponentDescriptorCache, ViewComponentDescriptorCache>();
 
             return serviceCollection;
         }