Class: RuboCop::Cop::FormulaAudit::Text Private
- Inherits:
-
RuboCop::Cop::FormulaCop
- Object
- RuboCop::Cop
- RuboCop::Cop::FormulaCop
- RuboCop::Cop::FormulaAudit::Text
- Defined in:
- Library/Homebrew/rubocops/text.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 checks for various problems in a formula's source code.
Instance Attribute Summary
Attributes inherited from RuboCop::Cop::FormulaCop
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 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'Library/Homebrew/rubocops/text.rb', line 13 def audit_formula(node, _class_node, _parent_class_node, body_node) @full_source_content = source_buffer(node).source if match = @full_source_content.match(/^require ['"]formula['"]$/) @offensive_node = node @source_buf = source_buffer(node) @line_no = match.pre_match.count("\n") + 1 @column = 0 @length = match[0].length @offense_source_range = source_range(@source_buf, @line_no, @column, @length) problem "`#{match}` is now unnecessary" end 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?("[email protected]")) && depends_on?("libressl") problem "Formulae should not depend on both OpenSSL and LibreSSL (even optionally)." end if formula_tap == "homebrew-core" && (depends_on?("veclibfort") || depends_on?("lapack")) problem "Formulae in homebrew/core should use OpenBLAS as the default serial linear algebra library." 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/) next if @formula_name == "goose" # needed in 2.3.0 problem "use \"dep\", \"ensure\", \"-vendor-only\"" end find_method_with_args(body_node, :system, "cargo", "build") do problem "use \"cargo\", \"install\", *std_cargo_args" end find_every_method_call_by_name(body_node, :system).each do |m| next unless parameters_passed?(m, /make && make/) offending_node(m) problem "Use separate `make` calls" end body_node.each_descendant(:dstr) do |dstr_node| dstr_node.each_descendant(:begin) do |interpolation_node| next unless interpolation_node.source.match?(/#\{\w+\s*\+\s*['"][^}]+\}/) offending_node(interpolation_node) problem "Do not concatenate paths in string interpolation" end end find_strings(body_node).each do |n| next unless regex_match_group(n, /JAVA_HOME/i) next if @formula_name.match?(/^openjdk(@|$)/) next if find_every_method_call_by_name(body_node, :depends_on).any? do |dependency| dependency.each_descendant(:str).count.zero? || regex_match_group(dependency.each_descendant(:str).first, /^openjdk(@|$)/) || depends_on?(:java) end offending_node(n) problem "Use `depends_on :java` to set JAVA_HOME" end prefix_path(body_node) do |prefix_node, path| next unless match = path.match(%r{^(bin|include|libexec|lib|sbin|share|Frameworks)(?:/| |$)}) offending_node(prefix_node) problem "Use `#{match[1].downcase}` instead of `prefix + \"#{match[1]}\"`" end end |