Merge pull request #3 from AAulicino/develop

1.1.0

Author: AAulicino

CHANGELOG.md

@@ -4,8 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2022-06-16
+### Added
+ - Nested coroutine calls support.
+
 ## [1.0.0] - 2022-06-13
 ### Added
-- Initial release
+- Initial release.
 
-[0.1.0]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/v1.0.0
+[1.1.0]: https://github.com/AAulicino/Unity-Coroutines-for-NSubstitute/compare/1.0.0...1.1.0
+[1.0.0]: https://github.com/AAulicino/Unity-Coroutines-for-NSubstitute/releases/tag/1.0.0

Editor/Substitutes/CoroutineCall/IStartCoroutineCall.cs

@@ -5,5 +5,6 @@ namespace CoroutineSubstitute.Substitutes.Call
     public interface IStartCoroutineCall : IEnumerator
     {
         int Id { get; }
+        void SetNestedCoroutine (IStartCoroutineCall call);
     }
 }

Editor/Substitutes/CoroutineCall/IStartCoroutineCallFactory.cs

@@ -4,6 +4,6 @@ namespace CoroutineSubstitute.Substitutes.Call
 {
     public interface IStartCoroutineCallFactory
     {
-        IStartCoroutineCall Create (int id, IEnumerator enumerator);
+        IStartCoroutineCall Create (IEnumerator enumerator);
     }
 }

Editor/Substitutes/CoroutineCall/StartCoroutineCall.cs

@@ -1,21 +1,73 @@
+using System;
 using System.Collections;
+using CoroutineSubstitute.Utils;
+using UnityEngine;
 
 namespace CoroutineSubstitute.Substitutes.Call
 {
     public class StartCoroutineCall : IStartCoroutineCall, IEnumerator
     {
-        readonly IEnumerator enumerator;
-
         public int Id { get; }
-        public object Current => enumerator.Current;
+        public object Current => nestedCoroutine ?? nestedCall?.Current ?? enumerator.Current;
+
+        readonly IEnumerator enumerator;
+        readonly IStartCoroutineCallFactory callFactory;
+        IStartCoroutineCall nestedCall;
+        Coroutine nestedCoroutine;
 
-        public StartCoroutineCall (int id, IEnumerator enumerator)
+        public StartCoroutineCall (
+            int id,
+            IEnumerator enumerator,
+            IStartCoroutineCallFactory callFactory
+        )
         {
             Id = id;
             this.enumerator = enumerator;
+            this.callFactory = callFactory;
+        }
+
+        public bool MoveNext ()
+        {
+            if (nestedCall != null)
+            {
+                if (nestedCall.MoveNext())
+                    return true;
+                nestedCall = null;
+            }
+
+            if (enumerator.MoveNext())
+            {
+                if (Current is IEnumerator enumerator)
+                    nestedCall = callFactory.Create(enumerator);
+                else if (Current is Coroutine coroutine)
+                    nestedCoroutine = coroutine;
+                return true;
+            }
+            return false;
+        }
+
+        public void SetNestedCoroutine (IStartCoroutineCall call)
+        {
+            if (nestedCall?.Current is Coroutine coroutine && coroutine.GetId() == call.Id)
+            {
+                nestedCall.SetNestedCoroutine(call);
+                return;
+            }
+
+            if (nestedCoroutine == null)
+                throw new InvalidOperationException("Nested coroutine is not set");
+
+            if (nestedCoroutine.GetId() != call.Id)
+            {
+                throw new InvalidOperationException(
+                    $"Received Coroutine={call.Id}, expected Coroutine={nestedCoroutine.GetId()}"
+                );
+            }
+
+            nestedCall = call;
+            nestedCoroutine = null;
         }
 
-        public bool MoveNext () => enumerator.MoveNext();
         public void Reset () => enumerator.Reset();
     }
 }

Editor/Substitutes/CoroutineCall/StartCoroutineCallFactory.cs

@@ -4,9 +4,11 @@ namespace CoroutineSubstitute.Substitutes.Call
 {
     public class StartCoroutineCallFactory : IStartCoroutineCallFactory
     {
-        public IStartCoroutineCall Create (int id, IEnumerator enumerator)
+        int id;
+
+        public IStartCoroutineCall Create (IEnumerator enumerator)
         {
-            return new StartCoroutineCall(id, enumerator);
+            return new StartCoroutineCall(id++, enumerator, this);
         }
     }
 }

Editor/Substitutes/CoroutineRunnerSubstitute.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using CoroutineSubstitute.Substitutes.Call;
 using CoroutineSubstitute.Utils;
 using UnityEngine;
@@ -29,7 +30,7 @@ public virtual Coroutine StartCoroutine (IEnumerator enumerator)
             if (enumerator is null)
                 throw new ArgumentNullException(nameof(enumerator));
 
-            IStartCoroutineCall call = callFactory.Create(activeCoroutines.Count, enumerator);
+            IStartCoroutineCall call = callFactory.Create(enumerator);
             activeCoroutines.Add(call.Id, call);
             return CoroutineFactory.Create(call.Id);
         }
@@ -50,8 +51,27 @@ public virtual void StopCoroutine (Coroutine routine)
         public virtual bool MoveNext ()
         {
             bool anySucceeded = false;
-            foreach (IStartCoroutineCall call in activeCoroutines.Values)
-                anySucceeded |= call.MoveNext();
+            HashSet<int> callsToRemove = new HashSet<int>();
+
+            foreach (IStartCoroutineCall call in activeCoroutines.Values.ToArray())
+            {
+                bool result = call.MoveNext();
+
+                if (callsToRemove.Contains(call.Id))
+                    continue;
+
+                if (call.Current is Coroutine coroutine)
+                {
+                    int coroutineId = coroutine.GetId();
+                    call.SetNestedCoroutine(activeCoroutines[coroutineId]);
+                    callsToRemove.Add(coroutineId);
+                }
+                anySucceeded |= result;
+            }
+
+            foreach (int id in callsToRemove)
+                activeCoroutines.Remove(id);
+
             return anySucceeded;
         }
 

Tests/Editor/Samples/Counter/Counter.cs

@@ -7,6 +7,8 @@ public class Counter
     {
         public int Current { get; private set; }
 
+        public bool KeepRunning { get; set; } = true;
+
         readonly ICoroutineRunner runner;
         Coroutine coroutine;
 
@@ -28,7 +30,7 @@ public void Stop ()
 
         IEnumerator CounterRoutine ()
         {
-            while (true)
+            while (KeepRunning)
             {
                 Current++;
                 yield return null;

Tests/Editor/Samples/Counter/CounterTests.cs

@@ -21,7 +21,7 @@ public void Setup ()
             }
         }
 
-        class StartCounter : BaseSubstitutionTests
+        class Start : BaseSubstitutionTests
         {
             [Test]
             public void Calls_StartCoroutine ()
@@ -67,9 +67,21 @@ public void Three_MoveNext_Increments_To_Three ()
 
                 Assert.AreEqual(3, Counter.Current);
             }
+
+            [Test]
+            public void Stops_When_Routine_Completed ()
+            {
+                Counter.Start();
+                Runner.MoveNext();
+
+                Counter.KeepRunning = false;
+                Runner.MoveNext();
+
+                Assert.AreEqual(1, Counter.Current);
+            }
         }
 
-        class StopCounter : BaseSubstitutionTests
+        class Stop : BaseSubstitutionTests
         {
             [Test]
             public void Calls_StopCoroutine ()