Class: RuboCop::Cop::FormulaAuditStrict::ShellCommands Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
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 shell command arguments are separated.

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.


689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'Library/Homebrew/rubocops/lines.rb', line 689

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  # Match shell commands separated by spaces in the same string
  shell_cmd_with_spaces_regex = /[^"' ]*(?:\s[^"' ]*)+/

  popen_commands = [
    :popen_read,
    :safe_popen_read,
    :popen_write,
    :safe_popen_write,
  ]

  shell_metacharacters = %w[> < < | ; : & * $ ? : ~ + @ !` ( ) [ ]]

  find_every_method_call_by_name(body_node, :system).each do |method|
    # Only separate when no shell metacharacters are present
    next if shell_metacharacters.any? { |meta| string_content(parameters(method).first).include?(meta) }

    next unless match = regex_match_group(parameters(method).first, shell_cmd_with_spaces_regex)

    good_args = match[0].gsub(" ", "\", \"")
    offending_node(parameters(method).first)
    problem "Separate `system` commands into `\"#{good_args}\"`"
  end

  popen_commands.each do |command|
    find_instance_method_call(body_node, "Utils", command) do |method|
      index = parameters(method).first.hash_type? ? 1 : 0

      # Only separate when no shell metacharacters are present
      next if shell_metacharacters.any? { |meta| string_content(parameters(method)[index]).include?(meta) }

      next unless match = regex_match_group(parameters(method)[index], shell_cmd_with_spaces_regex)

      good_args = match[0].gsub(" ", "\", \"")
      offending_node(parameters(method)[index])
      problem "Separate `Utils.#{command}` commands into `\"#{good_args}\"`"
    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.


729
730
731
732
733
734
# File 'Library/Homebrew/rubocops/lines.rb', line 729

def autocorrect(node)
  lambda do |corrector|
    good_args = node.source.gsub(" ", "\", \"")
    corrector.replace(node.source_range, good_args)
  end
end