[#1] FIXED Adding instanced scene namespace as custom type

Cat-Lips · Cat-Lips · commit c758c6cb2826 · 2021-03-19T21:47:14.000+11:00
diff --git a/CustomGeneratorTests/CustomGeneratorTests.csproj b/CustomGeneratorTests/CustomGeneratorTests.csproj
@@ -9,6 +9,6 @@
     <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="GodotSharp.SourceGenerators" Version="1.1.0" />
+    <PackageReference Include="GodotSharp.SourceGenerators" Version="1.1.1" />
   </ItemGroup>
 </Project>
diff --git a/GodotTests/GodotTests.csproj b/GodotTests/GodotTests.csproj
@@ -14,7 +14,7 @@
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.0.0-alpha0002" />
     <PackageReference Include="FluentAssertions.Analyzers" Version="0.11.4" />
-    <PackageReference Include="GodotSharp.SourceGenerators" Version="1.1.0" />
+    <PackageReference Include="GodotSharp.SourceGenerators" Version="1.1.1" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\CustomGeneratorTests\CustomGeneratorTests.csproj" OutputItemType="analyzer" />
diff --git a/GodotTests/TestRunner/TestRunner.cs b/GodotTests/TestRunner/TestRunner.cs
@@ -26,6 +26,7 @@ public static IEnumerable<Func<ITest>> Tests
                 yield return () => GetTest<EmptySceneWithNoNamespace>();
                 yield return () => GetTest<InheritedScene>();
                 yield return () => GetTest<InstancedScene>();
+                yield return () => GetTest<InstancedSceneFromDifferentNamespace>();
                 yield return () => GetTest<ScriptForSceneWithDifferentName>();
                 yield return () => GetTest<ScriptForSceneWithDifferentPath>();
             }
diff --git a/GodotTests/TestScenes/EmptyScene.tscn b/GodotTests/TestScenes/EmptyScene.tscn
@@ -2,7 +2,7 @@
 
 [ext_resource path="res://TestScenes/EmptyScene.cs" type="Script" id=1]
 
-[node name="Control" type="Control"]
+[node name="Scene" type="Control"]
 anchor_right = 1.0
 anchor_bottom = 1.0
 script = ExtResource( 1 )
diff --git a/GodotTests/TestScenes/EmptySceneWithNoNamespace.tscn b/GodotTests/TestScenes/EmptySceneWithNoNamespace.tscn
@@ -2,7 +2,7 @@
 
 [ext_resource path="res://TestScenes/EmptySceneWithNoNamespace.cs" type="Script" id=1]
 
-[node name="Control" type="Control"]
+[node name="Scene" type="Control"]
 anchor_right = 1.0
 anchor_bottom = 1.0
 script = ExtResource( 1 )
diff --git a/GodotTests/TestScenes/InheritedScene.cs b/GodotTests/TestScenes/InheritedScene.cs
@@ -1,3 +1,4 @@
+using System.Linq;
 using FluentAssertions;
 using Godot;
 using GodotTests.Utilities;
@@ -13,6 +14,11 @@ void ITest.InitTests()
             _.Local_Layout.Label2.Text.Should().Be("Label2.Local");
 
             _.Local_Layout.Get().Should().Be(GetNode("Local-Layout"));
+
+            // Inheritance should not expose private `_` of parent
+            _.GetType().GetProperties().Select(x => x.Name)
+                .Should().HaveCount(1)
+                .And.BeEquivalentTo(new[] { "Local_Layout" });
         }
     }
 }
diff --git a/GodotTests/TestScenes/InstancedScene.cs b/GodotTests/TestScenes/InstancedScene.cs
@@ -8,6 +8,6 @@ namespace GodotTests.TestScenes
     public abstract partial class InstancedScene : Control, ITest
     {
         void ITest.InitTests()
-            => _.Root.Should().BeOfType<RootScene>().And.NotBeNull();
+            => _.InstancedScene.Should().BeOfType<RootScene>().And.NotBeNull();
     }
 }
diff --git a/GodotTests/TestScenes/InstancedScene.tscn b/GodotTests/TestScenes/InstancedScene.tscn
@@ -3,15 +3,15 @@
 [ext_resource path="res://RootScene.tscn" type="PackedScene" id=1]
 [ext_resource path="res://TestScenes/InstancedScene.cs" type="Script" id=2]
 
