Skip to content

Assist to convert nested function to closure. #13467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
185 changes: 185 additions & 0 deletions crates/ide-assists/src/handlers/convert_nested_function_to_closure.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
use ide_db::assists::{AssistId, AssistKind};
use syntax::ast::{self, HasGenericParams, HasName};
use syntax::{AstNode, SyntaxKind};

use crate::assist_context::{AssistContext, Assists};

// Assist: convert_nested_function_to_closure
//
// Converts a function that is defined within the body of another function into a closure.
//
// ```
// fn main() {
// fn fo$0o(label: &str, number: u64) {
// println!("{}: {}", label, number);
// }
//
// foo("Bar", 100);
// }
// ```
// ->
// ```
// fn main() {
// let foo = |label: &str, number: u64| {
// println!("{}: {}", label, number);
// };
//
// foo("Bar", 100);
// }
// ```
pub(crate) fn convert_nested_function_to_closure(
acc: &mut Assists,
ctx: &AssistContext<'_>,
) -> Option<()> {
let name = ctx.find_node_at_offset::<ast::Name>()?;
let function = name.syntax().parent().and_then(ast::Fn::cast)?;

if !is_nested_function(&function) || is_generic(&function) {
return None;
}

let target = function.syntax().text_range();
let body = function.body()?;
let name = function.name()?;
let params = function.param_list()?;

acc.add(
AssistId("convert_nested_function_to_closure", AssistKind::RefactorRewrite),
"Convert nested function to closure",
target,
|edit| {
let has_semicolon = has_semicolon(&function);
let params_text = params.syntax().text().to_string();
let params_text_trimmed =
params_text.strip_prefix("(").and_then(|p| p.strip_suffix(")"));

if let Some(closure_params) = params_text_trimmed {
let body = body.to_string();
let body = if has_semicolon { body } else { format!("{};", body) };
edit.replace(target, format!("let {} = |{}| {}", name, closure_params, body));
}
},
)
}

/// Returns whether the given function is nested within the body of another function.
fn is_nested_function(function: &ast::Fn) -> bool {
function
.syntax()
.parent()
.map(|p| p.ancestors().any(|a| a.kind() == SyntaxKind::FN))
.unwrap_or(false)
Comment on lines +67 to +71
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will trigger incorrectly if we have an associated function nested in a function (very rare that someone does this but it could happen), so it might be nicer to do the following

function.ancestors().skip(1).find_map(ast::Item::cast).unwrap_or(false, |it| matches!(it, ast::item::Fn(_))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what that snippet is supposed to do, namely because there are two arguments that are passed to unwrap_or. Would it be easier to just check if the function is an associated function?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh my bad, this was supposed to be a map_or_else. But yes it would be easier to just check if it is an assocaited function actually, that is go from the ast::Fn to the hir version and check if that is an assoc item.

}

/// Returns whether the given nested function has generic parameters.
fn is_generic(function: &ast::Fn) -> bool {
function.generic_param_list().is_some()
}

/// Returns whether the given nested function has a trailing semicolon.
fn has_semicolon(function: &ast::Fn) -> bool {
function
.syntax()
.next_sibling_or_token()
.map(|t| t.kind() == SyntaxKind::SEMICOLON)
.unwrap_or(false)
}

#[cfg(test)]
mod tests {
use crate::tests::{check_assist, check_assist_not_applicable};

use super::convert_nested_function_to_closure;

#[test]
fn convert_nested_function_to_closure_works() {
check_assist(
convert_nested_function_to_closure,
r#"
fn main() {
fn $0foo(a: u64, b: u64) -> u64 {
2 * (a + b)
}

_ = foo(3, 4);
}
"#,
r#"
fn main() {
let foo = |a: u64, b: u64| {
2 * (a + b)
};

_ = foo(3, 4);
}
"#,
);
}

#[test]
fn convert_nested_function_to_closure_works_with_existing_semicolon() {
check_assist(
convert_nested_function_to_closure,
r#"
fn main() {
fn foo$0(a: u64, b: u64) -> u64 {
2 * (a + b)
};

_ = foo(3, 4);
}
"#,
r#"
fn main() {
let foo = |a: u64, b: u64| {
2 * (a + b)
};

_ = foo(3, 4);
}
"#,
);
}

#[test]
fn convert_nested_function_to_closure_does_not_work_on_top_level_function() {
check_assist_not_applicable(
convert_nested_function_to_closure,
r#"
fn ma$0in() {}
"#,
);
}

#[test]
fn convert_nested_function_to_closure_does_not_work_when_cursor_off_name() {
check_assist_not_applicable(
convert_nested_function_to_closure,
r#"
fn main() {
fn foo(a: u64, $0b: u64) -> u64 {
2 * (a + b)
};

_ = foo(3, 4);
}
"#,
);
}

#[test]
fn convert_nested_function_to_closure_does_not_work_if_function_has_generic_params() {
check_assist_not_applicable(
convert_nested_function_to_closure,
r#"
fn main() {
fn fo$0o<S: Into<String>>(s: S) -> String {
s.into()
};

_ = foo("hello");
}
"#,
);
}
}
2 changes: 2 additions & 0 deletions crates/ide-assists/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ mod handlers {
mod convert_iter_for_each_to_for;
mod convert_let_else_to_match;
mod convert_match_to_let_else;
mod convert_nested_function_to_closure;
mod convert_tuple_struct_to_named_struct;
mod convert_named_struct_to_tuple_struct;
mod convert_to_guarded_return;
Expand Down Expand Up @@ -224,6 +225,7 @@ mod handlers {
convert_let_else_to_match::convert_let_else_to_match,
convert_named_struct_to_tuple_struct::convert_named_struct_to_tuple_struct,
convert_match_to_let_else::convert_match_to_let_else,
convert_nested_function_to_closure::convert_nested_function_to_closure,
convert_to_guarded_return::convert_to_guarded_return,
convert_tuple_struct_to_named_struct::convert_tuple_struct_to_named_struct,
convert_two_arm_bool_match_to_matches_macro::convert_two_arm_bool_match_to_matches_macro,
Expand Down
25 changes: 25 additions & 0 deletions crates/ide-assists/src/tests/generated.rs
Original file line number Diff line number Diff line change
Expand Up @@ -469,6 +469,31 @@ impl Point {
)
}

#[test]
fn doctest_convert_nested_function_to_closure() {
check_doc_test(
"convert_nested_function_to_closure",
r#####"
fn main() {
fn fo$0o(label: &str, number: u64) {
println!("{}: {}", label, number);
}

foo("Bar", 100);
}
"#####,
r#####"
fn main() {
let foo = |label: &str, number: u64| {
println!("{}: {}", label, number);
};

foo("Bar", 100);
}
"#####,
)
}

#[test]
fn doctest_convert_to_guarded_return() {
check_doc_test(
Expand Down