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

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/keg_only.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 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, #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:



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
43
44
45
46
47
48
 
# File 'rubocops/keg_only.rb', line 14

def audit_formula(formula_nodes)
  keg_only_node = find_node_method_by_name(formula_nodes.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 /\A[A-Z]/.match?(reason) && !reason.start_with?(*allowlist)
    problem "'#{first_word}' from the `keg_only` reason should be '#{first_word.downcase}'." do |corrector|
      reason[0] = reason[0].downcase
      corrector.replace(@offensive_node.source_range, "\"#{reason}\"")
    end
  end

  return unless reason.end_with?(".")

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

#autocorrect(node) ⇒ Object

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. 



50
51
52
53
54
55
56
57
 
# File 'rubocops/keg_only.rb', line 50

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