Class: RuboCop::Cop::FormulaAudit::OnSystemConditionals

Inherits:
RuboCop::Cop::FormulaCop show all
Extended by:
AutoCorrector
Includes:
OnSystemConditionalsHelper
Defined in:
rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/on_system_conditionals.rbi

Overview

DO NOT EDIT MANUALLY This is an autogenerated file for dynamic methods in RuboCop::Cop::FormulaAudit::OnSystemConditionals. Please instead update this file by running bin/tapioca dsl RuboCop::Cop::FormulaAudit::OnSystemConditionals.

Constant Summary collapse

NO_ON_SYSTEM_METHOD_NAMES =

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. 

[:install, :post_install].freeze
NO_ON_SYSTEM_BLOCK_NAMES =

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. 

[:service, :test].freeze

Constants included from OnSystemConditionalsHelper

OnSystemConditionalsHelper::ARCH_OPTIONS, OnSystemConditionalsHelper::BASE_OS_OPTIONS, OnSystemConditionalsHelper::MACOS_MODULE_NAMES, OnSystemConditionalsHelper::MACOS_VERSION_CONDITIONALS, OnSystemConditionalsHelper::MACOS_VERSION_OPTIONS, OnSystemConditionalsHelper::ON_SYSTEM_OPTIONS

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods included from OnSystemConditionalsHelper

#audit_arch_conditionals, #audit_base_os_conditionals, #audit_macos_references, #audit_macos_version_conditionals, #audit_on_system_blocks, #hardware_cpu_search, #if_arch_node_search, #if_base_os_node_search, #if_macos_version_node_search, #macos_version_comparison_search, #on_macos_version_method_call, #on_system_method_call

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(_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. 



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'rubocops/lines.rb', line 421

def audit_formula(_node, _class_node, _parent_class_node, body_node)
  NO_ON_SYSTEM_METHOD_NAMES.each do |formula_method_name|
    method_node = find_method_def(body_node, formula_method_name)
    audit_on_system_blocks(method_node, formula_method_name) if method_node
  end
  NO_ON_SYSTEM_BLOCK_NAMES.each do |formula_block_name|
    block_node = find_block(body_node, formula_block_name)
    audit_on_system_blocks(block_node, formula_block_name) if block_node
  end

  # Don't restrict OS.mac? or OS.linux? usage in taps; they don't care
  # as much as we do about e.g. formulae.brew.sh generation, often use
  # platform-specific URLs and we don't want to add DSLs to support
  # that case.
  return if formula_tap != "homebrew-core"

  audit_arch_conditionals(body_node,
                          allowed_methods: NO_ON_SYSTEM_METHOD_NAMES,
                          allowed_blocks:  NO_ON_SYSTEM_BLOCK_NAMES)

  audit_base_os_conditionals(body_node,
                             allowed_methods: NO_ON_SYSTEM_METHOD_NAMES,
                             allowed_blocks:  NO_ON_SYSTEM_BLOCK_NAMES)

  audit_macos_version_conditionals(body_node,
                                   allowed_methods:     NO_ON_SYSTEM_METHOD_NAMES,
                                   allowed_blocks:      NO_ON_SYSTEM_BLOCK_NAMES,
                                   recommend_on_system: true)
end