Класс: RuboCop::Cop::FormulaAudit::NonPublicApiUsage Приватный

Обзор

# bad - `tap` is @api internal
class Foo < Formula
  def install
    puts tap
  end
end

# good - `bin` is @api public
class Foo < Formula
  def install
    bin.install "foo"
  end
end

Краткое описание констант свернуть

INTERNAL_MSG =

Эта константа является частью приватного API. Эту константу можно использовать только в репозитории Homebrew/brew. Третьим сторонам следует по возможности избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.

"Do not use `%<method>s` in official tap formulae; it is an internal API (`@api internal`)."

PRIVATE_MSG =

Эта константа является частью приватного API. Эту константу можно использовать только в репозитории Homebrew/brew. Третьим сторонам следует по возможности избегать использования этой константы, поскольку она может быть удалена или изменена без предупреждения.

"Do not use `%<method>s` in official tap formulae; it is a private API (`@api private`)."

Краткое описание атрибутов экземпляра

Атрибуты, унаследованные от RuboCop::Cop::FormulaCop

#file_path

Краткое описание методов экземпляра свернуть

• #audit_formula(formula_nodes) ⇒ void приватный

Методы, унаследованные от 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?

Методы, включённые из HelperFunctions

#block_method_called_in_block?, #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, #source_buffer, #start_column, #string_content

40
41
42
43
44
45
46

# File 'rubocops/non_public_api_usage.rb', line 40

def audit_formula(formula_nodes)
  return if ApiAnnotationHelper::OFFICIAL_TAPS.none?(formula_tap)
  return if (body_node = formula_nodes.body_node).nil?

  check_method_calls(body_node, internal_methods, INTERNAL_MSG)
  check_method_calls(body_node, private_methods, PRIVATE_MSG)
end