Merge pull request #3 from josefalanga/main

Implement substitutions

Author: weaversam8

README.md

@@ -62,7 +62,6 @@ A few gotchas to look out for:
 
 As of version v0.0.2, all Yarn Spinner opcodes are currently implemented, as well as Yarn Spinner 1's internal standard library of functions and operators. As of version v0.2.1, typed versions of these functions (introduced in Yarn Spinner 2) are present, but full YS2 parity has not been verified at this time. The known features currently missing are:
 
-- Inline expressions [(see Yarn docs on "Using Variables in Lines")](https://docs.yarnspinner.dev/getting-started/writing-in-yarn/logic-and-variables#using-variables-in-lines)
 - Line conditions and the `IsAvailable` flag on options [(see Yarn Docs on "Conditional Options")](https://docs.yarnspinner.dev/getting-started/writing-in-yarn/flow-control#conditional-options)
 - Localisation and Line IDs [(see Yarn's Localization docs)](https://docs.yarnspinner.dev/using-yarnspinner-with-unity/assets-and-localization)
 - An appropriate replacement for the distinction Yarn makes between Functions and Coroutines in Unity (to allow users to register blocking command handlers via this Python runner independent of Unity)

examples/yarn2/expressions.csv

@@ -1,2 +1,6 @@
 id,text,file,node,lineNumber
-line:/Users/sweaver/Git/YarnRunner-Python/examples/yarn2/expressions.yarn-Start-0,Hello there {0}.,/Users/sweaver/Git/YarnRunner-Python/examples/yarn2/expressions.yarn,Start,5
+line:C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn-Start-0,My name is {0}.,C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn,Start,7
+line:C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn-Start-1,I want to hug {0},C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn,Start,13
+line:C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn-Start-2,You punch {0},C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn,Start,14
+line:C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn-Start-3,I want to punch {0},C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn,Start,15
+line:C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn-Start-4,You hug {0},C:\Documents\development\YarnRunner-Python\examples\yarn2\expressions.yarn,Start,16

examples/yarn2/expressions.yarn

@@ -1,6 +1,17 @@
 title: Start
 ---
 <<set $name to "Sam">>
+<<set $friend to "Jose">>
 
-Hello there {$name}.
+//simple expression in line
+My name is {$name}.
+
+//in custom command parameters
+<<test_command "Hello there {$name}." 5 "My name is {$name} {$friend}.">>
+
+//in options
+-> I want to hug {$friend}
+    You punch {$friend}
+-> I want to punch {$friend}
+    You hug {$friend}
 ===

examples/yarn2/expressions.yarnc

@@ -13,28 +13,26 @@
 runner1 = YarnRunner(compiled_yarn_f1, names_csv_f1, autostart=False)
 runner2 = YarnRunner(compiled_yarn_f2, names_csv_f2, autostart=False)
 
-# TODO: implement a test for expression parsing
 
+def expression_command_handler(first, second, third):
+    assert first == "Hello there Sam."
+    assert second == "5"
+    assert third == "My name is Sam Jose."
 
 def test_expressions1():
-    try:
-        runner1.resume()
+    expected_line = "Hello there Sam."
 
-        # the runner should throw an error
-        raise Exception(
-            "The runner ran without any issues. This test should fail. An Exception was expected.")
-    except Exception as e:
-        assert str(
-            e) == "Yarn stories with interpolated inline expressions are not yet supported."
+    runner1.resume()
 
+    assert runner1.get_line() == expected_line
 
 def test_expressions2():
-    try:
-        runner2.resume()
-
-        # the runner should throw an error
-        raise Exception(
-            "The runner ran without any issues. This test should fail. An Exception was expected.")
-    except Exception as e:
-        assert str(
-            e) == "Yarn stories with interpolated inline expressions are not yet supported."
+    runner2.add_command_handler("test_command", expression_command_handler)
+    expected_line = "My name is Sam."
+
+    runner2.resume()
+    choices = runner2.get_choices()
+
+    assert runner2.get_line() == expected_line
+    assert choices[0]['text'] == "I want to hug Jose"
+    assert choices[1]['text'] == "I want to punch Jose"

tests/test_expressions.py

@@ -72,10 +72,13 @@ def __find_label(self, label_key):
                 f"The current node `{self.current_node}` does not have a label named `{label_key}")
 
     def __find_expressions(self, operand):
-        # TODO: implement this functionality
-        if int(operand.float_value) != 0:
-            raise Exception(
-                f"Yarn stories with interpolated inline expressions are not yet supported.")
+        params_amount = operand.float_value
+
+        params = []
+        while params_amount > 0:
+            params.insert(0, self._vm_data_stack.pop(0))
+            params_amount -= 1
+        return params
 
     def __debug_log(self, msg, **kwargs):
         if self._enable_tracing:
@@ -202,10 +205,9 @@ def __run_line(self, instruction):
 
         # if this instruction has a second operand, it's the number of expressions
         # on the line that need to be evaluated.
+        line_substitutions = []
         if len(instruction.operands) > 1:
-            line_substitutions = self.__find_expressions(
-                instruction.operands[1])
-            # TODO: implement substitutions
+            line_substitutions = self.__find_expressions(instruction.operands[1])
 
         if self._experimental_newlines:
             # attempt to add a newlines if the last thing we did was run a line
@@ -219,7 +221,7 @@ def __run_line(self, instruction):
                     for _i in range(diff - 1):
                         self._line_buffer.append('')
 
-        self._line_buffer.append(self.__lookup_string(string_key))
+        self._line_buffer.append(self.__lookup_string(string_key).format(*line_substitutions))
 
     def __run_command(self, instruction):
         # split the command specifier by spaces, ignoring spaces
@@ -248,9 +250,9 @@ def sanitize_quotes(arg):
             if len(instruction.operands) > 1:
                 line_substitutions = self.__find_expressions(
                     instruction.operands[1])
-                # TODO: implement substitutions
+                for index, arg in enumerate(args):
+                    args[index] = arg.format(*line_substitutions)
 
-            # TODO: maybe do some argument type parsing later
             ret = self._command_handlers[command](*args)
 
             if type(ret) is str:
@@ -262,14 +264,14 @@ def __add_option(self, instruction):
 
         # if this instruction has a second operand, it's the number of expressions
         # on the line that need to be evaluated.
+        line_substitutions = []
         if len(instruction.operands) > 2:
             line_substitutions = self.__find_expressions(
                 instruction.operands[2])
-            # TODO: implement substitutions
 
         self._option_buffer.append({
             'index': len(self._option_buffer),
-            'text': self.__lookup_string(title_string_key),
+            'text': self.__lookup_string(title_string_key).format(*line_substitutions),
             'choice': choice_path
         })