Merge pull request #590 from ExtendRealityLtd/feat/bool-event-proxy

feat(Proxy): add boolean event proxy emitter

Runtime/Event/Proxy/BooleanEventProxyEmitter.cs

@@ -0,0 +1,23 @@
+namespace Zinnia.Event.Proxy
+{
+    using System;
+    using UnityEngine.Events;
+
+    /// <summary>
+    /// Emits a <see cref="UnityEvent"/> with a <see cref="bool"/> payload whenever the <see cref="SingleEventProxyEmitter{TValue,TEvent}.Receive"/> method is called.
+    /// </summary>
+    public class BooleanEventProxyEmitter : RestrictableSingleEventProxyEmitter<bool, BooleanEventProxyEmitter.UnityEvent>
+    {
+        /// <summary>
+        /// Defines the event with the specified state.
+        /// </summary>
+        [Serializable]
+        public class UnityEvent : UnityEvent<bool> { }
+
+        /// <inheritdoc />
+        protected override object GetTargetToCheck()
+        {
+            return Payload;
+        }
+    }
+}

Tests/Editor/Event/Proxy/BooleanEventProxyEmitterTest.cs

@@ -0,0 +1,147 @@
+using Zinnia.Data.Type;
+using Zinnia.Event.Proxy;
+using Zinnia.Rule;
+
+namespace Test.Zinnia.Event.Proxy
+{
+    using NUnit.Framework;
+    using Test.Zinnia.Utility.Mock;
+    using UnityEngine;
+
+    public class BooleanEventProxyEmitterTest
+    {
+        private GameObject containingObject;
+        private BooleanEventProxyEmitter subject;
+
+        [SetUp]
+        public void SetUp()
+        {
+            containingObject = new GameObject("BooleanEventProxyEmitterTest");
+            subject = containingObject.AddComponent<BooleanEventProxyEmitter>();
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            Object.DestroyImmediate(containingObject);
+        }
+
+        [Test]
+        public void Receive()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            bool payload = true;
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.Receive(payload);
+
+            Assert.IsTrue(subject.Payload);
+            Assert.IsTrue(emittedMock.Received);
+        }
+
+        [Test]
+        public void EmitPayload()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            bool payload = true;
+            subject.Payload = payload;
+
+            Assert.IsTrue(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.EmitPayload();
+
+            Assert.IsTrue(subject.Payload);
+            Assert.IsTrue(emittedMock.Received);
+        }
+
+        [Test]
+        public void ClearPayload()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            bool payload = true;
+            subject.Payload = payload;
+
+            Assert.IsTrue(subject.Payload);
+            subject.ClearPayload();
+            Assert.IsFalse(subject.Payload);
+        }
+
+        [Test]
+        public void ReceiveInactiveGameObject()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            subject.gameObject.SetActive(false);
+
+            bool payload = true;
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.Receive(payload);
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+        }
+
+        [Test]
+        public void ReceiveInactiveComponent()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            subject.enabled = false;
+
+            bool payload = true;
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.Receive(payload);
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+        }
+
+        [Test]
+        public void EmitPayloadInactiveGameObject()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            subject.gameObject.SetActive(false);
+            bool payload = false;
+            subject.Payload = payload;
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.EmitPayload();
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+        }
+
+        [Test]
+        public void EmitPayloadInactiveComponent()
+        {
+            UnityEventListenerMock emittedMock = new UnityEventListenerMock();
+            subject.Emitted.AddListener(emittedMock.Listen);
+            subject.enabled = false;
+            bool payload = false;
+            subject.Payload = payload;
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+
+            subject.EmitPayload();
+
+            Assert.IsFalse(subject.Payload);
+            Assert.IsFalse(emittedMock.Received);
+        }
+    }
+}