GD-291: Spy fails for class with custom formatted function signature (#292)

* GD-291: Spy fails for class with custom formatted function signature

- spy was failing to parse the function signature for custom formatted functions
- scans now until end of function to collect the complete function signature
- fixed error line detection for verify_no_interactions and verify_no_more_interactions

Author: MikeSchulze

addons/gdUnit3/src/asserts/GdUnitAssertImpl.gd

@@ -23,6 +23,7 @@ static func _get_line_number() -> int:
 		 or source.ends_with("AssertImpl.gd") \
 		 or source.ends_with("GdUnitTestSuite.gd") \
 		 or source.ends_with("GdUnitSceneRunnerImpl.gd") \
+		 or source.ends_with("GdUnitObjectInteractions.gd") \
 		 or source.ends_with("GdUnitAwaiter.gd"):
 			continue
 		return stack_info.get("line")

addons/gdUnit3/src/core/parse/GdScriptParser.gd

@@ -502,6 +502,16 @@ func extract_source_code(script_path :PoolStringArray) -> PoolStringArray:
 		source_code += load_source_code(base_script, script_path)
 	return source_code
 
+func extract_func_signature(rows :PoolStringArray, index :int) -> String:
+	var signature = ""
+	for rowIndex in range(index, rows.size()):
+		var row :String = rows[rowIndex]
+		signature += row.trim_prefix("\t").trim_suffix("\t")
+		if is_func_end(row):
+			return clean_up_row(signature)
+	push_error("Can't fully extract function signature of '%s'" % rows[index])
+	return ""
+
 func load_source_code(script :GDScript, script_path :PoolStringArray) -> PoolStringArray:
 	var map := script.get_script_constant_map()
 	for key in map.keys():
@@ -543,14 +553,16 @@ func parse_func_name(row :String) -> String:
 
 func parse_functions(rows :PoolStringArray, clazz_name :String, clazz_path :PoolStringArray) -> Array:
 	var func_descriptors := Array()
-	for row in rows:
+	for rowIndex in rows.size():
+		var row = rows[rowIndex]
 		# step over inner class functions
 		if row.begins_with("\t"):
 			continue
 		var input = clean_up_row(row)
 		var token := next_token(input, 0)
 		if token == TOKEN_FUNCTION_STATIC_DECLARATION or token == TOKEN_FUNCTION_DECLARATION:
-			func_descriptors.append(parse_func_description(row, clazz_name, clazz_path))
+			var func_signature = extract_func_signature(rows, rowIndex)
+			func_descriptors.append(parse_func_description(func_signature, clazz_name, clazz_path))
 	return func_descriptors
 
 func parse_func_description(func_signature :String, clazz_name :String, clazz_path :PoolStringArray) -> GdFunctionDescriptor:

addons/gdUnit3/test/core/parse/GdScriptParserTest.gd

@@ -319,6 +319,20 @@ func test_extract_source_code_inner_class_Area4D():
 	var file_content := resource_as_array("res://addons/gdUnit3/test/core/resources/Area4D.txt")
 	assert_array(rows).contains_exactly(file_content)
 
+func test_extract_function_signature() -> void:
+	var path := GdObjects.extract_class_path("res://addons/gdUnit3/test/mocker/resources/ClassWithCustomFormattings.gd")
+	var rows = _parser.extract_source_code(path)
+	
+	assert_that(_parser.extract_func_signature(rows, 9))\
+		.is_equal("funca1(set_name:String,path:String=\"\",load_on_init:bool=false,set_auto_save:bool=false,set_network_sync:bool=false)->void:")
+	assert_that(_parser.extract_func_signature(rows, 14))\
+		.is_equal("funca2(set_name:String,path:String=\"\",load_on_init:bool=false,set_auto_save:bool=false,set_network_sync:bool=false)->void:")
+	assert_that(_parser.extract_func_signature(rows, 19))\
+		.is_equal("funca3(set_name:String,path:String=\"\",load_on_init:bool=false,set_auto_save:bool=false,set_network_sync:bool=false):")
+	assert_that(_parser.extract_func_signature(rows, 24))\
+		.is_equal("funca4(set_name:String,path:String=\"\",load_on_init:bool=false,set_auto_save:bool=false,set_network_sync:bool=false):")
+
+
 func test_strip_leading_spaces():
 	assert_str(GdScriptParser.TokenInnerClass._strip_leading_spaces("")).is_empty()
 	assert_str(GdScriptParser.TokenInnerClass._strip_leading_spaces(" ")).is_empty()

addons/gdUnit3/test/mocker/resources/ClassWithCustomFormattings.gd

@@ -0,0 +1,31 @@
+extends Object
+
+var _message
+
+func _init(message:String, path:String="", load_on_init:bool=false, 
+	set_auto_save:bool=false, set_network_sync:bool=false
+) -> void:
+	_message = message
+
+func a1(set_name:String, path:String="", load_on_init:bool=false, 
+	set_auto_save:bool=false, set_network_sync:bool=false
+) -> void:
+	pass
+
+func a2(set_name:String, path:String="", load_on_init:bool=false, 
+	set_auto_save:bool=false, set_network_sync:bool=false
+) -> 	void:
+	pass
+
+func a3(set_name:String, path:String="", load_on_init:bool=false, 
+	set_auto_save:bool=false, set_network_sync:bool=false
+) :
+	pass
+
+func a4(set_name:String,
+	path:String="",
+	load_on_init:bool=false,
+	set_auto_save:bool=false,
+	set_network_sync:bool=false
+):
+	pass

addons/gdUnit3/test/spy/GdUnitSpyTest.gd

@@ -94,6 +94,16 @@ func test_spy_on_custom_class():
 	# verify if a not used argument not counted
 	verify(spy_instance, 0).get_area("test_no")
 
+# GD-291 https://github.com/MikeSchulze/gdUnit3/issues/291
+func test_spy_class_with_custom_formattings() -> void:
+	var resource = load("res://addons/gdUnit3/test/mocker/resources/ClassWithCustomFormattings.gd")
+	var spy = spy(resource.new("test"))
+	spy.a1("set_name", "", true)
+	verify(spy, 1).a1("set_name", "", true)
+	verify_no_more_interactions(spy)
+	verify_no_interactions(spy, GdUnitAssert.EXPECT_FAIL)
+	assert_int(GdAssertReports.get_last_error_line_number()).is_equal(104)
+
 func test_spy_copied_class_members():
 	var instance = auto_free(load("res://addons/gdUnit3/test/mocker/resources/TestPersion.gd").new("user-x", "street", 56616))
 	assert_that(instance._name).is_equal("user-x")