Merge pull request #2 from Thundernerd/develop

Update Readme & Extra Test Case

Author: Thundernerd

README.md

@@ -127,6 +127,23 @@ private void InvokeEvent()
 }
 ```
 
+### Exposing
+
+Now that you've set up your Safe Event you most likely want to be able to use it from a different place.
+
+The recommended way of doing this is by exposing an event property as shown below, instead of directly exposing the Safe Event
+
+```c#
+private SafeEvent<int> onFooEvent;
+
+public event Action<int> OnFooEvent
+{
+    add => onFooEvent.Subscribe(value);
+    remove => onFooEvent.Unsubscribe(value);
+}
+```
+
+The benefit of this is that to the outside it looks and behaves like a normal event even though under the hood it has the benefits of the Safe Event.
 
 ## Support
 **Safe Event** is a small and open-source utility that I hope helps other people. It is by no means necessary but if you feel generous you can support me by donating.

Tests/Runtime/DummyBehaviour.cs

@@ -1,4 +1,6 @@
-using UnityEngine;
+using System;
+using TNRD.Events;
+using UnityEngine;
 
 public class DummyBehaviour : MonoBehaviour
 {
@@ -9,6 +11,14 @@ public class DummyBehaviour : MonoBehaviour
     public int Arg1 { get; private set; }
     public int Arg2 { get; private set; }
 
+    private SafeEvent onExposedEvent;
+
+    public event Action OnExposedEvent
+    {
+        add => onExposedEvent.Subscribe(value);
+        remove => onExposedEvent.Unsubscribe(value);
+    }
+
     public void Dummy()
     {
         Invoked = true;
@@ -24,4 +34,9 @@ public void Dummy(int arg1, int arg2)
         Arg1 = arg1;
         Arg2 = arg2;
     }
+
+    public void DispatchOnExposedEvent()
+    {
+        onExposedEvent.Invoke();
+    }
 }

Tests/Runtime/SafeEventTests.cs

@@ -71,4 +71,25 @@ public IEnumerator Invoke_On_Destroyed_GameObject()
         Assert.IsNotNull(exception);
         Object.Destroy(holder);
     }
+
+    [UnityTest]
+    public IEnumerator Dispatch_Exposed_Action()
+    {
+        var holder = new GameObject();
+        var dummyBehaviour = holder.AddComponent<DummyBehaviour>();
+        yield return null;
+
+        bool invoked = false;
+
+        dummyBehaviour.OnExposedEvent += () =>
+        {
+            invoked = true;
+        };
+
+        Assert.IsFalse(invoked);
+        dummyBehaviour.DispatchOnExposedEvent();
+        Assert.IsTrue(invoked);
+
+        Object.Destroy(holder);
+    }
 }