Class: Homebrew::API::FormulaStruct Private

Inherits:
T::Struct
  • Object
show all
Defined in:
api/formula_struct.rb,
sorbet/rbi/dsl/homebrew/api/formula_struct.rbi

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.

Constant Summary collapse

PREDICATES =

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

[
  :bottle,
  :deprecate,
  :disable,
  :head,
  :keg_only,
  :no_autobump,
  :pour_bottle,
  :service,
  :service_run,
  :service_name,
  :stable,
].freeze
DependsOnArgs =

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

T.type_alias do
  T.any(
    # Dependencies
    T.any(
      # Formula name: "foo"
      String,
      # Formula name and dependency type: { "foo" => :build }
      T::Hash[String, Symbol],
    ),
    # Requirements
    T.any(
      # Requirement name: :macos
      Symbol,
      # Requirement name and other info: { macos: :build }
      T::Hash[Symbol, T::Array[T.anything]],
    ),
  )
end
UsesFromMacOSArgs =

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

T.type_alias do
  [
    T.any(
      # Formula name: "foo"
      String,
      # Formula name and dependency type: { "foo" => :build }
      # Formula name, dependency type, and version bounds: { "foo" => :build, since: :catalina }
      T::Hash[T.any(String, Symbol), T.any(Symbol, T::Array[Symbol])],
    ),
    # If the first argument is only a name, this argument contains the version bounds: { since: :catalina }
    T::Hash[Symbol, Symbol],
  ]
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(aliases: [], bottle_checksums: [], bottle_rebuild: 0, caveats: nil, conflicts: [], deprecate_args: {}, desc:, disable_args: {}, head_dependencies: [], head_url_args:, head_uses_from_macos: [], homepage:, keg_only_args: [], license:, link_overwrite_paths: [], no_autobump_args: {}, oldnames: [], post_install_defined: true, pour_bottle_args: {}, revision: 0, ruby_source_checksum:, service_args: [], service_name_args: {}, service_run_args: [], service_run_kwargs: {}, stable_dependencies: [], stable_checksum: nil, stable_url_args:, stable_uses_from_macos: [], stable_version:, version_scheme: 0, versioned_formulae: []) ⇒ void

Parameters:




# File ''

const :aliases, T::Array[String], default: []
const :bottle_checksums, T::Array[T::Hash[Symbol, T.anything]], default: []
const :bottle_rebuild, Integer, default: 0
const :caveats, T.nilable(String)
const :conflicts, T::Array[[String, T::Hash[Symbol, String]]], default: []
const :deprecate_args, T::Hash[Symbol, T.nilable(T.any(String, Symbol))], default: {}
const :desc, String
const :disable_args, T::Hash[Symbol, T.nilable(T.any(String, Symbol))], default: {}
const :head_dependencies, T::Array[DependsOnArgs], default: []
const :head_url_args, [String, T::Hash[Symbol, T.anything]]
const :head_uses_from_macos, T::Array[UsesFromMacOSArgs], default: []
const :homepage, String
const :keg_only_args, T::Array[T.any(String, Symbol)], default: []
const :license, SPDX::LicenseExpression
const :link_overwrite_paths, T::Array[String], default: []
const :no_autobump_args, T::Hash[Symbol, T.any(String, Symbol)], default: {}
const :oldnames, T::Array[String], default: []
const :post_install_defined, T::Boolean, default: true
const :pour_bottle_args, T::Hash[Symbol, Symbol], default: {}
const :revision, Integer, default: 0
const :ruby_source_checksum, String
const :service_args, T::Array[[Symbol, BasicObject]], default: []
const :service_name_args, T::Hash[Symbol, String], default: {}
const :service_run_args, T::Array[Homebrew::Service::RunParam], default: []
const :service_run_kwargs, T::Hash[Symbol, Homebrew::Service::RunParam], default: {}
const :stable_dependencies, T::Array[DependsOnArgs], default: []
const :stable_checksum, T.nilable(String)
const :stable_url_args, [String, T::Hash[Symbol, T.anything]]
const :stable_uses_from_macos, T::Array[UsesFromMacOSArgs], default: []
const :stable_version, String
const :version_scheme, Integer, default: 0
const :versioned_formulae, T::Array[String], default: []

Instance Attribute Details

#aliases ⇒ Array<String> (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.

Changes to this struct must be mirrored in Homebrew::API::Formula.generate_formula_struct_hash

Returns:




# File ''

const :aliases, T::Array[String], default: []

#bottle_checksums ⇒ Array<Hash{Symbol => T.anything}> (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 the value of prop bottle_checksums.

Returns:




# File ''

const :bottle_checksums, T::Array[T::Hash[Symbol, T.anything]], default: []

#bottle_rebuild ⇒ Integer (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 the value of prop bottle_rebuild.

Returns:

  • (Integer) 



# File ''

const :bottle_rebuild, Integer, default: 0

#caveats ⇒ String? (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 the value of prop caveats.

Returns:




# File ''

const :caveats, T.nilable(String)

#conflicts ⇒ Array<Array<(String, Hash{Symbol => String})>> (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 the value of prop conflicts.

Returns:




# File ''

const :conflicts, T::Array[[String, T::Hash[Symbol, String]]], default: []

#deprecate_args ⇒ Hash{Symbol => String, Symbol, nil} (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 the value of prop deprecate_args.

Returns:




# File ''

const :deprecate_args, T::Hash[Symbol, T.nilable(T.any(String, Symbol))], default: {}

#desc ⇒ String (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 the value of prop desc.

Returns:




# File ''

const :desc, String

#disable_args ⇒ Hash{Symbol => String, Symbol, nil} (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 the value of prop disable_args.

Returns:




# File ''

const :disable_args, T::Hash[Symbol, T.nilable(T.any(String, Symbol))], default: {}

