Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 6d4eeea

Browse files
tnielenstnielens
committed
manual-unwrap-or / pr remarks
1 parent 9c93279 commit 6d4eeea

File tree

8 files changed

+101
-79
lines changed

8 files changed

+101
-79
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1781,7 +1781,6 @@ Released 2018-09-13
17811781
[`large_stack_arrays`]: https://rust-lang.github.io/rust-clippy/master/index.html#large_stack_arrays
17821782
[`len_without_is_empty`]: https://rust-lang.github.io/rust-clippy/master/index.html#len_without_is_empty
17831783
[`len_zero`]: https://rust-lang.github.io/rust-clippy/master/index.html#len_zero
1784-
[`less_concise_than_option_unwrap_or`]: https://rust-lang.github.io/rust-clippy/master/index.html#less_concise_than_option_unwrap_or
17851784
[`let_and_return`]: https://rust-lang.github.io/rust-clippy/master/index.html#let_and_return
17861785
[`let_underscore_lock`]: https://rust-lang.github.io/rust-clippy/master/index.html#let_underscore_lock
17871786
[`let_underscore_must_use`]: https://rust-lang.github.io/rust-clippy/master/index.html#let_underscore_must_use
@@ -1797,6 +1796,7 @@ Released 2018-09-13
17971796
[`manual_saturating_arithmetic`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_saturating_arithmetic
17981797
[`manual_strip`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_strip
17991798
[`manual_swap`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_swap
1799+
[`manual_unwrap_or`]: https://rust-lang.github.io/rust-clippy/master/index.html#manual_unwrap_or
18001800
[`many_single_char_names`]: https://rust-lang.github.io/rust-clippy/master/index.html#many_single_char_names
18011801
[`map_clone`]: https://rust-lang.github.io/rust-clippy/master/index.html#map_clone
18021802
[`map_entry`]: https://rust-lang.github.io/rust-clippy/master/index.html#map_entry

‎clippy_lints/src/lib.rs‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,6 @@ mod large_const_arrays;
224224
mod large_enum_variant;
225225
mod large_stack_arrays;
226226
mod len_zero;
227-
mod less_concise_than;
228227
mod let_if_seq;
229228
mod let_underscore;
230229
mod lifetimes;
@@ -235,6 +234,7 @@ mod main_recursion;
235234
mod manual_async_fn;
236235
mod manual_non_exhaustive;
237236
mod manual_strip;
237+
mod manual_unwrap_or;
238238
mod map_clone;
239239
mod map_err_ignore;
240240
mod map_identity;
@@ -610,7 +610,6 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
610610
&large_stack_arrays::LARGE_STACK_ARRAYS,
611611
&len_zero::LEN_WITHOUT_IS_EMPTY,
612612
&len_zero::LEN_ZERO,
613-
&less_concise_than::LESS_CONCISE_THAN_OPTION_UNWRAP_OR,
614613
&let_if_seq::USELESS_LET_IF_SEQ,
615614
&let_underscore::LET_UNDERSCORE_LOCK,
616615
&let_underscore::LET_UNDERSCORE_MUST_USE,
@@ -642,6 +641,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
642641
&manual_async_fn::MANUAL_ASYNC_FN,
643642
&manual_non_exhaustive::MANUAL_NON_EXHAUSTIVE,
644643
&manual_strip::MANUAL_STRIP,
644+
&manual_unwrap_or::MANUAL_UNWRAP_OR,
645645
&map_clone::MAP_CLONE,
646646
&map_err_ignore::MAP_ERR_IGNORE,
647647
&map_identity::MAP_IDENTITY,
@@ -1128,7 +1128,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
11281128
store.register_late_pass(|| box repeat_once::RepeatOnce);
11291129
store.register_late_pass(|| box unwrap_in_result::UnwrapInResult);
11301130
store.register_late_pass(|| box self_assignment::SelfAssignment);
1131-
store.register_late_pass(|| box less_concise_than::LessConciseThan);
1131+
store.register_late_pass(|| box manual_unwrap_or::ManualUnwrapOr);
11321132
store.register_late_pass(|| box float_equality_without_abs::FloatEqualityWithoutAbs);
11331133
store.register_late_pass(|| box async_yields_async::AsyncYieldsAsync);
11341134
store.register_late_pass(|| box manual_strip::ManualStrip);
@@ -1213,7 +1213,6 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
12131213
LintId::of(&infinite_iter::MAYBE_INFINITE_ITER),
12141214
LintId::of(&items_after_statements::ITEMS_AFTER_STATEMENTS),
12151215
LintId::of(&large_stack_arrays::LARGE_STACK_ARRAYS),
1216-
LintId::of(&less_concise_than::LESS_CONCISE_THAN_OPTION_UNWRAP_OR),
12171216
LintId::of(&literal_representation::LARGE_DIGIT_GROUPS),
12181217
LintId::of(&literal_representation::UNREADABLE_LITERAL),
12191218
LintId::of(&loops::EXPLICIT_INTO_ITER_LOOP),
@@ -1371,6 +1370,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
13711370
LintId::of(&manual_async_fn::MANUAL_ASYNC_FN),
13721371
LintId::of(&manual_non_exhaustive::MANUAL_NON_EXHAUSTIVE),
13731372
LintId::of(&manual_strip::MANUAL_STRIP),
1373+
LintId::of(&manual_unwrap_or::MANUAL_UNWRAP_OR),
13741374
LintId::of(&map_clone::MAP_CLONE),
13751375
LintId::of(&map_identity::MAP_IDENTITY),
13761376
LintId::of(&map_unit_fn::OPTION_MAP_UNIT_FN),
@@ -1666,6 +1666,7 @@ pub fn register_plugins(store: &mut rustc_lint::LintStore, sess: &Session, conf:
16661666
LintId::of(&loops::MUT_RANGE_BOUND),
16671667
LintId::of(&loops::WHILE_LET_LOOP),
16681668
LintId::of(&manual_strip::MANUAL_STRIP),
1669+
LintId::of(&manual_unwrap_or::MANUAL_UNWRAP_OR),
16691670
LintId::of(&map_identity::MAP_IDENTITY),
16701671
LintId::of(&map_unit_fn::OPTION_MAP_UNIT_FN),
16711672
LintId::of(&map_unit_fn::RESULT_MAP_UNIT_FN),

‎clippy_lints/src/manual_unwrap_or.rs‎

Lines changed: 59 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@ use crate::utils;
22
use if_chain::if_chain;
33
use rustc_errors::Applicability;
44
use rustc_hir::{def, Arm, Expr, ExprKind, PatKind, QPath};
5+
use rustc_lint::LintContext;
56
use rustc_lint::{LateContext, LateLintPass};
7+
use rustc_middle::lint::in_external_macro;
68
use rustc_session::{declare_lint_pass, declare_tool_lint};
79

810
declare_clippy_lint! {
911
/// **What it does:**
10-
/// Finds patterns that can be encoded more concisely with `Option::unwrap_or`.
12+
/// Finds patterns that reimplement `Option::unwrap_or`.
1113
///
1214
/// **Why is this bad?**
1315
/// Concise code helps focusing on behavior instead of boilerplate.
@@ -16,47 +18,43 @@ declare_clippy_lint! {
1618
///
1719
/// **Example:**
1820
/// ```rust
19-
/// match int_optional {
21+
/// match int_option {
2022
/// Some(v) => v,
2123
/// None => 1,
2224
/// }
2325
/// ```
2426
///
2527
/// Use instead:
2628
/// ```rust
27-
/// int_optional.unwrap_or(1)
29+
/// int_option.unwrap_or(1)
2830
/// ```
29-
pub LESS_CONCISE_THAN_OPTION_UNWRAP_OR,
30-
pedantic,
31-
"finds patterns that can be encoded more concisely with `Option::unwrap_or`"
31+
pub MANUAL_UNWRAP_OR,
32+
complexity,
33+
"finds patterns that can be encoded more concisely with `Option::unwrap_or(_else)`"
3234
}
3335

34-
declare_lint_pass!(LessConciseThan => [LESS_CONCISE_THAN_OPTION_UNWRAP_OR]);
36+
declare_lint_pass!(ManualUnwrapOr => [MANUAL_UNWRAP_OR]);
3537

36-
impl LateLintPass<'_> for LessConciseThan {
38+
impl LateLintPass<'_> for ManualUnwrapOr {
3739
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) {
38-
if utils::in_macro(expr.span) {
39-
return;
40-
}
41-
if lint_option_unwrap_or_case(cx, expr) {
40+
if in_external_macro(cx.sess(), expr.span) {
4241
return;
4342
}
43+
lint_option_unwrap_or_case(cx, expr);
4444
}
4545
}
4646

4747
fn lint_option_unwrap_or_case<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) -> bool {
48-
#[allow(clippy::needless_bool)]
4948
fn applicable_none_arm<'a>(arms: &'a [Arm<'a>]) -> Option<&'a Arm<'a>> {
5049
if_chain! {
5150
if arms.len() == 2;
5251
if arms.iter().all(|arm| arm.guard.is_none());
5352
if let Some((idx, none_arm)) = arms.iter().enumerate().find(|(_, arm)|
54-
if_chain! {
55-
if let PatKind::Path(ref qpath) = arm.pat.kind;
56-
if utils::match_qpath(qpath, &utils::paths::OPTION_NONE);
57-
then { true }
58-
else { false }
59-
}
53+
if let PatKind::Path(ref qpath) = arm.pat.kind {
54+
utils::match_qpath(qpath, &utils::paths::OPTION_NONE)
55+
} else {
56+
false
57+
}
6058
);
6159
let some_arm = &arms[1 - idx];
6260
if let PatKind::TupleStruct(ref some_qpath, &[some_binding], _) = some_arm.pat.kind;
@@ -65,43 +63,50 @@ fn lint_option_unwrap_or_case<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'tc
6563
if let ExprKind::Path(QPath::Resolved(_, body_path)) = some_arm.body.kind;
6664
if let def::Res::Local(body_path_hir_id) = body_path.res;
6765
if body_path_hir_id == binding_hir_id;
68-
then { Some(none_arm) }
69-
else { None }
66+
if !utils::usage::contains_return_break_continue_macro(none_arm.body);
67+
then {
68+
Some(none_arm)
69+
}
70+
else {
71+
None
72+
}
7073
}
7174
}
75+
7276
if_chain! {
73-
if !utils::usage::contains_return_break_continue_macro(expr);
74-
if let ExprKind::Match (match_expr, match_arms, _) = expr.kind;
75-
let ty = cx.typeck_results().expr_ty(match_expr);
76-
if utils::is_type_diagnostic_item(cx, ty, sym!(option_type));
77-
if let Some(none_arm) = applicable_none_arm(match_arms);
78-
if let Some(match_expr_snippet) = utils::snippet_opt(cx, match_expr.span);
79-
if let Some(none_body_snippet) = utils::snippet_opt(cx, none_arm.body.span);
80-
if let Some(indent) = utils::indent_of(cx, expr.span);
81-
then {
82-
let reindented_none_body =
83-
utils::reindent_multiline(none_body_snippet.into(), true, Some(indent));
84-
let eager_eval = utils::eager_or_lazy::is_eagerness_candidate(cx, none_arm.body);
85-
let method = if eager_eval {
86-
"unwrap_or"
87-
} else {
88-
"unwrap_or_else"
89-
};
90-
utils::span_lint_and_sugg(
91-
cx,
92-
LESS_CONCISE_THAN_OPTION_UNWRAP_OR, expr.span,
93-
"this pattern can be more concisely encoded with `Option::unwrap_or`",
94-
"replace with",
95-
format!(
96-
"{}.{}({}{})",
97-
match_expr_snippet,
98-
method,
99-
if eager_eval { ""} else { "|| " },
100-
reindented_none_body
101-
),
102-
Applicability::MachineApplicable,
103-
);
104-
true
105-
} else { false}
77+
if let ExprKind::Match(scrutinee, match_arms, _) = expr.kind;
78+
let ty = cx.typeck_results().expr_ty(scrutinee);
79+
if utils::is_type_diagnostic_item(cx, ty, sym!(option_type));
80+
if let Some(none_arm) = applicable_none_arm(match_arms);
81+
if let Some(scrutinee_snippet) = utils::snippet_opt(cx, scrutinee.span);
82+
if let Some(none_body_snippet) = utils::snippet_opt(cx, none_arm.body.span);
83+
if let Some(indent) = utils::indent_of(cx, expr.span);
84+
then {
85+
let reindented_none_body =
86+
utils::reindent_multiline(none_body_snippet.into(), true, Some(indent));
87+
let eager_eval = utils::eager_or_lazy::is_eagerness_candidate(cx, none_arm.body);
88+
let method = if eager_eval {
89+
"unwrap_or"
90+
} else {
91+
"unwrap_or_else"
92+
};
93+
utils::span_lint_and_sugg(
94+
cx,
95+
MANUAL_UNWRAP_OR, expr.span,
96+
&format!("this pattern reimplements `Option::{}`", &method),
97+
"replace with",
98+
format!(
99+
"{}.{}({}{})",
100+
scrutinee_snippet,
101+
method,
102+
if eager_eval { ""} else { "|| " },
103+
reindented_none_body
104+
),
105+
Applicability::MachineApplicable,
106+
);
107+
true
108+
} else {
109+
false
110+
}
106111
}
107112
}

‎src/lintlist/mod.rs‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1075,13 +1075,6 @@ vec![
10751075
deprecation: None,
10761076
module: "len_zero",
10771077
},
1078-
Lint {
1079-
name: "less_concise_than_option_unwrap_or",
1080-
group: "pedantic",
1081-
desc: "finds patterns that can be encoded more concisely with `Option::unwrap_or`",
1082-
deprecation: None,
1083-
module: "less_concise_than",
1084-
},
10851078
Lint {
10861079
name: "let_and_return",
10871080
group: "style",
@@ -1187,6 +1180,13 @@ vec![
11871180
deprecation: None,
11881181
module: "swap",
11891182
},
1183+
Lint {
1184+
name: "manual_unwrap_or",
1185+
group: "complexity",
1186+
desc: "finds patterns that can be encoded more concisely with `Option::unwrap_or(_else)`",
1187+
deprecation: None,
1188+
module: "manual_unwrap_or",
1189+
},
11901190
Lint {
11911191
name: "many_single_char_names",
11921192
group: "style",

‎tests/ui/less_concise_than.fixed‎ renamed to ‎tests/ui/manual_unwrap_or.fixed‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
// run-rustfix
2-
#![warn(clippy::less_concise_than_option_unwrap_or)]
32
#![allow(dead_code)]
43

54
fn unwrap_or() {
65
// int case
76
Some(1).unwrap_or(42);
87

8+
// int case reversed
9+
Some(1).unwrap_or(42);
10+
911
// richer none expr
1012
Some(1).unwrap_or_else(|| 1 + 42);
1113

‎tests/ui/less_concise_than.rs‎ renamed to ‎tests/ui/manual_unwrap_or.rs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
// run-rustfix
2-
#![warn(clippy::less_concise_than_option_unwrap_or)]
32
#![allow(dead_code)]
43

54
fn unwrap_or() {
@@ -9,6 +8,12 @@ fn unwrap_or() {
98
None => 42,
109
};
1110

11+
// int case reversed
12+
match Some(1) {
13+
None => 42,
14+
Some(i) => i,
15+
};
16+
1217
// richer none expr
1318
match Some(1) {
1419
Some(i) => i,

‎tests/ui/less_concise_than.stderr‎ renamed to ‎tests/ui/manual_unwrap_or.stderr‎

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,34 @@
1-
error: this pattern can be more concisely encoded with `Option::unwrap_or`
2-
--> $DIR/less_concise_than.rs:7:5
1+
error: this pattern reimplements `Option::unwrap_or`
2+
--> $DIR/manual_unwrap_or.rs:6:5
33
|
44
LL | / match Some(1) {
55
LL | | Some(i) => i,
66
LL | | None => 42,
77
LL | | };
88
| |_____^ help: replace with: `Some(1).unwrap_or(42)`
99
|
10-
= note: `-D clippy::less-concise-than-option-unwrap-or` implied by `-D warnings`
10+
= note: `-D clippy::manual-unwrap-or` implied by `-D warnings`
1111

12-
error: this pattern can be more concisely encoded with `Option::unwrap_or`
13-
--> $DIR/less_concise_than.rs:13:5
12+
error: this pattern reimplements `Option::unwrap_or`
13+
--> $DIR/manual_unwrap_or.rs:12:5
14+
|
15+
LL | / match Some(1) {
16+
LL | | None => 42,
17+
LL | | Some(i) => i,
18+
LL | | };
19+
| |_____^ help: replace with: `Some(1).unwrap_or(42)`
20+
21+
error: this pattern reimplements `Option::unwrap_or_else`
22+
--> $DIR/manual_unwrap_or.rs:18:5
1423
|
1524
LL | / match Some(1) {
1625
LL | | Some(i) => i,
1726
LL | | None => 1 + 42,
1827
LL | | };
1928
| |_____^ help: replace with: `Some(1).unwrap_or_else(|| 1 + 42)`
2029

21-
error: this pattern can be more concisely encoded with `Option::unwrap_or`
22-
--> $DIR/less_concise_than.rs:19:5
30+
error: this pattern reimplements `Option::unwrap_or_else`
31+
--> $DIR/manual_unwrap_or.rs:24:5
2332
|
2433
LL | / match Some(1) {
2534
LL | | Some(i) => i,
@@ -39,14 +48,14 @@ LL | b + 42
3948
LL | });
4049
|
4150

42-
error: this pattern can be more concisely encoded with `Option::unwrap_or`
43-
--> $DIR/less_concise_than.rs:29:5
51+
error: this pattern reimplements `Option::unwrap_or`
52+
--> $DIR/manual_unwrap_or.rs:34:5
4453
|
4554
LL | / match Some("Bob") {
4655
LL | | Some(i) => i,
4756
LL | | None => "Alice",
4857
LL | | };
4958
| |_____^ help: replace with: `Some("Bob").unwrap_or("Alice")`
5059

51-
error: aborting due to 4 previous errors
60+
error: aborting due to 5 previous errors
5261

‎tests/ui/shadow.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
#![allow(
99
unused_parens,
1010
unused_variables,
11-
clippy::less_concise_than_option_unwrap_or,
11+
clippy::manual_unwrap_or,
1212
clippy::missing_docs_in_private_items,
1313
clippy::single_match
1414
)]

0 commit comments

Comments
 (0)