clippy_lints/src/map_unit_fn.rs

   1 use clippy_utils::diagnostics::span_lint_and_then;
   2 use clippy_utils::source::snippet;
   3 use clippy_utils::ty::is_type_diagnostic_item;
   4 use clippy_utils::{iter_input_pats, method_chain_args};
   5 use if_chain::if_chain;
   6 use rustc_errors::Applicability;
   7 use rustc_hir as hir;
   8 use rustc_lint::{LateContext, LateLintPass};
   9 use rustc_middle::ty::{self, Ty};
  10 use rustc_session::{declare_lint_pass, declare_tool_lint};
  11 use rustc_span::source_map::Span;
  12 use rustc_span::sym;
  13
  14 declare_clippy_lint! {
  15     /// ### What it does
  16     /// Checks for usage of `option.map(f)` where f is a function
  17     /// or closure that returns the unit type `()`.
  18     ///
  19     /// ### Why is this bad?
  20     /// Readability, this can be written more clearly with
  21     /// an if let statement
  22     ///
  23     /// ### Example
  24     /// ```rust
  25     /// # fn do_stuff() -> Option<String> { Some(String::new()) }
  26     /// # fn log_err_msg(foo: String) -> Option<String> { Some(foo) }
  27     /// # fn format_msg(foo: String) -> String { String::new() }
  28     /// let x: Option<String> = do_stuff();
  29     /// x.map(log_err_msg);
  30     /// # let x: Option<String> = do_stuff();
  31     /// x.map(|msg| log_err_msg(format_msg(msg)));
  32     /// ```
  33     ///
  34     /// The correct use would be:
  35     ///
  36     /// ```rust
  37     /// # fn do_stuff() -> Option<String> { Some(String::new()) }
  38     /// # fn log_err_msg(foo: String) -> Option<String> { Some(foo) }
  39     /// # fn format_msg(foo: String) -> String { String::new() }
  40     /// let x: Option<String> = do_stuff();
  41     /// if let Some(msg) = x {
  42     ///     log_err_msg(msg);
  43     /// }
  44     ///
  45     /// # let x: Option<String> = do_stuff();
  46     /// if let Some(msg) = x {
  47     ///     log_err_msg(format_msg(msg));
  48     /// }
  49     /// ```
  50     pub OPTION_MAP_UNIT_FN,
  51     complexity,
  52     "using `option.map(f)`, where `f` is a function or closure that returns `()`"
  53 }
  54
  55 declare_clippy_lint! {
  56     /// ### What it does
  57     /// Checks for usage of `result.map(f)` where f is a function
  58     /// or closure that returns the unit type `()`.
  59     ///
  60     /// ### Why is this bad?
  61     /// Readability, this can be written more clearly with
  62     /// an if let statement
  63     ///
  64     /// ### Example
  65     /// ```rust
  66     /// # fn do_stuff() -> Result<String, String> { Ok(String::new()) }
  67     /// # fn log_err_msg(foo: String) -> Result<String, String> { Ok(foo) }
  68     /// # fn format_msg(foo: String) -> String { String::new() }
  69     /// let x: Result<String, String> = do_stuff();
  70     /// x.map(log_err_msg);
  71     /// # let x: Result<String, String> = do_stuff();
  72     /// x.map(|msg| log_err_msg(format_msg(msg)));
  73     /// ```
  74     ///
  75     /// The correct use would be:
  76     ///
  77     /// ```rust
  78     /// # fn do_stuff() -> Result<String, String> { Ok(String::new()) }
  79     /// # fn log_err_msg(foo: String) -> Result<String, String> { Ok(foo) }
  80     /// # fn format_msg(foo: String) -> String { String::new() }
  81     /// let x: Result<String, String> = do_stuff();
  82     /// if let Ok(msg) = x {
  83     ///     log_err_msg(msg);
  84     /// };
  85     /// # let x: Result<String, String> = do_stuff();
  86     /// if let Ok(msg) = x {
  87     ///     log_err_msg(format_msg(msg));
  88     /// };
  89     /// ```
  90     pub RESULT_MAP_UNIT_FN,
  91     complexity,
  92     "using `result.map(f)`, where `f` is a function or closure that returns `()`"
  93 }
  94
  95 declare_lint_pass!(MapUnit => [OPTION_MAP_UNIT_FN, RESULT_MAP_UNIT_FN]);
  96
  97 fn is_unit_type(ty: Ty<'_>) -> bool {
  98     match ty.kind() {
  99         ty::Tuple(slice) => slice.is_empty(),
 100         ty::Never => true,
 101         _ => false,
 102     }
 103 }
 104
 105 fn is_unit_function(cx: &LateContext<'_>, expr: &hir::Expr<'_>) -> bool {
 106     let ty = cx.typeck_results().expr_ty(expr);
 107
 108     if let ty::FnDef(id, _) = *ty.kind() {
 109         if let Some(fn_type) = cx.tcx.fn_sig(id).no_bound_vars() {
 110             return is_unit_type(fn_type.output());
 111         }
 112     }
 113     false
 114 }
 115
 116 fn is_unit_expression(cx: &LateContext<'_>, expr: &hir::Expr<'_>) -> bool {
 117     is_unit_type(cx.typeck_results().expr_ty(expr))
 118 }
 119
 120 /// The expression inside a closure may or may not have surrounding braces and
 121 /// semicolons, which causes problems when generating a suggestion. Given an
 122 /// expression that evaluates to '()' or '!', recursively remove useless braces
 123 /// and semi-colons until is suitable for including in the suggestion template
 124 fn reduce_unit_expression<'a>(cx: &LateContext<'_>, expr: &'a hir::Expr<'_>) -> Option<Span> {
 125     if !is_unit_expression(cx, expr) {
 126         return None;
 127     }
 128
 129     match expr.kind {
 130         hir::ExprKind::Call(_, _) | hir::ExprKind::MethodCall(_, _, _, _) => {
 131             // Calls can't be reduced any more
 132             Some(expr.span)
 133         },
 134         hir::ExprKind::Block(block, _) => {
 135             match (block.stmts, block.expr.as_ref()) {
 136                 (&[], Some(inner_expr)) => {
 137                     // If block only contains an expression,
 138                     // reduce `{ X }` to `X`
 139                     reduce_unit_expression(cx, inner_expr)
 140                 },
 141                 (&[ref inner_stmt], None) => {
 142                     // If block only contains statements,
 143                     // reduce `{ X; }` to `X` or `X;`
 144                     match inner_stmt.kind {
 145                         hir::StmtKind::Local(local) => Some(local.span),
 146                         hir::StmtKind::Expr(e) => Some(e.span),
 147                         hir::StmtKind::Semi(..) => Some(inner_stmt.span),
 148                         hir::StmtKind::Item(..) => None,
 149                     }
 150                 },
 151                 _ => {
 152                     // For closures that contain multiple statements
 153                     // it's difficult to get a correct suggestion span
 154                     // for all cases (multi-line closures specifically)
 155                     //
 156                     // We do not attempt to build a suggestion for those right now.
 157                     None
 158                 },
 159             }
 160         },
 161         _ => None,
 162     }
 163 }
 164
 165 fn unit_closure<'tcx>(
 166     cx: &LateContext<'tcx>,
 167     expr: &hir::Expr<'_>,
 168 ) -> Option<(&'tcx hir::Param<'tcx>, &'tcx hir::Expr<'tcx>)> {
 169     if_chain! {
 170         if let hir::ExprKind::Closure(_, decl, inner_expr_id, _, _) = expr.kind;
 171         let body = cx.tcx.hir().body(inner_expr_id);
 172         let body_expr = &body.value;
 173         if decl.inputs.len() == 1;
 174         if is_unit_expression(cx, body_expr);
 175         if let Some(binding) = iter_input_pats(decl, body).next();
 176         then {
 177             return Some((binding, body_expr));
 178         }
 179     }
 180     None
 181 }
 182
 183 /// Builds a name for the let binding variable (`var_arg`)
 184 ///
 185 /// `x.field` => `x_field`
 186 /// `y` => `_y`
 187 ///
 188 /// Anything else will return `a`.
 189 fn let_binding_name(cx: &LateContext<'_>, var_arg: &hir::Expr<'_>) -> String {
 190     match &var_arg.kind {
 191         hir::ExprKind::Field(_, _) => snippet(cx, var_arg.span, "_").replace(".", "_"),
 192         hir::ExprKind::Path(_) => format!("_{}", snippet(cx, var_arg.span, "")),
 193         _ => "a".to_string(),
 194     }
 195 }
 196
 197 #[must_use]
 198 fn suggestion_msg(function_type: &str, map_type: &str) -> String {
 199     format!(
 200         "called `map(f)` on an `{0}` value where `f` is a {1} that returns the unit type `()`",
 201         map_type, function_type
 202     )
 203 }
 204
 205 fn lint_map_unit_fn(cx: &LateContext<'_>, stmt: &hir::Stmt<'_>, expr: &hir::Expr<'_>, map_args: &[hir::Expr<'_>]) {
 206     let var_arg = &map_args[0];
 207
 208     let (map_type, variant, lint) = if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(var_arg), sym::Option) {
 209         ("Option", "Some", OPTION_MAP_UNIT_FN)
 210     } else if is_type_diagnostic_item(cx, cx.typeck_results().expr_ty(var_arg), sym::Result) {
 211         ("Result", "Ok", RESULT_MAP_UNIT_FN)
 212     } else {
 213         return;
 214     };
 215     let fn_arg = &map_args[1];
 216
 217     if is_unit_function(cx, fn_arg) {
 218         let msg = suggestion_msg("function", map_type);
 219         let suggestion = format!(
 220             "if let {0}({binding}) = {1} {{ {2}({binding}) }}",
 221             variant,
 222             snippet(cx, var_arg.span, "_"),
 223             snippet(cx, fn_arg.span, "_"),
 224             binding = let_binding_name(cx, var_arg)
 225         );
 226
 227         span_lint_and_then(cx, lint, expr.span, &msg, |diag| {
 228             diag.span_suggestion(stmt.span, "try this", suggestion, Applicability::MachineApplicable);
 229         });
 230     } else if let Some((binding, closure_expr)) = unit_closure(cx, fn_arg) {
 231         let msg = suggestion_msg("closure", map_type);
 232
 233         span_lint_and_then(cx, lint, expr.span, &msg, |diag| {
 234             if let Some(reduced_expr_span) = reduce_unit_expression(cx, closure_expr) {
 235                 let suggestion = format!(
 236                     "if let {0}({1}) = {2} {{ {3} }}",
 237                     variant,
 238                     snippet(cx, binding.pat.span, "_"),
 239                     snippet(cx, var_arg.span, "_"),
 240                     snippet(cx, reduced_expr_span, "_")
 241                 );
 242                 diag.span_suggestion(
 243                     stmt.span,
 244                     "try this",
 245                     suggestion,
 246                     Applicability::MachineApplicable, // snippet
 247                 );
 248             } else {
 249                 let suggestion = format!(
 250                     "if let {0}({1}) = {2} {{ ... }}",
 251                     variant,
 252                     snippet(cx, binding.pat.span, "_"),
 253                     snippet(cx, var_arg.span, "_"),
 254                 );
 255                 diag.span_suggestion(stmt.span, "try this", suggestion, Applicability::HasPlaceholders);
 256             }
 257         });
 258     }
 259 }
 260
 261 impl<'tcx> LateLintPass<'tcx> for MapUnit {
 262     fn check_stmt(&mut self, cx: &LateContext<'_>, stmt: &hir::Stmt<'_>) {
 263         if stmt.span.from_expansion() {
 264             return;
 265         }
 266
 267         if let hir::StmtKind::Semi(expr) = stmt.kind {
 268             if let Some(arglists) = method_chain_args(expr, &["map"]) {
 269                 lint_map_unit_fn(cx, stmt, expr, arglists[0]);
 270             }
 271         }
 272     }
 273 }