Class: RuboCop::Cop::FormulaAudit::LivecheckSkip Private

Inherits:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::LivecheckSkip

Extended by:: AutoCorrector

Defined in:: rubocops/livecheck.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 ensures that no other livecheck information is provided for skipped formulae.

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/livecheck.rb', line 15

def audit_formula(formula_nodes)
  livecheck_node = find_block(formula_nodes.body_node, :livecheck)
  return if livecheck_node.blank?

  skip = T.let(find_every_method_call_by_name(livecheck_node, :skip).first,
               T.nilable(T.any(RuboCop::AST::Node, String)))
  return if skip.blank?

  return if find_every_method_call_by_name(livecheck_node).length < 3

  offending_node(livecheck_node)
  problem "Skipped formulae must not contain other livecheck information." do |corrector|
    skip = find_every_method_call_by_name(livecheck_node, :skip).fetch(0)
    skip = find_strings(skip).fetch(0)
    skip = string_content(skip) if skip.present?
    corrector.replace(
      livecheck_node.source_range,
      <<~EOS.strip,
        livecheck do
            skip#{" \"#{skip}\"" if skip.present?}          end
      EOS
    )
  end
end

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