Layer SubstituteForBuilder on top of AutoSubstituteBuilder (#48)

twsouthwick · web-flow · commit 3f4264dfc2c1 · 2020-10-06T07:19:25.000-07:00
This greatly simplifies some of the registration code as now there is no need to call .Configure(...) or .Configured() to continue registering other types. Since .Configured() was never released publicly, this is now removed, while .Configure(...) is obsoleted with a new API .ConfigureSubsitute introduced which returns the current SubstituteForBuilder.

The new succinct syntax is much more fluid, and doesn't break currently built tests.
diff --git a/AutofacContrib.NSubstitute.Tests/AutoSubstituteOptionsFixture.cs b/AutofacContrib.NSubstitute.Tests/AutoSubstituteOptionsFixture.cs
@@ -113,7 +113,7 @@ public void InternalConstructorSucceeds()
         public void BaseCalledByDefault()
         {
             using var mock = AutoSubstitute.Configure()
-                .SubstituteForPartsOf<ClassWithBase>().Configured()
+                .SubstituteForPartsOf<ClassWithBase>()
                 .Build()
                 .Container;
 
@@ -124,7 +124,7 @@ public void BaseCalledByDefault()
         public void BaseCallDisabled()
         {
             using var mock = AutoSubstitute.Configure()
-                .SubstituteForPartsOf<ClassWithBase>().DoNotCallBase().Configured()
+                .SubstituteForPartsOf<ClassWithBase>().DoNotCallBase()
                 .Build()
                 .Container;
 
diff --git a/AutofacContrib.NSubstitute.Tests/ExampleFixture.cs b/AutofacContrib.NSubstitute.Tests/ExampleFixture.cs
@@ -1,7 +1,7 @@
 ﻿using Autofac;
 using NSubstitute;
-using NSubstitute.Extensions;
 using NUnit.Framework;
+using System;
 
 namespace AutofacContrib.NSubstitute.Tests
 {
@@ -167,16 +167,15 @@ public void Example_test_with_concrete_object_provided()
         }
 
         [Test]
+        [Obsolete]
         public void Example_test_with_substitute_for_concrete_resolved_from_autofac()
         {
             const int val1 = 2;
             const int val2 = 3;
             const int val3 = 4;
 
-#pragma warning disable CS0618 // Type or member is obsolete
             using var mock = AutoSubstitute.Configure()
                 .ResolveAndSubstituteFor<ConcreteClassWithDependency>(new TypedParameter(typeof(int), val1))
-#pragma warning restore CS0618 // Type or member is obsolete
                 .Build();
 
             mock.Resolve<IDependency2>().SomeOtherMethod().Returns(val2);
diff --git a/AutofacContrib.NSubstitute.Tests/SubstituteForFixture.cs b/AutofacContrib.NSubstitute.Tests/SubstituteForFixture.cs
@@ -10,7 +10,8 @@ namespace AutofacContrib.NSubstitute.Tests
     public class SubstituteForFixture
     {
         [Test]
-        public void Example_test_with_substitute_for_concrete()
+        [Obsolete]
+        public void Example_test_with_substitute_for_concrete_obsolete()
         {
             const int val1 = 3;
             const int val2 = 2;
@@ -27,14 +28,32 @@ public void Example_test_with_substitute_for_concrete()
             Assert.That(result, Is.EqualTo(val3));
         }
 
+        [Test]
+        public void Example_test_with_substitute_for_concrete()
+        {
+            const int val1 = 3;
+            const int val2 = 2;
+            const int val3 = 10;
+
+            using var utoSubstitute = AutoSubstitute.Configure()
+                .SubstituteFor<ConcreteClass>(val2).ConfigureSubstitute(c => c.Add(Arg.Any<int>()).Returns(val3))
+                .Build();
+
+            utoSubstitute.Resolve<IDependency2>().SomeOtherMethod().Returns(val1);
+
+            var result = utoSubstitute.Resolve<MyClassWithConcreteDependency>().AMethod();
+
+            Assert.That(result, Is.EqualTo(val3));
+        }
+
         [Test]
         public void SubstituteForConfigureWithContext()
         {
             const int val = 2;
 
             using var utoSubstitute = AutoSubstitute.Configure()
-                .SubstituteFor<ConcreteClass>(val).Configured()
-                .SubstituteFor<ConcreteClassWithObject>().Configure((s, ctx) =>
+                .SubstituteFor<ConcreteClass>(val)
+                .SubstituteFor<ConcreteClassWithObject>().ConfigureSubstitute((s, ctx) =>
                 {
                     s.Configure().GetResult().Returns(ctx.Resolve<ConcreteClass>());
                 })
@@ -50,7 +69,7 @@ public void SubstituteForConfigureWithContext()
         public void BaseCalledOnSubstituteForPartsOf()
         {
             using var mock = AutoSubstitute.Configure()
-                .SubstituteForPartsOf<Test1>().Configured()
+                .SubstituteForPartsOf<Test1>()
                 .Build();
 
             var test1 = mock.Resolve<Test1>();
@@ -63,7 +82,7 @@ public void BaseCalledOnSubstituteForPartsOf()
         public void BaseNotCalledOnSubstituteFor()
         {
             using var mock = AutoSubstitute.Configure()
-                .SubstituteFor<Test1>().Configured()
+                .SubstituteFor<Test1>()
                 .Build();
 
             var test1 = mock.Resolve<Test1>();
@@ -76,7 +95,7 @@ public void BaseNotCalledOnSubstituteFor()
         public void FailsIfSubstituteTypeIsChanged()
         {
             var builder = AutoSubstitute.Configure()
-                .SubstituteFor<Test1>().Configured();
+                .SubstituteFor<Test1>();
 
             Assert.Throws<InvalidOperationException>(() => builder.SubstituteForPartsOf<Test1>());
         }
@@ -85,7 +104,7 @@ public void FailsIfSubstituteTypeIsChanged()
         public void FailsIfSubstituteTypeIsChanged2()
         {
             var builder = AutoSubstitute.Configure()
-                .SubstituteForPartsOf<Test1>().Configured();
+                .SubstituteForPartsOf<Test1>();
 
             Assert.Throws<InvalidOperationException>(() => builder.SubstituteFor<Test1>());
         }
@@ -95,7 +114,7 @@ public void PropertiesNotSetByDefault()
         {
             using var mock = AutoSubstitute.Configure()
                 .Provide<IProperty, CustomProperty>(out _)
-                .SubstituteFor<TestWithProperty>().Configured()
+                .SubstituteFor<TestWithProperty>()
                 .Build();
 
             Assert.IsNull(mock.Resolve<TestWithProperty>().PropertySetter);
@@ -109,7 +128,6 @@ public void PropertiesSetIfRequested()
                 .Provide<IProperty, CustomProperty>(out var property)
                 .SubstituteFor<TestWithProperty>()
                     .InjectProperties()
-                    .Configured()
                 .Build();
 
             Assert.AreEqual(property.Value, mock.Resolve<TestWithProperty>().PropertySetter);
@@ -122,7 +140,7 @@ public void PropertiesSetIfGloballyRequested()
             using var mock = AutoSubstitute.Configure()
                 .InjectProperties()
                 .Provide<IProperty, CustomProperty>(out var property)
-                .SubstituteFor<TestWithProperty>().Configured()
+                .SubstituteFor<TestWithProperty>()
                 .Build();
 
             Assert.AreEqual(property.Value, mock.Resolve<TestWithProperty>().PropertySetter);
diff --git a/AutofacContrib.NSubstitute/AutoSubstituteBuilder.cs b/AutofacContrib.NSubstitute/AutoSubstituteBuilder.cs
@@ -14,13 +14,28 @@ public class AutoSubstituteBuilder
         private readonly ContainerBuilder _builder;
         private readonly AutoSubstituteOptions _options;
 
+        /// <summary>
+        /// Create a new instance of the builder.
+        /// </summary>
         public AutoSubstituteBuilder()
         {
             _substituteForRegistrations = new Dictionary<Type, object>();
             _afterBuildActions = new List<Action<IComponentContext>>();
             _builder = new ContainerBuilder();
             _options = new AutoSubstituteOptions();
         }
+       
+        /// <summary>
+        /// Creates a new instance that allows linking to the previous instance for derived builders.
+        /// </summary>
+        /// <param name="other">A <see cref="AutoSubstituteBuilder"/> that should be connected to this instance</param>
+        private protected AutoSubstituteBuilder(AutoSubstituteBuilder other)
+        {
+            _substituteForRegistrations = other._substituteForRegistrations;
+            _afterBuildActions = other._afterBuildActions;
+            _builder = other._builder;
+            _options = other._options;
+        }
 
         /// <summary>
         /// Builds an <see cref="AutoSubstitute"/> from the current builder.
@@ -274,7 +289,7 @@ private SubstituteForBuilder<TService> CreateSubstituteForBuilder<TService>(Func
             return builder;
         }
 
-        internal IProvidedValue<TService> CreateProvidedValue<TService>(Func<IComponentContext, TService> factory)
+        private protected IProvidedValue<TService> CreateProvidedValue<TService>(Func<IComponentContext, TService> factory)
         {
             var value = new ProvidedValue<TService>(factory);
 
diff --git a/AutofacContrib.NSubstitute/SubstituteForBuilder.cs b/AutofacContrib.NSubstitute/SubstituteForBuilder.cs
@@ -2,25 +2,25 @@
 using Autofac.Builder;
 using NSubstitute.Core;
 using System;
+using System.ComponentModel;
 
 namespace AutofacContrib.NSubstitute
 {
     /// <summary>
     /// A class to configure substituted services.
     /// </summary>
     /// <typeparam name="TService">The type of the substituted service.</typeparam>
-    public class SubstituteForBuilder<TService>
+    public class SubstituteForBuilder<TService> : AutoSubstituteBuilder
         where TService : class
     {
-        private readonly AutoSubstituteBuilder _builder;
         private readonly IRegistrationBuilder<TService, SimpleActivatorData, SingleRegistrationStyle> _registration;
 
         internal SubstituteForBuilder(
             AutoSubstituteBuilder builder,
             IRegistrationBuilder<TService, SimpleActivatorData, SingleRegistrationStyle> registration,
             bool isSubstituteFor)
+            : base(builder)
         {
-            _builder = builder;
             _registration = registration;
             IsSubstituteFor = isSubstituteFor;
         }
@@ -37,28 +37,32 @@ internal SubstituteForBuilder(
         /// </summary>
         /// <param name="action">The delegate to configure the service.</param>
         /// <returns>The original <see cref="AutoSubstituteBuilder"/>.</returns>
+        [Obsolete("Use ConfigureSubstitute instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public AutoSubstituteBuilder Configure(Action<TService> action)
-            => Configure((s, _) => action(s));
+            => ConfigureSubstitute((s, _) => action(s));
+
+        /// <summary>
+        /// Allows for configuration of the service.
+        /// </summary>
+        /// <param name="action">The delegate to configure the service.</param>
+        /// <returns>The original <see cref="AutoSubstituteBuilder"/>.</returns>
+        public SubstituteForBuilder<TService> ConfigureSubstitute(Action<TService> action)
+            => ConfigureSubstitute((s, _) => action(s));
 
         /// <summary>
         /// Allows for configuration of the service with access to the resolved components.
         /// </summary>
         /// <param name="action">The delegate to configure the service.</param>
         /// <returns>The original <see cref="AutoSubstituteBuilder"/>.</returns>
-        public AutoSubstituteBuilder Configure(Action<TService, IComponentContext> action)
+        public SubstituteForBuilder<TService> ConfigureSubstitute(Action<TService, IComponentContext> action)
         {
             _registration.OnActivated(args =>
             {
                 action(args.Instance, args.Context.Resolve<IComponentContext>());
             });
 
-            return _builder;
+            return this;
         }
-
-        /// <summary>
-        /// Completes the configuration of the substitute.
-        /// </summary>
-        /// <returns>The original <see cref="AutoSubstituteBuilder"/>.</returns>
-        public AutoSubstituteBuilder Configured() => _builder;
     }
 }
diff --git a/AutofacContrib.NSubstitute/SubstituteForBuilderExtensions.cs b/AutofacContrib.NSubstitute/SubstituteForBuilderExtensions.cs
@@ -13,27 +13,19 @@ public static class SubstituteForBuilderExtensions
         /// <returns></returns>
         public static SubstituteForBuilder<T> DoNotCallBase<T>(this SubstituteForBuilder<T> builder)
             where T : class
-        {
-            builder.Configure(t =>
+            => builder.ConfigureSubstitute(t =>
             {
                 var router = SubstitutionContext.Current.GetCallRouterFor(t);
 
                 router.CallBaseByDefault = false;
             });
 
-            return builder;
-        }
-
         public static SubstituteForBuilder<T> InjectProperties<T>(this SubstituteForBuilder<T> builder)
             where T : class
-        {
-            builder.Configure((t, ctx) =>
+            => builder.ConfigureSubstitute((t, ctx) =>
             {
                 ctx.InjectUnsetProperties(t);
                 AutoPropertyInjectorMockHandler.Instance.OnMockCreated(t, typeof(T), ctx, builder.Context);
             });
-
-            return builder;
-        }
     }
 }
diff --git a/README.md b/README.md
@@ -164,7 +164,7 @@ public void Example_test_with_substitute_for_concrete()
     const int val2 = 2;
     const int val3 = 10;
     using var autoSubstitute = AutoSubstitute.Configure()
-        .SubstituteFor<ConcreteClass>(val2).Configure(c => c.Add(Arg.Any<int>()).Returns(val3))
+        .SubstituteFor<ConcreteClass>(val2).ConfigureSubstitute(c => c.Add(Arg.Any<int>()).Returns(val3))
         .Build();
     autoSubstitute.Resolve<IDependency2>().SomeOtherMethod().Returns(val1);
 
@@ -183,8 +183,8 @@ public void SubstituteForConfigureWithContext()
 	const int val = 2;
 
 	using var utoSubstitute = AutoSubstitute.Configure()
-		.SubstituteFor<ConcreteClass>(val).Configured()
-		.SubstituteFor<ConcreteClassWithObject>().Configure((s, ctx) =>
+		.SubstituteFor<ConcreteClass>(val)
+		.SubstituteFor<ConcreteClassWithObject>().ConfigureSubstitute((s, ctx) =>
 		{
 			s.Configure().GetResult().Returns(ctx.Resolve<ConcreteClass>());
 		})
@@ -209,7 +209,7 @@ public abstract class Test1
 public void BaseCalledOnSubstituteForPartsOf()
 {
     using var mock = AutoSubstitute.Configure()
-        .SubstituteForPartsOf<Test1>().Configured()
+        .SubstituteForPartsOf<Test1>()
         .Build();
 
     var test1 = mock.Resolve<Test1>();
@@ -230,7 +230,7 @@ public abstract class Test1
 public void BaseCalledOnSubstituteForPartsOf()
 {
     using var mock = AutoSubstitute.Configure()
-        .SubstituteForPartsOf<Test1>().DoNotCallBase().Configured()
+        .SubstituteForPartsOf<Test1>().DoNotCallBase()
         .Build();
 
     var test1 = mock.Resolve<Test1>();
@@ -249,7 +249,6 @@ public void PropertiesSetIfRequested()
 		.Provide<IProperty, CustomProperty>(out var property)
 		.SubstituteFor<TestWithProperty>()
 			.InjectProperties()
-			.Configured()
 		.Build();
 
 	Assert.AreEqual(property.Value, mock.Resolve<TestWithProperty>().PropertySetter);
@@ -262,7 +261,7 @@ public void PropertiesSetIfGloballyRequested()
 	using var mock = AutoSubstitute.Configure()
 		.InjectProperties()
 		.Provide<IProperty, CustomProperty>(out var property)
-		.SubstituteFor<TestWithProperty>().Configured()
+		.SubstituteFor<TestWithProperty>()
 		.Build();
 
 	Assert.AreEqual(property.Value, mock.Resolve<TestWithProperty>().PropertySetter);
