Merge pull request #74 from jonisavo/feature/refactor-logger

Rename IUIComponentLogger to ILogger, make it usable by other types

Assets/UIComponents.Tests/UIComponentDebugLoggerTests.cs → Assets/UIComponents.Tests/DebugLoggerTests.cs

@@ -5,19 +5,19 @@
 namespace UIComponents.Tests
 {
     [TestFixture]
-    public class UIComponentDebugLoggerTests
+    public class DebugLoggerTests
     {
         private class TestComponent : UIComponent {}
 
         private TestComponent _testComponent;
 
-        private UIComponentDebugLogger _logger;
+        private DebugLogger _logger;
 
         [SetUp]
         public void SetUp()
         {
             _testComponent = new TestComponent();
-            _logger = new UIComponentDebugLogger();
+            _logger = new DebugLogger();
         }
 
         [Test]

Assets/UIComponents.Tests/ProvideAttributeTests.cs

@@ -40,12 +40,12 @@ private partial class ComponentWithDependencies : UIComponent
         }
 
         private TestBed _testBed;
-        private IUIComponentLogger _mockLogger;
+        private ILogger _mockLogger;
 
         [SetUp]
         public void SetUp()
         {
-            _mockLogger = Substitute.For<IUIComponentLogger>();
+            _mockLogger = Substitute.For<ILogger>();
             _testBed = TestBed.Create()
                 .WithSingleton(_mockLogger)
                 .Build();

Assets/UIComponents.Tests/StylesheetAttributeTests.cs

@@ -22,12 +22,12 @@ private partial class InheritedComponent : UIComponentWithTwoStylesheets {}
 
         private TestBed _testBed;
         private IAssetResolver _mockResolver;
-        private IUIComponentLogger _mockLogger;
+        private ILogger _mockLogger;
 
         [SetUp]
         public void SetUp()
         {
-            _mockLogger = Substitute.For<IUIComponentLogger>();
+            _mockLogger = Substitute.For<ILogger>();
             _mockResolver = MockUtilities.CreateMockResolver();
             _mockResolver.LoadAsset<StyleSheet>("Assets/StylesheetOne.uss")
                 .Returns(Task.FromResult(ScriptableObject.CreateInstance<StyleSheet>()));

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()));
-            }
-        }
     }
 }

Assets/UIComponents/Core/DebugLogger.cs

@@ -0,0 +1,25 @@
+using UnityEngine;
+
+namespace UIComponents
+{
+    /// <summary>
+    /// The default logger for UIComponents. Uses Debug.Log.
+    /// </summary>
+    public class DebugLogger : ILogger
+    {
+        public void Log(string message, object caller)
+        {
+            Debug.LogFormat("[{0}] {1}", caller.GetType().Name, message);
+        }
+
+        public void LogWarning(string message, object caller)
+        {
+            Debug.LogWarningFormat("[{0}] {1}", caller.GetType().Name, message);
+        }
+
+        public void LogError(string message, object caller)
+        {
+            Debug.LogErrorFormat("[{0}] {1}", caller.GetType().Name, message);
+        }
+    }
+}

Assets/UIComponents/Core/IUIComponentLogger.cs → Assets/UIComponents/Core/ILogger.cs

@@ -3,27 +3,27 @@
     /// <summary>
     /// An interface for logging information in UIComponents.
     /// </summary>
-    public interface IUIComponentLogger
+    public interface ILogger
     {
         /// <summary>
         /// Logs a regular message.
         /// </summary>
         /// <param name="message">Message to log</param>
-        /// <param name="component">UIComponent which logged this message</param>
-        void Log(string message, UIComponent component);
+        /// <param name="caller">Object which logged this message</param>
+        void Log(string message, object caller);
 
         /// <summary>
         /// Logs a warning.
         /// </summary>
         /// <param name="message">Message to log</param>
-        /// <param name="component">UIComponent which logged this message</param>
-        void LogWarning(string message, UIComponent component);
+        /// <param name="caller">Object which logged this message</param>
+        void LogWarning(string message, object caller);
 
         /// <summary>
         /// Logs an error.
         /// </summary>
         /// <param name="message">Message to log</param>
-        /// <param name="component">UIComponent which logged this message</param>
-        void LogError(string message, UIComponent component);
+        /// <param name="caller">Object which logged this message</param>
+        void LogError(string message, object caller);
     }
 }

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.

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;