feat(UIComponent): remove GetTypeName method

BREAKING CHANGE: UIComponent's GetTypeName method has been removed as it was unnecessary. Use GetType().Name instead.
jonisavo · Oct 23, 2022 · 1f7343a · 1f7343a
1 parent 5749d0f
commit 1f7343a
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 29 deletions.
diff --git a/Assets/UIComponents.Tests/UIComponentTests.cs b/Assets/UIComponents.Tests/UIComponentTests.cs
@@ -182,18 +182,5 @@ public void Bare_Component_Initializes_Synchronously()
                 Assert.That(component.Initialized, Is.True);
             }
         }
-
-        [TestFixture]
-        public partial class GetTypeName
-        {
-            private partial class TestComponent : UIComponent {}
-
-            [Test]
-            public void ShouldReturnTypeName()
-            {
-                var component = new TestComponent();
-                Assert.That(nameof(TestComponent), Is.EqualTo(component.GetTypeName()));
-            }
-        }
     }
 }
diff --git a/Assets/UIComponents/Core/UIComponent.cs b/Assets/UIComponents/Core/UIComponent.cs
@@ -20,9 +20,9 @@ namespace UIComponents
     /// <seealso cref="StylesheetAttribute"/>
     /// <seealso cref="DependencyAttribute"/>
     /// <seealso cref="ResourcesAssetResolver"/>
-    /// <seealso cref="UIComponentDebugLogger"/>
+    /// <seealso cref="DebugLogger"/>
     [Dependency(typeof(IAssetResolver), provide: typeof(ResourcesAssetResolver))]
-    [Dependency(typeof(IUIComponentLogger), provide: typeof(UIComponentDebugLogger))]
+    [Dependency(typeof(ILogger), provide: typeof(DebugLogger))]
     public abstract class UIComponent : VisualElement
     {
         /// <summary>
@@ -42,10 +42,10 @@ public abstract class UIComponent : VisualElement
         public Task<UIComponent> InitializationTask => _initCompletionSource.Task;
 
         /// <summary>
-        /// The IUIComponentLogger used by this UIComponent.
-        /// Defaults to <see cref="UIComponentDebugLogger"/>.
+        /// The logger used by this UIComponent.
+        /// Defaults to <see cref="DebugLogger"/>.
         /// </summary>
-        protected readonly IUIComponentLogger Logger;
+        protected readonly ILogger Logger;
 
         private readonly DependencyInjector _dependencyInjector;
 
@@ -70,7 +70,7 @@ protected UIComponent()
 
             _dependencyInjector = DiContext.Current.GetInjector(_componentType);
             AssetResolver = Provide<IAssetResolver>();
-            Logger = Provide<IUIComponentLogger>();
+            Logger = Provide<ILogger>();
             UIC_PopulateProvideFields();
 
             DependencySetupProfilerMarker.End();
@@ -179,15 +179,6 @@ public IEnumerator WaitForInitializationEnumerator()
             yield return _initCompletionSource.Task.AsEnumerator();
         }
 
-        /// <summary>
-        /// Returns the component's type's name.
-        /// </summary>
-        /// <returns>Type name</returns>
-        public string GetTypeName()
-        {
-            return _componentType.Name;
-        }
-
         /// <summary>
         /// Returns a dependency. Throws a <see cref="MissingProviderException"/>
         /// if the dependency can not be provided.

diff --git a/Assets/UIComponents/Testing/TestBed.cs b/Assets/UIComponents/Testing/TestBed.cs
@@ -99,7 +99,7 @@ public async Task<TComponent> CreateComponentAsync<TComponent>(Func<TComponent>
             var task = await Task.WhenAny(initTask, timeoutTask);
 
             if (task == timeoutTask)
-                throw new TestBedTimeoutException(component.GetTypeName(), (int) AsyncTimeout.TotalMilliseconds);
+                throw new TestBedTimeoutException(component.GetType().Name, (int) AsyncTimeout.TotalMilliseconds);
 
             var initializedComponent = await initTask;