Spec-Zone.ru › Homebrew

Класс: Cask::Artifact::AbstractArtifact Абстрактный Приватный

Наследует:
Object
  • Object
  • Cask::Artifact::AbstractArtifact
показать все
Расширен модулем:
T::Helpers, Utils::Output::Mixin
Включает:
Comparable, Utils::Output::Mixin
Определён в:
cask/artifact/abstract_artifact.rb

Обзор

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

Этот класс является абстрактным.

Его нельзя создать напрямую. Подклассы должны реализовать приведённые ниже методы abstract.

Абстрактный суперкласс для всех артефактов.

Непосредственные известные подклассы

AbstractFlightBlock, AbstractInstallSteps, AbstractUninstall, GeneratedCompletion, Installer, Pkg, Relocated, StageOnly

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

DirectivesType =

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

T.anything или объединение всех возможных типов аргументов были бы лучшим выбором, но возможность вызывать .inspect, .to_s и т. д. без дополнительных затрат на проверки типов удобна.

T.type_alias { Object }

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

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

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

  • .dirmethod ⇒ Symbol приватный
  • .dsl_key ⇒ Symbol приватный
  • .english_article ⇒ String приватный
  • .english_name ⇒ String приватный
  • .read_script_arguments(arguments, stanza, default_arguments = {}, override_arguments = {}, key = nil) ⇒ Array<([String, nil], Hash{Symbol => T.untyped})> приватный

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

  • #cask_sandbox ⇒ Sandbox? приватный
  • #cask_sandbox_command(env, args, home:) ⇒ Array<String, Pathname> приватный
  • #config ⇒ Config приватный
  • #initialize(cask, *dsl_args) ⇒ void конструктор приватный
  • #run_cask_sandbox(sandbox, args, input: []) ⇒ void приватный
  • #sort_order ⇒ Hash{T.class_of(AbstractArtifact) => Integer} приватный
  • #staged_path_join_executable(path) ⇒ Pathname приватный
  • #summarize ⇒ String абстрактный приватный
  • #to_args ⇒ Array<T.anything> приватный

Методы, включённые из 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, *dsl_args) ⇒ void

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

Параметры:

  • cask (Cask)
  • dsl_args (T.anything)


178
179
180
181
182
183
184
185
186
# File 'cask/artifact/abstract_artifact.rb', line 178

def initialize(cask, *dsl_args)
  @cask = cask
  @dirmethod = T.let(nil, T.nilable(Symbol))
  @dsl_args = T.let(dsl_args.deep_dup, T::Array[T.anything])
  @dsl_key = T.let(nil, T.nilable(Symbol))
  @english_article = T.let(nil, T.nilable(String))
  @english_name = T.let(nil, T.nilable(String))
  @sort_order = T.let(nil, T.nilable(T::Hash[T.class_of(AbstractArtifact), Integer]))
end

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

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

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

Возвращает:

  • (Cask)


175
176
177
# File 'cask/artifact/abstract_artifact.rb', line 175

def cask
  @cask
end

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

.dirmethod ⇒ Symbol

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

Возвращает:

  • (Symbol)


43
44
45
# File 'cask/artifact/abstract_artifact.rb', line 43

def self.dirmethod
  @dirmethod ||= T.let(:"#{dsl_key}dir", T.nilable(Symbol))
end

.dsl_key ⇒ Symbol

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

Возвращает:

  • (Symbol)


37
38
39
40
# File 'cask/artifact/abstract_artifact.rb', line 37

def self.dsl_key
  @dsl_key ||= T.let(T.must(name).sub(/^.*:/, "").gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym,
                     T.nilable(Symbol))
end

.english_article ⇒ String

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

Возвращает:

  • (String)


32
33
34
# File 'cask/artifact/abstract_artifact.rb', line 32

def self.english_article
  @english_article ||= T.let(/^[aeiou]/i.match?(english_name) ? "an" : "a", T.nilable(String))
end

.english_name ⇒ String

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

Возвращает:

  • (String)


27
28
29
# File 'cask/artifact/abstract_artifact.rb', line 27

def self.english_name
  @english_name ||= T.let(T.must(name).sub(/^.*:/, "").gsub(/(.)([A-Z])/, '\1 \2'), T.nilable(String))
end

.read_script_arguments(arguments, stanza, default_arguments = {}, override_arguments = {}, key = nil) ⇒ Array<([String, nil], Hash{Symbol => T.untyped})>

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

ЗАДАЧА:

Такую логику было бы уместнее разместить в dsl.rb или в конструкторе, вызываемом из dsl.rb, если это не замедлит работу.

Параметры:

  • arguments (DirectivesType)
  • stanza (String, Symbol)
  • default_arguments (Hash{Symbol => T.anything}) (по умолчанию: {})
  • override_arguments (Hash{Symbol => T.anything}) (по умолчанию: {})
  • key (Symbol, nil) (по умолчанию: nil)

Возвращает:

  • (Array<([String, nil], Hash{Symbol => T.untyped})>)


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'cask/artifact/abstract_artifact.rb', line 137

