Class: RuboCop::Cop::FormulaAudit::Caveats Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
Library/Homebrew/rubocops/caveats.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This cop makes sure that caveats don't recommend unsupported or unsafe operations.

Examples:

# bad
def caveats
  <<~EOS
    Use `setuid` to allow running the exeutable by non-root users.
  EOS
end

# good
def caveats
  <<~EOS
    Use `sudo` to run the executable.
  EOS
end

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

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?

Methods included from HelperFunctions

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

Instance Method Details

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


27
28
29
30
31
32
33
# File 'Library/Homebrew/rubocops/caveats.rb', line 27

def audit_formula(_node, _class_node, _parent_class_node, _body_node)
  caveats_strings.each do |n|
    next unless regex_match_group(n, /\bsetuid\b/i)

    problem "Don't recommend setuid in the caveats, suggest sudo instead."
  end
end