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

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
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 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, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #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.



507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
# File 'rubocops/lines.rb', line 507

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  install = find_method_def(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? }
    unless 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