ide/ssr.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
//! This module provides an SSR assist. It is not desirable to include this
//! assist in ide_assists because that would require the ide_assists crate
//! depend on the ide_ssr crate.
use ide_assists::{Assist, AssistId, AssistKind, AssistResolveStrategy, GroupLabel};
use ide_db::{label::Label, source_change::SourceChange, FileRange, RootDatabase};
pub(crate) fn ssr_assists(
db: &RootDatabase,
resolve: &AssistResolveStrategy,
frange: FileRange,
) -> Vec<Assist> {
let mut ssr_assists = Vec::with_capacity(2);
let (match_finder, comment_range) = match ide_ssr::ssr_from_comment(db, frange) {
Some(ssr_data) => ssr_data,
None => return ssr_assists,
};
let id = AssistId("ssr", AssistKind::RefactorRewrite);
let (source_change_for_file, source_change_for_workspace) = if resolve.should_resolve(&id) {
let edits = match_finder.edits();
let source_change_for_file = {
let text_edit_for_file = edits.get(&frange.file_id).cloned().unwrap_or_default();
SourceChange::from_text_edit(frange.file_id, text_edit_for_file)
};
let source_change_for_workspace = SourceChange::from_iter(match_finder.edits());
(Some(source_change_for_file), Some(source_change_for_workspace))
} else {
(None, None)
};
let assists = vec![
("Apply SSR in file", source_change_for_file),
("Apply SSR in workspace", source_change_for_workspace),
];
for (label, source_change) in assists.into_iter() {
let assist = Assist {
id,
label: Label::new(label.to_owned()),
group: Some(GroupLabel("Apply SSR".into())),
target: comment_range,
source_change,
command: None,
};
ssr_assists.push(assist);
}
ssr_assists
}
#[cfg(test)]
mod tests {
use expect_test::expect;
use ide_assists::{Assist, AssistResolveStrategy};
use ide_db::{
base_db::ra_salsa::Durability, symbol_index::SymbolsDatabase, FileRange, FxHashSet,
RootDatabase,
};
use test_fixture::WithFixture;
use triomphe::Arc;
use super::ssr_assists;
fn get_assists(ra_fixture: &str, resolve: AssistResolveStrategy) -> Vec<Assist> {
let (mut db, file_id, range_or_offset) = RootDatabase::with_range_or_offset(ra_fixture);
let mut local_roots = FxHashSet::default();
local_roots.insert(test_fixture::WORKSPACE);
db.set_local_roots_with_durability(Arc::new(local_roots), Durability::HIGH);
ssr_assists(
&db,
&resolve,
FileRange { file_id: file_id.into(), range: range_or_offset.into() },
)
}
#[test]
fn not_applicable_comment_not_ssr() {
let ra_fixture = r#"
//- /lib.rs
// This is foo $0
fn foo() {}
"#;
let assists = get_assists(ra_fixture, AssistResolveStrategy::All);
assert_eq!(0, assists.len());
}
#[test]
fn resolve_edits_true() {
let assists = get_assists(
r#"
//- /lib.rs
mod bar;
// 2 ==>> 3$0
fn foo() { 2 }
//- /bar.rs
fn bar() { 2 }
"#,
AssistResolveStrategy::All,
);
assert_eq!(2, assists.len());
let mut assists = assists.into_iter();
let apply_in_file_assist = assists.next().unwrap();
expect![[r#"
Assist {
id: AssistId(
"ssr",
RefactorRewrite,
),
label: "Apply SSR in file",
group: Some(
GroupLabel(
"Apply SSR",
),
),
target: 10..21,
source_change: Some(
SourceChange {
source_file_edits: {
FileId(
0,
): (
TextEdit {
indels: [
Indel {
insert: "3",
delete: 33..34,
},
],
},
None,
),
},
file_system_edits: [],
is_snippet: false,
},
),
command: None,
}
"#]]
.assert_debug_eq(&apply_in_file_assist);
let apply_in_workspace_assist = assists.next().unwrap();
expect![[r#"
Assist {
id: AssistId(
"ssr",
RefactorRewrite,
),
label: "Apply SSR in workspace",
group: Some(
GroupLabel(
"Apply SSR",
),
),
target: 10..21,
source_change: Some(
SourceChange {
source_file_edits: {
FileId(
0,
): (
TextEdit {
indels: [
Indel {
insert: "3",
delete: 33..34,
},
],
},
None,
),
FileId(
1,
): (
TextEdit {
indels: [
Indel {
insert: "3",
delete: 11..12,
},
],
},
None,
),
},
file_system_edits: [],
is_snippet: false,
},
),
command: None,
}
"#]]
.assert_debug_eq(&apply_in_workspace_assist);
}
#[test]
fn resolve_edits_false() {
let assists = get_assists(
r#"
//- /lib.rs
mod bar;
// 2 ==>> 3$0
fn foo() { 2 }
//- /bar.rs
fn bar() { 2 }
"#,
AssistResolveStrategy::None,
);
assert_eq!(2, assists.len());
let mut assists = assists.into_iter();
let apply_in_file_assist = assists.next().unwrap();
expect![[r#"
Assist {
id: AssistId(
"ssr",
RefactorRewrite,
),
label: "Apply SSR in file",
group: Some(
GroupLabel(
"Apply SSR",
),
),
target: 10..21,
source_change: None,
command: None,
}
"#]]
.assert_debug_eq(&apply_in_file_assist);
let apply_in_workspace_assist = assists.next().unwrap();
expect![[r#"
Assist {
id: AssistId(
"ssr",
RefactorRewrite,
),
label: "Apply SSR in workspace",
group: Some(
GroupLabel(
"Apply SSR",
),
),
target: 10..21,
source_change: None,
command: None,
}
"#]]
.assert_debug_eq(&apply_in_workspace_assist);
}
}