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

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
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
  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_name, #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?, #check_precedence, #class_name, #component_precedes?, descendant_send_nodes, descendant_send_nodes_by_method_name, #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, #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:



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'rubocops/uses_from_macos.rb', line 102

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

  depends_on_linux = depends_on_linux?(body_node)
  check_uses_from_macos_nodes(body_node, depends_on_linux)

  [:head, :stable].each do |spec|
    software_spec = find_block(body_node, spec)&.body
    next unless software_spec

    check_uses_from_macos_nodes(software_spec, depends_on_linux || depends_on_linux?(software_spec))
  end
end

#check_uses_from_macos_nodes(node, depends_on_linux) ⇒ 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:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'rubocops/uses_from_macos.rb', line 117

def check_uses_from_macos_nodes(node, depends_on_linux)
  find_method_calls_by_name(node, :uses_from_macos).each do |method|
    offending_node(method)

    dep_arg = method.first_argument
    dep = case dep_arg
    when RuboCop::AST::StrNode
      dep_arg
    when RuboCop::AST::HashNode
      dep_arg = dep_arg.node_parts.first
      dep_arg.key if dep_arg.is_a?(RuboCop::AST::PairNode)
    end

    if depends_on_linux
      problem "`uses_from_macos` should not be used when Linux is required." do |corrector|
        corrector.replace(method.source_range, "depends_on #{dep_arg.source}") if dep
      end
      next
    end

    next if dep.nil?
    next unless dep.str_type?

    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}'." do |corrector|
      corrector.replace(method.source_range, "depends_on #{dep_arg.source}")
    end
  end
end

#depends_on_linux?(node) ⇒ Boolean

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.

Parameters:

Returns:

  • (Boolean) 


151
152
153
154
155
 
# File 'rubocops/uses_from_macos.rb', line 151

def depends_on_linux?(node)
  find_method_calls_by_name(node, :depends_on).any? do |depends_on|
    depends_on_name_type?(depends_on, :linux, :any)
  end
end