Skip to content

Commit

Permalink
Skip needless_for_each if an input stmt is local
Browse files Browse the repository at this point in the history
  • Loading branch information
Y-Nak committed Mar 14, 2021
1 parent 4d892a5 commit 8e3d769
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 33 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

A collection of lints to catch common mistakes and improve your [Rust](https://github.com/rust-lang/rust) code.

[There are over 400 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)
[There are over 450 lints included in this crate!](https://rust-lang.github.io/rust-clippy/master/index.html)

Lints are divided into categories, each with a default [lint level](https://doc.rust-lang.org/rustc/lints/levels.html).
You can choose how much Clippy is supposed to ~~annoy~~ help you by changing the lint level by category.
Expand Down
50 changes: 23 additions & 27 deletions clippy_lints/src/needless_for_each.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,31 +49,28 @@ impl LateLintPass<'_> for NeedlessForEach {
fn check_stmt(&mut self, cx: &LateContext<'tcx>, stmt: &'tcx Stmt<'_>) {
let expr = match stmt.kind {
StmtKind::Expr(expr) | StmtKind::Semi(expr) => expr,
StmtKind::Local(local) if local.init.is_some() => local.init.unwrap(),
_ => return,
};

if_chain! {
// Check the method name is `for_each`.
if let ExprKind::MethodCall(method_name, _, for_each_args, _) = expr.kind;
if let ExprKind::MethodCall(method_name, _, [for_each_recv, for_each_arg], _) = expr.kind;
if method_name.ident.name == Symbol::intern("for_each");
// Check `for_each` is an associated function of `Iterator`.
if is_trait_method(cx, expr, sym::Iterator);
// Checks the receiver of `for_each` is also a method call.
if let Some(for_each_receiver) = for_each_args.get(0);
if let ExprKind::MethodCall(_, _, iter_args, _) = for_each_receiver.kind;
if let ExprKind::MethodCall(_, _, [iter_recv], _) = for_each_recv.kind;
// Skip the lint if the call chain is too long. e.g. `v.field.iter().for_each()` or
// `v.foo().iter().for_each()` must be skipped.
if let Some(iter_receiver) = iter_args.get(0);
if matches!(
iter_receiver.kind,
iter_recv.kind,
ExprKind::Array(..) | ExprKind::Call(..) | ExprKind::Path(..)
);
// Checks the type of the `iter` method receiver is NOT a user defined type.
if has_iter_method(cx, cx.typeck_results().expr_ty(&iter_receiver)).is_some();
if has_iter_method(cx, cx.typeck_results().expr_ty(&iter_recv)).is_some();
// Skip the lint if the body is not block because this is simpler than `for` loop.
// e.g. `v.iter().for_each(f)` is simpler and clearer than using `for` loop.
if let ExprKind::Closure(_, _, body_id, ..) = for_each_args[1].kind;
if let ExprKind::Closure(_, _, body_id, ..) = for_each_arg.kind;
let body = cx.tcx.hir().body(body_id);
if let ExprKind::Block(..) = body.value.kind;
then {
Expand All @@ -85,38 +82,37 @@ impl LateLintPass<'_> for NeedlessForEach {
return;
}

// We can't use `Applicability::MachineApplicable` when the closure contains `return`
// because `Diagnostic::multipart_suggestion` doesn't work with multiple overlapped
// spans.
let mut applicability = if ret_collector.spans.is_empty() {
Applicability::MachineApplicable
let (mut applicability, ret_suggs) = if ret_collector.spans.is_empty() {
(Applicability::MachineApplicable, None)
} else {
Applicability::MaybeIncorrect
(
Applicability::MaybeIncorrect,
Some(
ret_collector
.spans
.into_iter()
.map(|span| (span, "continue".to_string()))
.collect(),
),
)
};

let mut suggs = vec![];
suggs.push((stmt.span, format!(
let sugg = format!(
"for {} in {} {}",
snippet_with_applicability(cx, body.params[0].pat.span, "..", &mut applicability),
snippet_with_applicability(cx, for_each_args[0].span, "..", &mut applicability),
snippet_with_applicability(cx, for_each_recv.span, "..", &mut applicability),
snippet_with_applicability(cx, body.value.span, "..", &mut applicability),
)));

for span in &ret_collector.spans {
suggs.push((*span, "continue".to_string()));
}
);

span_lint_and_then(
cx,
NEEDLESS_FOR_EACH,
stmt.span,
"needless use of `for_each`",
|diag| {
diag.multipart_suggestion("try", suggs, applicability);
// `Diagnostic::multipart_suggestion` ignores the second and subsequent overlapped spans,
// so `span_note` is needed here even though `suggs` includes the replacements.
for span in ret_collector.spans {
diag.span_note(span, "replace `return` with `continue`");
diag.span_suggestion(stmt.span, "try", sugg, applicability);
if let Some(ret_suggs) = ret_suggs {
diag.multipart_suggestion("try replacing `return` with `continue`", ret_suggs, applicability);
}
}
)
Expand Down
5 changes: 5 additions & 0 deletions tests/ui/needless_for_each_fixable.fixed
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ fn should_not_lint() {
acc += elem;
}),
}

// `for_each` is in a let bingind.
let _ = v.iter().for_each(|elem| {
acc += elem;
});
}

fn main() {}
5 changes: 5 additions & 0 deletions tests/ui/needless_for_each_fixable.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,11 @@ fn should_not_lint() {
acc += elem;
}),
}

// `for_each` is in a let bingind.
let _ = v.iter().for_each(|elem| {
acc += elem;
});
}

fn main() {}
9 changes: 4 additions & 5 deletions tests/ui/needless_for_each_unfixable.stderr
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ LL | | });
| |_______^
|
= note: `-D clippy::needless-for-each` implied by `-D warnings`
note: replace `return` with `continue`
--> $DIR/needless_for_each_unfixable.rs:9:13
|
LL | return;
| ^^^^^^
help: try
|
LL | for v in v.iter() {
Expand All @@ -25,6 +20,10 @@ LL | } else {
LL | println!("{}", v);
LL | }
...
help: try replacing `return` with `continue`
|
LL | continue;
| ^^^^^^^^

error: aborting due to previous error

0 comments on commit 8e3d769

Please sign in to comment.