Fix yarnspinner tests

Author: alec-deason

.github/workflows/ci.yml

@@ -78,6 +78,7 @@ jobs:
         run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
       - name: Run cargo test
         run: cargo test --workspace
+        working-directory: crates/yarnspinner
       - name: Run cargo test
         run: cargo test --workspace --all-features
       - name: Run doc tests

crates/runtime/src/dialogue.rs

@@ -116,6 +116,14 @@ impl Dialogue {
             language_code: Default::default(),
         }
     }
+
+    pub fn next(
+        &mut self,
+        #[cfg(feature = "bevy")]
+        world: &mut World,
+    ) -> Option<Vec<DialogueEvent>> {
+        self.vm.next(#[cfg(feature = "bevy")] world)
+    }
 }
 
 fn visited(storage: Box<dyn VariableStorage>) -> yarn_fn_type! { impl Fn(String) -> bool } {
@@ -140,17 +148,6 @@ fn visited_count(storage: Box<dyn VariableStorage>) -> yarn_fn_type! { impl Fn(S
     }
 }
 
-/*
-impl Iterator for Dialogue {
-    type Item = Vec<DialogueEvent>;
-
-    /// Panicking version of [`Dialogue::continue_`].
-    fn next(&mut self) -> Option<Self::Item> {
-        self.vm.next()
-    }
-}
-*/
-
 // Accessors
 impl Dialogue {
     /// The [`Dialogue`]'s locale, as an IETF BCP 47 code.

crates/runtime/src/virtual_machine.rs

@@ -33,18 +33,6 @@ pub(crate) struct VirtualMachine {
     language_code: Option<Language>,
 }
 
-/*
-impl Iterator for VirtualMachine {
-    type Item = Vec<DialogueEvent>;
-
-    fn next(&mut self) -> Option<Self::Item> {
-        self.assert_can_continue().is_ok().then(||
-            self.continue_()
-            .unwrap_or_else(|e| panic!("Encountered error while running dialogue through its `Iterator` implementation: {e}")))
-    }
-}
-*/
-
 impl VirtualMachine {
     pub(crate) fn new(
         library: Library,
@@ -112,6 +100,12 @@ impl VirtualMachine {
         std::mem::take(&mut self.batched_events)
     }
 
+    pub fn next(&mut self, #[cfg(feature = "bevy")] world: &mut World) -> Option<Vec<DialogueEvent>> {
+        self.assert_can_continue().is_ok().then(||
+            self.continue_(#[cfg(feature = "bevy")] world)
+            .unwrap_or_else(|e| panic!("Encountered error while running dialogue through its `Iterator` implementation: {e}")))
+    }
+
     pub(crate) fn set_node(&mut self, node_name: impl Into<String>) -> Result<()> {
         let node_name = node_name.into();
         debug!("Loading node \"{node_name}\"");
@@ -654,3 +648,19 @@ fn expand_substitutions(text: &str, substitutions: &[String]) -> String {
             text.replace(&format!("{{{i}}}",), substitution)
         })
 }
+
+struct RunToCompletionIterator<'a> {
+    vm: &'a mut VirtualMachine,
+    #[cfg(feature = "bevy")]
+    world: &'a mut World,
+}
+
+impl <'a>Iterator for RunToCompletionIterator<'a> {
+    type Item = Vec<DialogueEvent>;
+
+    fn next(&mut self) -> Option<Self::Item> {
+        self.vm.assert_can_continue().is_ok().then(||
+            self.vm.continue_(#[cfg(feature = "bevy")] self.world)
+            .unwrap_or_else(|e| panic!("Encountered error while running dialogue through its `Iterator` implementation: {e}")))
+    }
+}

crates/yarnspinner/tests/language_tests.rs

@@ -79,9 +79,19 @@ fn test_end_of_notes_with_options_not_added() {
 
     let mut dialogue = TestBase::default().with_compilation(result).dialogue;
     dialogue.set_node("Start").unwrap();
-    let has_options = dialogue
-        .flatten()
-        .any(|event| matches!(event, DialogueEvent::Options(_)));
+
+    #[cfg(feature = "bevy")]
+    let mut world = World::default();
+
+    let mut has_options = false;
+    'outer: while let Some(events) = dialogue.next(#[cfg(feature = "bevy")] world) {
+        for event in events {
+            if matches!(event, DialogueEvent::Options(_)) {
+                has_options = true;
+                break 'outer;
+            }
+        }
+    }
     assert!(!has_options);
 }
 

crates/yarnspinner/tests/test_base/mod.rs

@@ -19,6 +19,8 @@ use std::path::{Path, PathBuf};
 use std::result::Result;
 use std::sync::atomic::{AtomicBool, Ordering};
 use std::sync::Arc;
+#[cfg(feature = "bevy")]
+use bevy::prelude::World;
 use yarnspinner::compiler::*;
 use yarnspinner::core::*;
 use yarnspinner::runtime::*;
@@ -147,7 +149,10 @@ impl TestBase {
     pub fn run_standard_testcase(&mut self) -> &mut Self {
         self.dialogue.set_node("Start").unwrap();
 
-        while let Some(events) = self.dialogue.next() {
+        #[cfg(feature = "bevy")]
+        let mut world = World::default();
+
+        while let Some(events) = self.dialogue.next(#[cfg(feature = "bevy")] world) {
             for event in events {
                 match event {
                     DialogueEvent::Line(line) => {