From 73dc8b6f06b49f4728a50e83781c361e9a8b3100 Mon Sep 17 00:00:00 2001 From: Kirill Bulatov Date: Thu, 2 Jan 2020 01:39:01 +0200 Subject: Another attempt to add multiple edits --- crates/ra_assists/src/assist_ctx.rs | 45 +++++++++++++++++++--- .../src/assists/inline_local_variable.rs | 4 +- crates/ra_assists/src/doc_tests.rs | 6 +-- crates/ra_assists/src/lib.rs | 7 +++- 4 files changed, 49 insertions(+), 13 deletions(-) (limited to 'crates/ra_assists/src') diff --git a/crates/ra_assists/src/assist_ctx.rs b/crates/ra_assists/src/assist_ctx.rs index 1a65b5dc0..879216a36 100644 --- a/crates/ra_assists/src/assist_ctx.rs +++ b/crates/ra_assists/src/assist_ctx.rs @@ -14,7 +14,7 @@ use crate::{AssistAction, AssistId, AssistLabel}; #[derive(Clone, Debug)] pub(crate) enum Assist { Unresolved { label: AssistLabel }, - Resolved { label: AssistLabel, action: AssistAction }, + Resolved { label: AssistLabel, action: AssistAction, alternative_actions: Vec }, } /// `AssistCtx` allows to apply an assist or check if it could be applied. @@ -81,18 +81,43 @@ impl<'a, DB: HirDatabase> AssistCtx<'a, DB> { self, id: AssistId, label: impl Into, - f: impl FnOnce(&mut AssistBuilder), + f: impl FnOnce(&mut ActionBuilder), ) -> Option { let label = AssistLabel { label: label.into(), id }; assert!(label.label.chars().nth(0).unwrap().is_uppercase()); let assist = if self.should_compute_edit { let action = { - let mut edit = AssistBuilder::default(); + let mut edit = ActionBuilder::default(); f(&mut edit); edit.build() }; - Assist::Resolved { label, action } + Assist::Resolved { label, action, alternative_actions: Vec::default() } + } else { + Assist::Unresolved { label } + }; + + Some(assist) + } + + #[allow(dead_code)] // will be used for auto import assist with multiple actions + pub(crate) fn add_assist_group( + self, + id: AssistId, + label: impl Into, + f: impl FnOnce() -> (ActionBuilder, Vec), + ) -> Option { + let label = AssistLabel { label: label.into(), id }; + let assist = if self.should_compute_edit { + let (action, alternative_actions) = f(); + Assist::Resolved { + label, + action: action.build(), + alternative_actions: alternative_actions + .into_iter() + .map(ActionBuilder::build) + .collect(), + } } else { Assist::Unresolved { label } }; @@ -128,13 +153,20 @@ impl<'a, DB: HirDatabase> AssistCtx<'a, DB> { } #[derive(Default)] -pub(crate) struct AssistBuilder { +pub(crate) struct ActionBuilder { edit: TextEditBuilder, cursor_position: Option, target: Option, + label: Option, } -impl AssistBuilder { +impl ActionBuilder { + #[allow(dead_code)] + /// Adds a custom label to the action, if it needs to be different from the assist label + pub fn label(&mut self, label: impl Into) { + self.label = Some(label.into()) + } + /// Replaces specified `range` of text with a given string. pub(crate) fn replace(&mut self, range: TextRange, replace_with: impl Into) { self.edit.replace(range, replace_with.into()) @@ -193,6 +225,7 @@ impl AssistBuilder { edit: self.edit.finish(), cursor_position: self.cursor_position, target: self.target, + label: self.label, } } } diff --git a/crates/ra_assists/src/assists/inline_local_variable.rs b/crates/ra_assists/src/assists/inline_local_variable.rs index 164aee90c..45e0f983f 100644 --- a/crates/ra_assists/src/assists/inline_local_variable.rs +++ b/crates/ra_assists/src/assists/inline_local_variable.rs @@ -4,7 +4,7 @@ use ra_syntax::{ TextRange, }; -use crate::assist_ctx::AssistBuilder; +use crate::assist_ctx::ActionBuilder; use crate::{Assist, AssistCtx, AssistId}; // Assist: inline_local_variable @@ -94,7 +94,7 @@ pub(crate) fn inline_local_varialbe(ctx: AssistCtx) -> Option< ctx.add_assist( AssistId("inline_local_variable"), "Inline variable", - move |edit: &mut AssistBuilder| { + move |edit: &mut ActionBuilder| { edit.delete(delete_range); for (desc, should_wrap) in refs.iter().zip(wrap_in_parens) { if should_wrap { diff --git a/crates/ra_assists/src/doc_tests.rs b/crates/ra_assists/src/doc_tests.rs index a8f8446cb..21bee228d 100644 --- a/crates/ra_assists/src/doc_tests.rs +++ b/crates/ra_assists/src/doc_tests.rs @@ -15,16 +15,16 @@ fn check(assist_id: &str, before: &str, after: &str) { let (db, file_id) = TestDB::with_single_file(&before); let frange = FileRange { file_id, range: selection.into() }; - let (_assist_id, action) = crate::assists(&db, frange) + let (_assist_id, action, _) = crate::assists(&db, frange) .into_iter() - .find(|(id, _)| id.id.0 == assist_id) + .find(|(id, _, _)| id.id.0 == assist_id) .unwrap_or_else(|| { panic!( "\n\nAssist is not applicable: {}\nAvailable assists: {}", assist_id, crate::assists(&db, frange) .into_iter() - .map(|(id, _)| id.id.0) + .map(|(id, _, _)| id.id.0) .collect::>() .join(", ") ) diff --git a/crates/ra_assists/src/lib.rs b/crates/ra_assists/src/lib.rs index 150b34ac7..95a530821 100644 --- a/crates/ra_assists/src/lib.rs +++ b/crates/ra_assists/src/lib.rs @@ -35,6 +35,7 @@ pub struct AssistLabel { #[derive(Debug, Clone)] pub struct AssistAction { + pub label: Option, pub edit: TextEdit, pub cursor_position: Option, pub target: Option, @@ -64,7 +65,7 @@ where /// /// Assists are returned in the "resolved" state, that is with edit fully /// computed. -pub fn assists(db: &H, range: FileRange) -> Vec<(AssistLabel, AssistAction)> +pub fn assists(db: &H, range: FileRange) -> Vec<(AssistLabel, AssistAction, Vec)> where H: HirDatabase + 'static, { @@ -75,7 +76,9 @@ where .iter() .filter_map(|f| f(ctx.clone())) .map(|a| match a { - Assist::Resolved { label, action } => (label, action), + Assist::Resolved { label, action, alternative_actions } => { + (label, action, alternative_actions) + } Assist::Unresolved { .. } => unreachable!(), }) .collect::>(); -- cgit v1.2.3 From 78a21253b494e573885ac8336bff6e93b401046f Mon Sep 17 00:00:00 2001 From: Kirill Bulatov Date: Sun, 12 Jan 2020 00:40:36 +0200 Subject: Apply the api design suggestions --- crates/ra_assists/src/assist_ctx.rs | 25 +++++++++++++---------- crates/ra_assists/src/doc_tests.rs | 8 ++++---- crates/ra_assists/src/lib.rs | 40 +++++++++++++++++++++++++------------ 3 files changed, 45 insertions(+), 28 deletions(-) (limited to 'crates/ra_assists/src') diff --git a/crates/ra_assists/src/assist_ctx.rs b/crates/ra_assists/src/assist_ctx.rs index 879216a36..e13f969c7 100644 --- a/crates/ra_assists/src/assist_ctx.rs +++ b/crates/ra_assists/src/assist_ctx.rs @@ -1,5 +1,6 @@ //! This module defines `AssistCtx` -- the API surface that is exposed to assists. use hir::{db::HirDatabase, InFile, SourceAnalyzer}; +use itertools::Either; use ra_db::FileRange; use ra_fmt::{leading_indent, reindent}; use ra_syntax::{ @@ -9,12 +10,12 @@ use ra_syntax::{ }; use ra_text_edit::TextEditBuilder; -use crate::{AssistAction, AssistId, AssistLabel}; +use crate::{AssistAction, AssistId, AssistLabel, ResolvedAssist}; #[derive(Clone, Debug)] pub(crate) enum Assist { Unresolved { label: AssistLabel }, - Resolved { label: AssistLabel, action: AssistAction, alternative_actions: Vec }, + Resolved { assist: ResolvedAssist }, } /// `AssistCtx` allows to apply an assist or check if it could be applied. @@ -92,7 +93,7 @@ impl<'a, DB: HirDatabase> AssistCtx<'a, DB> { f(&mut edit); edit.build() }; - Assist::Resolved { label, action, alternative_actions: Vec::default() } + Assist::Resolved { assist: ResolvedAssist { label, action_data: Either::Left(action) } } } else { Assist::Unresolved { label } }; @@ -105,18 +106,20 @@ impl<'a, DB: HirDatabase> AssistCtx<'a, DB> { self, id: AssistId, label: impl Into, - f: impl FnOnce() -> (ActionBuilder, Vec), + f: impl FnOnce() -> Vec, ) -> Option { let label = AssistLabel { label: label.into(), id }; let assist = if self.should_compute_edit { - let (action, alternative_actions) = f(); + let actions = f(); + assert!(!actions.is_empty(), "Assist cannot have no"); + Assist::Resolved { - label, - action: action.build(), - alternative_actions: alternative_actions - .into_iter() - .map(ActionBuilder::build) - .collect(), + assist: ResolvedAssist { + label, + action_data: Either::Right( + actions.into_iter().map(ActionBuilder::build).collect(), + ), + }, } } else { Assist::Unresolved { label } diff --git a/crates/ra_assists/src/doc_tests.rs b/crates/ra_assists/src/doc_tests.rs index 21bee228d..5dc1ee233 100644 --- a/crates/ra_assists/src/doc_tests.rs +++ b/crates/ra_assists/src/doc_tests.rs @@ -15,21 +15,21 @@ fn check(assist_id: &str, before: &str, after: &str) { let (db, file_id) = TestDB::with_single_file(&before); let frange = FileRange { file_id, range: selection.into() }; - let (_assist_id, action, _) = crate::assists(&db, frange) + let assist = crate::assists(&db, frange) .into_iter() - .find(|(id, _, _)| id.id.0 == assist_id) + .find(|assist| assist.label.id.0 == assist_id) .unwrap_or_else(|| { panic!( "\n\nAssist is not applicable: {}\nAvailable assists: {}", assist_id, crate::assists(&db, frange) .into_iter() - .map(|(id, _, _)| id.id.0) + .map(|assist| assist.label.id.0) .collect::>() .join(", ") ) }); - let actual = action.edit.apply(&before); + let actual = assist.get_first_action().edit.apply(&before); assert_eq_text!(after, &actual); } diff --git a/crates/ra_assists/src/lib.rs b/crates/ra_assists/src/lib.rs index 95a530821..a2983ae87 100644 --- a/crates/ra_assists/src/lib.rs +++ b/crates/ra_assists/src/lib.rs @@ -14,6 +14,7 @@ mod test_db; pub mod ast_transform; use hir::db::HirDatabase; +use itertools::Either; use ra_db::FileRange; use ra_syntax::{TextRange, TextUnit}; use ra_text_edit::TextEdit; @@ -41,6 +42,21 @@ pub struct AssistAction { pub target: Option, } +#[derive(Debug, Clone)] +pub struct ResolvedAssist { + pub label: AssistLabel, + pub action_data: Either>, +} + +impl ResolvedAssist { + pub fn get_first_action(&self) -> AssistAction { + match &self.action_data { + Either::Left(action) => action.clone(), + Either::Right(actions) => actions[0].clone(), + } + } +} + /// Return all the assists applicable at the given position. /// /// Assists are returned in the "unresolved" state, that is only labels are @@ -65,7 +81,7 @@ where /// /// Assists are returned in the "resolved" state, that is with edit fully /// computed. -pub fn assists(db: &H, range: FileRange) -> Vec<(AssistLabel, AssistAction, Vec)> +pub fn assists(db: &H, range: FileRange) -> Vec where H: HirDatabase + 'static, { @@ -76,13 +92,11 @@ where .iter() .filter_map(|f| f(ctx.clone())) .map(|a| match a { - Assist::Resolved { label, action, alternative_actions } => { - (label, action, alternative_actions) - } + Assist::Resolved { assist } => assist, Assist::Unresolved { .. } => unreachable!(), }) .collect::>(); - a.sort_by(|a, b| match (a.1.target, b.1.target) { + a.sort_by(|a, b| match (a.get_first_action().target, b.get_first_action().target) { (Some(a), Some(b)) => a.len().cmp(&b.len()), (Some(_), None) => Ordering::Less, (None, Some(_)) => Ordering::Greater, @@ -177,7 +191,7 @@ mod helpers { AssistCtx::with_ctx(&db, frange, true, assist).expect("code action is not applicable"); let action = match assist { Assist::Unresolved { .. } => unreachable!(), - Assist::Resolved { action, .. } => action, + Assist::Resolved { assist } => assist.get_first_action(), }; let actual = action.edit.apply(&before); @@ -204,7 +218,7 @@ mod helpers { AssistCtx::with_ctx(&db, frange, true, assist).expect("code action is not applicable"); let action = match assist { Assist::Unresolved { .. } => unreachable!(), - Assist::Resolved { action, .. } => action, + Assist::Resolved { assist } => assist.get_first_action(), }; let mut actual = action.edit.apply(&before); @@ -227,7 +241,7 @@ mod helpers { AssistCtx::with_ctx(&db, frange, true, assist).expect("code action is not applicable"); let action = match assist { Assist::Unresolved { .. } => unreachable!(), - Assist::Resolved { action, .. } => action, + Assist::Resolved { assist } => assist.get_first_action(), }; let range = action.target.expect("expected target on action"); @@ -246,7 +260,7 @@ mod helpers { AssistCtx::with_ctx(&db, frange, true, assist).expect("code action is not applicable"); let action = match assist { Assist::Unresolved { .. } => unreachable!(), - Assist::Resolved { action, .. } => action, + Assist::Resolved { assist } => assist.get_first_action(), }; let range = action.target.expect("expected target on action"); @@ -296,10 +310,10 @@ mod tests { let mut assists = assists.iter(); assert_eq!( - assists.next().expect("expected assist").0.label, + assists.next().expect("expected assist").label.label, "Change visibility to pub(crate)" ); - assert_eq!(assists.next().expect("expected assist").0.label, "Add `#[derive]`"); + assert_eq!(assists.next().expect("expected assist").label.label, "Add `#[derive]`"); } #[test] @@ -318,7 +332,7 @@ mod tests { let assists = super::assists(&db, frange); let mut assists = assists.iter(); - assert_eq!(assists.next().expect("expected assist").0.label, "Extract into variable"); - assert_eq!(assists.next().expect("expected assist").0.label, "Replace with match"); + assert_eq!(assists.next().expect("expected assist").label.label, "Extract into variable"); + assert_eq!(assists.next().expect("expected assist").label.label, "Replace with match"); } } -- cgit v1.2.3 From d51cf7794d110b064fd0e8d53726b4608ec50d1a Mon Sep 17 00:00:00 2001 From: Kirill Bulatov Date: Wed, 15 Jan 2020 20:20:20 +0200 Subject: itertools::Either -> either::Either --- crates/ra_assists/src/assist_ctx.rs | 2 +- crates/ra_assists/src/lib.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'crates/ra_assists/src') diff --git a/crates/ra_assists/src/assist_ctx.rs b/crates/ra_assists/src/assist_ctx.rs index e13f969c7..621b9feb2 100644 --- a/crates/ra_assists/src/assist_ctx.rs +++ b/crates/ra_assists/src/assist_ctx.rs @@ -1,6 +1,6 @@ //! This module defines `AssistCtx` -- the API surface that is exposed to assists. +use either::Either; use hir::{db::HirDatabase, InFile, SourceAnalyzer}; -use itertools::Either; use ra_db::FileRange; use ra_fmt::{leading_indent, reindent}; use ra_syntax::{ diff --git a/crates/ra_assists/src/lib.rs b/crates/ra_assists/src/lib.rs index a2983ae87..d45b58966 100644 --- a/crates/ra_assists/src/lib.rs +++ b/crates/ra_assists/src/lib.rs @@ -13,8 +13,8 @@ mod doc_tests; mod test_db; pub mod ast_transform; +use either::Either; use hir::db::HirDatabase; -use itertools::Either; use ra_db::FileRange; use ra_syntax::{TextRange, TextUnit}; use ra_text_edit::TextEdit; -- cgit v1.2.3 From 79b77403b65877e4d20bbbac6dd853a3beead445 Mon Sep 17 00:00:00 2001 From: Kirill Bulatov Date: Wed, 15 Jan 2020 20:21:05 +0200 Subject: Reduce visibility --- crates/ra_assists/src/assist_ctx.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'crates/ra_assists/src') diff --git a/crates/ra_assists/src/assist_ctx.rs b/crates/ra_assists/src/assist_ctx.rs index 621b9feb2..9d533fa0c 100644 --- a/crates/ra_assists/src/assist_ctx.rs +++ b/crates/ra_assists/src/assist_ctx.rs @@ -166,7 +166,7 @@ pub(crate) struct ActionBuilder { impl ActionBuilder { #[allow(dead_code)] /// Adds a custom label to the action, if it needs to be different from the assist label - pub fn label(&mut self, label: impl Into) { + pub(crate) fn label(&mut self, label: impl Into) { self.label = Some(label.into()) } -- cgit v1.2.3