Add basic indexer tests

Author: lionel-

crates/ark/src/lsp/indexer.rs

@@ -340,3 +340,96 @@ fn index_comment(_path: &Path, contents: &Rope, node: &Node) -> anyhow::Result<O
         data: IndexEntryData::Section { level, title },
     }))
 }
+#[cfg(test)]
+mod tests {
+    use std::path::PathBuf;
+
+    use insta::assert_debug_snapshot;
+
+    use super::*;
+    use crate::lsp::documents::Document;
+
+    macro_rules! test_index {
+        ($code:expr) => {
+            let doc = Document::new($code, None);
+            let path = PathBuf::from("/path/to/file.R");
+            let root = doc.ast.root_node();
+            let mut cursor = root.walk();
+
+            let mut entries = vec![];
+            for node in root.children(&mut cursor) {
+                if let Ok(Some(entry)) = index_node(&path, &doc.contents, &node) {
+                    entries.push(entry);
+                }
+            }
+            assert_debug_snapshot!(entries);
+        };
+    }
+
+    // Note that unlike document symbols whose ranges cover the whole entity
+    // they represent, the range of workspace symbols only cover the identifers
+
+    #[test]
+    fn test_index_function() {
+        test_index!(
+            r#"
+my_function <- function(a, b = 1) {
+  a + b
+
+  # These are not indexed as workspace symbol
+  inner <- function() {
+    2
+  }
+  inner_var <- 3
+}
+
+my_variable <- 1
+"#
+        );
+    }
+
+    #[test]
+    fn test_index_variable() {
+        test_index!(
+            r#"
+x <- 10
+y = "hello"
+"#
+        );
+    }
+
+    #[test]
+    fn test_index_s7_methods() {
+        test_index!(
+            r#"
+Class <- new_class("Class")
+generic <- new_generic("generic", "arg",
+  function(arg) {
+    S7_dispatch()
+  }
+)
+method(generic, Class) <- function(arg) {
+  NULL
+}
+"#
+        );
+    }
+
+    #[test]
+    fn test_index_comment_section() {
+        test_index!(
+            r#"
+# Section 1 ----
+x <- 10
+
+## Subsection ======
+y <- 20
+
+x <- function() {
+    # This inner section is not indexed ----
+}
+
+"#
+        );
+    }
+}

crates/ark/src/lsp/snapshots/ark__lsp__indexer__tests__index_comment_section.snap

@@ -0,0 +1,89 @@
+---
+source: crates/ark/src/lsp/indexer.rs
+expression: entries
+---
+[
+    IndexEntry {
+        key: "Section 1",
+        range: Range {
+            start: Position {
+                line: 1,
+                character: 0,
+            },
+            end: Position {
+                line: 1,
+                character: 16,
+            },
+        },
+        data: Section {
+            level: 1,
+            title: "Section 1",
+        },
+    },
+    IndexEntry {
+        key: "x",
+        range: Range {
+            start: Position {
+                line: 2,
+                character: 0,
+            },
+            end: Position {
+                line: 2,
+                character: 1,
+            },
+        },
+        data: Variable {
+            name: "x",
+        },
+    },
+    IndexEntry {
+        key: "Subsection",
+        range: Range {
+            start: Position {
+                line: 4,
+                character: 0,
+            },
+            end: Position {
+                line: 4,
+                character: 20,
+            },
+        },
+        data: Section {
+            level: 2,
+            title: "Subsection",
+        },
+    },
+    IndexEntry {
+        key: "y",
+        range: Range {
+            start: Position {
+                line: 5,
+                character: 0,
+            },
+            end: Position {
+                line: 5,
+                character: 1,
+            },
+        },
+        data: Variable {
+            name: "y",
+        },
+    },
+    IndexEntry {
+        key: "x",
+        range: Range {
+            start: Position {
+                line: 7,
+                character: 0,
+            },
+            end: Position {
+                line: 7,
+                character: 1,
+            },
+        },
+        data: Function {
+            name: "x",
+            arguments: [],
+        },
+    },
+]

crates/ark/src/lsp/snapshots/ark__lsp__indexer__tests__index_function.snap

@@ -0,0 +1,42 @@
+---
+source: crates/ark/src/lsp/indexer.rs
+expression: entries
+---
+[
+    IndexEntry {
+        key: "my_function",
+        range: Range {
+            start: Position {
+                line: 1,
+                character: 0,
+            },
+            end: Position {
+                line: 1,
+                character: 11,
+            },
+        },
+        data: Function {
+            name: "my_function",
+            arguments: [
+                "a",
+                "b",
+            ],
+        },
+    },
+    IndexEntry {
+        key: "my_variable",
+        range: Range {
+            start: Position {
+                line: 11,
+                character: 0,
+            },
+            end: Position {
+                line: 11,
+                character: 11,
+            },
+        },
+        data: Variable {
+            name: "my_variable",
+        },
+    },
+]

crates/ark/src/lsp/snapshots/ark__lsp__indexer__tests__index_s7_methods.snap

@@ -0,0 +1,54 @@
+---
+source: crates/ark/src/lsp/indexer.rs
+expression: entries
+---
+[
+    IndexEntry {
+        key: "Class",
+        range: Range {
+            start: Position {
+                line: 1,
+                character: 0,
+            },
+            end: Position {
+                line: 1,
+                character: 5,
+            },
+        },
+        data: Variable {
+            name: "Class",
+        },
+    },
+    IndexEntry {
+        key: "generic",
+        range: Range {
+            start: Position {
+                line: 2,
+                character: 0,
+            },
+            end: Position {
+                line: 2,
+                character: 7,
+            },
+        },
+        data: Variable {
+            name: "generic",
+        },
+    },
+    IndexEntry {
+        key: "method(generic, Class)",
+        range: Range {
+            start: Position {
+                line: 7,
+                character: 0,
+            },
+            end: Position {
+                line: 7,
+                character: 22,
+            },
+        },
+        data: Variable {
+            name: "method(generic, Class)",
+        },
+    },
+]

crates/ark/src/lsp/snapshots/ark__lsp__indexer__tests__index_variable.snap

@@ -0,0 +1,38 @@
+---
+source: crates/ark/src/lsp/indexer.rs
+expression: entries
+---
+[
+    IndexEntry {
+        key: "x",
+        range: Range {
+            start: Position {
+                line: 1,
+                character: 0,
+            },
+            end: Position {
+                line: 1,
+                character: 1,
+            },
+        },
+        data: Variable {
+            name: "x",
+        },
+    },
+    IndexEntry {
+        key: "y",
+        range: Range {
+            start: Position {
+                line: 2,
+                character: 0,
+            },
+            end: Position {
+                line: 2,
+                character: 1,
+            },
+        },
+        data: Variable {
+            name: "y",
+        },
+    },
+]