rubydex 0.3.0 → 0.4.1

data/rust/rubydex/src/query.rs

@@ -5,7 +5,7 @@ use std::thread;
 
 use url::Url;
 
-use crate::model::built_in::OBJECT_ID;
+use crate::model::built_in::{BUILT_IN_URI_ID, OBJECT_ID};
 use crate::model::declaration::{Ancestor, Declaration, Namespace};
 use crate::model::definitions::{Definition, Parameter};
 use crate::model::graph::Graph;
@@ -833,6 +833,63 @@ pub fn follow_method_alias(graph: &Graph, alias_id: DefinitionId) -> Result<Decl
     }
 }
 
+/// Returns `true` when any definition of `declaration` was seeded by rubydex rather than read from indexed source.
+///
+/// Dead code candidates are reported at declaration granularity, so a seeded definition disqualifies the declaration
+/// even when user code also reopens it.
+fn is_built_in(graph: &Graph, declaration: &Declaration) -> bool {
+    declaration.definitions().iter().any(|definition_id| {
+        graph
+            .definitions()
+            .get(definition_id)
+            .is_some_and(|definition| definition.uri_id() == &*BUILT_IN_URI_ID)
+    })
+}
+
+/// Returns a list of declarations that may be unused in the codebase, which means
+/// that the analysis could not find any references to them. This misses
+/// meta-programming or untyped code, which is why the term candidates is used.
+///
+/// Currently, only supports constants.
+///
+/// # Panics
+///
+/// Will panic if any of the threads panic
+pub fn dead_code_candidates(graph: &Graph) -> Vec<DeclarationId> {
+    let num_threads = thread::available_parallelism().map_or(4, std::num::NonZero::get);
+    let declarations = graph.declarations();
+
+    let ids: Vec<DeclarationId> = declarations.keys().copied().collect();
+    let chunk_size = ids.len().div_ceil(num_threads);
+
+    if chunk_size == 0 {
+        return Vec::new();
+    }
+
+    thread::scope(|s| {
+        let handles: Vec<_> = ids
+            .chunks(chunk_size)
+            .map(|chunk| {
+                s.spawn(|| {
+                    chunk
+                        .iter()
+                        .filter(|id| {
+                            let decl = declarations.get(id).unwrap();
+                            decl.constant_references().is_some_and(HashSet::is_empty)
+                                && !matches!(decl, Declaration::Namespace(Namespace::SingletonClass(_)))
+                                && !decl.has_no_definitions()
+                                && !is_built_in(graph, decl)
+                        })
+                        .copied()
+                        .collect::<Vec<_>>()
+                })
+            })
+            .collect();
+
+        handles.into_iter().flat_map(|h| h.join().unwrap()).collect()
+    })
+}
+
 #[cfg(test)]
 mod tests {
     use std::str::FromStr;
@@ -920,6 +977,21 @@ mod tests {
         };
     }
 
+    macro_rules! assert_dead_code_candidates {
+        ($context:expr, [$($expected:expr),* $(,)?]) => {
+            let mut actual: Vec<String> = dead_code_candidates($context.graph())
+                .iter()
+                .map(|id| $context.graph().declarations().get(id).unwrap().name().to_string())
+                .collect();
+            actual.sort();
+
+            let mut expected: Vec<String> = vec![$(String::from($expected)),*];
+            expected.sort();
+
+            assert_eq!(expected, actual);
+        };
+    }
+
     #[test]
     fn fuzzy_search_returns_partial_matches() {
         let mut context = GraphTest::new();
@@ -1173,7 +1245,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 +1300,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 +1355,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 +1404,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 +1431,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 +1473,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 +1527,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 +1554,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 +1595,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 +1647,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 +2182,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 +2223,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 +2260,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 +2286,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 +2330,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 +2358,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 +2423,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 +2544,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 +2589,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 +2641,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 +2684,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 +2729,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 +2766,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 +2799,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 +2837,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 +2872,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 +2913,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 +2946,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 +2999,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 +3037,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 +3069,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 +3095,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 +3127,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 +3176,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 +3249,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 +3269,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 +3585,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 {
@@ -3902,4 +4054,122 @@ mod tests {
             Err(FindMemberError::DeclarationNotFound),
         );
     }
+
+    #[test]
+    fn dead_code_candidates_returns_unreferenced_constants() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            class UnusedClass; end
+            module UnusedModule; end
+            UNUSED_CONSTANT = 1
+            ",
+        );
+        context.resolve();
+
+        assert_dead_code_candidates!(context, ["UnusedClass", "UnusedModule", "UNUSED_CONSTANT"]);
+    }
+
+    #[test]
+    fn dead_code_candidates_excludes_referenced_constants() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            class UsedClass; end
+            USED_CONSTANT = 1
+            ",
+        );
+        context.index_uri(
+            "file:///bar.rb",
+            r"
+            UsedClass
+            USED_CONSTANT
+            ",
+        );
+        context.resolve();
+
+        assert_dead_code_candidates!(context, []);
+    }
+
+    #[test]
+    fn dead_code_candidates_excludes_methods_and_variables() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            $global_var = 1
+
+            class Holder
+              @@class_var = 1
+
+              def initialize
+                @instance_var = 1
+              end
+
+              def never_called; end
+            end
+            ",
+        );
+        context.resolve();
+
+        assert_dead_code_candidates!(context, ["Holder"]);
+    }
+
+    #[test]
+    fn dead_code_candidates_counts_references_rather_than_reachability() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            class Target; end
+            AliasName = Target
+            ",
+        );
+        context.resolve();
+
+        // `AliasName` is itself dead, but it still references `Target`, giving `Target` a non-zero count.
+        // A single pass only peels the outermost layer of a dead subgraph.
+        assert_dead_code_candidates!(context, ["AliasName"]);
+    }
+
+    #[test]
+    fn dead_code_candidates_excludes_built_ins_and_definitionless_declarations() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            class Unused
+              def self.class_method; end
+            end
+
+            class Class
+            end
+            ",
+        );
+        context.resolve();
+
+        // A reopened built-in remains excluded regardless of definition order.
+        assert_dead_code_candidates!(context, ["Unused"]);
+    }
+
+    #[test]
+    fn dead_code_candidates_excludes_singleton_classes() {
+        let mut context = GraphTest::new();
+        context.index_uri(
+            "file:///foo.rb",
+            r"
+            class Unused; end
+            class Attached; end
+
+            class << Attached
+              def never_called; end
+            end
+            ",
+        );
+        context.resolve();
+
+        assert_dead_code_candidates!(context, ["Unused"]);
+    }
 }