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

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

Overview

This cop audits versioned Formulae for conflicts_with.

Constant Summary collapse

MSG =
"Versioned formulae should not use `conflicts_with`. " \
"Use `keg_only :versioned_formula` instead."
ALLOWLIST =
%w[
  [email protected]
].freeze

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, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #size, #versioned_formula?

Methods included from HelperFunctions

#line_number, #line_start_column, #problem, #regex_match_group, #source_buffer, #start_column, #string_content

Instance Method Details

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


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'Library/Homebrew/rubocops/conflicts.rb', line 18

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  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(@formula_name, Regexp::IGNORECASE)
    reason = string_content(reason).sub(name, "")
    first_word = reason.split.first

    if reason.match?(/\A[A-Z]/)
      problem "'#{first_word}' from the `conflicts_with` reason should be '#{first_word.downcase}'."
    end

    problem "`conflicts_with` reason should not end with a period." if reason.end_with?(".")
  end

  return unless versioned_formula?

  problem MSG if !ALLOWLIST.include?(@formula_name) &&
                 method_called_ever?(body_node, :conflicts_with)
end

#autocorrect(node) ⇒ Object


41
42
43
44
45
46
47
48
49
50
51
52
# File 'Library/Homebrew/rubocops/conflicts.rb', line 41

def autocorrect(node)
  lambda do |corrector|
    if versioned_formula?
      corrector.replace(node.source_range, "keg_only :versioned_formula")
    else
      reason = string_content(node)
      reason[0] = reason[0].downcase
      reason = reason.delete_suffix(".")
      corrector.replace(node.source_range, "\"#{reason}\"")
    end
  end
end