Class: SystemCommand::Result Private

Inherits:

Object
SystemCommand::Result

Includes:: Context, Utils::Output::Mixin

Defined in:: system_command.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

Result containing the output and exit status of a finished sub-process.

Instance Method Summary collapse

#assert_success! ⇒ void private
#initialize(command, output, status, secrets:) ⇒ void constructor private
#merged_output ⇒ String private
#plist ⇒ T.untyped private
#stderr ⇒ String private
#stdout ⇒ String private
#success? ⇒ Boolean private
#to_ary ⇒ Array<(String, String, Process::Status)> (also: #to_a) private

Methods included from 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

Methods included from Context

current, current=, #debug?, #quiet?, #verbose?, #with_context

Constructor Details

#initialize(command, output, status, secrets:) ⇒ `void`

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Parameters:

command (Array<String>)
output (Array<Array<([String, Symbol], String)>>)
status (Process::Status)
secrets (Array<String>)

# File 'system_command.rb', line 501

def initialize(command, output, status, secrets:)
  @command       = command
  @output        = output
  @status        = status
  @exit_status   = T.let(status.exitstatus, T.nilable(Integer))
  @secrets       = secrets
end

Instance Attribute Details

#command ⇒ `Array<String>`

Returns:

(Array<String>)



485
486
487

# File 'system_command.rb', line 485

def command
  @command
end

#exit_status ⇒ `Integer`^?

Returns:

(Integer, nil)



491
492
493

# File 'system_command.rb', line 491

def exit_status
  @exit_status
end

#status ⇒ `Process::Status`

Returns:

(Process::Status)



488
489
490

# File 'system_command.rb', line 488

def status
  @status
end

Instance Method Details

#assert_success! ⇒ `void`

This method returns an undefined value.

Raises:

(ErrorDuringExecution)

# File 'system_command.rb', line 510

def assert_success!
  return if @status.success?

  raise ErrorDuringExecution.new(command, status: @status, output: @output, secrets: @secrets)
end

#merged_output ⇒ `String`

Returns:

(String)



531
532
533

# File 'system_command.rb', line 531

def merged_output
  @merged_output ||= T.let(@output.map { |_, line| line }.join, T.nilable(String))
end

#plist ⇒ `T.untyped`

Returns:

(T.untyped)

# File 'system_command.rb', line 549

def plist
  require "plist"
  @plist ||= T.let(begin
    output = stdout

    output = output.sub(/\A(.*?)(\s*<\?\s*xml)/m) do
      warn_plist_garbage(T.must(Regexp.last_match(1)))
      Regexp.last_match(2)
    end

    output = output.sub(%r{(<\s*/\s*plist\s*>\s*)(.*?)\Z}m) do
      warn_plist_garbage(T.must(Regexp.last_match(2)))
      Regexp.last_match(1)
    end

    Plist.parse_xml(output, marshal: false)
  end, T.untyped)
end

#stderr ⇒ `String`

Returns:

(String)

# File 'system_command.rb', line 524

def stderr
  @stderr ||= T.let(@output.select { |type,| type == :stderr }
                           .map { |_, line| line }
                           .join, T.nilable(String))
end

#stdout ⇒ `String`

Returns:

(String)

# File 'system_command.rb', line 517

def stdout
  @stdout ||= T.let(@output.select { |type,| type == :stdout }
                           .map { |_, line| line }
                           .join, T.nilable(String))
end

#success? ⇒ `Boolean`

Returns:

(Boolean)

# File 'system_command.rb', line 536

def success?
  return false if @exit_status.nil?

  @exit_status.zero?
end

#to_ary ⇒ `Array<(String, String, Process::Status)>` Also known as: to_a

Returns:

(Array<(String, String, Process::Status)>)



543
544
545

# File 'system_command.rb', line 543

def to_ary
  [stdout, stderr, status]
end

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

Class: SystemCommand::Result Private

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

Methods included from Context

Constructor Details

#initialize(command, output, status, secrets:) ⇒ void

Instance Attribute Details

#command ⇒ Array<String>

#exit_status ⇒ Integer?

#status ⇒ Process::Status

Instance Method Details

#assert_success! ⇒ void

#merged_output ⇒ String

#plist ⇒ T.untyped

#stderr ⇒ String

#stdout ⇒ String

#success? ⇒ Boolean

#to_ary ⇒ Array<(String, String, Process::Status)> Also known as: to_a

#initialize(command, output, status, secrets:) ⇒ `void`

#command ⇒ `Array<String>`

#exit_status ⇒ `Integer`^?

#status ⇒ `Process::Status`

#assert_success! ⇒ `void`

#merged_output ⇒ `String`

#plist ⇒ `T.untyped`

#stderr ⇒ `String`

#stdout ⇒ `String`

#success? ⇒ `Boolean`

#to_ary ⇒ `Array<(String, String, Process::Status)>` Also known as: to_a