Class: RuboCop::Cop::FormulaAudit::ComponentsRedundancy Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
Library/Homebrew/rubocops/components_redundancy.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

This cop checks if redundant components are present and for other component errors.

  • url|checksum|mirror should be inside stable block
  • head and head do should not be simultaneously present
  • bottle :unneeded/:disable and bottle do should not be simultaneously present
  • stable do should not be present without a head spec

Constant Summary collapse

HEAD_MSG =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"`head` and `head do` should not be simultaneously present"
BOTTLE_MSG =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"`bottle :modifier` and `bottle do` should not be simultaneously present"
STABLE_MSG =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

"`stable do` should not be present without a `head` spec"

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, #block_size, #caveats_strings, #check_precedence, #class_name, #component_precedes?, #depends_on?, #depends_on_name_type?, #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, #formula_tap, #get_checksum_node, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #size, #versioned_formula?

Methods included from HelperFunctions

#line_number, #line_start_column, #problem, #regex_match_group, #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. You should avoid using this method if possible, as it may be removed or be changed in the future.


22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'Library/Homebrew/rubocops/components_redundancy.rb', line 22

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  urls = find_method_calls_by_name(body_node, :url)

  urls.each do |url|
    url.arguments.each do |arg|
      next if arg.class != RuboCop::AST::HashNode

      url_args = arg.keys.each.map(&:value)
      if method_called?(body_node, :sha256) && url_args.include?(:tag) && url_args.include?(:revision)
        problem "Do not use both sha256 and tag/revision."
      end
    end
  end

  stable_block = find_block(body_node, :stable)
  if stable_block
    [:url, :sha256, :mirror].each do |method_name|
      problem "`#{method_name}` should be put inside `stable` block" if method_called?(body_node, method_name)
    end
  end

  problem HEAD_MSG if method_called?(body_node, :head) &&
                      find_block(body_node, :head)

  problem BOTTLE_MSG if method_called?(body_node, :bottle) &&
                        find_block(body_node, :bottle)

  return if method_called?(body_node, :head) ||
            find_block(body_node, :head)

  problem STABLE_MSG if stable_block
end