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

Наследует:

RuboCop::Cop::FormulaCop

Object
Base
RuboCop::Cop::FormulaCop
RuboCop::Cop::FormulaAudit::AssertStatements

Расширен модулем:: AutoCorrector

Определён в:: rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/assert_statements.rbi

Обзор

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

Этот cop проверяет, что используются идиоматические инструкции assert_*.

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

Атрибуты, унаследованные от 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

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

#audit_formula(formula_nodes) ⇒ `void`

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

Этот метод возвращает неопределённое значение.

Параметры:

formula_nodes (FormulaNodes)

# File 'rubocops/lines.rb', line 94

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

  find_every_method_call_by_name(body_node, :assert).each do |method|
    if method_called_ever?(method, :include?) && !method_called_ever?(method, :!)
      problem "Use `assert_match` instead of `assert ...include?`"
    end

    if method_called_ever?(method, :exist?) && !method_called_ever?(method, :!)
      problem "Use `assert_path_exists <path_to_file>` instead of `#{method.source}`"
    end

    if method_called_ever?(method, :exist?) && method_called_ever?(method, :!)
      problem "Use `refute_path_exists <path_to_file>` instead of `#{method.source}`"
    end

    if method_called_ever?(method, :executable?) && !method_called_ever?(method, :!)
      problem "Use `assert_predicate <path_to_file>, :executable?` instead of `#{method.source}`"
    end
  end

  find_every_method_call_by_name(body_node, :assert_predicate).each do |method|
    args = parameters(method)
    next if args.fetch(1).source != ":exist?"

    @offensive_node = method
    problem "Use `assert_path_exists <path_to_file>` instead of `#{method.source}`" do |corrector|
      correct = "assert_path_exists #{args.fetch(0).source}"
      correct += ", #{args.fetch(2).source}" if args.length == 3
      corrector.replace(@offensive_node.source_range, correct)
    end
  end

  find_every_method_call_by_name(body_node, :refute_predicate).each do |method|
    args = parameters(method)
    next if args.fetch(1).source != ":exist?"

    @offensive_node = method
    problem "Use `refute_path_exists <path_to_file>` instead of `#{method.source}`" do |corrector|
      correct = "refute_path_exists #{args.fetch(0).source}"
      correct += ", #{args.fetch(2).source}" if args.length == 3
      corrector.replace(@offensive_node.source_range, correct)
    end
  end
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/RuboCop/Cop/FormulaAudit/AssertStatements.html