rrubocop 0.8.15

10x faster RuboCop drop-in. Same output format and configs, without maintaining RuboCop gems.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! GraphQL/ObjectDescription — types need a description.

use tree_sitter::Node;

use super::helpers::{
    class_body_stmts, description_method_in, module_body_stmts, DEPT_INCLUDE,
};
use crate::cop::shared::{argument_nodes, call_method_name};
use crate::cop::{Cop, CopConfig};
use crate::diagnostic::Diagnostic;
use crate::parse::source::SourceFile;

pub struct ObjectDescription;

impl Cop for ObjectDescription {
    fn name(&self) -> &'static str {
        "GraphQL/ObjectDescription"
    }

    fn default_include(&self) -> &'static [&'static str] {
        DEPT_INCLUDE
    }

    fn default_exclude(&self) -> &'static [&'static str] {
        &[
            "spec/**/*",
            "test/**/*",
            "**/*_schema.rb",
            "**/base_*.rb",
            "**/graphql/query_context.rb",
        ]
    }

    fn interested_node_kinds(&self) -> &'static [&'static str] {
        &["class", "module"]
    }

    fn check_node(
        &self,
        source: &SourceFile,
        node: Node<'_>,
        _config: &CopConfig,
        diagnostics: &mut Vec<Diagnostic>,
        _corrections: Option<&mut Vec<crate::correction::Correction>>,
    ) {
        let Some(stmts) = body_to_check(source, node) else {
            return;
        };
        if description_method_in(source, &stmts) {
            return;
        }
        let (line, col) = source.offset_to_line_col(
            node.child_by_field_name("name").unwrap_or(node).start_byte(),
        );
        diagnostics.push(self.diagnostic(
            source,
            line,
            col,
            "Missing type description".into(),
        ));
    }
}

fn body_to_check<'a>(source: &SourceFile, node: Node<'a>) -> Option<Vec<Node<'a>>> {
    if node.kind() == "module" {
        let kids = module_body_stmts(node);
        kids.iter().any(|n| is_include_call(source, *n)).then_some(kids)
    } else {
        Some(class_body_stmts(node))
    }
}

fn is_include_call(source: &SourceFile, node: Node<'_>) -> bool {
    call_method_name(source, node) == Some(b"include") && !argument_nodes(node).is_empty()
}