Class: RuboCop::Cop::FormulaAudit::Urls Private

Inherits:
RuboCop::Cop::FormulaCop show all
Includes:
UrlHelper
Defined in:
rubocops/urls.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/urls.rbi

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 urls and mirrors 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 included from UrlHelper

#audit_url, #audit_urls

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

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?

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:



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
 
# File 'rubocops/urls.rb', line 15

def audit_formula(formula_nodes)
  return if (body_node = formula_nodes.body_node).nil?

  urls = find_every_func_call_by_name(body_node, :url)
  mirrors = find_every_func_call_by_name(body_node, :mirror)

  # Identify livecheck URLs, to skip some checks for them
  livecheck_url = if (livecheck = find_every_func_call_by_name(body_node, :livecheck).first) &&
                     (livecheck_url = find_every_func_call_by_name(livecheck.parent, :url).first)
    string_content(parameters(livecheck_url).first)
  end

  audit_url(:formula, urls, mirrors, livecheck_url:)

  return if formula_tap != "homebrew-core"

  # Check for binary URLs
  audit_urls(urls, /(darwin|macos|osx)/i) do |match, url|
    next if @formula_name.include?(match.to_s.downcase)
    next if url.match?(/.(patch|diff)(\?full_index=1)?$/)
    next if tap_style_exception? :not_a_binary_url_prefix_allowlist
    next if tap_style_exception? :binary_bootstrap_formula_urls_allowlist

    problem "#{url} looks like a binary package, not a source archive; " \
            "homebrew/core is source-only."
  end
end