#head_dependencies ⇒ Array<DependsOnArgs> (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 the value of prop head_dependencies.

Returns:




# File ''

const :head_dependencies, T::Array[DependsOnArgs], default: []

#head_url_args ⇒ Array<(String, Hash{Symbol => T.anything})> (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 the value of prop head_url_args.

Returns:




# File ''

const :head_url_args, [String, T::Hash[Symbol, T.anything]]

#head_uses_from_macos ⇒ Array<UsesFromMacOSArgs> (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 the value of prop head_uses_from_macos.

Returns:




# File ''

const :head_uses_from_macos, T::Array[UsesFromMacOSArgs], default: []

#homepage ⇒ String (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 the value of prop homepage.

Returns:




# File ''

const :homepage, String

#keg_only_args ⇒ Array<String, Symbol> (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 the value of prop keg_only_args.

Returns:




# File ''

const :keg_only_args, T::Array[T.any(String, Symbol)], default: []

#license ⇒ SPDX::LicenseExpression (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 the value of prop license.

Returns:




# File ''

const :license, SPDX::LicenseExpression

#link_overwrite_paths ⇒ Array<String> (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 the value of prop link_overwrite_paths.

Returns:




# File ''

const :link_overwrite_paths, T::Array[String], default: []

#no_autobump_args ⇒ Hash{Symbol => String, Symbol} (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 the value of prop no_autobump_args.

Returns:




# File ''

const :no_autobump_args, T::Hash[Symbol, T.any(String, Symbol)], default: {}

#oldnames ⇒ Array<String> (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 the value of prop oldnames.

Returns:




# File ''

const :oldnames, T::Array[String], default: []

#post_install_defined ⇒ Boolean (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 the value of prop post_install_defined.

Returns:

  • (Boolean) 



# File ''

const :post_install_defined, T::Boolean, default: true

#pour_bottle_args ⇒ Hash{Symbol => Symbol} (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 the value of prop pour_bottle_args.

Returns:




# File ''

const :pour_bottle_args, T::Hash[Symbol, Symbol], default: {}

#revision ⇒ Integer (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 the value of prop revision.

Returns:

  • (Integer) 



# File ''

const :revision, Integer, default: 0

#ruby_source_checksum ⇒ String (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 the value of prop ruby_source_checksum.

Returns:




# File ''

const :ruby_source_checksum, String

#service_args ⇒ Array<Array<(Symbol, BasicObject)>> (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 the value of prop service_args.

Returns:




# File ''

const :service_args, T::Array[[Symbol, BasicObject]], default: []

#service_name_args ⇒ Hash{Symbol => String} (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 the value of prop service_name_args.

Returns:




# File ''

const :service_name_args, T::Hash[Symbol, String], default: {}

#service_run_args ⇒ Array<Homebrew::Service::RunParam> (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 the value of prop service_run_args.

Returns:




# File ''

const :service_run_args, T::Array[Homebrew::Service::RunParam], default: []

#service_run_kwargs ⇒ Hash{Symbol => Homebrew::Service::RunParam} (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 the value of prop service_run_kwargs.

Returns:




# File ''

const :service_run_kwargs, T::Hash[Symbol, Homebrew::Service::RunParam], default: {}

#stable_checksum ⇒ String? (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 the value of prop stable_checksum.

Returns:




# File ''

const :stable_checksum, T.nilable(String)

#stable_dependencies ⇒ Array<DependsOnArgs> (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 the value of prop stable_dependencies.

Returns:




# File ''

const :stable_dependencies, T::Array[DependsOnArgs], default: []

#stable_url_args ⇒ Array<(String, Hash{Symbol => T.anything})> (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 the value of prop stable_url_args.

Returns:




# File ''

const :stable_url_args, [String, T::Hash[Symbol, T.anything]]

#stable_uses_from_macos ⇒ Array<UsesFromMacOSArgs> (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 the value of prop stable_uses_from_macos.

Returns:




# File ''

const :stable_uses_from_macos, T::Array[UsesFromMacOSArgs], default: []

#stable_version ⇒ String (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 the value of prop stable_version.

Returns:




# File ''

const :stable_version, String

#version_scheme ⇒ Integer (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 the value of prop version_scheme.

Returns:

  • (Integer) 



# File ''

const :version_scheme, Integer, default: 0

#versioned_formulae ⇒ Array<String> (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 the value of prop versioned_formulae.

Returns:




# File ''

const :versioned_formulae, T::Array[String], default: []

Class Method Details

.from_hash(formula_hash) ⇒ FormulaStruct

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:

Returns:



11
12
13
14
15
16
 
# File 'api/formula_struct.rb', line 11

def self.from_hash(formula_hash)
  formula_hash = formula_hash.transform_keys(&:to_sym)
                             .slice(*decorator.all_props)
                             .compact_blank
  new(**formula_hash)
end

Instance Method Details

#bottle? ⇒ 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) 


10
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 10

def bottle?; end

#deprecate? ⇒ 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) 


13
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 13

def deprecate?; end

#disable? ⇒ 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) 


16
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 16

def disable?; end

#head? ⇒ 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) 


19
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 19

def head?; end

#keg_only? ⇒ 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) 


22
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 22

def keg_only?; end

#no_autobump? ⇒ 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) 


25
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 25

def no_autobump?; end

#pour_bottle? ⇒ 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) 


28
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 28

def pour_bottle?; end

#service? ⇒ 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) 


31
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 31

def service?; end

#service_name? ⇒ 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) 


34
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 34

def service_name?; end

#service_run? ⇒ 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) 


37
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 37

def service_run?; end

#stable? ⇒ 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) 


40
 
# File 'sorbet/rbi/dsl/homebrew/api/formula_struct.rbi', line 40

def stable?; end