Class: RuboCop::Cop::FormulaAudit::ProvidedByMacos Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/uses_from_macos.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 formulae that are keg-only because they are provided by macos.

Constant Summary collapse

PROVIDED_BY_MACOS_FORMULAE =

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. 

%w[
  apr
  bc
  berkeley-db
  bison
  bzip2
  cups
  curl
  cyrus-sasl
  dyld-headers
  ed
  expat
  file-formula
  flex
  gnu-getopt
  gperf
  icu4c
  krb5
  libarchive
  libedit
  libffi
  libiconv
  libpcap
  libressl
  libxcrypt
  libxml2
  libxslt
  llvm
  lsof
  m4
  ncompress
  ncurses
  net-snmp
  netcat
  openldap
  pax
  pcsc-lite
  pod2man
  rpcgen
  ruby
  sqlite
  ssh-copy-id
  swift
  tcl-tk
  unifdef
  unzip
  whois
  zip
  zlib
].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. 



62
63
64
65
66
67
68
69
70
71
 
# File 'rubocops/uses_from_macos.rb', line 62

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

  find_method_with_args(body_node, :keg_only, :provided_by_macos) do
    return if PROVIDED_BY_MACOS_FORMULAE.include? @formula_name

    problem "Formulae that are `keg_only :provided_by_macos` should be " \
            "added to the `PROVIDED_BY_MACOS_FORMULAE` list (in the Homebrew/brew repo)"
  end
end