Mostly remove ImoportLocator infra

This commit is contained in:
Aleksey Kladov 2020-02-06 17:17:51 +01:00
parent cf812c12d1
commit ad204f7562
3 changed files with 21 additions and 178 deletions

View File

@ -6,8 +6,9 @@
use crate::{ use crate::{
assist_ctx::{ActionBuilder, Assist, AssistCtx}, assist_ctx::{ActionBuilder, Assist, AssistCtx},
auto_import_text_edit, AssistId, ImportsLocator, auto_import_text_edit, AssistId,
}; };
use ra_ide_db::imports_locator::ImportsLocatorIde;
// Assist: auto_import // Assist: auto_import
// //
@ -26,10 +27,7 @@
// let map = HashMap<|>::new(); // let map = HashMap<|>::new();
// } // }
// ``` // ```
pub(crate) fn auto_import<F: ImportsLocator>( pub(crate) fn auto_import(ctx: AssistCtx) -> Option<Assist> {
ctx: AssistCtx,
imports_locator: &mut F,
) -> Option<Assist> {
let path_to_import: ast::Path = ctx.find_node_at_offset()?; let path_to_import: ast::Path = ctx.find_node_at_offset()?;
let path_to_import_syntax = path_to_import.syntax(); let path_to_import_syntax = path_to_import.syntax();
if path_to_import_syntax.ancestors().find_map(ast::UseItem::cast).is_some() { if path_to_import_syntax.ancestors().find_map(ast::UseItem::cast).is_some() {
@ -52,6 +50,8 @@ pub(crate) fn auto_import<F: ImportsLocator>(
return None; return None;
} }
let mut imports_locator = ImportsLocatorIde::new(ctx.db);
let proposed_imports = imports_locator let proposed_imports = imports_locator
.find_imports(&name_to_import) .find_imports(&name_to_import)
.into_iter() .into_iter()
@ -81,16 +81,12 @@ fn import_to_action(import: ModPath, position: &SyntaxNode, anchor: &SyntaxNode)
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
use crate::helpers::{ use crate::helpers::{check_assist, check_assist_not_applicable};
check_assist_with_imports_locator, check_assist_with_imports_locator_not_applicable,
TestImportsLocator,
};
#[test] #[test]
fn applicable_when_found_an_import() { fn applicable_when_found_an_import() {
check_assist_with_imports_locator( check_assist(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
<|>PubStruct <|>PubStruct
@ -112,9 +108,8 @@ pub mod PubMod {
#[test] #[test]
fn auto_imports_are_merged() { fn auto_imports_are_merged() {
check_assist_with_imports_locator( check_assist(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
use PubMod::PubStruct1; use PubMod::PubStruct1;
@ -148,9 +143,8 @@ pub struct PubStruct2<T> {
#[test] #[test]
fn applicable_when_found_multiple_imports() { fn applicable_when_found_multiple_imports() {
check_assist_with_imports_locator( check_assist(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
PubSt<|>ruct PubSt<|>ruct
@ -184,9 +178,8 @@ pub mod PubMod3 {
#[test] #[test]
fn not_applicable_for_already_imported_types() { fn not_applicable_for_already_imported_types() {
check_assist_with_imports_locator_not_applicable( check_assist_not_applicable(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
use PubMod::PubStruct; use PubMod::PubStruct;
@ -201,9 +194,8 @@ pub mod PubMod {
#[test] #[test]
fn not_applicable_for_types_with_private_paths() { fn not_applicable_for_types_with_private_paths() {
check_assist_with_imports_locator_not_applicable( check_assist_not_applicable(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
PrivateStruct<|> PrivateStruct<|>
@ -216,9 +208,8 @@ pub mod PubMod {
#[test] #[test]
fn not_applicable_when_no_imports_found() { fn not_applicable_when_no_imports_found() {
check_assist_with_imports_locator_not_applicable( check_assist_not_applicable(
auto_import, auto_import,
TestImportsLocator::new,
" "
PubStruct<|>", PubStruct<|>",
); );
@ -226,9 +217,8 @@ fn not_applicable_when_no_imports_found() {
#[test] #[test]
fn not_applicable_in_import_statements() { fn not_applicable_in_import_statements() {
check_assist_with_imports_locator_not_applicable( check_assist_not_applicable(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
use PubStruct<|>; use PubStruct<|>;
@ -240,9 +230,8 @@ pub mod PubMod {
#[test] #[test]
fn function_import() { fn function_import() {
check_assist_with_imports_locator( check_assist(
auto_import, auto_import,
TestImportsLocator::new,
r" r"
test_function<|> test_function<|>

View File

@ -12,9 +12,8 @@
pub mod ast_transform; pub mod ast_transform;
use either::Either; use either::Either;
use hir::ModuleDef;
use ra_db::FileRange; use ra_db::FileRange;
use ra_ide_db::{imports_locator::ImportsLocatorIde, RootDatabase}; use ra_ide_db::RootDatabase;
use ra_syntax::{TextRange, TextUnit}; use ra_syntax::{TextRange, TextUnit};
use ra_text_edit::TextEdit; use ra_text_edit::TextEdit;
@ -73,50 +72,6 @@ pub fn applicable_assists(db: &RootDatabase, range: FileRange) -> Vec<AssistLabe
}) })
} }
/// A functionality for locating imports for the given name.
///
/// Currently has to be a trait with the real implementation provided by the ra_ide_api crate,
/// due to the search functionality located there.
/// Later, this trait should be removed completely and the search functionality moved to a separate crate,
/// accessible from the ra_assists crate.
pub trait ImportsLocator {
/// Finds all imports for the given name and the module that contains this name.
fn find_imports(&mut self, name_to_import: &str) -> Vec<ModuleDef>;
}
impl ImportsLocator for ImportsLocatorIde<'_> {
fn find_imports(&mut self, name_to_import: &str) -> Vec<ModuleDef> {
self.find_imports(name_to_import)
}
}
/// Return all the assists applicable at the given position
/// and additional assists that need the imports locator functionality to work.
///
/// Assists are returned in the "resolved" state, that is with edit fully
/// computed.
pub fn assists_with_imports_locator(db: &RootDatabase, range: FileRange) -> Vec<ResolvedAssist> {
let mut imports_locator = ImportsLocatorIde::new(db);
AssistCtx::with_ctx(db, range, true, |ctx| {
let mut assists = assists::all()
.iter()
.map(|f| f(ctx.clone()))
.chain(
assists::all_with_imports_locator()
.iter()
.map(|f| f(ctx.clone(), &mut imports_locator)),
)
.filter_map(std::convert::identity)
.map(|a| match a {
Assist::Resolved { assist } => assist,
Assist::Unresolved { .. } => unreachable!(),
})
.collect();
sort_assists(&mut assists);
assists
})
}
/// Return all the assists applicable at the given position. /// Return all the assists applicable at the given position.
/// ///
/// Assists are returned in the "resolved" state, that is with edit fully /// Assists are returned in the "resolved" state, that is with edit fully
@ -147,7 +102,7 @@ fn sort_assists(assists: &mut Vec<ResolvedAssist>) {
} }
mod assists { mod assists {
use crate::{Assist, AssistCtx, ImportsLocator}; use crate::{Assist, AssistCtx};
mod add_derive; mod add_derive;
mod add_explicit_type; mod add_explicit_type;
@ -206,72 +161,19 @@ pub(crate) fn all() -> &'static [fn(AssistCtx) -> Option<Assist>] {
raw_string::make_usual_string, raw_string::make_usual_string,
raw_string::remove_hash, raw_string::remove_hash,
early_return::convert_to_guarded_return, early_return::convert_to_guarded_return,
auto_import::auto_import,
] ]
} }
pub(crate) fn all_with_imports_locator<'a, F: ImportsLocator>(
) -> &'a [fn(AssistCtx, &mut F) -> Option<Assist>] {
&[auto_import::auto_import]
}
} }
#[cfg(test)] #[cfg(test)]
mod helpers { mod helpers {
use hir::db::DefDatabase; use ra_db::{fixture::WithFixture, FileRange};
use ra_db::{fixture::WithFixture, FileId, FileRange}; use ra_ide_db::RootDatabase;
use ra_syntax::TextRange; use ra_syntax::TextRange;
use test_utils::{add_cursor, assert_eq_text, extract_offset, extract_range}; use test_utils::{add_cursor, assert_eq_text, extract_offset, extract_range};
use crate::{Assist, AssistCtx, ImportsLocator}; use crate::{Assist, AssistCtx};
use ra_ide_db::RootDatabase;
use std::sync::Arc;
// FIXME remove the `ModuleDefId` reexport from `ra_hir` when this gets removed.
pub(crate) struct TestImportsLocator {
db: Arc<RootDatabase>,
test_file_id: FileId,
}
impl TestImportsLocator {
pub(crate) fn new(db: Arc<RootDatabase>, test_file_id: FileId) -> Self {
TestImportsLocator { db, test_file_id }
}
}
impl ImportsLocator for TestImportsLocator {
fn find_imports(&mut self, name_to_import: &str) -> Vec<hir::ModuleDef> {
let crate_def_map = self.db.crate_def_map(self.db.test_crate());
let mut findings = Vec::new();
let mut module_ids_to_process =
crate_def_map.modules_for_file(self.test_file_id).collect::<Vec<_>>();
while !module_ids_to_process.is_empty() {
let mut more_ids_to_process = Vec::new();
for local_module_id in module_ids_to_process.drain(..) {
for (name, namespace_data) in
crate_def_map[local_module_id].scope.entries_without_primitives()
{
let found_a_match = &name.to_string() == name_to_import;
vec![namespace_data.types, namespace_data.values]
.into_iter()
.filter_map(std::convert::identity)
.for_each(|(module_def_id, _)| {
if found_a_match {
findings.push(module_def_id.into());
}
if let hir::ModuleDefId::ModuleId(module_id) = module_def_id {
more_ids_to_process.push(module_id.local_id);
}
});
}
}
module_ids_to_process = more_ids_to_process;
}
findings
}
}
pub(crate) fn check_assist(assist: fn(AssistCtx) -> Option<Assist>, before: &str, after: &str) { pub(crate) fn check_assist(assist: fn(AssistCtx) -> Option<Assist>, before: &str, after: &str) {
let (before_cursor_pos, before) = extract_offset(before); let (before_cursor_pos, before) = extract_offset(before);
@ -297,38 +199,6 @@ pub(crate) fn check_assist(assist: fn(AssistCtx) -> Option<Assist>, before: &str
assert_eq_text!(after, &actual); assert_eq_text!(after, &actual);
} }
pub(crate) fn check_assist_with_imports_locator<F: ImportsLocator>(
assist: fn(AssistCtx, &mut F) -> Option<Assist>,
imports_locator_provider: fn(db: Arc<RootDatabase>, file_id: FileId) -> F,
before: &str,
after: &str,
) {
let (before_cursor_pos, before) = extract_offset(before);
let (db, file_id) = RootDatabase::with_single_file(&before);
let db = Arc::new(db);
let mut imports_locator = imports_locator_provider(Arc::clone(&db), file_id);
let frange =
FileRange { file_id, range: TextRange::offset_len(before_cursor_pos, 0.into()) };
let assist =
AssistCtx::with_ctx(db.as_ref(), frange, true, |ctx| assist(ctx, &mut imports_locator))
.expect("code action is not applicable");
let action = match assist {
Assist::Unresolved { .. } => unreachable!(),
Assist::Resolved { assist } => assist.get_first_action(),
};
let actual = action.edit.apply(&before);
let actual_cursor_pos = match action.cursor_position {
None => action
.edit
.apply_to_offset(before_cursor_pos)
.expect("cursor position is affected by the edit"),
Some(off) => off,
};
let actual = add_cursor(&actual, actual_cursor_pos);
assert_eq_text!(after, &actual);
}
pub(crate) fn check_assist_range( pub(crate) fn check_assist_range(
assist: fn(AssistCtx) -> Option<Assist>, assist: fn(AssistCtx) -> Option<Assist>,
before: &str, before: &str,
@ -402,22 +272,6 @@ pub(crate) fn check_assist_not_applicable(
assert!(assist.is_none()); assert!(assist.is_none());
} }
pub(crate) fn check_assist_with_imports_locator_not_applicable<F: ImportsLocator>(
assist: fn(AssistCtx, &mut F) -> Option<Assist>,
imports_locator_provider: fn(db: Arc<RootDatabase>, file_id: FileId) -> F,
before: &str,
) {
let (before_cursor_pos, before) = extract_offset(before);
let (db, file_id) = RootDatabase::with_single_file(&before);
let db = Arc::new(db);
let mut imports_locator = imports_locator_provider(Arc::clone(&db), file_id);
let frange =
FileRange { file_id, range: TextRange::offset_len(before_cursor_pos, 0.into()) };
let assist =
AssistCtx::with_ctx(db.as_ref(), frange, true, |ctx| assist(ctx, &mut imports_locator));
assert!(assist.is_none());
}
pub(crate) fn check_assist_range_not_applicable( pub(crate) fn check_assist_range_not_applicable(
assist: fn(AssistCtx) -> Option<Assist>, assist: fn(AssistCtx) -> Option<Assist>,
before: &str, before: &str,

View File

@ -17,7 +17,7 @@ pub struct Assist {
} }
pub(crate) fn assists(db: &RootDatabase, frange: FileRange) -> Vec<Assist> { pub(crate) fn assists(db: &RootDatabase, frange: FileRange) -> Vec<Assist> {
ra_assists::assists_with_imports_locator(db, frange) ra_assists::assists(db, frange)
.into_iter() .into_iter()
.map(|assist| { .map(|assist| {
let file_id = frange.file_id; let file_id = frange.file_id;