Class: RuboCop::Cop::FormulaAudit::BottleFormat Private

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Defined in:
rubocops/bottle.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 bottle block in formulae.

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. 



13
14
15
16
17
18
19
20
21
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
 
# File 'rubocops/bottle.rb', line 13

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  bottle_node = find_block(body_node, :bottle)
  return if bottle_node.nil?

  sha256_nodes = find_method_calls_by_name(bottle_node.body, :sha256)
  cellar_node = find_node_method_by_name(bottle_node.body, :cellar)
  cellar_source = cellar_node&.first_argument&.source

  if sha256_nodes.present? && cellar_node.present?
    offending_node(cellar_node)
    problem "`cellar` should be a parameter to `sha256`" do |corrector|
      corrector.remove(range_by_whole_lines(cellar_node.source_range, include_final_newline: true))
    end
  end

  sha256_nodes.each do |sha256_node|
    sha256_hash = sha256_node.last_argument
    sha256_pairs = sha256_hash.pairs
    next if sha256_pairs.count != 1

    sha256_pair = sha256_pairs.first
    sha256_key = sha256_pair.key
    sha256_value = sha256_pair.value
    next unless sha256_value.sym_type?

    tag = sha256_value.value
    digest_source = sha256_key.source
    sha256_line = if cellar_source.present?
      "sha256 cellar: #{cellar_source}, #{tag}: #{digest_source}"
    else
      "sha256 #{tag}: #{digest_source}"
    end

    offending_node(sha256_node)
    problem "`sha256` should use new syntax" do |corrector|
      corrector.replace(sha256_node.source_range, sha256_line)
    end
  end
end