clippy_lints/src/manual_ok_or.rs

   1 use clippy_utils::diagnostics::span_lint_and_sugg;
   2 use clippy_utils::source::{indent_of, reindent_multiline, snippet_opt};
   3 use clippy_utils::ty::is_type_diagnostic_item;
   4 use clippy_utils::{is_lang_ctor, path_to_local_id};
   5 use if_chain::if_chain;
   6 use rustc_errors::Applicability;
   7 use rustc_hir::LangItem::{ResultErr, ResultOk};
   8 use rustc_hir::{Closure, Expr, ExprKind, PatKind};
   9 use rustc_lint::LintContext;
  10 use rustc_lint::{LateContext, LateLintPass};
  11 use rustc_middle::lint::in_external_macro;
  12 use rustc_session::{declare_lint_pass, declare_tool_lint};
  13 use rustc_span::symbol::sym;
  14
  15 declare_clippy_lint! {
  16     /// ### What it does
  17     ///
  18     /// Finds patterns that reimplement `Option::ok_or`.
  19     ///
  20     /// ### Why is this bad?
  21     ///
  22     /// Concise code helps focusing on behavior instead of boilerplate.
  23     ///
  24     /// ### Examples
  25     /// ```rust
  26     /// let foo: Option<i32> = None;
  27     /// foo.map_or(Err("error"), |v| Ok(v));
  28     /// ```
  29     ///
  30     /// Use instead:
  31     /// ```rust
  32     /// let foo: Option<i32> = None;
  33     /// foo.ok_or("error");
  34     /// ```
  35     #[clippy::version = "1.49.0"]
  36     pub MANUAL_OK_OR,
  37     pedantic,
  38     "finds patterns that can be encoded more concisely with `Option::ok_or`"
  39 }
  40
  41 declare_lint_pass!(ManualOkOr => [MANUAL_OK_OR]);
  42
  43 impl<'tcx> LateLintPass<'tcx> for ManualOkOr {
  44     fn check_expr(&mut self, cx: &LateContext<'tcx>, scrutinee: &'tcx Expr<'tcx>) {
  45         if in_external_macro(cx.sess(), scrutinee.span) {
  46             return;
  47         }
  48
  49         if_chain! {
  50             if let ExprKind::MethodCall(method_segment, [receiver, or_expr, map_expr], _) = scrutinee.kind;
  51             if method_segment.ident.name == sym!(map_or);
  52             let ty = cx.typeck_results().expr_ty(receiver);
  53             if is_type_diagnostic_item(cx, ty, sym::Option);
  54             if is_ok_wrapping(cx, map_expr);
  55             if let ExprKind::Call(Expr { kind: ExprKind::Path(err_path), .. }, &[ref err_arg]) = or_expr.kind;
  56             if is_lang_ctor(cx, err_path, ResultErr);
  57             if let Some(method_receiver_snippet) = snippet_opt(cx, receiver.span);
  58             if let Some(err_arg_snippet) = snippet_opt(cx, err_arg.span);
  59             if let Some(indent) = indent_of(cx, scrutinee.span);
  60             then {
  61                 let reindented_err_arg_snippet =
  62                     reindent_multiline(err_arg_snippet.into(), true, Some(indent + 4));
  63                 span_lint_and_sugg(
  64                     cx,
  65                     MANUAL_OK_OR,
  66                     scrutinee.span,
  67                     "this pattern reimplements `Option::ok_or`",
  68                     "replace with",
  69                     format!(
  70                         "{}.ok_or({})",
  71                         method_receiver_snippet,
  72                         reindented_err_arg_snippet
  73                     ),
  74                     Applicability::MachineApplicable,
  75                 );
  76             }
  77         }
  78     }
  79 }
  80
  81 fn is_ok_wrapping(cx: &LateContext<'_>, map_expr: &Expr<'_>) -> bool {
  82     if let ExprKind::Path(ref qpath) = map_expr.kind {
  83         if is_lang_ctor(cx, qpath, ResultOk) {
  84             return true;
  85         }
  86     }
  87     if_chain! {
  88         if let ExprKind::Closure(&Closure { body, .. }) = map_expr.kind;
  89         let body = cx.tcx.hir().body(body);
  90         if let PatKind::Binding(_, param_id, ..) = body.params[0].pat.kind;
  91         if let ExprKind::Call(Expr { kind: ExprKind::Path(ok_path), .. }, &[ref ok_arg]) = body.value.kind;
  92         if is_lang_ctor(cx, ok_path, ResultOk);
  93         then { path_to_local_id(ok_arg, param_id) } else { false }
  94     }
  95 }