Add tests and tidy up translation parser

Author: jonnydgreen

addons/parley/constants.gd

@@ -8,6 +8,7 @@
 const VERSION: StringName = &"2.1.0"
 const AST_VERSION: StringName = &"1.1.0"
 const USER_CONFIG_PATH: StringName = &"user://parley_user_config.json"
+const DIALOGUE_SEQUENCE_EXTENSION: StringName = &"ds"
 #endregion
 
 

addons/parley/dialogue_ast_format_saver.gd

@@ -3,14 +3,20 @@
 @tool
 class_name ParleyDialogueSequenceAstFormatSaver extends ResourceFormatSaver
 
+
+const ParleyConstants = preload('./constants.gd')
+
+
 ## Returns the list of extensions available for saving the resource object,
 ## provided it is recognized (see _recognize).
 func _recognize(resource: Resource) -> bool:
 	return is_instance_of(resource, ParleyDialogueSequenceAst)
 
+
 ## Returns whether the given resource object can be saved by this saver.
 func _get_recognized_extensions(_resource: Resource) -> PackedStringArray:
-	return PackedStringArray(["ds"])
+	return PackedStringArray([ParleyConstants.DIALOGUE_SEQUENCE_EXTENSION])
+
 
 ## Saves the given resource object to a file at the target path.
 ## flags is a bitmask composed with SaverFlags constants.

addons/parley/import_plugin.gd

@@ -31,7 +31,7 @@ func _get_visible_name() -> String:
 
 
 func _get_recognized_extensions() -> PackedStringArray:
-	return ["ds"]
+	return [ParleyConstants.DIALOGUE_SEQUENCE_EXTENSION]
 
 
 func _get_save_extension() -> String:

addons/parley/models/dialogue_node_ast.gd

@@ -61,4 +61,12 @@ func to_resolved(resolved_text: String) -> ParleyDialogueNodeAst:
 
 func resolve_character() -> ParleyCharacter:
 	return ParleyCharacterStore.resolve_character_ref(character)
+
+
+## Get translation strings for the Dialogue Node
+func get_translation_strings() -> Array[PackedStringArray]:
+	var translation_strings: Array[PackedStringArray] = []
+	if text:
+		translation_strings.append(PackedStringArray([text, ParleyUtils.translation.get_msg_ctx(self, 'text_translation_key')]))
+	return translation_strings
 #endregion

addons/parley/models/dialogue_option_node_ast.gd

@@ -61,4 +61,12 @@ func to_resolved(resolved_text: String) -> ParleyDialogueOptionNodeAst:
 
 func resolve_character() -> ParleyCharacter:
 	return ParleyCharacterStore.resolve_character_ref(character)
+
+
+## Get translation strings for the Dialogue Option Node
+func get_translation_strings() -> Array[PackedStringArray]:
+	var translation_strings: Array[PackedStringArray] = []
+	if text:
+		translation_strings.append(PackedStringArray([text, ParleyUtils.translation.get_msg_ctx(self, 'text_translation_key')]))
+	return translation_strings
 #endregion

addons/parley/models/node_ast.gd

@@ -57,6 +57,11 @@ func _to_string() -> String:
 	return "ParleyNodeAst<%s>" % [str(to_dict())]
 
 
+## Get translation strings for the current node
+func get_translation_strings() -> Array[PackedStringArray]:
+	return []
+
+
 static func get_colour() -> Color:
 	return Color("#7a2167")
 #endregion

addons/parley/parley_manager.gd

