clippy_lints/src/ok_if_let.rs

   1 // Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution.
   3 //
   4 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   5 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   7 // option. This file may not be copied, modified, or distributed
   8 // except according to those terms.
   9
  10
  11 use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
  12 use crate::rustc::{declare_tool_lint, lint_array};
  13 use if_chain::if_chain;
  14 use crate::rustc::hir::*;
  15 use crate::utils::{match_type, method_chain_args, paths, snippet, span_help_and_lint};
  16
  17 /// **What it does:*** Checks for unnecessary `ok()` in if let.
  18 ///
  19 /// **Why is this bad?** Calling `ok()` in if let is unnecessary, instead match
  20 /// on `Ok(pat)`
  21 ///
  22 /// **Known problems:** None.
  23 ///
  24 /// **Example:**
  25 /// ```rust
  26 /// for result in iter {
  27 ///     if let Some(bench) = try!(result).parse().ok() {
  28 ///         vec.push(bench)
  29 ///     }
  30 /// }
  31 /// ```
  32 /// Could be written:
  33 ///
  34 /// ```rust
  35 /// for result in iter {
  36 ///     if let Ok(bench) = try!(result).parse() {
  37 ///         vec.push(bench)
  38 ///     }
  39 /// }
  40 /// ```
  41 declare_clippy_lint! {
  42     pub IF_LET_SOME_RESULT,
  43     style,
  44     "usage of `ok()` in `if let Some(pat)` statements is unnecessary, match on `Ok(pat)` instead"
  45 }
  46
  47 #[derive(Copy, Clone)]
  48 pub struct Pass;
  49
  50 impl LintPass for Pass {
  51     fn get_lints(&self) -> LintArray {
  52         lint_array!(IF_LET_SOME_RESULT)
  53     }
  54 }
  55
  56 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
  57     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
  58         if_chain! { //begin checking variables
  59             if let ExprKind::Match(ref op, ref body, ref source) = expr.node; //test if expr is a match
  60             if let MatchSource::IfLetDesugar { .. } = *source; //test if it is an If Let
  61             if let ExprKind::MethodCall(_, _, ref result_types) = op.node; //check is expr.ok() has type Result<T,E>.ok()
  62             if let PatKind::TupleStruct(QPath::Resolved(_, ref x), ref y, _)  = body[0].pats[0].node; //get operation
  63             if method_chain_args(op, &["ok"]).is_some(); //test to see if using ok() methoduse std::marker::Sized;
  64
  65             then {
  66                 let is_result_type = match_type(cx, cx.tables.expr_ty(&result_types[0]), &paths::RESULT);
  67                 let some_expr_string = snippet(cx, y[0].span, "");
  68                 if print::to_string(print::NO_ANN, |s| s.print_path(x, false)) == "Some" && is_result_type {
  69                     span_help_and_lint(cx, IF_LET_SOME_RESULT, expr.span,
  70                     "Matching on `Some` with `ok()` is redundant",
  71                     &format!("Consider matching on `Ok({})` and removing the call to `ok` instead", some_expr_string));
  72                 }
  73             }
  74         }
  75     }
  76 }