Class: RuboCop::Cop::FormulaAudit::AssertStatements Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/lines.rb

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 idiomatic assert_* statements are used.

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, #caveats_strings, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #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(_node, _class_node, _parent_class_node, body_node) ⇒ Object

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. 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'rubocops/lines.rb', line 93

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  return if body_node.nil?

  find_every_method_call_by_name(body_node, :assert).each do |method|
    if method_called_ever?(method, :include?) && !method_called_ever?(method, :!)
      problem "Use `assert_match` instead of `assert ...include?`"
    end

    if method_called_ever?(method, :exist?) && !method_called_ever?(method, :!)
      problem "Use `assert_predicate <path_to_file>, :exist?` instead of `#{method.source}`"
    end

    if method_called_ever?(method, :exist?) && method_called_ever?(method, :!)
      problem "Use `refute_predicate <path_to_file>, :exist?` instead of `#{method.source}`"
    end

    if method_called_ever?(method, :executable?) && !method_called_ever?(method, :!)
      problem "Use `assert_predicate <path_to_file>, :executable?` instead of `#{method.source}`"
    end
  end
end