rust-clippy/clippy_lints/src/unnecessary_wraps.rs

use crate::utils::{
    contains_return, in_macro, is_type_diagnostic_item, match_qpath, paths, return_ty, snippet, span_lint_and_sugg,
    span_lint_and_then, visitors::find_all_ret_expressions,
};
use if_chain::if_chain;
use rustc_errors::Applicability;
use rustc_hir::intravisit::FnKind;
use rustc_hir::{Body, ExprKind, FnDecl, HirId, Impl, ItemKind, Node};
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty::subst::GenericArgKind;
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::symbol::sym;
use rustc_span::Span;

declare_clippy_lint! {
    /// **What it does:** Checks for private functions that only return `Ok` or `Some`.
    ///
    /// **Why is this bad?** It is not meaningful to wrap values when no `None` or `Err` is returned.
    ///
    /// **Known problems:** Since this lint changes function type signature, you may need to
    /// adjust some code at callee side.
    ///
    /// **Example:**
    ///
    /// ```rust
    /// fn get_cool_number(a: bool, b: bool) -> Option<i32> {
    ///     if a && b {
    ///         return Some(50);
    ///     }
    ///     if a {
    ///         Some(0)
    ///     } else {
    ///         Some(10)
    ///     }
    /// }
    /// ```
    /// Use instead:
    /// ```rust
    /// fn get_cool_number(a: bool, b: bool) -> i32 {
    ///     if a && b {
    ///         return 50;
    ///     }
    ///     if a {
    ///         0
    ///     } else {
    ///         10
    ///     }
    /// }
    /// ```
    pub UNNECESSARY_WRAPS,
    complexity,
    "functions that only return `Ok` or `Some`"
}

declare_lint_pass!(UnnecessaryWraps => [UNNECESSARY_WRAPS]);

impl<'tcx> LateLintPass<'tcx> for UnnecessaryWraps {
    fn check_fn(
        &mut self,
        cx: &LateContext<'tcx>,
        fn_kind: FnKind<'tcx>,
        fn_decl: &FnDecl<'tcx>,
        body: &Body<'tcx>,
        span: Span,
        hir_id: HirId,
    ) {
        // Abort if public function/method or closure.
        match fn_kind {
            FnKind::ItemFn(.., visibility, _) | FnKind::Method(.., Some(visibility), _) => {
                if visibility.node.is_pub() {
                    return;
                }
            },
            FnKind::Closure(..) => return,
            _ => (),
        }

        // Abort if the method is implementing a trait or of it a trait method.
        if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
            if matches!(
                item.kind,
                ItemKind::Impl(Impl { of_trait: Some(_), .. }) | ItemKind::Trait(..)
            ) {
                return;
            }
        }

        // Check if return type is Option or Result. If neither, abort.
        let return_ty = return_ty(cx, hir_id);
        let (return_type_label, path) = if is_type_diagnostic_item(cx, return_ty, sym::option_type) {
            ("Option", &paths::OPTION_SOME)
        } else if is_type_diagnostic_item(cx, return_ty, sym::result_type) {
            ("Result", &paths::RESULT_OK)
        } else {
            return;
        };

        // Take the first inner type of the Option or Result. If can't, abort.
        let inner_ty = if_chain! {
            // Skip Option or Result and take the first outermost inner type.
            if let Some(inner_ty) = return_ty.walk().nth(1);
            if let GenericArgKind::Type(inner_ty) = inner_ty.unpack();
            then {
                inner_ty
            } else {
                return;
            }
        };

        // Check if all return expression respect the following condition and collect them.
        let mut suggs = Vec::new();
        let can_sugg = find_all_ret_expressions(cx, &body.value, |ret_expr| {
            if_chain! {
                // Abort if in macro.
                if !in_macro(ret_expr.span);
                // Check if a function call.
                if let ExprKind::Call(ref func, ref args) = ret_expr.kind;
                // Get the Path of the function call.
                if let ExprKind::Path(ref qpath) = func.kind;
                // Check if OPTION_SOME or RESULT_OK, depending on return type.
                if match_qpath(qpath, path);
                // Make sure the function call has only one argument.
                if args.len() == 1;
                // Make sure the function argument does not contain a return expression.
                if !contains_return(&args[0]);
                then {
                    suggs.push((ret_expr.span, snippet(cx, args[0].span.source_callsite(), "..").to_string()));
                    true
                } else {
                    false
                }
            }
        });

        if can_sugg && !suggs.is_empty() {
            // Issue 6640: If the inner type is Unit, emit lint similar to clippy::unused_unit.
            if inner_ty.is_unit() {
                span_lint_and_sugg(
                    cx,
                    UNNECESSARY_WRAPS,
                    fn_decl.output.span(),
                    "unneeded wrapped unit return type",
                    format!("remove the `-> {}<[...]>`", return_type_label).as_str(),
                    String::new(),
                    Applicability::MaybeIncorrect,
                );
            } else {
                span_lint_and_then(
                    cx,
                    UNNECESSARY_WRAPS,
                    span,
                    format!(
                        "this function's return value is unnecessarily wrapped by `{}`",
                        return_type_label
                    )
                    .as_str(),
                    |diag| {
                        diag.span_suggestion(
                            fn_decl.output.span(),
                            format!("remove `{}` from the return type...", return_type_label).as_str(),
                            inner_ty.to_string(),
                            Applicability::MaybeIncorrect,
                        );
                        diag.multipart_suggestion(
                            "...and change the returning expressions",
                            suggs,
                            Applicability::MaybeIncorrect,
                        );
                    },
                );
            }
        }
    }
}