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

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/options.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 audits options in formulae.

Constant Summary collapse

DEPRECATION_MSG =

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

"macOS has been 64-bit only since 10.6 so 32-bit options are deprecated."
UNI_DEPRECATION_MSG =

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

"macOS has been 64-bit only since 10.6 so universal options are deprecated."
DEP_OPTION =

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

"Formulae in homebrew/core should not use `deprecated_option`."
OPTION =

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

"Formulae in homebrew/core should not use `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, #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:



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
47
48
 
# File 'rubocops/options.rb', line 18

def audit_formula(formula_nodes)
  return if (body_node = formula_nodes.body_node).nil?

  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/)

    offending_node(option_call)
    option = string_content(option)
    problem UNI_DEPRECATION_MSG if option == "universal"

    if !/with(out)?-/.match?(option) &&
       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 if 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