Spec-Zone.ru › Homebrew

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

Наследует:
RuboCop::Cop::FormulaCop
  • Object
  • Base
  • RuboCop::Cop::FormulaCop
  • RuboCop::Cop::FormulaAudit::KegOnly
показать все
Расширен модулем:
AutoCorrector
Определён в:
rubocops/keg_only.rb

Обзор

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

Этот cop проверяет, что причина keg_only имеет правильный формат.

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

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

#file_path

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

  • #audit_formula(formula_nodes) ⇒ void приватный
  • #autocorrect(node) ⇒ 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)


14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# File 'rubocops/keg_only.rb', line 14

def audit_formula(formula_nodes)
  keg_only_node = find_node_method_by_name(formula_nodes.body_node, :keg_only)
  return unless keg_only_node

  allowlist = %w[ApplemacOSOSHomebrewXcodeGPGGNOMEBSDFirefox].freeze

  reason = parameters(keg_only_node).fetch(0)
  @offensive_node = reason
  name = Regexp.new(T.must(@formula_name), Regexp::IGNORECASE)
  reason = string_content(reason).sub(name, "")
  first_word = reason.split.fetch(0)

  if /\A[A-Z]/.match?(reason) && !reason.start_with?(*allowlist)
    problem "'#{first_word}' from the `keg_only` reason should be '#{first_word.downcase}'." do |corrector|
      reason[0] = T.must(reason[0]).downcase # reason[0] must exist because of the regexp match
      corrector.replace(@offensive_node.source_range, "\"#{reason}\"")
    end
  end

  return unless reason.end_with?(".")

  problem "`keg_only` reason should not end with a period." do |corrector|
    corrector.replace(@offensive_node.source_range, "\"#{reason.chop}\"")
  end
end

#autocorrect(node) ⇒ void

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

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

Параметры:

  • node (RuboCop::AST::Node)


51
52
53
54
55
56
57
58
59
60
# File 'rubocops/keg_only.rb', line 51

def autocorrect(node)
  lambda do |corrector|
    reason = string_content(node)
    raise "unexpected empty reason" unless reason[0]

    reason[0] = T.must(reason[0]).downcase # reason[0] must exist because of the previous line
    reason = reason.delete_suffix(".")
    corrector.replace(node.source_range, "\"#{reason}\"")
  end
end

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API