Class: RuboCop::Cop::FormulaAudit::Conflicts Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/conflicts.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 versioned formulae for conflicts_with.

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. 

"Versioned formulae should not use `conflicts_with`. " \
"Use `keg_only :versioned_formula` instead."

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:



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
48
49
50
51
 
# File 'rubocops/conflicts.rb', line 17

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

  find_method_calls_by_name(body_node, :conflicts_with).each do |conflicts_with_call|
    next unless parameters(conflicts_with_call).last.respond_to? :values

    reason = parameters(conflicts_with_call).last.values.first
    offending_node(reason)
    name = Regexp.new(T.must(@formula_name), Regexp::IGNORECASE)
    reason_text = string_content(reason).sub(name, "")
    first_word = reason_text.split.first

    if reason_text.match?(/\A[A-Z]/)
      problem "'#{first_word}' from the `conflicts_with` reason " \
              "should be '#{first_word.downcase}'." do |corrector|
        reason_text[0] = reason_text[0].downcase
        corrector.replace(reason.source_range, "\"#{reason_text}\"")
      end
    end
    next unless reason_text.end_with?(".")

    problem "`conflicts_with` reason should not end with a period." do |corrector|
      corrector.replace(reason.source_range, "\"#{reason_text.chop}\"")
    end
  end

  return unless versioned_formula?

  if !tap_style_exception?(:versioned_formulae_conflicts_allowlist) && method_called_ever?(body_node,
                                                                                           :conflicts_with)
    problem MSG do |corrector|
      corrector.replace(T.must(@offensive_node).source_range, "keg_only :versioned_formula")
    end
  end
end