-[node name="InstancedScene" type="CenterContainer"]
+[node name="Scene" type="CenterContainer"]
 anchor_right = 1.0
 anchor_bottom = 1.0
 script = ExtResource( 2 )
 __meta__ = {
 "_edit_use_anchors_": false
 }
 
-[node name="Root" parent="." instance=ExtResource( 1 )]
+[node name="InstancedScene" parent="." instance=ExtResource( 1 )]
 anchor_right = 0.0
 anchor_bottom = 0.0
 offset_left = 340.0
diff --git a/GodotTests/TestScenes/InstancedSceneFromDifferentNamespace.cs b/GodotTests/TestScenes/InstancedSceneFromDifferentNamespace.cs
@@ -0,0 +1,15 @@
+using FluentAssertions;
+using Godot;
+using GodotTests.TestScenes.Script;
+using GodotTests.Utilities;
+
+namespace GodotTests.TestScenes
+{
+    [SceneTree]
+    public abstract partial class InstancedSceneFromDifferentNamespace : Control, ITest
+    {
+        // Known Issue: tscn and script must have same name
+        void ITest.InitTests()
+            => _.InstancedScene.Should().BeOfType<SceneInDifferentNamespace>().And.NotBeNull();
+    }
+}
diff --git a/GodotTests/TestScenes/InstancedSceneFromDifferentNamespace.tscn b/GodotTests/TestScenes/InstancedSceneFromDifferentNamespace.tscn
@@ -0,0 +1,20 @@
+[gd_scene load_steps=3 format=2]
+
+[ext_resource path="res://TestScenes/Scene/SceneInDifferentNamespace.tscn" type="PackedScene" id=1]
+[ext_resource path="res://TestScenes/InstancedSceneFromDifferentNamespace.cs" type="Script" id=2]
+
+[node name="Scene" type="CenterContainer"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+script = ExtResource( 2 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="InstancedScene" parent="." instance=ExtResource( 1 )]
+anchor_right = 0.0
+anchor_bottom = 0.0
+offset_left = 491.0
+offset_top = 281.0
+offset_right = 533.0
+offset_bottom = 319.0
diff --git a/GodotTests/TestScenes/Scene/SceneInDifferentNamespace.tscn b/GodotTests/TestScenes/Scene/SceneInDifferentNamespace.tscn
@@ -0,0 +1,37 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://TestScenes/Script/SceneInDifferentNamespace.cs" type="Script" id=1]
+
+[node name="Scene" type="CenterContainer"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+script = ExtResource( 1 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Layout" type="VBoxContainer" parent="."]
+offset_left = 491.0
+offset_top = 281.0
+offset_right = 533.0
+offset_bottom = 319.0
+script = null
+
+[node name="-Label-1-" type="Label" parent="Layout"]
+offset_right = 42.0
+offset_bottom = 17.0
+text = "Label1"
+align = 1
+valign = 1
+structured_text_bidi_override_options = [  ]
+script = null
+
+[node name="-Label-2-" type="Label" parent="Layout"]
+offset_top = 21.0
+offset_right = 42.0
+offset_bottom = 38.0
+text = "Label2"
+align = 1
+valign = 1
+structured_text_bidi_override_options = [  ]
+script = null
diff --git a/GodotTests/TestScenes/Script/SceneInDifferentNamespace.cs b/GodotTests/TestScenes/Script/SceneInDifferentNamespace.cs
@@ -0,0 +1,9 @@
+﻿using Godot;
+
+namespace GodotTests.TestScenes.Script
+{
+    [SceneTree("../Scene/SceneInDifferentNamespace.tscn")]
+    public abstract partial class SceneInDifferentNamespace : Control
+    {
+    }
+}
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 C# Source Generators for use with the Godot Game Engine (available via Nuget):
 * `SceneTree` class attribute: Provides strongly typed access to the scene hierarchy (via `_` operator)
 * `GodotOverride` method attribute: Allows use of On*, instead of virtual _* overrides
-* **NEW:** Base classes/helpers to create project specific source generators
+* Base classes/helpers to create project specific source generators
 
 (See tests for example usage patterns)
 
diff --git a/SourceGenerators/SceneTreeExtensions/SceneTreeScraper.cs b/SourceGenerators/SceneTreeExtensions/SceneTreeScraper.cs
@@ -23,7 +23,8 @@ private enum Phase
         public static (ICollection<SceneTreeNode> ChildNodes, ICollection<string> CustomTypes) GetNodes(string tscnFile)
         {
             // If present, use resource name as node type (script, scene)
-            // NB: Using the scene name requires the C# type to have the same name
+            // Known Issue: For instanced scenes, scene and script must match
+            //  (If required, will need to scrape instanced tscn to get script name)
             var resourceNames = new Dictionary<string, string>();
 
             // Scan resources (top of file) to get script/scene names
@@ -55,7 +56,9 @@ void NodeScan()
                     match = Regex.Match(line, SceneInstanceRegex, RegexOptions.Compiled);
                     if (match.Success)
                     {
-                        AddNode(resourceNames[match.Groups["Id"].Value]);
+                        var customType = resourceNames[match.Groups["Id"].Value];
+                        customTypes.Add(customType);
+                        AddNode(customType);
                         return;
                     }
 
diff --git a/SourceGenerators/SourceGenerators.csproj b/SourceGenerators/SourceGenerators.csproj
@@ -25,7 +25,8 @@
     <Description>C# Source Generators for use with the Godot Game Engine:
  - `SceneTree` class attribute: Provides strongly typed access to the scene hierarchy (via `_` operator)
  - `GodotOverride` method attribute: Allows use of On*, instead of virtual _* overrides
- - NEW: Base classes/helpers to create project specific source generators
+ - Base classes/helpers to create project specific source generators
+ - FIXED: [SceneTree] Instanced scene from different namespace fails to compile
 
 (See tests for example usage patterns)
 
@@ -35,7 +36,7 @@ NB:  Project reload or vs restart may be required to initialise Intellisense...
     <PackageProjectUrl>https://github.com/Cat-Lips/GodotSharp.SourceGenerators</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageTags>Godot C#</PackageTags>
-    <Version>1.1.0</Version>
+    <Version>1.1.1</Version>
     <!--<Version>1.1.1-$(Configuration)-$([System.DateTime]::Now.ToString(yyyyMMdd-HHmmss))</Version>-->
   </PropertyGroup>
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ public static IEnumerable<Func<ITest>> Tests`
`26`	`26`	`yield return () => GetTest<EmptySceneWithNoNamespace>();`
`27`	`27`	`yield return () => GetTest<InheritedScene>();`
`28`	`28`	`yield return () => GetTest<InstancedScene>();`
	`29`	`+ yield return () => GetTest<InstancedSceneFromDifferentNamespace>();`
`29`	`30`	`yield return () => GetTest<ScriptForSceneWithDifferentName>();`
`30`	`31`	`yield return () => GetTest<ScriptForSceneWithDifferentPath>();`
`31`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+using System.Linq;`
`1`	`2`	`using FluentAssertions;`
`2`	`3`	`using Godot;`
`3`	`4`	`using GodotTests.Utilities;`
`@@ -13,6 +14,11 @@ void ITest.InitTests()`
`13`	`14`	`_.Local_Layout.Label2.Text.Should().Be("Label2.Local");`
`14`	`15`
`15`	`16`	`_.Local_Layout.Get().Should().Be(GetNode("Local-Layout"));`
	`17`	`+`
	`18`	+ // Inheritance should not expose private `_` of parent
	`19`	`+ _.GetType().GetProperties().Select(x => x.Name)`
	`20`	`+ .Should().HaveCount(1)`
	`21`	`+ .And.BeEquivalentTo(new[] { "Local_Layout" });`
`16`	`22`	`}`
`17`	`23`	`}`
`18`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@ namespace GodotTests.TestScenes`
`8`	`8`	`public abstract partial class InstancedScene : Control, ITest`
`9`	`9`	`{`
`10`	`10`	`void ITest.InitTests()`
`11`		`- => _.Root.Should().BeOfType<RootScene>().And.NotBeNull();`
	`11`	`+ => _.InstancedScene.Should().BeOfType<RootScene>().And.NotBeNull();`
`12`	`12`	`}`
`13`	`13`	`}`