def self.read_script_arguments(arguments, stanza, default_arguments = {}, override_arguments = {}, key = nil)
  # TODO: when stanza names are harmonized with class names,
  #       stanza may not be needed as an explicit argument
  description = key ? "#{stanza}#{key.inspect}" : stanza.to_s

  arguments = case arguments
  when String then { executable: arguments } # backward-compatible string value
  when Hash then arguments.dup # Avoid mutating the original argument
  else odie "Unsupported arguments type #{arguments.class}"
  end

  # key sanity
  permitted_keys = [:args, :input, :executable, :must_succeed, :sudo, :print_stdout, :print_stderr]
  unknown_keys = arguments.keys - permitted_keys
  unless unknown_keys.empty?
    opoo "Unknown arguments to #{description} -- " \
         "#{unknown_keys.inspect} (ignored). Running " \
         "`brew update; brew cleanup` will likely fix it."
  end
  arguments.select! { |k| permitted_keys.include?(k) }

  # key warnings
  override_keys = override_arguments.keys
  ignored_keys = arguments.keys & override_keys
  unless ignored_keys.empty?
    onoe "Some arguments to #{description} will be ignored -- :#{unknown_keys.inspect} (overridden)."
  end

  # extract executable
  executable = arguments.key?(:executable) ? arguments.delete(:executable) : nil

  arguments = default_arguments.merge arguments
  arguments.merge! override_arguments

  [executable, arguments]
end

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

#cask_sandbox ⇒ Sandbox?

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

Возвращает:

  • (Sandbox, nil)


194
195
196
197
198
199
200
201
202
203
204
# File 'cask/artifact/abstract_artifact.rb', line 194

def cask_sandbox
  Sandbox.ensure_sandbox_installed!
  return unless Sandbox.available?

  Sandbox.new.tap do |sandbox|
    sandbox.allow_read(path: cask.staged_path, type: :subpath)
    sandbox.allow_write_temp_and_cache
    sandbox.deny_read_home
    sandbox.deny_all_network
  end
end

#cask_sandbox_command(env, args, home:) ⇒ Array<String, Pathname>

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

Параметры:

  • env (Hash{String => String, Boolean, PATH})
  • args (Array<String, Pathname>)
  • home (String)

Возвращает:

  • (Array<String, Pathname>)


213
214
215
216
# File 'cask/artifact/abstract_artifact.rb', line 213

def cask_sandbox_command(env, args, home:)
  env = { "HOME" => home }.merge(env)
  ["/usr/bin/env", *env.map { |key, value| "#{key}=#{value}" }, *args]
end

#config ⇒ Config

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

Возвращает:

  • (Config)


189
190
191
# File 'cask/artifact/abstract_artifact.rb', line 189

def config
  cask.config
end

#run_cask_sandbox(sandbox, args, input: []) ⇒ void

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

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

Параметры:

  • sandbox (Sandbox)
  • args (Array<String, Pathname>)
  • input (String, Array<String>) (по умолчанию: [])


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'cask/artifact/abstract_artifact.rb', line 225

def run_cask_sandbox(sandbox, args, input: [])
  return sandbox.run(*args) if Array(input).empty?

  Tempfile.create("homebrew-cask-script-input", HOMEBREW_TEMP) do |input_file|
    input_file.write(Array(input).join)
    input_file.close
    sandbox.allow_read(path: input_file.path)
    sandbox.run(
      "/bin/sh",
      "-c",
      "input=$1; shift; exec \"$@\" < \"$input\"",
      "sh",
      input_file.path,
      *args,
    )
  end
end

#sort_order ⇒ Hash{T.class_of(AbstractArtifact) => Integer}

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

Возвращает:

  • (Hash{T.class_of(AbstractArtifact) => Integer})


71
72
73
74
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
104
105
106
107
108
109
110
111
112
113
114
# File 'cask/artifact/abstract_artifact.rb', line 71

def sort_order
  @sort_order ||= T.let(
    [
      PreflightBlock,
      PreflightSteps,
      UninstallPreflightSteps,
      # The `uninstall` stanza should be run first, as it may
      # depend on other artifacts still being installed.
      Uninstall,
      Installer,
      # `pkg` should be run before `binary`, so
      # targets are created prior to linking.
      # `pkg` should be run before `app`, since an `app` could
      # contain a nested installer (e.g. `wireshark`).
      Pkg,
      [
        App,
        Suite,
        Artifact,
        Colorpicker,
        Prefpane,
        Qlplugin,
        Mdimporter,
        Dictionary,
        Font,
        Service,
        InputMethod,
        InternetPlugin,
        KeyboardLayout,
        AudioUnitPlugin,
        VstPlugin,
        Vst3Plugin,
        ScreenSaver,
      ],
      Binary,
      Manpage,
      PostflightSteps,
      UninstallPostflightSteps,
      PostflightBlock,
      Zap,
    ].each_with_index.flat_map { |classes, i| Array(classes).map { |c| [c, i] } }.to_h,
    T.nilable(T::Hash[T.class_of(AbstractArtifact), Integer]),
  )
end

#staged_path_join_executable(path) ⇒ Pathname

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

Параметры:

  • path (String, Pathname)

Возвращает:

  • (Pathname)


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'cask/artifact/abstract_artifact.rb', line 51

def staged_path_join_executable(path)
  path = Pathname(path)
  path = path.expand_path if path.to_s.start_with?("~")

  absolute_path = if path.absolute?
    path
  else
    cask.staged_path.join(path)
  end

  FileUtils.chmod "+x", absolute_path if absolute_path.exist? && !absolute_path.executable?

  if absolute_path.exist?
    absolute_path
  else
    path
  end
end

#summarize ⇒ String

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

Этот метод является абстрактным.

Возвращает:

  • (String)


48
# File 'cask/artifact/abstract_artifact.rb', line 48

def summarize; end

#to_args ⇒ Array<T.anything>

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

Возвращает:

  • (Array<T.anything>)


249
250
251
# File 'cask/artifact/abstract_artifact.rb', line 249

def to_args
  @dsl_args.compact_blank
end

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

Spec-Zone.ru

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