Class: RuboCop::Cop::FormulaAudit::GenerateCompletionsDSL 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.

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.



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
# File 'rubocops/lines.rb', line 424

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  install = find_method_def(body_node, :install)
  return if install.blank?

  correctable_shell_completion_node(install) do |node, shell, base_name, executable, subcmd, shell_parameter| # rubocop:disable Metrics/ParameterLists
    # generate_completions_from_executable only applicable if shell is passed
    next unless shell_parameter.match?(/(bash|zsh|fish)/)

    base_name = base_name.delete_prefix("_").delete_suffix(".fish")
    shell = shell.to_s.delete_suffix("_completion").to_sym
    shell_parameter_stripped = shell_parameter
                               .delete_suffix("bash")
                               .delete_suffix("zsh")
                               .delete_suffix("fish")
    shell_parameter_format = if shell_parameter_stripped.empty?
      nil
    elsif shell_parameter_stripped == "--"
      :flag
    elsif shell_parameter_stripped == "--shell="
      :arg
    else
      shell_parameter_stripped
    end

    replacement_args = %w[]
    replacement_args << executable.source
    replacement_args << subcmd.source
    replacement_args << "base_name: \"#{base_name}\"" unless base_name == @formula_name
    replacement_args << "shells: [:#{shell}]"
    unless shell_parameter_format.nil?
      replacement_args << "shell_parameter_format: #{shell_parameter_format.inspect}"
    end

    offending_node(node)
    replacement = "generate_completions_from_executable(#{replacement_args.join(", ")})"

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

  shell_completion_node(install) do |node|
    next if node.source.include?("<<~") # skip heredoc completion scripts
    next if node.source.match?(/{.*=>.*}/) # skip commands needing custom ENV variables

    offending_node(node)
    problem "Use `generate_completions_from_executable` DSL instead of `#{@offensive_node.source}`."
  end
end