Class: RuboCop::Cop::FormulaAudit::SafePopenCommands Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
brew/Library/Homebrew/rubocops/lines.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 the safe versions of popen_* calls 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, #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.



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'brew/Library/Homebrew/rubocops/lines.rb', line 221

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  test = find_block(body_node, :test)

  [:popen_read, :popen_write].each do |unsafe_command|
    test_methods = []

    unless test.nil?
      find_instance_method_call(test, "Utils", unsafe_command) do |method|
        test_methods << method.source_range
      end
    end

    find_instance_method_call(body_node, "Utils", unsafe_command) do |method|
      unless test_methods.include?(method.source_range)
        problem "Use `Utils.safe_#{unsafe_command}` instead of `Utils.#{unsafe_command}`"
      end
    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.



241
242
243
244
245
# File 'brew/Library/Homebrew/rubocops/lines.rb', line 241

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.loc.selector, "safe_#{node.method_name}")
  end
end