Class: RuboCop::Cop::FormulaAudit::ShellVariables 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 environment variables are passed correctly to popen_* calls.

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.



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
# File 'brew/Library/Homebrew/rubocops/lines.rb', line 252

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  popen_commands = [
    :popen,
    :popen_read,
    :safe_popen_read,
    :popen_write,
    :safe_popen_write,
  ]

  popen_commands.each do |command|
    find_instance_method_call(body_node, "Utils", command) do |method|
      next unless match = regex_match_group(parameters(method).first, /^([^"' ]+)=([^"' ]+)(?: (.*))?$/)

      good_args = "Utils.#{command}({ \"#{match[1]}\" => \"#{match[2]}\" }, \"#{match[3]}\")"

      problem "Use `#{good_args}` instead of `#{method.source}`"
    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.



272
273
274
275
276
277
# File 'brew/Library/Homebrew/rubocops/lines.rb', line 272

def autocorrect(node)
  lambda do |corrector|
    match = regex_match_group(node, /^([^"' ]+)=([^"' ]+)(?: (.*))?$/)
    corrector.replace(node.source_range, "{ \"#{match[1]}\" => \"#{match[2]}\" }, \"#{match[3]}\"")
  end
end