Merge pull request #15 from SpatialFocus/feat/inherited-cachegetterproperty

Support for inherited IMemoryCache property, closes #2

Author: Dresel

SpatialFocus.MethodCache.Fody.sln

@@ -38,6 +38,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SpatialFocus.MethodCache.Sa
 		{81703F57-025F-42C4-AE8B-568E2F56CCE2} = {81703F57-025F-42C4-AE8B-568E2F56CCE2}
 	EndProjectSection
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SpatialFocus.MethodCache.TestAssembly2", "src\SpatialFocus.MethodCache.TestAssembly2\SpatialFocus.MethodCache.TestAssembly2.csproj", "{766C91B4-5753-4B31-9FBF-684D6754D2DA}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -72,6 +74,10 @@ Global
 		{E03D9328-B71F-4451-9956-6D28186F84A7}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E03D9328-B71F-4451-9956-6D28186F84A7}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E03D9328-B71F-4451-9956-6D28186F84A7}.Release|Any CPU.Build.0 = Release|Any CPU
+		{766C91B4-5753-4B31-9FBF-684D6754D2DA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{766C91B4-5753-4B31-9FBF-684D6754D2DA}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{766C91B4-5753-4B31-9FBF-684D6754D2DA}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{766C91B4-5753-4B31-9FBF-684D6754D2DA}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -84,6 +90,7 @@ Global
 		{C47814DC-272E-4FB8-A97C-2B6C75F60C76} = {674F705E-E459-490B-B536-3F750485AE33}
 		{88A8C843-A479-42B8-AAF6-8F816C660515} = {674F705E-E459-490B-B536-3F750485AE33}
 		{E03D9328-B71F-4451-9956-6D28186F84A7} = {674F705E-E459-490B-B536-3F750485AE33}
+		{766C91B4-5753-4B31-9FBF-684D6754D2DA} = {674F705E-E459-490B-B536-3F750485AE33}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {1a3946bb-e6d6-4999-932a-807a80bc0cdb}

src/SpatialFocus.MethodCache.Fody/Extensions/TypeDefinitionExtension.cs

@@ -5,6 +5,7 @@
 namespace SpatialFocus.MethodCache.Fody.Extensions
 {
 	using System;
+	using System.Collections.Generic;
 	using System.Linq;
 	using Mono.Cecil;
 
@@ -39,7 +40,24 @@ public static bool IsEligibleForWeaving(this TypeDefinition typeDefinition, Refe
 				throw new ArgumentNullException(nameof(references));
 			}
 
-			return typeDefinition.Properties.Where(propertyDefinition =>
+			bool isEligibleForWeaving = typeDefinition.TryGetCacheGetterProperty(references)?.Count == 1;
+
+			return isEligibleForWeaving;
+		}
+
+		public static List<PropertyDefinition> TryGetCacheGetterProperty(this TypeDefinition typeDefinition, References references)
+		{
+			if (typeDefinition == null)
+			{
+				throw new ArgumentNullException(nameof(typeDefinition));
+			}
+
+			if (references == null)
+			{
+				throw new ArgumentNullException(nameof(references));
+			}
+
+			List<PropertyDefinition> properties = typeDefinition.Properties.Where(propertyDefinition =>
 				{
 					TypeDefinition propertyTypeDefinition = propertyDefinition.PropertyType.Resolve();
 					TypeDefinition memoryCacheInterface = references.MemoryCacheInterface.Resolve();
@@ -61,7 +79,15 @@ public static bool IsEligibleForWeaving(this TypeDefinition typeDefinition, Refe
 
 					return false;
 				})
-				.Count() == 1;
+				.ToList();
+
+			if (!properties.Any() && typeDefinition.BaseType != null)
+			{
+				TypeDefinition baseTypeDefinition = typeDefinition.BaseType.Resolve();
+				properties = baseTypeDefinition.TryGetCacheGetterProperty(references);
+			}
+
+			return properties;
 		}
 
 		public static CustomAttribute TryGetCacheAttribute(this TypeDefinition typeDefinition, References references)

src/SpatialFocus.MethodCache.Fody/MemoryCache.cs

@@ -51,37 +51,16 @@ public static MethodReference GetCacheGetterMethod(ClassWeavingContext classWeav
 			}
 
 			// TODO: Check if this can be inherited, extract to class level
-			List<PropertyDefinition> propertyDefinitions = classWeavingContext.TypeDefinition.Properties.Where(definition =>
-				{
-					TypeDefinition typeDefinition = definition.PropertyType.Resolve();
-					TypeDefinition memoryCacheInterface = classWeavingContext.References.MemoryCacheInterface.Resolve();
-
-					if (definition.GetMethod.IsStatic)
-					{
-						return false;
-					}
-
-					if (typeDefinition.IsInterface && typeDefinition.Equals(memoryCacheInterface))
-					{
-						return true;
-					}
-
-					if (typeDefinition.Interfaces.Any(x => x.InterfaceType == memoryCacheInterface))
-					{
-						return true;
-					}
-
-					return false;
-				})
-				.ToList();
+			List<PropertyDefinition> propertyDefinitions =
+				classWeavingContext.TypeDefinition.TryGetCacheGetterProperty(classWeavingContext.References);
 
 			// TODO: Also check fields
-			if (propertyDefinitions.Count != 1)
+			if (propertyDefinitions == null || propertyDefinitions.Count != 1)
 			{
-				throw new WeavingException("Property not found");
+				throw new WeavingException("Cache Property not found or multiple properties found.");
 			}
 
-			MethodDefinition methodDefinition = propertyDefinitions.Single().GetMethod;
+			MethodReference methodDefinition = classWeavingContext.TypeDefinition.Module.ImportReference(propertyDefinitions.Single().GetMethod);
 
 			if (methodDefinition.DeclaringType.GenericParameters.Any())
 			{

src/SpatialFocus.MethodCache.Fody/ModuleWeaver.cs

@@ -32,7 +32,7 @@ public override void Execute()
 				if (!weavingCandidate.ClassDefinition.IsEligibleForWeaving(references))
 				{
 					WriteWarning(
-						$"Class {weavingCandidate.ClassDefinition.Name} contains [Cache] attribute but does not contain a single non-inherited property implementing IMemoryCache interface");
+						$"Class {weavingCandidate.ClassDefinition.Name} contains [Cache] attribute but does not contain a single property implementing IMemoryCache interface");
 					continue;
 				}
 

src/SpatialFocus.MethodCache.TestAssembly/DerivedTestClass.cs

@@ -0,0 +1,35 @@
+// <copyright file="DerivedTestClass.cs" company="Spatial Focus GmbH">
+// Copyright (c) Spatial Focus GmbH. All rights reserved.
+// </copyright>
+
+namespace SpatialFocus.MethodCache.TestAssembly
+{
+	using Microsoft.Extensions.Caching.Memory;
+
+	[Cache]
+	public class DerivedTestClass : BaseClass
+	{
+		public DerivedTestClass(IMemoryCache memoryCache) : base(memoryCache)
+		{
+		}
+
+#pragma warning disable CA1822 // Mark members as static
+		public int Add(int a, int b)
+		{
+			return a + b;
+		}
+#pragma warning restore CA1822 // Mark members as static
+	}
+
+#pragma warning disable SA1402 // File may only contain a single type
+	public class BaseClass
+	{
+		public BaseClass(IMemoryCache memoryCache)
+		{
+			MemoryCache = memoryCache;
+		}
+
+		public IMemoryCache MemoryCache { get; }
+	}
+#pragma warning restore SA1402 // File may only contain a single type
+}

src/SpatialFocus.MethodCache.TestAssembly/DerivedTestClass2.cs

@@ -0,0 +1,23 @@
+// <copyright file="DerivedTestClass2.cs" company="Spatial Focus GmbH">
+// Copyright (c) Spatial Focus GmbH. All rights reserved.
+// </copyright>
+
+namespace SpatialFocus.MethodCache.TestAssembly
+{
+	using Microsoft.Extensions.Caching.Memory;
+
+	[Cache]
+	public class DerivedTestClass2 : TestAssembly2.BaseClass
+	{
+		public DerivedTestClass2(IMemoryCache memoryCache) : base(memoryCache)
+		{
+		}
+
+#pragma warning disable CA1822 // Mark members as static
+		public int Add(int a, int b)
+		{
+			return a + b;
+		}
+#pragma warning restore CA1822 // Mark members as static
+	}
+}

src/SpatialFocus.MethodCache.TestAssembly/SpatialFocus.MethodCache.TestAssembly.csproj

@@ -10,6 +10,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
+		<ProjectReference Include="..\SpatialFocus.MethodCache.TestAssembly2\SpatialFocus.MethodCache.TestAssembly2.csproj" />
 		<ProjectReference Include="..\SpatialFocus.MethodCache\SpatialFocus.MethodCache.csproj" />
 	</ItemGroup>
 

src/SpatialFocus.MethodCache.TestAssembly2/BaseClass.cs

@@ -0,0 +1,18 @@
+// <copyright file="BaseClass.cs" company="Spatial Focus GmbH">
+// Copyright (c) Spatial Focus GmbH. All rights reserved.
+// </copyright>
+
+namespace SpatialFocus.MethodCache.TestAssembly2
+{
+	using Microsoft.Extensions.Caching.Memory;
+
+	public class BaseClass
+	{
+		public BaseClass(IMemoryCache memoryCache)
+		{
+			MemoryCache = memoryCache;
+		}
+
+		public IMemoryCache MemoryCache { get; }
+	}
+}

src/SpatialFocus.MethodCache.TestAssembly2/SpatialFocus.MethodCache.TestAssembly2.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<TargetFramework>netstandard2.0</TargetFramework>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="3.1.9" />
+	</ItemGroup>
+
+</Project>

src/SpatialFocus.MethodCache.Tests/MemoryCacheBasicTests.cs

@@ -83,5 +83,33 @@ public void BasicTest4NoCache()
 			Assert.Equal(0, mockMemoryCache.CountSets);
 			Assert.Equal(0, mockMemoryCache.CountGets);
 		}
+
+		[Fact]
+		public void BasicTest5DerivedClass()
+		{
+			using MockMemoryCache mockMemoryCache = MockMemoryCache.Default;
+
+			dynamic instance = TestHelpers.CreateInstance<DerivedTestClass>(MemoryCacheBasicTests.TestResult.Assembly, mockMemoryCache);
+
+			dynamic result = instance.Add(1, 2);
+
+			Assert.Equal(3, result);
+			Assert.Equal(1, mockMemoryCache.CountSets);
+			Assert.Equal(1, mockMemoryCache.CountGets);
+		}
+
+		[Fact]
+		public void BasicTest6DerivedClass()
+		{
+			using MockMemoryCache mockMemoryCache = MockMemoryCache.Default;
+
+			dynamic instance = TestHelpers.CreateInstance<DerivedTestClass2>(MemoryCacheBasicTests.TestResult.Assembly, mockMemoryCache);
+
+			dynamic result = instance.Add(1, 2);
+
+			Assert.Equal(3, result);
+			Assert.Equal(1, mockMemoryCache.CountSets);
+			Assert.Equal(1, mockMemoryCache.CountGets);
+		}
 	}
 }