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

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Text

show all

Extended by:: AutoCorrector

Defined in:: rubocops/text.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/text.rbi

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 checks for various problems in a formula's source code.

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

#audit_formula(formula_nodes) ⇒ void private
#prefix_path(node, *pattern, **kwargs, &block) ⇒ T.untyped private

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:

formula_nodes (FormulaNodes)

# File 'rubocops/text.rb', line 14

def audit_formula(formula_nodes)
  node = formula_nodes.node
  full_source_content = source_buffer(node).source

  if (match = full_source_content.match(/^require ['"]formula['"]$/))
    range = source_range(source_buffer(node), match.pre_match.count("\n") + 1, 0, match[0].length)
    add_offense(range, message: "`#{match}` is now unnecessary") do |corrector|
      corrector.remove(range_with_surrounding_space(range:))
    end
  end

  return if (body_node = formula_nodes.body_node).nil?

  if find_method_def(body_node, :plist)
    problem "`def plist` is deprecated. Please use services instead: https://docs.brew.sh/Formula-Cookbook#service-files"
  end

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

  if formula_tap == "homebrew-core"
    if depends_on?("veclibfort") || depends_on?("lapack")
      problem "Formulae in homebrew/core should use OpenBLAS as the default serial linear algebra library."
    end

    if find_node_method_by_name(body_node, :keg_only)&.source&.include?("HOMEBREW_PREFIX")
      problem "`keg_only` reason should not include `HOMEBREW_PREFIX` " \
              "as it creates confusing `brew info` output."
    end
  end

  # 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 no longer necessary or correct"
  end

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

  find_method_with_args(body_node, :revision, 0) do
    problem "\"revision 0\" is unnecessary"
  end

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

  if !depends_on?(:xcode) && method_called_ever?(body_node, :xcodebuild)
    problem "`xcodebuild` needs an Xcode dependency"
  end

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

    find_method_with_args(method_node, :system, "cargo", "build") do |m|
      next if parameters_passed?(m, [/--lib/])

      problem "use \"cargo\", \"install\", *std_cargo_args"
    end
  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_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

  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

#prefix_path(node, *pattern, **kwargs, &block) ⇒ `T.untyped`