Class: RuboCop::Cop::FormulaAudit::Text

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

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, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content, #versioned_formula?

Instance Method Details

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



9
10
11
12
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'brew/Library/Homebrew/rubocops/text.rb', line 9

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  if !find_node_method_by_name(body_node, :plist_options) &&
     find_method_def(body_node, :plist)
    problem "Please set plist_options when using a formula-defined plist."
  end

  if depends_on?("openssl") && depends_on?("libressl")
    problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)."
  end

  if method_called_ever?(body_node, :virtualenv_create) ||
     method_called_ever?(body_node, :virtualenv_install_with_resources)
    find_method_with_args(body_node, :resource, "setuptools") do
      problem "Formulae using virtualenvs do not need a `setuptools` resource."
    end
  end

  unless method_called_ever?(body_node, :go_resource)
    # processed_source.ast is passed instead of body_node because `require` would be outside body_node
    find_method_with_args(processed_source.ast, :require, "language/go") do
      problem "require \"language/go\" is unnecessary unless using `go_resource`s"
    end
  end

  find_instance_method_call(body_node, "Formula", :factory) do
    problem "\"Formula.factory(name)\" is deprecated in favor of \"Formula[name]\""
  end

  find_every_method_call_by_name(body_node, :xcodebuild).each do |m|
    next if parameters_passed?(m, /SYMROOT=/)

    problem 'xcodebuild should be passed an explicit "SYMROOT"'
  end

  find_method_with_args(body_node, :system, "xcodebuild") do
    problem %q(use "xcodebuild *args" instead of "system 'xcodebuild', *args")
  end

  find_method_with_args(body_node, :system, "go", "get") do
    problem "Do not use `go get`. Please ask upstream to implement Go vendoring"
  end

  find_method_with_args(body_node, :system, "dep", "ensure") do |d|
    next if parameters_passed?(d, /vendor-only/)

    problem "use \"dep\", \"ensure\", \"-vendor-only\""
  end

  find_method_with_args(body_node, :system, "cargo", "build") do
    problem "use \"cargo\", \"install\", \"--root\", prefix, \"--path\", \".\""
  end
end