Class: RuboCop::Cop::FormulaAudit::SingleGenerateCompletionsDSLCall Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/single_generate_completions_dsl_call.rbi

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 the generate_completions_from_executable DSL is used with only a single, combined call for all shells.

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, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #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(formula_nodes) ⇒ void

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.

This method returns an undefined value.

Parameters:



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'rubocops/lines.rb', line 578

def audit_formula(formula_nodes)
  install = find_method_def(formula_nodes.body_node, :install)
  return if install.blank?

  methods = find_every_method_call_by_name(install, :generate_completions_from_executable)
  return if methods.length <= 1

  offenses = []
  shells = []
  methods.each do |method|
    next unless method.source.include?("shells:")

    shells << method.source.match(/shells: \[(:bash|:zsh|:fish)\]/).captures.first
    offenses << method
  end

  return if offenses.blank?

  T.must(offenses[0...-1]).each_with_index do |node, i|
    # commands have to be the same to be combined
    # send_type? matches `bin/"foo"`, str_type? matches remaining command parts,
    # the rest are kwargs we need to filter out
    method_commands = node.arguments.filter { |arg| arg.send_type? || arg.str_type? }
    next_method_commands = offenses[i + 1].arguments.filter { |arg| arg.send_type? || arg.str_type? }
    if method_commands != next_method_commands
      shells.delete_at(i)
      next
    end

    offending_node(node)
    problem "Use a single `generate_completions_from_executable` " \
            "call combining all specified shells." do |corrector|
      # adjust range by -4 and +1 to also include & remove leading spaces and trailing \n
      corrector.replace(@offensive_node.source_range.adjust(begin_pos: -4, end_pos: 1), "")
    end
  end

  return if shells.length <= 1 # no shells to combine left

  offending_node(offenses.last)
  replacement = if (%w[:bash :zsh :fish] - shells).empty?
    @offensive_node.source.sub(/shells: \[(:bash|:zsh|:fish)\]/, "")
                   .sub(", )", ")") # clean up dangling trailing comma
                   .sub("(, ", "(") # clean up dangling leading comma
                   .sub(", , ", ", ") # clean up dangling enclosed comma
  else
    @offensive_node.source.sub(/shells: \[(:bash|:zsh|:fish)\]/,
                               "shells: [#{shells.join(", ")}]")
  end

  problem "Use `#{replacement}` instead of `#{@offensive_node.source}`." do |corrector|
    corrector.replace(@offensive_node.source_range, replacement)
  end
end