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

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/components_redundancy.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 checks if redundant components are present and for other component errors.

  • url|checksum|mirror|version 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
  • stable do should not be present with only url|checksum|mirror|version
  • head do should not be present with only url

Constant Summary collapse

HEAD_MSG =

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. 

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

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. 

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

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. 

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

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. 

[:url, :sha256, :mirror, :version].freeze

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

Methods included from Kernel

#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path

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. 



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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'rubocops/components_redundancy.rb', line 23

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  return if body_node.nil?

  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
    STABLE_BLOCK_METHODS.each do |method_name|
      problem "`#{method_name}` should be put inside `stable` block" if method_called?(body_node, method_name)
    end

    unless stable_block.body.nil?
      child_nodes = stable_block.body.begin_type? ? stable_block.body.child_nodes : [stable_block.body]
      if child_nodes.all? { |n| n.send_type? && STABLE_BLOCK_METHODS.include?(n.method_name) }
        problem "`stable do` should not be present with only #{STABLE_BLOCK_METHODS.join("/")}"
      end
    end
  end

  head_block = find_block(body_node, :head)
  if head_block && !head_block.body.nil?
    child_nodes = head_block.body.begin_type? ? head_block.body.child_nodes : [head_block.body]
    if child_nodes.all? { |n| n.send_type? && n.method_name == :url }
      problem "`head do` should not be present with only `url`"
    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