Class: RuboCop::Cop::FormulaAudit::UsesFromMacos

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
brew/Library/Homebrew/rubocops/uses_from_macos.rb

Overview

This cop audits uses_from_macos dependencies in formulae

Constant Summary collapse

PROVIDED_BY_MACOS_FORMULAE =

Generate with: brew ruby -e ‘puts Formula.select {|f| f.keg_only_reason&.provided_by_macos? }.map(&:name).sort.join(“\n”)’ Not done at runtime as its too slow and RuboCop doesn’t have access.

%w[
  apr
  bc
  bison
  bzip2
  cups
  curl
  dyld-headers
  ed
  expat
  file-formula
  flex
  gcore
  gnu-getopt
  icu4c
  krb5
  libarchive
  libedit
  libffi
  libiconv
  libpcap
  libressl
  libxml2
  libxslt
  llvm
  lsof
  m4
  ncompress
  ncurses
  net-snmp
  openldap
  openlibm
  pod2man
  rpcgen
  ruby
  sqlite
  ssh-copy-id
  swift
  tcl-tk
  texinfo
  unifdef
  unzip
  zip
  zlib
].freeze
ALLOWED_USES_FROM_MACOS_DEPS =

These formulae aren’t keg_only :provided_by_macos but are provided by macOS (or very similarly e.g. OpenSSL where system provides LibreSSL) TODO: consider making some of these keg-only.

(PROVIDED_BY_MACOS_FORMULAE + %w[
  bash
  cpio
  expect
  groff
  gzip
  openssl
  openssl@1.1
  perl
  php
  python
  python@3
  rsync
  vim
  xz
  zsh
]).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, #block_size, #caveats_strings, #check_precedence, #class_name, #component_precedes?, #depends_on?, #depends_on_name_type?, #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, #formula_tap, #get_checksum_node, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_called_in_block?, #method_name, #node_equals?, #offending_node, #on_class, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content, #versioned_formula?

Instance Method Details

#audit_formula(_node, _class_node, _parent_class_node, body_node) ⇒ Object



80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'brew/Library/Homebrew/rubocops/uses_from_macos.rb', line 80

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  find_method_with_args(body_node, :uses_from_macos, /^"(.+)"/).each do |method|
    dep = if parameters(method).first.class == RuboCop::AST::StrNode
      parameters(method).first
    elsif parameters(method).first.class == RuboCop::AST::HashNode
      parameters(method).first.keys.first
    end

    next if ALLOWED_USES_FROM_MACOS_DEPS.include?(string_content(dep))

    problem "`uses_from_macos` should only be used for macOS dependencies, not #{string_content(dep)}."
  end
end