Merge pull request #712 from Geminior/allow-scope-naming-on-create

Allow scope naming on create
hadashiA · Nov 3, 2024 · e1e3bdd · e1e3bdd
2 parents 931849c + e1850af
commit e1e3bdd
Show file tree

Hide file tree

Showing 2 changed files with 67 additions and 12 deletions.
diff --git a/VContainer/Assets/Tests/Unity/LifetimeScopeTest.cs b/VContainer/Assets/Tests/Unity/LifetimeScopeTest.cs
@@ -1,4 +1,5 @@
 using System.Collections;
+using System.Linq;
 using UnityEngine;
 using NUnit.Framework;
 using UnityEngine.TestTools;
@@ -225,6 +226,60 @@ public void ParentTypeReference()
             Assert.That(child.Parent, Is.EqualTo(parent));
         }
 
+        [Test]
+        public void CreateWithName()
+        {
+            var names = Enumerable.Range(0, 6).Select(_ => GenerateRandomString()).ToArray();
+
+            var parentScopes = new[]
+            {
+                LifetimeScope.Create(builder => { builder.RegisterEntryPoint<SampleEntryPoint>().AsSelf(); },
+                    names[0]),
+
+                LifetimeScope.Create(
+                    new DummyInstaller(),
+                    names[1])
+            };
+
+            var childScopes = new[]
+            {
+                parentScopes[0].CreateChild(builder => { builder.RegisterEntryPoint<SampleEntryPoint>().AsSelf(); },
+                    names[2]),
+
+                parentScopes[0].CreateChild(
+                new DummyInstaller(),
+                names[3]),
+
+                parentScopes[0].CreateChild<LifetimeScope>(builder => { builder.RegisterEntryPoint<SampleEntryPoint>().AsSelf(); },
+                    names[4]),
+
+                parentScopes[0].CreateChild<LifetimeScope>(
+                    new DummyInstaller(),
+                    names[5])
+            };
+
+            for (var i = 0; i < parentScopes.Length; i++)
+            {
+                Assert.AreEqual(names[i], parentScopes[i].name);
+            }
+
+            for (var i = 0; i < childScopes.Length; i++)
+            {
+                Assert.AreEqual(names[i + parentScopes.Length], childScopes[i].name);
+            }
+        }
+
+        private class DummyInstaller : IInstaller
+        {
+            public void Install(IContainerBuilder builder)
+            {
+                /* NOOP */
+            }
+        }
+
+        private static string GenerateRandomString(int size = 10) =>
+            string.Join(string.Empty, Enumerable.Range(0, size).Select(_ => (char)Random.Range(97, 123)));
+
         // [Test]
         // public void ParentTypeReferenceInvalid()
         // {

diff --git a/VContainer/Assets/VContainer/Runtime/Unity/LifetimeScope.cs b/VContainer/Assets/VContainer/Runtime/Unity/LifetimeScope.cs
@@ -63,9 +63,9 @@ void IDisposable.Dispose()
         static readonly Stack<IInstaller> GlobalExtraInstallers = new Stack<IInstaller>();
         static readonly object SyncRoot = new object();
 
-        static LifetimeScope Create(IInstaller installer = null)
+        public static LifetimeScope Create(IInstaller installer = null, string name = null)
         {
-            var gameObject = new GameObject("LifetimeScope");
+            var gameObject = new GameObject(name ?? "LifetimeScope");
             gameObject.SetActive(false);
             var newScope = gameObject.AddComponent<LifetimeScope>();
             if (installer != null)
@@ -76,8 +76,8 @@ static LifetimeScope Create(IInstaller installer = null)
             return newScope;
         }
 
-        public static LifetimeScope Create(Action<IContainerBuilder> configuration)
-            => Create(new ActionInstaller(configuration));
+        public static LifetimeScope Create(Action<IContainerBuilder> configuration, string name = null)
+            => Create(new ActionInstaller(configuration), name);
 
         public static ParentOverrideScope EnqueueParent(LifetimeScope parent)
             => new ParentOverrideScope(parent);
@@ -226,10 +226,10 @@ void SetContainer(IObjectResolver container)
             AutoInjectAll();
         }
 
-        public TScope CreateChild<TScope>(IInstaller installer = null)
+        public TScope CreateChild<TScope>(IInstaller installer = null, string childScopeName = null)
             where TScope : LifetimeScope
         {
-            var childGameObject = new GameObject("LifetimeScope (Child)");
+            var childGameObject = new GameObject(childScopeName ?? "LifetimeScope (Child)");
             childGameObject.SetActive(false);
             if (IsRoot)
             {
@@ -249,15 +249,15 @@ public TScope CreateChild<TScope>(IInstaller installer = null)
             return child;
         }
 
-        public LifetimeScope CreateChild(IInstaller installer = null)
-            => CreateChild<LifetimeScope>(installer);
+        public LifetimeScope CreateChild(IInstaller installer = null, string childScopeName = null)
+            => CreateChild<LifetimeScope>(installer, childScopeName);
 
-        public TScope CreateChild<TScope>(Action<IContainerBuilder> installation)
+        public TScope CreateChild<TScope>(Action<IContainerBuilder> installation, string childScopeName = null)
             where TScope : LifetimeScope
-            => CreateChild<TScope>(new ActionInstaller(installation));
+            => CreateChild<TScope>(new ActionInstaller(installation), childScopeName);
 
-        public LifetimeScope CreateChild(Action<IContainerBuilder> installation)
-            => CreateChild<LifetimeScope>(new ActionInstaller(installation));
+        public LifetimeScope CreateChild(Action<IContainerBuilder> installation, string childScopeName = null)
+            => CreateChild<LifetimeScope>(new ActionInstaller(installation), childScopeName);
 
         public TScope CreateChildFromPrefab<TScope>(TScope prefab, IInstaller installer = null)
             where TScope : LifetimeScope