@@ -194,7 +194,7 @@ func update_localisations(dialogue_sequences_to_register: Array[ParleyDialogueSe
 	if clean:
 		for i: int in range(pot_generation_candidates.size() - 1, -1, -1):
 			var candidate: String = pot_generation_candidates[i]
-			if candidate.get_extension() == "ds" and not ResourceLoader.exists(candidate):
+			if candidate.get_extension() == ParleyConstants.DIALOGUE_SEQUENCE_EXTENSION and not ResourceLoader.exists(candidate):
 				pot_generation_candidates.remove_at(i)
 				changed = true
 

addons/parley/translation_parser.gd

@@ -2,6 +2,9 @@
 extends EditorTranslationParserPlugin
 
 
+const ParleyConstants = preload("./constants.gd")
+
+
 func _parse_file(path: String) -> Array[PackedStringArray]:
 	if not ResourceLoader.exists(path):
 		return []
@@ -11,14 +14,9 @@ func _parse_file(path: String) -> Array[PackedStringArray]:
 	for node: ParleyNodeAst in dialogue_sequence.nodes:
 		if not uid:
 			continue
-		# TODO: handle this at the node level to be much more maintainable
-		var text: Variant = node.get("text")
-		if is_instance_of(text, TYPE_STRING) and text:
-			# TODO: add support for nodes to have a custom translation key
-			ret.append(PackedStringArray([text, ParleyUtils.translation.get_msg_ctx(node, 'text_translation_key')])) # id[,ctx]
+		ret.append_array(node.get_translation_strings())
 	return ret
 
 
 func _get_recognized_extensions() -> PackedStringArray:
-	# TODO: is there a constant we can use?
-	return ["ds"]
+	return [ParleyConstants.DIALOGUE_SEQUENCE_EXTENSION]

tests/dialogue_node_editor_test.gd

@@ -39,13 +39,17 @@ class Test_dialogue_node_editor:
 
 
 	func use_dialogue_node_editor(p_dialogue_node_editor: ParleyDialogueNodeEditor, test_case: Dictionary) -> void:
-		var _dialogue: Variant = test_case.get('dialogue')
+		var dialogue_variant: Variant = test_case.get('dialogue')
 		var selected_character: Variant = test_case.get('selected_character')
-		if _dialogue and _dialogue is String:
-			var dialogue: String = _dialogue
+		var text_translation_key_variant: Variant = test_case.get('text_translation_key')
+		if dialogue_variant and dialogue_variant is String:
+			var dialogue: String = dialogue_variant
 			p_dialogue_node_editor.dialogue_editor.insert_text_at_caret(dialogue)
 		if is_instance_of(selected_character, TYPE_INT):
 			p_dialogue_node_editor.character_selector.item_selected.emit(selected_character)
+		if text_translation_key_variant and text_translation_key_variant is String:
+			var text_translation_key: String = text_translation_key_variant
+			p_dialogue_node_editor.text_translation_key_editor.key_changed.emit(text_translation_key)
 
 
 	func test_initial_render(params: Variant = use_parameters([
@@ -137,6 +141,10 @@ class Test_dialogue_node_editor:
 			"input": {"id": "1", "selected_character": 0},
 			"expected": {"id": "1", "character_id": "%s::default_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 0, "dialogue": "", "text_translation_key": ""},
 		},
+		{
+			"input": {"id": "1", "text_translation_key": "some_text_translation_key"},
+			"expected": {"id": "1", "character_id": "", "selected_character": -1, "dialogue": "", "text_translation_key": "some_text_translation_key"},
+		},
 	])) -> void:
 		# Arrange
 		var input: Dictionary = params['input']
@@ -155,4 +163,5 @@ class Test_dialogue_node_editor:
 		assert_eq(dialogue_node_editor.dialogue, str(expected['dialogue']))
 		assert_eq(dialogue_node_editor.dialogue_editor.text, str(expected['dialogue']))
 		assert_eq(dialogue_node_editor.character_selector.selected, expected_selected_character)
+		assert_eq(dialogue_node_editor.text_translation_key, str(expected['text_translation_key']))
 		assert_signal_emitted_with_parameters(dialogue_node_editor, 'dialogue_node_changed', [expected['id'], expected['character_id'], expected['dialogue'], expected['text_translation_key']])

tests/dialogue_option_node_editor_test.gd

@@ -0,0 +1,167 @@
+# Copyright 2024-2025 the Bisterix Studio authors. All rights reserved. MIT license.
+
+extends GutTest
+
+# TODO: move test file next to the scene
+const DialogueOptionNodeEditorScene: PackedScene = preload('res://addons/parley/components/dialogue_option/dialogue_option_node_editor.tscn')
+
+
+class Test_dialogue_option_node_editor:
+	extends GutTest
+	
+	var dialogue_option_node_editor: ParleyDialogueOptionNodeEditor = null
+	var character_store: ParleyCharacterStore = null
+	
+	func before_each() -> void:
+		dialogue_option_node_editor = DialogueOptionNodeEditorScene.instantiate()
+		character_store = load('res://tests/fixtures/characters/base_character_store.tres')
+		character_store.id = "test"
+		character_store.characters = []
+		var _result: ParleyCharacter = character_store.add_character("Default Character")
+		dialogue_option_node_editor.character_store = character_store
+		add_child_autofree(dialogue_option_node_editor)
+	
+	func after_each() -> void:
+		dialogue_option_node_editor = null
+	
+	func setup_dialogue_option_node_editor(p_dialogue_option_node_editor: ParleyDialogueOptionNodeEditor, test_case: Dictionary) -> void:
+		var id: Variant = test_case.get('id')
+		var _character_name: Variant = test_case.get('character_name')
+		var option: Variant = test_case.get('option')
+		if id:
+			p_dialogue_option_node_editor.id = id
+		if _character_name and _character_name is String:
+			var character_name: String = _character_name
+			var _added_character: ParleyCharacter = character_store.add_character(character_name)
+			p_dialogue_option_node_editor.character = character_store.get_ref_by_index(character_store.characters.size() - 1)
+		if option:
+			p_dialogue_option_node_editor.option = option
+
+
+	func use_dialogue_option_node_editor(p_dialogue_option_node_editor: ParleyDialogueOptionNodeEditor, test_case: Dictionary) -> void:
+		var dialogue_variant: Variant = test_case.get('option')
+		var selected_character: Variant = test_case.get('selected_character')
+		var text_translation_key_variant: Variant = test_case.get('text_translation_key')
+		if dialogue_variant and dialogue_variant is String:
+			var option: String = dialogue_variant
+			p_dialogue_option_node_editor.option_editor.insert_text_at_caret(option)
+		if is_instance_of(selected_character, TYPE_INT):
+			p_dialogue_option_node_editor.character_selector.item_selected.emit(selected_character)
+		if text_translation_key_variant and text_translation_key_variant is String:
+			var text_translation_key: String = text_translation_key_variant
+			p_dialogue_option_node_editor.text_translation_key_editor.key_changed.emit(text_translation_key)
+
+
+	func test_initial_render(params: Variant = use_parameters([
+		{
+			"input": {"id": null, "character_name": null, "option": null},
+			"expected": {"id": "", "character_id": "", "selected_character": - 1, "option": ""},
+		},
+		{
+			"input": {"id": "1", "character_name": null, "option": null},
+			"expected": {"id": "1", "character_id": "", "selected_character": - 1, "option": ""},
+		},
+		{
+			"input": {"id": null, "character_name": "Test Character", "option": null},
+			"expected": {"id": "", "character_id": "%s::test_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 1, "option": ""},
+		},
+		{
+			"input": {"id": null, "character_name": null, "option": "Some option"},
+			"expected": {"id": "", "character_id": "", "selected_character": - 1, "option": "Some option"},
+		},
+		{
+			"input": {"id": "1", "character_name": "Test Character", "option": "Some option"},
+			"expected": {"id": "1", "character_id": "%s::test_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 1, "option": "Some option"},
+		},
+	])) -> void:
+		# Arrange
+		var input: Dictionary = params['input']
+		var expected: Dictionary = params['expected']
+		var expected_selected_character: int = expected['selected_character']
+		setup_dialogue_option_node_editor(dialogue_option_node_editor, input)
+		watch_signals(dialogue_option_node_editor)
+		
+		# Act
+		await wait_until(func() -> bool: return dialogue_option_node_editor.is_inside_tree(), .1)
+
+		# Assert
+		assert_true(dialogue_option_node_editor.is_inside_tree())
+		assert_eq(dialogue_option_node_editor.id, str(expected['id']))
+		assert_eq(dialogue_option_node_editor.character, str(expected['character_id']))
+		assert_eq(dialogue_option_node_editor.character_selector.selected, expected_selected_character)
+		assert_eq(dialogue_option_node_editor.option, str(expected['option']))
+		assert_eq(dialogue_option_node_editor.option_editor.text, str(expected['option']))
+		assert_signal_not_emitted(dialogue_option_node_editor, 'dialogue_option_node_changed')
+
+
+	func test_update_render_with_variables(params: Variant = use_parameters([
+		{
+			"input": {"id": null, "character_name": null, "option": null},
+			"expected": {"id": "", "character_id": "", "selected_character": - 1, "option": ""},
+		},
+		{
+			"input": {"id": "1", "character_name": null, "option": null},
+			"expected": {"id": "1", "character_id": "", "selected_character": - 1, "option": ""},
+		},
+		{
+			"input": {"id": null, "character_name": "Test Character", "option": null},
+			"expected": {"id": "", "character_id": "%s:test_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 1, "option": ""},
+		},
+		{
+			"input": {"id": null, "character_name": null, "option": "Some option"},
+			"expected": {"id": "", "character_id": "", "selected_character": - 1, "option": "Some option"},
+		},
+		{
+			"input": {"id": "1", "character_name": "Test Character", "option": "Some option"},
+			"expected": {"id": "1", "character_id": "%s:test_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 1, "option": "Some option"},
+		},
+	])) -> void:
+		# Arrange
+		var input: Dictionary = params['input']
+		var expected: Dictionary = params['expected']
+		watch_signals(dialogue_option_node_editor)
+		
+		# Act
+		await wait_until(func() -> bool: return dialogue_option_node_editor.is_inside_tree(), .1)
+		setup_dialogue_option_node_editor(dialogue_option_node_editor, input)
+
+		# Assert
+		assert_true(dialogue_option_node_editor.is_inside_tree())
+		assert_eq(dialogue_option_node_editor.id, str(expected['id']))
+		assert_eq(dialogue_option_node_editor.option, str(expected['option']))
+		assert_eq(dialogue_option_node_editor.option_editor.text, str(expected['option']))
+		assert_signal_not_emitted(dialogue_option_node_editor, 'dialogue_option_node_changed')
+
+	func test_update_render_with_text_input(params: Variant = use_parameters([
+		{
+			"input": {"id": "1", "option": "Some option"},
+			"expected": {"id": "1", "character_id": "", "selected_character": -1, "option": "Some option", "text_translation_key": ""},
+		},
+		{
+			"input": {"id": "1", "selected_character": 0},
+			"expected": {"id": "1", "character_id": "%s::default_character" % ParleyUtils.resource.get_uid(character_store), "selected_character": 0, "option": "", "text_translation_key": ""},
+		},
+		{
+			"input": {"id": "1", "text_translation_key": "some_text_translation_key"},
+			"expected": {"id": "1", "character_id": "", "selected_character": -1, "option": "", "text_translation_key": "some_text_translation_key"},
+		},
+	])) -> void:
+		# Arrange
+		var input: Dictionary = params['input']
+		var expected: Dictionary = params['expected']
+		var expected_selected_character: int = expected['selected_character']
+		watch_signals(dialogue_option_node_editor)
+		dialogue_option_node_editor.id = input['id']
+		
+		# Act
+		await wait_until(func() -> bool: return dialogue_option_node_editor.is_inside_tree(), .1)
+		use_dialogue_option_node_editor(dialogue_option_node_editor, input)
+		await wait_for_signal(dialogue_option_node_editor.dialogue_option_node_changed, .1)
+
+		# Assert
+		assert_true(dialogue_option_node_editor.is_inside_tree())
+		assert_eq(dialogue_option_node_editor.option, str(expected['option']))
+		assert_eq(dialogue_option_node_editor.option_editor.text, str(expected['option']))
+		assert_eq(dialogue_option_node_editor.character_selector.selected, expected_selected_character)
+		assert_eq(dialogue_option_node_editor.text_translation_key, str(expected['text_translation_key']))
+		assert_signal_emitted_with_parameters(dialogue_option_node_editor, 'dialogue_option_node_changed', [expected['id'], expected['character_id'], expected['option'], expected['text_translation_key']])