Class: RuboCop::Cop::FormulaAudit::NoAutobump Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Includes:
NoAutobumpHelper
Defined in:
rubocops/no_autobump.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/no_autobump.rbi

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This cop audits no_autobump! reason. See the NoAutobumpHelper module for details of the checks.

Constant Summary

Constants included from NoAutobumpHelper

NoAutobumpHelper::DISALLOWED_NO_AUTOBUMP_REASONS, NoAutobumpHelper::PUNCTUATION_MARKS

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods included from NoAutobumpHelper

#audit_no_autobump

Methods included from HelperFunctions

#block_method_called_in_block?, #block_size, #check_precedence, #class_name, #component_precedes?, #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, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_name, #node_equals?, #offending_node, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #caveats_strings, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #style_exceptions_dir, #tap_style_exception?, #versioned_formula?

Instance Method Details

#audit_formula(formula_nodes) ⇒ void

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

This method returns an undefined value.

Parameters:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'rubocops/no_autobump.rb', line 17

def audit_formula(formula_nodes)
  body_node = formula_nodes.body_node
  no_autobump_call = find_node_method_by_name(body_node, :no_autobump!)

  return if no_autobump_call.nil?

  reason_found = T.let(false, T::Boolean)
  reason(no_autobump_call) do |reason_node|
    reason_found = true
    offending_node(reason_node)
    audit_no_autobump(:formula, reason_node)
  end

  return if reason_found

  problem 'Add a reason for exclusion from autobump: `no_autobump! because: "..."`'
end

#reason(node, *pattern, **kwargs, &block) ⇒ T.untyped

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

Returns:

  • (T.untyped)


17
# File 'sorbet/rbi/dsl/rubo_cop/cop/formula_audit/no_autobump.rbi', line 17

def reason(node, *pattern, **kwargs, &block); end