Class: RuboCop::Cop::FormulaAudit::KegOnly Private

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

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This cop makes sure that a keg_only reason has the correct format.

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



13
14
15
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
# File 'brew/Library/Homebrew/rubocops/keg_only.rb', line 13

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  keg_only_node = find_node_method_by_name(body_node, :keg_only)
  return unless keg_only_node

  allowlist = %w[
    Apple
    macOS
    OS
    Homebrew
    Xcode
    GPG
    GNOME
    BSD
    Firefox
  ].freeze

  reason = parameters(keg_only_node).first
  offending_node(reason)
  name = Regexp.new(@formula_name, Regexp::IGNORECASE)
  reason = string_content(reason).sub(name, "")
  first_word = reason.split.first

  if reason =~ /\A[A-Z]/ && !reason.start_with?(*allowlist)
    problem "'#{first_word}' from the `keg_only` reason should be '#{first_word.downcase}'."
  end

  return unless reason.end_with?(".")

  problem "`keg_only` reason should not end with a period."
end

#autocorrect(node) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



44
45
46
47
48
49
50
51
# File 'brew/Library/Homebrew/rubocops/keg_only.rb', line 44

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