luciano/d2
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rename

Browse source
This commit is contained in:
Alexander Wang 2023-06-25 12:11:13 -07:00
parent 80ddea94fa
commit 1cd3116747
No known key found for this signature in database
GPG key ID: D89FA31966BDBECE
6 changed files with 1120 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
d2oracle/edit.go
View file

@ -1427,7 +1427,7 @@ func ensureNode(g *d2graph.Graph, excludedEdges []*d2ast.Edge, scopeObj *d2graph
}
}
func Rename(g *d2graph.Graph, key, newName string) (_ *d2graph.Graph, newKey string, err error) {
func Rename(g *d2graph.Graph, boardPath []string, key, newName string) (_ *d2graph.Graph, newKey string, err error) {
defer xdefer.Errorf(&err, "failed to rename %#v to %#v", key, newName)
mk, err := d2parser.ParseMapKey(key)
@ -1435,6 +1435,19 @@ func Rename(g *d2graph.Graph, key, newName string) (_ *d2graph.Graph, newKey str
return nil, "", err
}
boardG := g
// baseAST := g.AST
if len(boardPath) > 0 {
// When compiling a nested board, we can read from boardG but only write to baseBoardG
boardG = GetBoardGraph(g, boardPath)
if boardG == nil {
return nil, "", fmt.Errorf("board %v not found", boardPath)
}
// TODO beter name
// baseAST = boardG.BaseAST
}
if len(mk.Edges) > 0 && mk.EdgeKey == nil {
// TODO: Not a fan of this dual interpretation depending on mk.Edges.
// Maybe we remove Rename and just have Move.
@ -1451,12 +1464,12 @@ func Rename(g *d2graph.Graph, key, newName string) (_ *d2graph.Graph, newKey str
return nil, "", fmt.Errorf("cannot rename to reserved keyword: %#v", newName)
}
if mk.Key != nil {
obj, ok := g.Root.HasChild(d2graph.Key(mk.Key))
obj, ok := boardG.Root.HasChild(d2graph.Key(mk.Key))
if !ok {
return nil, "", fmt.Errorf("key does not exist")
}
// If attempt to name something "x", but "x" already exists, rename it "x 2" instead
generatedName, _, err := generateUniqueKey(g, newName, obj, nil)
generatedName, _, err := generateUniqueKey(boardG, newName, obj, nil)
if err == nil {
newName = generatedName
}
@ -1465,8 +1478,7 @@ func Rename(g *d2graph.Graph, key, newName string) (_ *d2graph.Graph, newKey str
mk.Key.Path[len(mk.Key.Path)-1] = d2ast.MakeValueBox(d2ast.RawString(newName, true)).StringBox()
}
// TODO
g, err = move(g, nil, key, d2format.Format(mk), false)
g, err = move(g, boardPath, key, d2format.Format(mk), false)
return g, newName, err
}

94
d2oracle/edit_test.go
View file

@ -2317,7 +2317,8 @@ func TestRename(t *testing.T) {
t.Parallel()
testCases := []struct {
name string
name string
boardPath []string
text string
key string
@ -2733,6 +2734,95 @@ more.(ok.q.z -> p.k): "furbling, v.:"
newName: "near",
expErr: `failed to rename "x.icon" to "near": cannot rename to reserved keyword: "near"`,
},
{
name: "layers-basic",
text: `x
layers: {
y: {
a
}
}
`,
boardPath: []string{"y"},
key: "a",
newName: "b",
exp: `x
layers: {
y: {
b
}
}
`,
},
{
name: "scenarios-basic",
text: `x
scenarios: {
y: {
a
}
}
`,
boardPath: []string{"y"},
key: "a",
newName: "b",
exp: `x
scenarios: {
y: {
b
}
}
`,
},
{
name: "scenarios-conflict",
text: `x
scenarios: {
y: {
a
}
}
`,
boardPath: []string{"y"},
key: "a",
newName: "x",
exp: `x
scenarios: {
y: {
x 2
}
}
`,
},
{
name: "scenarios-scope-err",
text: `x
scenarios: {
y: {
a
}
}
`,
boardPath: []string{"y"},
key: "x",
newName: "b",
expErr: `failed to rename "x" to "b": operation would modify AST outside of given scope`,
},
}
for _, tc := range testCases {
@ -2745,7 +2835,7 @@ more.(ok.q.z -> p.k): "furbling, v.:"
testFunc: func(g *d2graph.Graph) (*d2graph.Graph, error) {
objectsBefore := len(g.Objects)
var err error
g, _, err = d2oracle.Rename(g, tc.key, tc.newName)
g, _, err = d2oracle.Rename(g, tc.boardPath, tc.key, tc.newName)
if err == nil {
objectsAfter := len(g.Objects)
if objectsBefore != objectsAfter {

291
testdata/d2oracle/TestRename/layers-basic.exp.json generated vendored Normal file
View file

@ -0,0 +1,291 @@
{
"graph": {
"name": "",
"isFolderOnly": false,
"ast": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-7:0:32",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-0:1:1",
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"primary": {},
"value": {}
}
},
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,2:0:3-6:1:31",
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,2:0:3-2:6:9",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,2:0:3-2:6:9",
"value": [
{
"string": "layers",
"raw_string": "layers"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,2:8:11-6:1:31",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,3:2:15-5:3:29",
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,3:2:15-3:3:16",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,3:2:15-3:3:16",
"value": [
{
"string": "y",
"raw_string": "y"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,3:5:18-5:3:29",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,4:4:24-4:5:25",
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,4:4:24-4:5:25",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,4:4:24-4:5:25",
"value": [
{
"string": "b",
"raw_string": "b"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
}
}
}
}
]
}
}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "x",
"id_val": "x",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
],
"layers": [
{
"name": "y",
"isFolderOnly": false,
"ast": {
"range": ",1:0:0-2:0:0",
"nodes": [
{
"map_key": {
"range": ",0:0:0-0:0:0",
"key": {
"range": ",0:0:0-0:0:0",
"path": [
{
"unquoted_string": {
"range": ",0:0:0-0:0:0",
"value": [
{
"string": "b"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "b",
"id_val": "b",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,4:4:24-4:5:25",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/layers-basic.d2,4:4:24-4:5:25",
"value": [
{
"string": "b",
"raw_string": "b"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "b"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
]
}
]
},
"err": "<nil>"
}

358
testdata/d2oracle/TestRename/scenarios-basic.exp.json generated vendored Normal file
View file

@ -0,0 +1,358 @@
{
"graph": {
"name": "",
"isFolderOnly": false,
"ast": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-7:0:35",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"primary": {},
"value": {}
}
},
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,2:0:3-6:1:34",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,2:0:3-2:9:12",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,2:0:3-2:9:12",
"value": [
{
"string": "scenarios",
"raw_string": "scenarios"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,2:11:14-6:1:34",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,3:2:18-5:3:32",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,3:2:18-3:3:19",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,3:2:18-3:3:19",
"value": [
{
"string": "y",
"raw_string": "y"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,3:5:21-5:3:32",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,4:4:27-4:5:28",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,4:4:27-4:5:28",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,4:4:27-4:5:28",
"value": [
{
"string": "b",
"raw_string": "b"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
}
}
}
}
]
}
}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "x",
"id_val": "x",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
],
"scenarios": [
{
"name": "y",
"isFolderOnly": false,
"ast": {
"range": ",1:0:0-2:0:0",
"nodes": [
{
"map_key": {
"range": ",0:0:0-0:0:0",
"key": {
"range": ",0:0:0-0:0:0",
"path": [
{
"unquoted_string": {
"range": ",0:0:0-0:0:0",
"value": [
{
"string": "x"
}
]
}
}
]
},
"primary": {},
"value": {}
}
},
{
"map_key": {
"range": ",0:0:0-0:0:0",
"key": {
"range": ",0:0:0-0:0:0",
"path": [
{
"unquoted_string": {
"range": ",0:0:0-0:0:0",
"value": [
{
"string": "b"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "x",
"id_val": "x",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
{
"id": "b",
"id_val": "b",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,4:4:27-4:5:28",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-basic.d2,4:4:27-4:5:28",
"value": [
{
"string": "b",
"raw_string": "b"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "b"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
]
}
]
},
"err": "<nil>"
}

358
testdata/d2oracle/TestRename/scenarios-conflict.exp.json generated vendored Normal file
View file

@ -0,0 +1,358 @@
{
"graph": {
"name": "",
"isFolderOnly": false,
"ast": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-7:0:37",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"primary": {},
"value": {}
}
},
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,2:0:3-6:1:36",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,2:0:3-2:9:12",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,2:0:3-2:9:12",
"value": [
{
"string": "scenarios",
"raw_string": "scenarios"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,2:11:14-6:1:36",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,3:2:18-5:3:34",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,3:2:18-3:3:19",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,3:2:18-3:3:19",
"value": [
{
"string": "y",
"raw_string": "y"
}
]
}
}
]
},
"primary": {},
"value": {
"map": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,3:5:21-5:3:34",
"nodes": [
{
"map_key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,4:4:27-4:7:30",
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,4:4:27-4:7:30",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,4:4:27-4:7:30",
"value": [
{
"string": "x 2",
"raw_string": "x 2"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
}
}
}
}
]
}
}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "x",
"id_val": "x",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
],
"scenarios": [
{
"name": "y",
"isFolderOnly": false,
"ast": {
"range": ",1:0:0-2:0:0",
"nodes": [
{
"map_key": {
"range": ",0:0:0-0:0:0",
"key": {
"range": ",0:0:0-0:0:0",
"path": [
{
"unquoted_string": {
"range": ",0:0:0-0:0:0",
"value": [
{
"string": "x"
}
]
}
}
]
},
"primary": {},
"value": {}
}
},
{
"map_key": {
"range": ",0:0:0-0:0:0",
"key": {
"range": ",0:0:0-0:0:0",
"path": [
{
"unquoted_string": {
"range": ",0:0:0-0:0:0",
"value": [
{
"string": "x 2"
}
]
}
}
]
},
"primary": {},
"value": {}
}
}
]
},
"root": {
"id": "",
"id_val": "",
"attributes": {
"label": {
"value": ""
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": ""
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
"edges": null,
"objects": [
{
"id": "x",
"id_val": "x",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,0:0:0-0:1:1",
"value": [
{
"string": "x",
"raw_string": "x"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
},
{
"id": "x 2",
"id_val": "x 2",
"references": [
{
"key": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,4:4:27-4:7:30",
"path": [
{
"unquoted_string": {
"range": "d2/testdata/d2oracle/TestRename/scenarios-conflict.d2,4:4:27-4:7:30",
"value": [
{
"string": "x 2",
"raw_string": "x 2"
}
]
}
}
]
},
"key_path_index": 0,
"map_key_edge_index": -1
}
],
"attributes": {
"label": {
"value": "x 2"
},
"labelDimensions": {
"width": 0,
"height": 0
},
"style": {},
"near_key": null,
"shape": {
"value": "rectangle"
},
"direction": {
"value": ""
},
"constraint": null
},
"zIndex": 0
}
]
}
]
},
"err": "<nil>"
}

4
testdata/d2oracle/TestRename/scenarios-scope-err.exp.json generated vendored Normal file
View file

@ -0,0 +1,4 @@
{
"graph": null,
"err": "failed to rename \"x\" to \"b\": operation would modify AST outside of given scope"
}