Class: RuboCop::Cop::FormulaAudit::Service Private

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Service

Extended by:: AutoCorrector

Defined in:: rubocops/service.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 audits the service block.

Constant Summary collapse

CELLAR_PATH_AUDIT_CORRECTIONS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

T.let(
  {
    bin:      :opt_bin,
    libexec:  :opt_libexec,
    pkgshare: :opt_pkgshare,
    prefix:   :opt_prefix,
    sbin:     :opt_sbin,
    share:    :opt_share,
  }.freeze,
  T::Hash[Symbol, Symbol],
)

REQUIRED_METHOD_CALLS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

At least one of these methods must be defined in a service block.

[:run, :name].freeze

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

#audit_formula(formula_nodes) ⇒ void private

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?, #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, #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:

formula_nodes (FormulaNodes)

# File 'rubocops/service.rb', line 29

def audit_formula(formula_nodes)
  service_node = find_block(formula_nodes.body_node, :service)
  return if service_node.blank?

  method_calls = service_node.each_descendant(:send).group_by(&:method_name)
  method_calls.delete(:service)

  # NOTE: Solving the first problem here might solve the second one too
  #       so we don't show both of them at the same time.
  if !method_calls.keys.intersect?(REQUIRED_METHOD_CALLS)
    offending_node(service_node)
    problem "Service blocks require `run` or `name` to be defined."
  elsif !method_calls.key?(:run)
    other_method_calls = method_calls.keys - [:name, :require_root]
    if other_method_calls.any?
      offending_node(service_node)
      problem "`run` must be defined to use methods other than `name` like #{other_method_calls}."
    end
  end

  # This check ensures that Cellar paths like `bin` are not referenced
  # because their `opt_` variants are more portable and work with the API.
  CELLAR_PATH_AUDIT_CORRECTIONS.each do |path, opt_path|
    next unless method_calls.key?(path)

    method_calls.fetch(path).each do |node|
      offending_node(node)
      problem "Use `#{opt_path}` instead of `#{path}` in service blocks." do |corrector|
        corrector.replace(node.source_range, opt_path)
      end
    end
  end
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/RuboCop/Cop/FormulaAudit/Service.html