Class: RuboCop::Cop::FormulaAudit::UsesFromMacos 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 uses_from_macos dependencies in formulae.

Constant Summary collapse

ALLOWED_USES_FROM_MACOS_DEPS =

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.

TODO:

consider making some of these keg-only.

These formulae aren't keg_only :provided_by_macos but are provided by macOS (or very similarly, e.g. OpenSSL where system provides LibreSSL).

%w[
  bash
  cpio
  expect
  git
  groff
  gzip
  jq
  less
  mandoc
  openssl
  perl
  php
  python
  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, #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

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:



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'rubocops/uses_from_macos.rb', line 100

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

  depends_on_linux = depends_on?(:linux)

  find_method_with_args(body_node, :uses_from_macos, /^"(.+)"/).each do |method|
    @offensive_node = method
    problem "`uses_from_macos` should not be used when Linux is required." if depends_on_linux

    dep = if parameters(method).first.instance_of?(RuboCop::AST::StrNode)
      parameters(method).first
    elsif parameters(method).first.instance_of?(RuboCop::AST::HashNode)
      parameters(method).first.keys.first
    end

    dep_name = string_content(dep)
    next if ALLOWED_USES_FROM_MACOS_DEPS.include? dep_name
    next if ProvidedByMacos::PROVIDED_BY_MACOS_FORMULAE.include? dep_name

    problem "`uses_from_macos` should only be used for macOS dependencies, not #{dep_name}."
  end
end