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

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
Library/Homebrew/rubocops/class.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 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

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.


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 'Library/Homebrew/rubocops/class.rb', line 37

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  test = find_block(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}"
    end

    if node == :shell_output && node_equals?(p2, 0)
      offending_node(p2)
      problem "Passing 0 to shell_output() is redundant"
    end
  end
end

#autocorrect(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.


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'Library/Homebrew/rubocops/class.rb', line 62

def autocorrect(node)
  lambda do |corrector|
    case node.type
    when :str, :dstr
      # Rubocop: intentionally outputted non-interpolated strings
      corrector.replace(node.source_range,
                        node.source.to_s.sub(%r{(/usr/local/(s?bin))},
                                             '#{\2}')) # rubocop:disable Lint/InterpolationCheck
    when :int
      corrector.remove(
        range_with_surrounding_comma(
          range_with_surrounding_space(range: node.source_range,
                                       side:  :left),
        ),
      )
    end
  end
end