Improve sanitization of expressions received via --focus-on

CHANGELOG.md

@@ -20,7 +20,7 @@ Please make sure to add your changes to the appropriate categories:
 
 ### Added
 
-- n/a
+- The `--focus-on` option now accepts expressions starting with `crate::…` (previously the crate's name had to be written out).
 
 ### Changed
 

src/analyzer.rs

@@ -600,14 +600,19 @@ pub(crate) fn parse_ast<N: syntax::AstNode>(text: &str) -> N {
     node
 }
 
+pub(crate) fn parse_use_tree(path_expr: &str) -> ast::UseTree {
+    parse_ast(&format!("use {path_expr};"))
+}
+
+pub(crate) fn parse_path_expr(path_expr: &str) -> ast::Path {
+    parse_ast(path_expr)
+}
+
 pub(crate) fn use_tree_matches_item_path(use_tree: &ast::UseTree, item_path: &str) -> bool {
     if item_path.is_empty() {
         return false;
     }
-    let node_path: ast::Path = {
-        let syntax = format!("use {item_path};");
-        parse_ast(&syntax)
-    };
+    let node_path: ast::Path = parse_path_expr(item_path);
     use_tree_matches_path(use_tree, &node_path)
 }
 

src/command/dependencies/filter.rs

@@ -55,15 +55,9 @@ impl<'a> Filter<'a> {
 
         let mut graph = graph.clone();
 
-        let focus_on = self
-            .options
-            .focus_on
-            .as_ref()
-            .cloned()
-            .unwrap_or_else(|| self.krate.display_name(self.db).unwrap().to_string());
-
-        let syntax = format!("use {focus_on};");
-        let use_tree: ast::UseTree = analyzer::parse_ast(&syntax);
+        let crate_name = self.krate.display_name(self.db).unwrap().to_string();
+        let focus_on = self.options.focus_on.as_deref();
+        let use_tree: ast::UseTree = crate::utils::sanitized_use_tree(focus_on, &crate_name)?;
 
         trace!("Searching for focus nodes in graph ...");
 

src/command/structure/filter.rs

@@ -37,15 +37,9 @@ impl<'a> Filter<'a> {
     }
 
     pub fn filter(&self, tree: &Tree<Node>) -> anyhow::Result<Tree<Node>> {
-        let focus_on = self
-            .options
-            .focus_on
-            .as_ref()
-            .cloned()
-            .unwrap_or_else(|| self.krate.display_name(self.db).unwrap().to_string());
-
-        let syntax = format!("use {focus_on};");
-        let use_tree: ast::UseTree = analyzer::parse_ast(&syntax);
+        let crate_name = self.krate.display_name(self.db).unwrap().to_string();
+        let focus_on = self.options.focus_on.as_deref();
+        let use_tree: ast::UseTree = crate::utils::sanitized_use_tree(focus_on, &crate_name)?;
 
         let max_depth = self.options.max_depth.unwrap_or(usize::MAX);
 

src/lib.rs

@@ -10,3 +10,4 @@ pub(crate) mod colors;
 pub(crate) mod graph;
 pub(crate) mod item;
 pub(crate) mod tree;
+pub(crate) mod utils;

src/utils.rs

@@ -0,0 +1,38 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+use ra_ap_syntax::ast;
+
+use anyhow::bail;
+
+pub fn sanitized_use_tree(
+    focus_on: Option<&str>,
+    crate_name: &str,
+) -> anyhow::Result<ast::UseTree> {
+    let mut path_expr = focus_on.unwrap_or(crate_name).to_owned();
+
+    // Trim leading `::` from `use` expression,
+    // expressions are implied to be absolute:
+    let double_colon_prefix = "::";
+    if path_expr.starts_with(double_colon_prefix) {
+        let range = 0..(double_colon_prefix.len() - 2);
+        path_expr.replace_range(range, "");
+    }
+
+    let crate_prefix = "crate::";
+    if path_expr.starts_with(crate_prefix) {
+        let range = 0..(crate_prefix.len() - 2);
+        path_expr.replace_range(range, crate_name);
+    }
+
+    for keyword in ["super", "self", "$crate"] {
+        let keyword_prefix = format!("{keyword}::");
+
+        if path_expr == keyword || path_expr.starts_with(&keyword_prefix) {
+            bail!("unexpected keyword `{keyword}` in `--focus-on` option");
+        }
+    }
+
+    Ok(crate::analyzer::parse_use_tree(&path_expr))
+}

tests/dependencies.rs

@@ -386,7 +386,7 @@ mod focus_on {
     mod simple_path {
         test_cmd!(
             args: "dependencies \
-                    --focus-on \"smoke::visibility::dummy\"",
+                    --focus-on \"crate::visibility::dummy\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke
@@ -396,7 +396,7 @@ mod focus_on {
     mod glob_path {
         test_cmd!(
             args: "dependencies \
-                    --focus-on \"smoke::visibility::*\"",
+                    --focus-on \"crate::visibility::*\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke
@@ -406,7 +406,7 @@ mod focus_on {
     mod self_path {
         test_cmd!(
             args: "dependencies \
-                    --focus-on \"smoke::visibility::dummy::{self}\"",
+                    --focus-on \"crate::visibility::dummy::{self}\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke
@@ -416,7 +416,7 @@ mod focus_on {
     mod use_tree {
         test_cmd!(
             args: "dependencies \
-                    --focus-on \"smoke::visibility::{dummy, hierarchy}\"",
+                    --focus-on \"crate::visibility::{dummy, hierarchy}\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke

tests/snapshots/dependencies__focus_on__glob_path__smoke.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 dependencies
 --focus-on
-smoke::visibility::*
+crate::visibility::*
 
 STDERR:
 

tests/snapshots/dependencies__focus_on__self_path__smoke.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 dependencies
 --focus-on
-smoke::visibility::dummy::{self}
+crate::visibility::dummy::{self}
 
 STDERR:
 

tests/snapshots/dependencies__focus_on__simple_path__smoke.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 dependencies
 --focus-on
-smoke::visibility::dummy
+crate::visibility::dummy
 
 STDERR:
 

tests/snapshots/dependencies__focus_on__use_tree__smoke.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 dependencies
 --focus-on
-smoke::visibility::{dummy, hierarchy}
+crate::visibility::{dummy, hierarchy}
 
 STDERR:
 

tests/snapshots/structure__focus_on__glob_path__smoke_structure.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 structure
 --focus-on
-smoke_structure::lorem::sit::*
+crate::lorem::sit::*
 
 STDERR:
 

tests/snapshots/structure__focus_on__self_path__smoke_structure.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 structure
 --focus-on
-smoke_structure::lorem::sit::{self}
+crate::lorem::sit::{self}
 
 STDERR:
 

tests/snapshots/structure__focus_on__simple_path__smoke_structure.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 structure
 --focus-on
-smoke_structure::lorem::sit
+crate::lorem::sit
 
 STDERR:
 

tests/snapshots/structure__focus_on__use_tree__smoke_structure.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 structure
 --focus-on
-smoke_structure::{lorem::sit::ipsum, sit::dolor::amet::lorem::sit}
+crate::{lorem::sit::ipsum, sit::dolor::amet::lorem::sit}
 
 STDERR:
 

tests/snapshots/structure__focus_on__with_max_depth__smoke_structure.snap

@@ -5,7 +5,7 @@ expression: output
 COMMAND:
 structure
 --focus-on
-smoke_structure::{lorem, sit}
+crate::{lorem, sit}
 --max-depth
 2
 

tests/structure.rs

@@ -346,7 +346,7 @@ mod focus_on {
     mod simple_path {
         test_cmd!(
             args: "structure \
-                    --focus-on \"smoke_structure::lorem::sit\"",
+                    --focus-on \"crate::lorem::sit\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke_structure
@@ -356,7 +356,7 @@ mod focus_on {
     mod glob_path {
         test_cmd!(
             args: "structure \
-                    --focus-on \"smoke_structure::lorem::sit::*\"",
+                    --focus-on \"crate::lorem::sit::*\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke_structure
@@ -366,7 +366,7 @@ mod focus_on {
     mod self_path {
         test_cmd!(
             args: "structure \
-                    --focus-on \"smoke_structure::lorem::sit::{self}\"",
+                    --focus-on \"crate::lorem::sit::{self}\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke_structure
@@ -376,7 +376,7 @@ mod focus_on {
     mod use_tree {
         test_cmd!(
             args: "structure \
-                    --focus-on \"smoke_structure::{lorem::sit::ipsum, sit::dolor::amet::lorem::sit}\"",
+                    --focus-on \"crate::{lorem::sit::ipsum, sit::dolor::amet::lorem::sit}\"",
             success: true,
             color_mode: ColorMode::Plain,
             project: smoke_structure
@@ -386,7 +386,7 @@ mod focus_on {
     mod with_max_depth {
         test_cmd!(
             args: "structure \
-                    --focus-on \"smoke_structure::{lorem, sit}\" \
+                    --focus-on \"crate::{lorem, sit}\" \
                     --max-depth 2",
             success: true,
             color_mode: ColorMode::Plain,