Class: RuboCop::Cop::FormulaAudit::Options

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

Overview

This cop audits options in Formulae.

Constant Summary collapse

DEPRECATION_MSG =
"macOS has been 64-bit only since 10.6 so 32-bit options are deprecated."
UNI_DEPRECATION_MSG =
"macOS has been 64-bit only since 10.6 so universal options are deprecated."
DEP_OPTION =
"Formulae should not use `deprecated_option`"
OPTION =
"Formulae should not have an `option`"

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, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content, #versioned_formula?

Instance Method Details

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



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
# File 'brew/Library/Homebrew/rubocops/options.rb', line 16

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  option_call_nodes = find_every_method_call_by_name(body_node, :option)
  option_call_nodes.each do |option_call|
    option = parameters(option_call).first
    problem DEPRECATION_MSG if regex_match_group(option, /32-bit/)
  end

  option_call_nodes.each do |option_call|
    offending_node(option_call)
    option = string_content(parameters(option_call).first)
    problem UNI_DEPRECATION_MSG if option == "universal"

    if option !~ /with(out)?-/ &&
       option != "cxx11" &&
       option != "universal"
      problem "Options should begin with with/without."\
              " Migrate '--#{option}' with `deprecated_option`."
    end

    next unless option =~ /^with(out)?-(?:checks?|tests)$/
    next if depends_on?("check", :optional, :recommended)

    problem "Use '--with#{Regexp.last_match(1)}-test' instead of '--#{option}'."\
            " Migrate '--#{option}' with `deprecated_option`."
  end

  return unless formula_tap == "homebrew-core"

  problem DEP_OPTION if method_called_ever?(body_node, :deprecated_option)
  problem OPTION if method_called_ever?(body_node, :option)
end