tree-sitter-stack-graphs 0.10.0

Create stack graphs using tree-sitter parsers
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2022, stack-graphs authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------

use stack_graphs::graph::StackGraph;
use tree_sitter_graph::Variables;
use tree_sitter_stack_graphs::NoCancellation;
use tree_sitter_stack_graphs::StackGraphLanguage;
use tree_sitter_stack_graphs::FILE_PATH_VAR;

use crate::edges::check_stack_graph_edges;
use crate::nodes::check_stack_graph_nodes;

#[test]
fn can_support_preexisting_nodes() {
    let tsg = r#"
    (module)@mod {
      node @mod.lexical_scope
    }
    "#;
    let python = "pass";

    let file_name = "test.py";

    let mut graph = StackGraph::new();
    let file = graph.get_or_create_file(file_name);
    let node_id = graph.new_node_id(file);
    let _preexisting_node = graph.add_scope_node(node_id, true).unwrap();

    let mut globals = Variables::new();
    globals
        .add(FILE_PATH_VAR.into(), file_name.into())
        .expect("failed to add file path variable");

    let language = StackGraphLanguage::from_str(tree_sitter_python::LANGUAGE.into(), tsg).unwrap();
    language
        .build_stack_graph_into(&mut graph, file, python, &globals, &NoCancellation)
        .expect("Failed to build graph");
}

#[test]
fn can_support_injected_nodes() {
    let tsg = r#"
    global EXT_NODE
    (module)@mod {
      node @mod.lexical_scope
      edge @mod.lexical_scope -> EXT_NODE
    }
    "#;
    let python = "pass";

    let file_name = "test.py";

    let mut graph = StackGraph::new();
    let file = graph.get_or_create_file(file_name);
    let node_id = graph.new_node_id(file);
    let _preexisting_node = graph.add_scope_node(node_id, true).unwrap();

    let language = StackGraphLanguage::from_str(tree_sitter_python::LANGUAGE.into(), tsg).unwrap();
    let mut builder = language.builder_into_stack_graph(&mut graph, file, python);

    let mut globals = Variables::new();
    globals
        .add(FILE_PATH_VAR.into(), file_name.into())
        .expect("failed to add file path variable");

    globals
        .add("EXT_NODE".into(), builder.inject_node(node_id).into())
        .expect("Failed to add EXT_NODE variable");

    builder
        .build(&globals, &NoCancellation)
        .expect("Failed to build graph");

    check_stack_graph_nodes(
        &graph,
        file,
        &["[test.py(0) exported scope]", "[test.py(1) scope]"],
    );
    check_stack_graph_edges(
        &graph,
        &["[test.py(1) scope] -0-> [test.py(0) exported scope]"],
    );
}