crates/ide_assists/src/handlers/replace_derive_with_manual_impl.rs

   1 use hir::ModuleDef;
   2 use ide_db::helpers::{import_assets::NameToImport, mod_path_to_ast};
   3 use ide_db::items_locator;
   4 use itertools::Itertools;
   5 use syntax::{
   6     ast::{self, make, AstNode, NameOwner},
   7     SyntaxKind::{IDENT, WHITESPACE},
   8 };
   9
  10 use crate::{
  11     assist_context::{AssistBuilder, AssistContext, Assists},
  12     utils::{
  13         add_trait_assoc_items_to_impl, filter_assoc_items, gen_trait_fn_body,
  14         generate_trait_impl_text, render_snippet, Cursor, DefaultMethods,
  15     },
  16     AssistId, AssistKind,
  17 };
  18
  19 // Assist: replace_derive_with_manual_impl
  20 //
  21 // Converts a `derive` impl into a manual one.
  22 //
  23 // ```
  24 // # trait Debug { fn fmt(&self, f: &mut Formatter) -> Result<()>; }
  25 // #[derive(Deb$0ug, Display)]
  26 // struct S;
  27 // ```
  28 // ->
  29 // ```
  30 // # trait Debug { fn fmt(&self, f: &mut Formatter) -> Result<()>; }
  31 // #[derive(Display)]
  32 // struct S;
  33 //
  34 // impl Debug for S {
  35 //     $0fn fmt(&self, f: &mut Formatter) -> Result<()> {
  36 //         f.debug_struct("S").finish()
  37 //     }
  38 // }
  39 // ```
  40 pub(crate) fn replace_derive_with_manual_impl(
  41     acc: &mut Assists,
  42     ctx: &AssistContext,
  43 ) -> Option<()> {
  44     let attr = ctx.find_node_at_offset::<ast::Attr>()?;
  45     let (name, args) = attr.as_simple_call()?;
  46     if name != "derive" {
  47         return None;
  48     }
  49
  50     if !args.syntax().text_range().contains(ctx.offset()) {
  51         cov_mark::hit!(outside_of_attr_args);
  52         return None;
  53     }
  54
  55     let trait_token = args.syntax().token_at_offset(ctx.offset()).find(|t| t.kind() == IDENT)?;
  56     let trait_name = trait_token.text();
  57
  58     let adt = attr.syntax().parent().and_then(ast::Adt::cast)?;
  59
  60     let current_module = ctx.sema.scope(adt.syntax()).module()?;
  61     let current_crate = current_module.krate();
  62
  63     let found_traits = items_locator::items_with_name(
  64         &ctx.sema,
  65         current_crate,
  66         NameToImport::Exact(trait_name.to_string()),
  67         items_locator::AssocItemSearch::Exclude,
  68         Some(items_locator::DEFAULT_QUERY_SEARCH_LIMIT.inner()),
  69     )
  70     .filter_map(|item| match item.as_module_def()? {
  71         ModuleDef::Trait(trait_) => Some(trait_),
  72         _ => None,
  73     })
  74     .flat_map(|trait_| {
  75         current_module
  76             .find_use_path(ctx.sema.db, hir::ModuleDef::Trait(trait_))
  77             .as_ref()
  78             .map(mod_path_to_ast)
  79             .zip(Some(trait_))
  80     });
  81
  82     let mut no_traits_found = true;
  83     for (trait_path, trait_) in found_traits.inspect(|_| no_traits_found = false) {
  84         add_assist(acc, ctx, &attr, &args, &trait_path, Some(trait_), &adt)?;
  85     }
  86     if no_traits_found {
  87         let trait_path = make::ext::ident_path(trait_name);
  88         add_assist(acc, ctx, &attr, &args, &trait_path, None, &adt)?;
  89     }
  90     Some(())
  91 }
  92
  93 fn add_assist(
  94     acc: &mut Assists,
  95     ctx: &AssistContext,
  96     attr: &ast::Attr,
  97     input: &ast::TokenTree,
  98     trait_path: &ast::Path,
  99     trait_: Option<hir::Trait>,
 100     adt: &ast::Adt,
 101 ) -> Option<()> {
 102     let target = attr.syntax().text_range();
 103     let annotated_name = adt.name()?;
 104     let label = format!("Convert to manual `impl {} for {}`", trait_path, annotated_name);
 105     let trait_name = trait_path.segment().and_then(|seg| seg.name_ref())?;
 106
 107     acc.add(
 108         AssistId("replace_derive_with_manual_impl", AssistKind::Refactor),
 109         label,
 110         target,
 111         |builder| {
 112             let insert_pos = adt.syntax().text_range().end();
 113             let impl_def_with_items =
 114                 impl_def_from_trait(&ctx.sema, adt, &annotated_name, trait_, trait_path);
 115             update_attribute(builder, input, &trait_name, attr);
 116             let trait_path = format!("{}", trait_path);
 117             match (ctx.config.snippet_cap, impl_def_with_items) {
 118                 (None, _) => {
 119                     builder.insert(insert_pos, generate_trait_impl_text(adt, &trait_path, ""))
 120                 }
 121                 (Some(cap), None) => builder.insert_snippet(
 122                     cap,
 123                     insert_pos,
 124                     generate_trait_impl_text(adt, &trait_path, "    $0"),
 125                 ),
 126                 (Some(cap), Some((impl_def, first_assoc_item))) => {
 127                     let mut cursor = Cursor::Before(first_assoc_item.syntax());
 128                     let placeholder;
 129                     if let ast::AssocItem::Fn(ref func) = first_assoc_item {
 130                         if let Some(m) = func.syntax().descendants().find_map(ast::MacroCall::cast)
 131                         {
 132                             if m.syntax().text() == "todo!()" {
 133                                 placeholder = m;
 134                                 cursor = Cursor::Replace(placeholder.syntax());
 135                             }
 136                         }
 137                     }
 138
 139                     builder.insert_snippet(
 140                         cap,
 141                         insert_pos,
 142                         format!("\n\n{}", render_snippet(cap, impl_def.syntax(), cursor)),
 143                     )
 144                 }
 145             };
 146         },
 147     )
 148 }
 149
 150 fn impl_def_from_trait(
 151     sema: &hir::Semantics<ide_db::RootDatabase>,
 152     adt: &ast::Adt,
 153     annotated_name: &ast::Name,
 154     trait_: Option<hir::Trait>,
 155     trait_path: &ast::Path,
 156 ) -> Option<(ast::Impl, ast::AssocItem)> {
 157     let trait_ = trait_?;
 158     let target_scope = sema.scope(annotated_name.syntax());
 159     let trait_items = filter_assoc_items(sema.db, &trait_.items(sema.db), DefaultMethods::No);
 160     if trait_items.is_empty() {
 161         return None;
 162     }
 163     let impl_def =
 164         make::impl_trait(trait_path.clone(), make::ext::ident_path(&annotated_name.text()));
 165     let (impl_def, first_assoc_item) =
 166         add_trait_assoc_items_to_impl(sema, trait_items, trait_, impl_def, target_scope);
 167
 168     // Generate a default `impl` function body for the derived trait.
 169     if let ast::AssocItem::Fn(ref func) = first_assoc_item {
 170         let _ = gen_trait_fn_body(func, trait_path, adt);
 171     };
 172
 173     Some((impl_def, first_assoc_item))
 174 }
 175
 176 fn update_attribute(
 177     builder: &mut AssistBuilder,
 178     input: &ast::TokenTree,
 179     trait_name: &ast::NameRef,
 180     attr: &ast::Attr,
 181 ) {
 182     let trait_name = trait_name.text();
 183     let new_attr_input = input
 184         .syntax()
 185         .descendants_with_tokens()
 186         .filter(|t| t.kind() == IDENT)
 187         .filter_map(|t| t.into_token().map(|t| t.text().to_string()))
 188         .filter(|t| t != &trait_name)
 189         .collect::<Vec<_>>();
 190     let has_more_derives = !new_attr_input.is_empty();
 191
 192     if has_more_derives {
 193         let new_attr_input = format!("({})", new_attr_input.iter().format(", "));
 194         builder.replace(input.syntax().text_range(), new_attr_input);
 195     } else {
 196         let attr_range = attr.syntax().text_range();
 197         builder.delete(attr_range);
 198
 199         if let Some(line_break_range) = attr
 200             .syntax()
 201             .next_sibling_or_token()
 202             .filter(|t| t.kind() == WHITESPACE)
 203             .map(|t| t.text_range())
 204         {
 205             builder.delete(line_break_range);
 206         }
 207     }
 208 }
 209
 210 #[cfg(test)]
 211 mod tests {
 212     use crate::tests::{check_assist, check_assist_not_applicable};
 213
 214     use super::*;
 215
 216     #[test]
 217     fn add_custom_impl_debug_record_struct() {
 218         check_assist(
 219             replace_derive_with_manual_impl,
 220             r#"
 221 //- minicore: fmt
 222 #[derive(Debu$0g)]
 223 struct Foo {
 224     bar: String,
 225 }
 226 "#,
 227             r#"
 228 struct Foo {
 229     bar: String,
 230 }
 231
 232 impl core::fmt::Debug for Foo {
 233     $0fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 234         f.debug_struct("Foo").field("bar", &self.bar).finish()
 235     }
 236 }
 237 "#,
 238         )
 239     }
 240     #[test]
 241     fn add_custom_impl_debug_tuple_struct() {
 242         check_assist(
 243             replace_derive_with_manual_impl,
 244             r#"
 245 //- minicore: fmt
 246 #[derive(Debu$0g)]
 247 struct Foo(String, usize);
 248 "#,
 249             r#"struct Foo(String, usize);
 250
 251 impl core::fmt::Debug for Foo {
 252     $0fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 253         f.debug_tuple("Foo").field(&self.0).field(&self.1).finish()
 254     }
 255 }
 256 "#,
 257         )
 258     }
 259     #[test]
 260     fn add_custom_impl_debug_empty_struct() {
 261         check_assist(
 262             replace_derive_with_manual_impl,
 263             r#"
 264 //- minicore: fmt
 265 #[derive(Debu$0g)]
 266 struct Foo;
 267 "#,
 268             r#"
 269 struct Foo;
 270
 271 impl core::fmt::Debug for Foo {
 272     $0fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 273         f.debug_struct("Foo").finish()
 274     }
 275 }
 276 "#,
 277         )
 278     }
 279     #[test]
 280     fn add_custom_impl_debug_enum() {
 281         check_assist(
 282             replace_derive_with_manual_impl,
 283             r#"
 284 //- minicore: fmt
 285 #[derive(Debu$0g)]
 286 enum Foo {
 287     Bar,
 288     Baz,
 289 }
 290 "#,
 291             r#"
 292 enum Foo {
 293     Bar,
 294     Baz,
 295 }
 296
 297 impl core::fmt::Debug for Foo {
 298     $0fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 299         match self {
 300             Self::Bar => write!(f, "Bar"),
 301             Self::Baz => write!(f, "Baz"),
 302         }
 303     }
 304 }
 305 "#,
 306         )
 307     }
 308     #[test]
 309     fn add_custom_impl_default_record_struct() {
 310         check_assist(
 311             replace_derive_with_manual_impl,
 312             r#"
 313 //- minicore: default
 314 #[derive(Defau$0lt)]
 315 struct Foo {
 316     foo: usize,
 317 }
 318 "#,
 319             r#"
 320 struct Foo {
 321     foo: usize,
 322 }
 323
 324 impl Default for Foo {
 325     $0fn default() -> Self {
 326         Self { foo: Default::default() }
 327     }
 328 }
 329 "#,
 330         )
 331     }
 332     #[test]
 333     fn add_custom_impl_default_tuple_struct() {
 334         check_assist(
 335             replace_derive_with_manual_impl,
 336             r#"
 337 //- minicore: default
 338 #[derive(Defau$0lt)]
 339 struct Foo(usize);
 340 "#,
 341             r#"
 342 struct Foo(usize);
 343
 344 impl Default for Foo {
 345     $0fn default() -> Self {
 346         Self(Default::default())
 347     }
 348 }
 349 "#,
 350         )
 351     }
 352     #[test]
 353     fn add_custom_impl_default_empty_struct() {
 354         check_assist(
 355             replace_derive_with_manual_impl,
 356             r#"
 357 //- minicore: default
 358 #[derive(Defau$0lt)]
 359 struct Foo;
 360 "#,
 361             r#"
 362 struct Foo;
 363
 364 impl Default for Foo {
 365     $0fn default() -> Self {
 366         Self {  }
 367     }
 368 }
 369 "#,
 370         )
 371     }
 372
 373     #[test]
 374     fn add_custom_impl_hash_enum() {
 375         check_assist(
 376             replace_derive_with_manual_impl,
 377             r#"
 378 //- minicore: hash
 379 #[derive(Has$0h)]
 380 enum Foo {
 381     Bar,
 382     Baz,
 383 }
 384 "#,
 385             r#"
 386 enum Foo {
 387     Bar,
 388     Baz,
 389 }
 390
 391 impl core::hash::Hash for Foo {
 392     $0fn hash<H: core::hash::Hasher>(&self, state: &mut H) {
 393         core::mem::discriminant(self).hash(state);
 394     }
 395 }
 396 "#,
 397         )
 398     }
 399     #[test]
 400     fn add_custom_impl_all() {
 401         check_assist(
 402             replace_derive_with_manual_impl,
 403             r#"
 404 mod foo {
 405     pub trait Bar {
 406         type Qux;
 407         const Baz: usize = 42;
 408         const Fez: usize;
 409         fn foo();
 410         fn bar() {}
 411     }
 412 }
 413
 414 #[derive($0Bar)]
 415 struct Foo {
 416     bar: String,
 417 }
 418 "#,
 419             r#"
 420 mod foo {
 421     pub trait Bar {
 422         type Qux;
 423         const Baz: usize = 42;
 424         const Fez: usize;
 425         fn foo();
 426         fn bar() {}
 427     }
 428 }
 429
 430 struct Foo {
 431     bar: String,
 432 }
 433
 434 impl foo::Bar for Foo {
 435     $0type Qux;
 436
 437     const Baz: usize = 42;
 438
 439     const Fez: usize;
 440
 441     fn foo() {
 442         todo!()
 443     }
 444 }
 445 "#,
 446         )
 447     }
 448     #[test]
 449     fn add_custom_impl_for_unique_input() {
 450         check_assist(
 451             replace_derive_with_manual_impl,
 452             r#"
 453 #[derive(Debu$0g)]
 454 struct Foo {
 455     bar: String,
 456 }
 457             "#,
 458             r#"
 459 struct Foo {
 460     bar: String,
 461 }
 462
 463 impl Debug for Foo {
 464     $0
 465 }
 466             "#,
 467         )
 468     }
 469
 470     #[test]
 471     fn add_custom_impl_for_with_visibility_modifier() {
 472         check_assist(
 473             replace_derive_with_manual_impl,
 474             r#"
 475 #[derive(Debug$0)]
 476 pub struct Foo {
 477     bar: String,
 478 }
 479             "#,
 480             r#"
 481 pub struct Foo {
 482     bar: String,
 483 }
 484
 485 impl Debug for Foo {
 486     $0
 487 }
 488             "#,
 489         )
 490     }
 491
 492     #[test]
 493     fn add_custom_impl_when_multiple_inputs() {
 494         check_assist(
 495             replace_derive_with_manual_impl,
 496             r#"
 497 #[derive(Display, Debug$0, Serialize)]
 498 struct Foo {}
 499             "#,
 500             r#"
 501 #[derive(Display, Serialize)]
 502 struct Foo {}
 503
 504 impl Debug for Foo {
 505     $0
 506 }
 507             "#,
 508         )
 509     }
 510
 511     #[test]
 512     fn test_ignore_derive_macro_without_input() {
 513         check_assist_not_applicable(
 514             replace_derive_with_manual_impl,
 515             r#"
 516 #[derive($0)]
 517 struct Foo {}
 518             "#,
 519         )
 520     }
 521
 522     #[test]
 523     fn test_ignore_if_cursor_on_param() {
 524         check_assist_not_applicable(
 525             replace_derive_with_manual_impl,
 526             r#"
 527 #[derive$0(Debug)]
 528 struct Foo {}
 529             "#,
 530         );
 531
 532         check_assist_not_applicable(
 533             replace_derive_with_manual_impl,
 534             r#"
 535 #[derive(Debug)$0]
 536 struct Foo {}
 537             "#,
 538         )
 539     }
 540
 541     #[test]
 542     fn test_ignore_if_not_derive() {
 543         check_assist_not_applicable(
 544             replace_derive_with_manual_impl,
 545             r#"
 546 #[allow(non_camel_$0case_types)]
 547 struct Foo {}
 548             "#,
 549         )
 550     }
 551
 552     #[test]
 553     fn works_at_start_of_file() {
 554         cov_mark::check!(outside_of_attr_args);
 555         check_assist_not_applicable(
 556             replace_derive_with_manual_impl,
 557             r#"
 558 $0#[derive(Debug)]
 559 struct S;
 560             "#,
 561         );
 562     }
 563 }