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

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

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 ensures that caveats don't have problematic text or logic.

Example

# bad
def caveats
  if File.exist?("/etc/issue")
    "This caveat only when file exists that won't work with JSON API."
  end
end

# good
def caveats
  "This caveat always works regardless of the JSON API."
end

# bad
def caveats
  <<~EOS
    Use `setuid` to allow running the executable 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, #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?

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

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:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'rubocops/caveats.rb', line 42

def audit_formula(_formula_nodes)
  caveats_strings.each do |n|
    if regex_match_group(n, /\bsetuid\b/i)
      problem "Instead of recommending `setuid` in the caveats, suggest `sudo`."
    end

    problem "Don't use ANSI escape codes in the caveats." if regex_match_group(n, /\e/)
  end

  return if formula_tap != "homebrew-core"

  # Forbid dynamic logic in caveats (only if/else/unless)
  caveats_method = find_method_def(@body, :caveats)
  return unless caveats_method

  dynamic_nodes = caveats_method.each_descendant.select do |descendant|
    descendant.type == :if
  end
  dynamic_nodes.each do |node|
    @offensive_node = node
    problem "Don't use dynamic logic (if/else/unless) in caveats."
  end
end