rubydex 0.3.0 → 0.4.0

data/rust/rubydex/src/query/cypher/tests.rs

@@ -1,5 +1,5 @@
-use super::run_query;
 use super::schema::RelType;
+use super::{render, run_query};
 use crate::model::graph::Graph;
 use crate::test_utils::GraphTest;
 use cypher_parser::{CypherValue, OutputFormat, ResultSet, execute, parse};
@@ -197,6 +197,31 @@ fn run_query_json_output() {
     assert_eq!(output, "[{\"c.name\":\"Dog\"}]");
 }
 
+#[test]
+fn render_formats_one_result_set_in_both_formats() {
+    // `execute` runs the query once; `render` formats that same result set as often as needed.
+    let graph = fixture_graph();
+    let result = run(&graph, "MATCH (c:Class {name: 'Dog'}) RETURN c.name");
+
+    assert_eq!(render(&result, OutputFormat::Json), "[{\"c.name\":\"Dog\"}]");
+
+    let table = render(&result, OutputFormat::Table);
+    assert!(table.contains("c.name"));
+    assert!(table.contains("Dog"));
+    assert!(table.contains("1 row"));
+}
+
+#[test]
+fn incoming_declares_and_defines_reach_the_document() {
+    // Exercises `expand_in`: walk the Document -> Definition -> Declaration spine backwards.
+    let graph = fixture_graph();
+    let result = run(
+        &graph,
+        "MATCH (decl:Class {name: 'Dog'})<-[:DECLARES]-(def:Definition)<-[:DEFINES]-(d:Document) RETURN DISTINCT d.name",
+    );
+    assert_eq!(column_strings(&result, 0), vec!["zoo.rb".to_string()]);
+}
+
 #[test]
 fn unknown_relationship_type_errors() {
     let graph = fixture_graph();

data/rust/rubydex/src/query/cypher.rs

@@ -18,8 +18,9 @@
 // `Graph` (in `schema`) and the static schema description (in `schema_info`).
 //
 // `Query` is the opaque parsed-query object: callers can `parse` a query string once (failing fast
-// on syntax errors), then `run_parsed` it against a graph that was built afterwards.
-pub use cypher_parser::{CypherError, OutputFormat, Query, parse};
+// on syntax errors), `execute` it against a graph that was built afterwards, and `render` the
+// resulting [`ResultSet`] without running the query again.
+pub use cypher_parser::{CypherError, CypherValue, OutputFormat, Query, ResultSet, execute, parse};
 
 pub mod schema;
 pub mod schema_info;
@@ -35,15 +36,11 @@ pub fn run_query(graph: &Graph, query: &str, output_format: OutputFormat) -> Res
     cypher_parser::run_query(graph, query, output_format)
 }
 
-/// Executes an already-parsed [`Query`] against the graph and formats the result. Pair with
-/// [`parse`] to validate a query before building the graph.
-///
-/// # Errors
-///
-/// Returns a [`CypherError`] if the query cannot be executed.
-pub fn run_parsed(graph: &Graph, query: &Query, output_format: OutputFormat) -> Result<String, CypherError> {
-    let result = cypher_parser::execute(graph, query)?;
-    Ok(cypher_parser::format::format(&result, output_format))
+/// Renders an already-executed [`ResultSet`] in the requested format. Pair with [`execute`] to run a
+/// parsed query once and render its result set as often as needed.
+#[must_use]
+pub fn render(result: &ResultSet, output_format: OutputFormat) -> String {
+    cypher_parser::format::format(result, output_format)
 }
 
 /// Returns a description of the queryable schema (node labels, relationship types, and properties)

data/rust/rubydex/src/query.rs

@@ -1173,7 +1173,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Child"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Child"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1222,7 +1228,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Child"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Child"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1271,7 +1283,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1320,8 +1332,14 @@ mod tests {
         );
         context.resolve();
 
-        let foo_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
-        let name_id = Name::new(StringId::from("<Foo>"), ParentScope::Attached(foo_id), Some(foo_id)).id();
+        let foo_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("<Foo>"),
+            ParentScope::Attached(foo_id),
+            Some(foo_id),
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1341,7 +1359,7 @@ mod tests {
             ]
         );
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1383,8 +1401,14 @@ mod tests {
         );
         context.resolve();
 
