Class: RuboCop::Cop::FormulaAudit::CMakeArgs Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/cmake_args.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 checks for a positional CMake source directory, which implicitly builds in the working directory.

Constant Summary collapse

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. 

"Use explicit `-S` and `-B` arguments for CMake."

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?, #check_precedence, #class_name, #component_precedes?, descendant_send_nodes, descendant_send_nodes_by_method_name, #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, #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:



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
47
 
# File 'rubocops/cmake_args.rb', line 17

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

  find_every_method_call_by_name(body_node, :system).each do |method|
    next if method.receiver

    args = parameters(method)
    command, source_dir = args
    next unless node_equals?(command, "cmake")
    # A leading argument that isn't an option is a positional source directory,
    # which implicitly builds in the working directory.
    next unless source_dir.is_a?(RuboCop::AST::StrNode)
    next if source_dir.value.start_with?("-")

    # `-S` and `-B` can be joined to their values, e.g. `-Bbuild`.
    options = args.filter_map { |arg| arg.value if arg.is_a?(RuboCop::AST::StrNode) }
    next if options.any? { |option| option.start_with?("-S") }

    # Only add a build directory when the call doesn't already give one.
    replacement = if options.any? { |option| option.start_with?("-B") }
      %Q("-S", #{source_dir.source})
    else
      %Q("-S", #{source_dir.source}, "-B", ".")
    end

    offending_node(source_dir)
    problem MSG do |corrector|
      corrector.replace(source_dir.source_range, replacement)
    end
  end
end