clippy_lints/src/map_unit_fn.rs

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