-        let foo_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
-        let name_id = Name::new(StringId::from("<Foo>"), ParentScope::Attached(foo_id), Some(foo_id)).id();
+        let foo_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("<Foo>"),
+            ParentScope::Attached(foo_id),
+            Some(foo_id),
+        )
+        .id();
 
         assert_declaration_completion_eq!(
             context,
@@ -1431,9 +1455,10 @@ mod tests {
         context.resolve();
 
         let name_id = Name::new(
+            context.graph().names(),
             StringId::from("Bar"),
             ParentScope::TopLevel,
-            Some(Name::new(StringId::from("Foo"), ParentScope::None, None).id()),
+            Some(Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id()),
         )
         .id();
 
@@ -1457,7 +1482,7 @@ mod tests {
             ]
         );
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -1498,8 +1523,14 @@ mod tests {
         );
         context.resolve();
 
-        let foo_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, Some(foo_id)).id();
+        let foo_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Bar"),
+            ParentScope::None,
+            Some(foo_id),
+        )
+        .id();
         // Foo::CONST is reachable from Foo::Bar through lexical scoping, so it must appear as a completion candidate
         // when the user types the unqualified name CONST
         assert_declaration_completion_eq!(
@@ -1544,9 +1575,10 @@ mod tests {
         context.resolve();
 
         let name_id = Name::new(
+            context.graph().names(),
             StringId::from("Bar"),
             ParentScope::None,
-            Some(Name::new(StringId::from("Foo"), ParentScope::None, None).id()),
+            Some(Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id()),
         )
         .id();
         assert_declaration_completion_eq!(
@@ -2078,7 +2110,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2119,7 +2151,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2156,7 +2188,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2182,7 +2214,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2226,7 +2258,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2254,7 +2286,7 @@ mod tests {
         context.index_uri("file:///foo.rb", "class Foo; end");
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2319,7 +2351,7 @@ mod tests {
         context.index_uri("file:///foo.rb", "class Foo; def bar(name:); end; end");
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_completion_eq!(
             context,
             CompletionReceiver::MethodArgument {
@@ -2440,7 +2472,13 @@ mod tests {
         );
         context.resolve();
 
-        let outer_name_id = Name::new(StringId::from("Outer"), ParentScope::None, None).id();
+        let outer_name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Outer"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2479,7 +2517,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Outer"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Outer"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         // `self_decl_id` points to the alias `Outer::MyAlias`, which is a `ConstantAlias` rather than a `Namespace`.
         // The completion should still collect members from the aliased namespace (`Outer::Original`) instead of
         // returning an error, so callers do not have to unwrap aliases themselves.
@@ -2525,7 +2569,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2568,7 +2612,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2613,7 +2657,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2650,7 +2694,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Object"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Object"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2677,7 +2727,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Mod"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Mod"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2715,7 +2765,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Mod"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Mod"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2750,7 +2800,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Object"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Object"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2785,7 +2841,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2818,9 +2874,21 @@ mod tests {
         );
         context.resolve();
 
-        let bar_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
-        let foo_ref_id = Name::new(StringId::from("Foo"), ParentScope::None, Some(bar_id)).id();
-        let nesting_name_id = Name::new(StringId::from("<Foo>"), ParentScope::Attached(foo_ref_id), Some(bar_id)).id();
+        let bar_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
+        let foo_ref_id = Name::new(
+            context.graph().names(),
+            StringId::from("Foo"),
+            ParentScope::None,
+            Some(bar_id),
+        )
+        .id();
+        let nesting_name_id = Name::new(
+            context.graph().names(),
+            StringId::from("<Foo>"),
+            ParentScope::Attached(foo_ref_id),
+            Some(bar_id),
+        )
+        .id();
 
         assert_declaration_completion_eq!(
             context,
@@ -2859,7 +2927,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Mod"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Mod"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -2897,8 +2965,14 @@ mod tests {
         );
         context.resolve();
 
-        let foo_ref_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
-        let nesting_name_id = Name::new(StringId::from("<Foo>"), ParentScope::Attached(foo_ref_id), None).id();
+        let foo_ref_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
+        let nesting_name_id = Name::new(
+            context.graph().names(),
+            StringId::from("<Foo>"),
+            ParentScope::Attached(foo_ref_id),
+            None,
+        )
+        .id();
 
         assert_declaration_completion_eq!(
             context,
@@ -2923,7 +2997,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         let result = completion_candidates(
             context.graph(),
             CompletionContext::new(CompletionReceiver::Expression {
@@ -2949,7 +3023,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         let result = completion_candidates(
             context.graph(),
             CompletionContext::new(CompletionReceiver::Expression {
@@ -2981,7 +3055,13 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Outer"), ParentScope::None, None).id();
+        let name_id = Name::new(
+            context.graph().names(),
+            StringId::from("Outer"),
+            ParentScope::None,
+            None,
+        )
+        .id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -3024,7 +3104,7 @@ mod tests {
         );
         context.resolve();
 
-        let name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -3097,7 +3177,7 @@ mod tests {
         );
         context.resolve();
 
-        let foo_name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let foo_name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -3117,7 +3197,7 @@ mod tests {
             ]
         );
 
-        let bar_name_id = Name::new(StringId::from("Bar"), ParentScope::None, None).id();
+        let bar_name_id = Name::new(context.graph().names(), StringId::from("Bar"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {
@@ -3433,7 +3513,7 @@ mod tests {
         );
         context.resolve();
 
-        let foo_name_id = Name::new(StringId::from("Foo"), ParentScope::None, None).id();
+        let foo_name_id = Name::new(context.graph().names(), StringId::from("Foo"), ParentScope::None, None).id();
         assert_declaration_completion_eq!(
             context,
             CompletionReceiver::Expression {