Spec-Zone.ru › Homebrew

Класс: Cask::Auditor Закрытый

Наследует:
Object
  • Object
  • Cask::Auditor
показать все
Подключает:
Utils::Output::Mixin
Определён в:
cask/auditor.rb

Обзор

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

Вспомогательный класс для проверки всех доступных языков cask.

Сводка констант свернуть

LANGUAGE_BLOCK_LIMIT =

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

10

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

  • #cask ⇒ ::Cask::Cask только для чтения закрытый
  • #language ⇒ String? только для чтения закрытый

Сводка методов класса свернуть

  • .audit(cask, audit_download: false, audit_online: nil, audit_strict: nil, audit_signing: nil, audit_new_cask: nil, quarantine: false, any_named_args: false, language: nil, only: [], except: []) ⇒ Set<Audit::Error> закрытый

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

  • #audit ⇒ Set<Audit::Error> закрытый
  • #initialize(cask, audit_download: false, audit_online: nil, audit_strict: nil, audit_signing: nil, audit_new_cask: nil, quarantine: false, any_named_args: false, language: nil, only: [], except: []) ⇒ void конструктор закрытый

Методы, подключённые из Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #opoo_without_github_actions_annotation, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_uninstalled, #pretty_upgradable, #pretty_warning

Подробное описание конструкторов

#initialize(cask, audit_download: false, audit_online: nil, audit_strict: nil, audit_signing: nil, audit_new_cask: nil, quarantine: false, any_named_args: false, language: nil, only: [], except: []) ⇒ void

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

Параметры:

  • cask (::Cask::Cask)
  • audit_download (Boolean) (по умолчанию: false)
  • audit_online (Boolean, nil) (по умолчанию: nil)
  • audit_strict (Boolean, nil) (по умолчанию: nil)
  • audit_signing (Boolean, nil) (по умолчанию: nil)
  • audit_new_cask (Boolean, nil) (по умолчанию: nil)
  • quarantine (Boolean) (по умолчанию: false)
  • any_named_args (Boolean) (по умолчанию: false)
  • language (String, nil) (по умолчанию: nil)
  • only (Array<String>) (по умолчанию: [])
  • except (Array<String>) (по умолчанию: [])


46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'cask/auditor.rb', line 46

def initialize(
  cask,
  audit_download: false,
  audit_online: nil,
  audit_strict: nil,
  audit_signing: nil,
  audit_new_cask: nil,
  quarantine: false,
  any_named_args: false,
  language: nil,
  only: [],
  except: []
)
  @cask = cask
  @audit_download = audit_download
  @audit_online = audit_online
  @audit_new_cask = audit_new_cask
  @audit_strict = audit_strict
  @audit_signing = audit_signing
  @quarantine = quarantine
  @any_named_args = any_named_args
  @language = language
  @only = only
  @except = except
end

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

#cask ⇒ ::Cask::Cask (только для чтения)

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

Возвращает:

  • (::Cask::Cask)


33
34
35
# File 'cask/auditor.rb', line 33

def cask
  @cask
end

#language ⇒ String? (только для чтения)

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

Возвращает:

  • (String, nil)


36
37
38
# File 'cask/auditor.rb', line 36

def language
  @language
end

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

.audit(cask, audit_download: false, audit_online: nil, audit_strict: nil, audit_signing: nil, audit_new_cask: nil, quarantine: false, any_named_args: false, language: nil, only: [], except: []) ⇒ Set<Audit::Error>

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

К выполнению:

использовать передачу аргументов (...) когда Sorbet будет поддерживать её в строгом режиме

Параметры:

  • cask (::Cask::Cask)
  • audit_download (Boolean) (по умолчанию: false)
  • audit_online (Boolean, nil) (по умолчанию: nil)
  • audit_strict (Boolean, nil) (по умолчанию: nil)
  • audit_signing (Boolean, nil) (по умолчанию: nil)
  • audit_new_cask (Boolean, nil) (по умолчанию: nil)
  • quarantine (Boolean) (по умолчанию: false)
  • any_named_args (Boolean) (по умолчанию: false)
  • language (String, nil) (по умолчанию: nil)
  • only (Array<String>) (по умолчанию: [])
  • except (Array<String>) (по умолчанию: [])

Возвращает:

  • (Set<Audit::Error>)


21
22
23
24
25
26
27
28
29
30
# File 'cask/auditor.rb', line 21

def self.audit(
  cask, audit_download: false, audit_online: nil, audit_strict: nil, audit_signing: nil,
  audit_new_cask: nil, quarantine: false, any_named_args: false, language: nil,
  only: [], except: []
)
  new(
    cask, audit_download:, audit_online:, audit_strict:, audit_signing:,
    audit_new_cask:, quarantine:, any_named_args:, language:, only:, except:
  ).audit
end

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

#audit ⇒ Set<Audit::Error>

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

Возвращает:

  • (Set<Audit::Error>)


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'cask/auditor.rb', line 75

def audit
  errors = Set.new

  if !language && !(blocks = language_blocks).empty?
    sample_languages = if blocks.length > LANGUAGE_BLOCK_LIMIT && !@audit_new_cask
      sample_keys = T.must(blocks.keys.sample(LANGUAGE_BLOCK_LIMIT))
      ohai "Auditing a sample of available languages for #{cask}: " \
           "#{sample_keys.map { |lang| lang[0].to_s }.to_sentence}"
      blocks.select { |k| sample_keys.include?(k) }
    else
      blocks
    end

    sample_languages.each_key do |l|
      audit = audit_languages(l)
      if audit.summary.present? && output_summary?(audit)
        ohai "Auditing language: #{l.map { |lang| "'#{lang}'" }.to_sentence}" if output_summary?
        puts audit.summary
      end
      errors += audit.errors
    end
  else
    audit = audit_cask_instance(cask)
    puts audit.summary if audit.summary.present? && output_summary?(audit)
    errors += audit.errors
  end

  errors
end

© 2009–present Homebrew contributors
Licensed under the BSD 2-Clause License.
https://docs.brew.sh/rubydoc/Cask/Auditor.html

Spec-Zone.ru

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