Class: RuboCop::Cop::FormulaAudit::Patches Private

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::Patches

Extended by:: AutoCorrector

Defined in:: rubocops/patches.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/patches.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 audits patches in formulae.

Constant Summary collapse

PATCH_TYPES =

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.

Keep in sync with Patch::TYPES in Library/Homebrew/patch.rb.

T.let([:unofficial, :backport, :cherry_pick].freeze, T::Array[Symbol])

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

#audit_formula(formula_nodes) ⇒ void private
#patch_data?(node, *pattern, **kwargs, &block) ⇒ Boolean 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/patches.rb', line 17

def audit_formula(formula_nodes)
  node = formula_nodes.node
  @full_source_content = T.let(source_buffer(node).source, T.nilable(String))

  return if (body_node = formula_nodes.body_node).nil?

  external_patches = find_all_blocks(body_node, :patch)
  external_patches.each do |patch_block|
    find_every_method_call_by_name(patch_block, :url).each do |url_node|
      url_string = parameters(url_node).fetch(0)
      sha256_node = find_every_method_call_by_name(patch_block, :sha256).first
      sha256_string = parameters(sha256_node).first if sha256_node
      patch_problems(url_string, sha256_string)
    end
    find_every_method_call_by_name(patch_block, :resolves).each do |resolves_node|
      parameters(resolves_node).each { |arg| resolves_problems(arg) }
    end
    find_every_method_call_by_name(patch_block, :type).each do |type_node|
      parameters(type_node).each { |arg| type_problems(arg) }
    end
  end

  inline_patches = find_every_method_call_by_name(body_node, :patch)
  inline_patches.each { |patch| inline_patch_problems(patch) }

  if inline_patches.empty? && patch_end?
    offending_patch_end_node(node)
    add_offense(@offense_source_range, message: "Patch is missing `patch :DATA`")
  end

  patches_node = find_method_def(body_node, :patches)
  return if patches_node.nil?

  legacy_patches = find_strings(patches_node)
  problem "Use the `patch` DSL instead of defining a `patches` method"
  legacy_patches.each { |p| patch_problems(p, nil) }
end

#patch_data?(node, *pattern, **kwargs, &block) ⇒ `Boolean`