Spec-Zone.ru › Homebrew

Класс: Cask::Audit Приватный

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

Обзор

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

Проверяет cask на наличие различных проблем.

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

Error =

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

T.type_alias do
  {
    message:   T.nilable(String),
    location:  T.nilable(Homebrew::SourceLocation),
    corrected: T::Boolean,
  }
end

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

  • #cask ⇒ Cask только для чтения приватный
  • #download ⇒ Download? только для чтения приватный

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

  • #add_error(message, location: nil, strict_only: false) ⇒ void приватный
  • #errors ⇒ Array<Error> приватный
  • #errors? ⇒ Boolean приватный
  • #initialize(cask, download: false, quarantine: false, online: nil, strict: nil, signing: nil, new_cask: nil, only: [], except: []) ⇒ void конструктор приватный
  • #new_cask? ⇒ Boolean приватный
  • #online? ⇒ Boolean приватный
  • #result ⇒ String? приватный
  • #run! ⇒ ::Cask::Audit приватный
  • #signing? ⇒ Boolean приватный
  • #strict? ⇒ Boolean приватный
  • #success? ⇒ Boolean приватный
  • #summary ⇒ String? приватный

Методы, подключённые из 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

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

clear_path_cache, curl, curl_args, curl_check_http_content, curl_download, curl_executable, curl_headers, curl_http_content_headers_and_checksum, curl_output, curl_path, curl_response_follow_redirections, curl_response_last_location, curl_supports_fail_with_body?, curl_supports_tls13?, curl_version, curl_with_workarounds, http_status_ok?, insecure_redirect?, no_insecure_redirect_curl_args, parse_curl_output, parse_curl_response, url_protected_by_cloudflare?, url_protected_by_incapsula?

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

#system_command, #system_command!

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

#initialize(cask, download: false, quarantine: false, online: nil, strict: nil, signing: nil, new_cask: nil, only: [], except: []) ⇒ void

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

Параметры:

  • cask (::Cask::Cask)
  • download (Boolean) (по умолчанию: false)
  • quarantine (Boolean) (по умолчанию: false)
  • online (Boolean, nil) (по умолчанию: nil)
  • strict (Boolean, nil) (по умолчанию: nil)
  • signing (Boolean, nil) (по умолчанию: nil)
  • new_cask (Boolean, 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/audit.rb', line 46

def initialize(
  cask,
  download: false, quarantine: false,
  online: nil, strict: nil, signing: nil,
  new_cask: nil, only: [], except: []
)
  # `new_cask` implies `online`, `strict` and `signing`
  online = new_cask if online.nil?
  strict = new_cask if strict.nil?
  signing = new_cask if signing.nil?

  # `online` and `signing` imply `download`
  download ||= online || signing

  @cask = cask
  @download = T.let(nil, T.nilable(Download))
  @download = Download.new(cask, quarantine:) if download
  @online = online
  @strict = strict
  @signing = signing
  @new_cask = new_cask
  @only = only
  @except = except
  @livecheck_result = T.let(nil, T.nilable(T.any(T::Boolean, Symbol)))
end

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

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

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

Возвращает:

  • (Cask) 


34
35
36
 
# File 'cask/audit.rb', line 34

def cask
  @cask
end

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

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

Возвращает:

  • (Download, nil) 


37
38
39
 
# File 'cask/audit.rb', line 37

def download
  @download
end

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

#add_error(message, location: nil, strict_only: false) ⇒ void

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

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

Параметры:

  • message (String, nil)
  • location (Homebrew::SourceLocation, nil) (по умолчанию: nil)
  • strict_only (Boolean) (по умолчанию: false) 


126
127
128
129
130
131
 
# File 'cask/audit.rb', line 126

def add_error(message, location: nil, strict_only: false)
  # Only raise non-critical audits if the user specified `--strict`.
  return if strict_only && !@strict

  errors << { message:, location:, corrected: false }
end

#errors ⇒ Array<Error>

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

Возвращает:

  • (Array<Error>) 


105
106
107
 
# File 'cask/audit.rb', line 105

def errors
  @errors ||= T.let([], T.nilable(T::Array[Error]))
end

#errors? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


110
111
112
 
# File 'cask/audit.rb', line 110

def errors?
  errors.any?
end

#new_cask? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


73
 
# File 'cask/audit.rb', line 73

def new_cask? = !!@new_cask

#online? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


76
 
# File 'cask/audit.rb', line 76

def online? =!!@online

#result ⇒ String?

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

Возвращает:

  • (String, nil) 


134
135
136
 
# File 'cask/audit.rb', line 134

def result
  Formatter.error("failed") if errors?
end

#run! ⇒ ::Cask::Audit

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

Возвращает:

  • (::Cask::Audit) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'cask/audit.rb', line 85

def run!
  only_audits = @only
  except_audits = @except

  private_methods.map(&:to_s).grep(/^audit_/).each do |audit_method_name|
    name = audit_method_name.delete_prefix("audit_")
    next if !only_audits.empty? && only_audits.exclude?(name)
    next if except_audits.include?(name)

    send(audit_method_name)
  end

  self
rescue => e
  odebug e, ::Utils::Backtrace.clean(e)
  add_error "exception while auditing #{cask}: #{e.message}"
  self
end

#signing? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


79
 
# File 'cask/audit.rb', line 79

def signing? = !!@signing

#strict? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


82
 
# File 'cask/audit.rb', line 82

def strict? = !!@strict

#success? ⇒ Boolean

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

Возвращает:

  • (Boolean) 


115
116
117
 
# File 'cask/audit.rb', line 115

def success?
  !errors?
end

#summary ⇒ String?

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

Возвращает:

  • (String, nil) 


139
140
141
142
143
144
145
146
147
148
149
 
# File 'cask/audit.rb', line 139

def summary
  return if success?

  summary = ["audit for #{cask}: #{result}"]

  errors.each do |error|
    summary << "#{Formatter.error("-")}#{error[:message]}"
  end

  summary.join("\n")
end

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

Spec-Zone.ru

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