Support setting referent properties via attributes (#843)

Co-authored-by: Kenneth Loeffler <[email protected]>
rojo-rbx · Jun 20, 2024 · 7e2bab9 · 7e2bab9
1 parent a7b45ee
commit 7e2bab9
Show file tree

Hide file tree

Showing 64 changed files with 942 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,25 @@
 # Rojo Changelog
 
 ## Unreleased Changes
+* Projects may now manually link `Ref` properties together using `Attributes`. ([#843])
+ 	This has two parts: using `id` or `$id` in JSON files or a `Rojo_Target` attribute, an Instance
+    is given an ID. Then, that ID may be used elsewhere in the project to point to an Instance
+    using an attribute named `Rojo_Target_PROP_NAME`, where `PROP_NAME` is the name of a property.
+
+    As an example, here is a `model.json` for an ObjectValue that refers to itself:
+
+    ```json
+    {
+        "id": "arbitrary string",
+        "attributes": {
+            "Rojo_Target_Value": "arbitrary string"
+        }
+    }
+    ```
+
+    This is a very rough implementation and the usage will become more ergonomic
+    over time.
+
 * Updated Undo/Redo history to be more robust ([#915])
 * Fixed removing trailing newlines ([#903])
 * Added Never option to Confirmation ([#893])
@@ -61,6 +80,7 @@
 [#834]: https://github.com/rojo-rbx/rojo/pull/834
 [#838]: https://github.com/rojo-rbx/rojo/pull/838
 [#840]: https://github.com/rojo-rbx/rojo/pull/840
+[#843]: https://github.com/rojo-rbx/rojo/pull/843
 [#883]: https://github.com/rojo-rbx/rojo/pull/883
 [#886]: https://github.com/rojo-rbx/rojo/pull/886
 [#893]: https://github.com/rojo-rbx/rojo/pull/893

diff --git a/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_all-2.snap b/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_all-2.snap
@@ -0,0 +1,141 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-10:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-10
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ProjectPointer
+    Parent: id-9
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: project target
+      Value:
+        Ref: id-9
+  id-11:
+    Children: []
+    ClassName: Model
+    Id: id-11
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ProjectPointer
+    Parent: id-7
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_PrimaryPart:
+            String: project target
+      PrimaryPart:
+        Ref: id-9
+  id-2:
+    Children:
+      - id-3
+    ClassName: DataModel
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ref_properties
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children:
+      - id-4
+      - id-5
+      - id-7
+      - id-9
+    ClassName: Workspace
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: Workspace
+    Parent: id-2
+    Properties: {}
+  id-4:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-4
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: CrossFormatPointer
+    Parent: id-3
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: folder target
+      Value:
+        Ref: id-5
+  id-5:
+    Children:
+      - id-6
+    ClassName: Folder
+    Id: id-5
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: FolderTarget
+    Parent: id-3
+    Properties: {}
+  id-6:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-6
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: FolderPointer
+    Parent: id-5
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: folder target
+      Value:
+        Ref: id-5
+  id-7:
+    Children:
+      - id-8
+      - id-11
+    ClassName: Folder
+    Id: id-7
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ModelTarget
+    Parent: id-3
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Id:
+            String: model target 2
+  id-8:
+    Children: []
+    ClassName: Model
+    Id: id-8
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ModelPointer
+    Parent: id-7
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_PrimaryPart:
+            String: model target 2
+      PrimaryPart:
+        Ref: id-7
+  id-9:
+    Children:
+      - id-10
+    ClassName: Folder
+    Id: id-9
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ProjectTarget
+    Parent: id-3
+    Properties: {}
+messageCursor: 1
+sessionId: id-1
+
diff --git a/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_all.snap b/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_all.snap
@@ -0,0 +1,121 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-10:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-10
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ProjectPointer
+    Parent: id-9
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: project target
+      Value:
+        Ref: id-9
+  id-2:
+    Children:
+      - id-3
+    ClassName: DataModel
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ref_properties
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children:
+      - id-4
+      - id-5
+      - id-7
+      - id-9
+    ClassName: Workspace
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: Workspace
+    Parent: id-2
+    Properties: {}
+  id-4:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-4
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: CrossFormatPointer
+    Parent: id-3
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: folder target
+      Value:
+        Ref: id-5
+  id-5:
+    Children:
+      - id-6
+    ClassName: Folder
+    Id: id-5
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: FolderTarget
+    Parent: id-3
+    Properties: {}
+  id-6:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-6
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: FolderPointer
+    Parent: id-5
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: folder target
+      Value:
+        Ref: id-5
+  id-7:
+    Children:
+      - id-8
+    ClassName: Folder
+    Id: id-7
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ModelTarget
+    Parent: id-3
+    Properties: {}
+  id-8:
+    Children: []
+    ClassName: Model
+    Id: id-8
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ModelPointer
+    Parent: id-7
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_PrimaryPart:
+            String: model target
+      PrimaryPart:
+        Ref: id-7
+  id-9:
+    Children:
+      - id-10
+    ClassName: Folder
+    Id: id-9
+    Metadata:
+      ignoreUnknownInstances: true
+    Name: ProjectTarget
+    Parent: id-3
+    Properties: {}
+messageCursor: 0
+sessionId: id-1
+
diff --git a/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_info.snap b/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_info.snap
@@ -0,0 +1,13 @@
+---
+source: tests/tests/serve.rs
+expression: redactions.redacted_yaml(info)
+---
+expectedPlaceIds: ~
+gameId: ~
+placeId: ~
+projectName: ref_properties
+protocolVersion: 4
+rootInstanceId: id-2
+serverVersion: "[server-version]"
+sessionId: id-1
+
diff --git a/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_remove_all-2.snap b/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_remove_all-2.snap
@@ -0,0 +1,33 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ref_properties_remove
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: pointer
+    Parent: id-2
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: test pointer
+      Value:
+        Ref: id-4
+messageCursor: 1
+sessionId: id-1
+
diff --git a/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_remove_all.snap b/rojo-test/serve-test-snapshots/end_to_end__tests__serve__ref_properties_remove_all.snap
@@ -0,0 +1,47 @@
+---
+source: tests/tests/serve.rs
+expression: "read_response.intern_and_redact(&mut redactions, root_id)"
+---
+instances:
+  id-2:
+    Children:
+      - id-3
+      - id-4
+    ClassName: Folder
+    Id: id-2
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: ref_properties_remove
+    Parent: "00000000000000000000000000000000"
+    Properties: {}
+  id-3:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-3
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: pointer
+    Parent: id-2
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Target_Value:
+            String: test pointer
+      Value:
+        Ref: id-4
+  id-4:
+    Children: []
+    ClassName: ObjectValue
+    Id: id-4
+    Metadata:
+      ignoreUnknownInstances: false
+    Name: target
+    Parent: id-2
+    Properties:
+      Attributes:
+        Attributes:
+          Rojo_Id:
+            String: test pointer
+messageCursor: 0
+sessionId: id-1
+