Class: RuboCop::Cop::FormulaAudit::Test Private

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Test

Extended by:: AutoCorrector

Defined in:: rubocops/class.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/test.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 makes sure that a test block contains a proper test.

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

#audit_formula(formula_nodes) ⇒ void private
#test_calls(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?, #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, #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/class.rb', line 37

def audit_formula(formula_nodes)
  test = find_block(formula_nodes.body_node, :test)
  return unless test

  if test.body.nil?
    problem "`test do` should not be empty"
    return
  end

  problem "`test do` should contain a real test" if test.body.single_line? && test.body.source.to_s == "true"

  test_calls(test) do |node, params|
    p1, p2 = params
    if (match = string_content(p1).match(%r{(/usr/local/(s?bin))}))
      offending_node(p1)
      problem "Use `\#{#{match[2]}}` instead of `#{match[1]}` in `#{node}`" do |corrector|
        corrector.replace(p1.source_range, p1.source.sub(match[1], "\#{#{match[2]}}"))
      end
    end

    if node == :shell_output && node_equals?(p2, 0)
      offending_node(p2)
      problem "Passing 0 to `shell_output` is redundant" do |corrector|
        corrector.remove(range_with_surrounding_comma(range_with_surrounding_space(range: p2.source_range,
                                                                                   side:  :left)))
      end
    end
  end
end

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