Class: Resource::BottleManifest Private

Inherits:
Resource
  • Object
show all
Defined in:
resource.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.

A resource for a bottle manifest.

Defined Under Namespace

Classes: Error

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bottle) ⇒ 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:



436
437
438
439
440
 
# File 'resource.rb', line 436

def initialize(bottle)
  super("#{bottle.name}_bottle_manifest")
  @bottle = bottle
  @manifest_annotations = T.let(nil, T.nilable(T::Hash[String, String]))
end

Instance Attribute Details

#bottle ⇒ Bottle (readonly)

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.

Returns:



430
431
432
 
# File 'resource.rb', line 430

def bottle
  @bottle
end

#manifest_annotations=(value) ⇒ 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.

This method returns an undefined value.



433
434
435
 
# File 'resource.rb', line 433

def manifest_annotations=(value)
  @manifest_annotations = value
end

Instance Method Details

#bottle_size ⇒ Integer?

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.

Returns:



478
479
480
 
# File 'resource.rb', line 478

def bottle_size
  manifest_annotations["sh.brew.bottle.size"]&.to_i
end

#clear_cache ⇒ 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.

This method returns an undefined value.



443
444
445
446
 
# File 'resource.rb', line 443

def clear_cache
  super
  @manifest_annotations = nil
end

#download_queue_name ⇒ String

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.

Returns:



516
 
# File 'resource.rb', line 516

def download_queue_name = "#{bottle.name} (#{bottle.resource.version})"

#download_queue_type ⇒ String

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.

Returns:



513
 
# File 'resource.rb', line 513

def download_queue_type = "Bottle Manifest"

#downloaded_and_valid? ⇒ Boolean

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.

Returns:

  • (Boolean) 


455
456
457
458
459
460
461
462
463
 
# File 'resource.rb', line 455

def downloaded_and_valid?
  return false unless downloaded?

  with_context(quiet: true) { verify_download_integrity(cached_download) }
  true
rescue Error
  clear_cache
  false
end

#installed_size ⇒ Integer?

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.

Returns:



483
484
485
 
# File 'resource.rb', line 483

def installed_size
  manifest_annotations["sh.brew.bottle.installed_size"]&.to_i
end

#path_exec_files ⇒ Array<String>?

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.

Returns:



488
489
490
 
# File 'resource.rb', line 488

def path_exec_files
  manifest_annotations["sh.brew.path_exec_files"]&.split(",")
end

#sbom_supplement ⇒ Hash{String => Object}?

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.

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'resource.rb', line 493

def sbom_supplement
  supplement = manifest_annotations["sh.brew.sbom.supplement"]
  return if supplement.blank?

  parsed_supplement = JSON.parse(supplement)
  return unless parsed_supplement.is_a?(Hash)

  if (tags = parsed_supplement["tags"]).is_a?(Hash)
    tag_supplement = tags[Utils::Bottles.tag.to_s]
    return tag_supplement if tag_supplement.is_a?(Hash)

    return
  end

  parsed_supplement
rescue JSON::ParserError
  nil
end

#tab ⇒ Hash{String => T.untyped}

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.

Returns:

Raises:



466
467
468
469
470
471
472
473
474
475
 
# File 'resource.rb', line 466

def tab
  tab = manifest_annotations["sh.brew.tab"]
  raise Error, "Couldn't find tab from manifest." if tab.blank?

  begin
    JSON.parse(tab)
  rescue JSON::ParserError
    raise Error, "Couldn't parse tab JSON."
  end
end

#verify_download_integrity(_filename) ⇒ 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.

This method returns an undefined value.

Parameters:



449
450
451
452
 
# File 'resource.rb', line 449

def verify_download_integrity(_filename)
  # We don't have a checksum, but we can at least try parsing it.
  tab
end