Skip to content

Commit

Permalink
feat: rename IUIComponentLogger to ILogger, turn caller argument type…
Browse files Browse the repository at this point in the history
… to object

BREAKING CHANGE: The IUIComponentLogger interface has been renamed to ILogger. It's methods' second argument is now of type object rather than UIComponent.
  • Loading branch information
jonisavo committed Oct 23, 2022
1 parent 9ee04f4 commit 5749d0f
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 35 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
25 changes: 25 additions & 0 deletions Assets/UIComponents/Core/DebugLogger.cs
Original file line number Diff line number Diff line change
@@ -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);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}
File renamed without changes.
25 changes: 0 additions & 25 deletions Assets/UIComponents/Core/UIComponentDebugLogger.cs

This file was deleted.

0 comments on commit 5749d0f

Please sign in to comment.