Class: RuboCop::Cop::FormulaAudit::BottleDigestIndentation 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 indentation of the sha256 digests in thebottle block in formulae.

Constant Summary

Constants included from Kernel

Kernel::IGNORE_INTERRUPTS_MUTEX

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(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:



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'rubocops/bottle.rb', line 95

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

  sha256_nodes = find_method_calls_by_name(bottle_node.body, :sha256)

  max_digest_column = 0
  sha256_nodes.each do |sha256_node|
    sha256_hash = sha256_node.last_argument
    digest_column = T.let(sha256_hash.pairs.last.value.source_range.column, Integer)

    max_digest_column = digest_column if digest_column > max_digest_column
  end
  # This must be in a separate loop to make sure max_digest_column is truly the maximum
  sha256_nodes.each do |sha256_node| # rubocop:disable Style/CombinableLoops
    sha256_hash = sha256_node.last_argument
    hash = sha256_hash.pairs.last.value
    digest_column = hash.source_range.column

    next if digest_column == max_digest_column

    offending_node(hash)
    problem "Align bottle digests" do |corrector|
      new_line = (" " * (max_digest_column - digest_column)) + hash.source
      corrector.replace(hash.source_range, new_line)
    end
  end
end