Class: RuboCop::Cop::FormulaAudit::Desc

Inherits:
RuboCop::Cop::FormulaCop show all
Includes:
DescHelper
Defined in:
Library/Homebrew/rubocops/formula_desc.rb

Overview

This cop audits desc in formulae. See the DescHelper module for details of the checks.

Constant Summary

Constants included from DescHelper

DescHelper::MAX_DESC_LENGTH, DescHelper::VALID_LOWERCASE_WORDS

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods included from DescHelper

#audit_desc, #autocorrect_desc

Methods included from HelperFunctions

#line_number, #line_start_column, #problem, #regex_match_group, #source_buffer, #start_column, #string_content

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #block_size, #caveats_strings, #check_precedence, #class_name, #component_precedes?, #depends_on?, #depends_on_name_type?, #end_column, #expression_negated?, #find_all_blocks, #find_block, #find_blocks, #find_const, #find_every_func_call_by_name, #find_every_method_call_by_name, #find_instance_call, #find_instance_method_call, #find_method_calls_by_name, #find_method_def, #find_method_with_args, #find_node_method_by_name, #find_strings, #format_component, #formula_tap, #get_checksum_node, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #size, #versioned_formula?

Instance Method Details

#audit_formula(_node, _class_node, _parent_class_node, body_node) ⇒ Object


16
17
18
19
# File 'Library/Homebrew/rubocops/formula_desc.rb', line 16

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  desc_call = find_node_method_by_name(body_node, :desc)
  audit_desc(:formula, @formula_name, desc_call)
end

#autocorrect(node) ⇒ Object


21
22
23
# File 'Library/Homebrew/rubocops/formula_desc.rb', line 21

def autocorrect(node)
  autocorrect_desc(node, @formula_name)
end