Class: Formula Private
- Extended by:
- APIHashable, Attrable, BuildEnvironment::DSL, Cachable, Forwardable, OnSystem::MacOSAndLinux
- Includes:
- Context, FileUtils, Homebrew::Livecheck::Constants, OnSystem::MacOSAndLinux, Utils::Shebang, Utils::Shell
- Defined in:
- extend/os/mac/formula.rb,
extend/os/linux/formula.rb,
formula.rb,
formula.rbi,
sorbet/rbi/parlour.rbi
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.
This file provides definitions for Forwardable#delegate, which is currently not supported by Sorbet.
Constant Summary
Constants included from Homebrew::Livecheck::Constants
Homebrew::Livecheck::Constants::LATEST_VERSION
Constants included from Utils::Shell
Utils::Shell::SHELL_PROFILE_MAP, Utils::Shell::UNSAFE_SHELL_CHAR
Class Attribute Summary collapse
-
.allow_network_access!(phases = []) ⇒ void
private
The phases for which network access is allowed.
-
.bottle(&block) ⇒ void
Adds a Formula.bottle SoftwareSpec.
-
.conflicts ⇒ Object
readonly
private
-
.deny_network_access!(phases = []) ⇒ void
private
The phases for which network access is denied.
-
.deprecated_option(hash) ⇒ Object
private
Deprecated options are used to rename options and migrate users who used them to newer ones.
-
.deprecation_date ⇒ Object
readonly
private
The date that this Formula was or becomes deprecated.
-
.deprecation_reason ⇒ nil, ...
readonly
private
The reason for deprecation of a Formula.
-
.desc(arg = T.unsafe(nil)) ⇒ T.untyped
private
-
.disable_date ⇒ Object
readonly
private
The date that this Formula was or becomes disabled.
-
.disable_reason ⇒ String, Symbol
readonly
private
The reason this Formula is disabled.
-
.head(val = nil, specs = {}, &block) ⇒ Object
private
Adds a Formula.head SoftwareSpec.
-
.homepage(arg = T.unsafe(nil)) ⇒ T.untyped
private
-
.keg_only_reason ⇒ Object
readonly
private
The reason for why this software is not linked (by default) to HOMEBREW_PREFIX.
-
.license(args = nil) ⇒ Object
private
The SPDX ID of the open-source license that the formula uses.
-
.link_overwrite_paths ⇒ Object
readonly
private
-
.livecheck(&block) ⇒ Object
private
Livecheck can be used to check for newer versions of the software.
-
.mirror(val) ⇒ Object
private
Additional URLs for the Formula.stable version of the formula.
-
.option(name, description = "") ⇒ Object
private
Options can be used as arguments to
brew install
. -
.pour_bottle_check_unsatisfied_reason ⇒ Object
private
If
pour_bottle?
returnsfalse
the user-visible reason to display for why they cannot use the bottle. -
.pour_bottle_only_if ⇒ Object
readonly
private
-
.revision(arg = T.unsafe(nil)) ⇒ T.untyped
private
-
.service(&block) ⇒ Object
private
Service can be used to define services.
-
.sha256(val) ⇒ Object
private
To verify the cached download’s integrity and security we verify the SHA-256 hash matches what we’ve declared in the Formula.
-
.skip_clean_paths ⇒ Object
readonly
private
-
.stable(&block) ⇒ Object
private
Allows adding Formula.depends_on and Patches just to the Formula.stable SoftwareSpec.
-
.url(val, specs = {}) ⇒ Object
private
The URL used to download the source for the Formula.stable version of the formula.
-
.version(val = nil) ⇒ Object
private
The version string for the Formula.stable version of the formula.
-
.version_scheme(arg = T.unsafe(nil)) ⇒ T.untyped
private
Instance Attribute Summary collapse
-
#active_log_type ⇒ String?
readonly
private
When performing a build, test, or other loggable action, indicates which log file location to use.
-
#active_spec ⇒ Object
writeonly
private
-
#active_spec_sym ⇒ Symbol
readonly
private
A symbol to indicate currently active SoftwareSpec.
-
#alias_name ⇒ String?
readonly
private
The name of the alias that was used to identify this Formula.
-
#alias_path ⇒ Pathname?
readonly
private
The path to the alias that was used to identify this Formula.
-
#build ⇒ BuildOptions, Tab
private
The BuildOptions or Tab for this Formula.
-
#buildpath ⇒ Pathname?
readonly
private
The current working directory during builds.
-
#follow_installed_alias ⇒ Boolean
(also: #follow_installed_alias?)
private
Whether this formula should be considered outdated if the target of the alias it was installed with has since changed.
-
#force_bottle ⇒ Boolean
private
Whether or not to force the use of a bottle.
-
#full_alias_name ⇒ String?
readonly
private
The fully-qualified alias referring to this Formula.
-
#full_name ⇒ String
readonly
The fully-qualified name of this Formula.
-
#head ⇒ SoftwareSpec?
readonly
private
The HEAD SoftwareSpec for this Formula.
-
#local_bottle_path ⇒ Pathname?
private
When installing a bottle (binary package) from a local path this will be set to the full path to the bottle tarball.
-
#name ⇒ String
readonly
The name of this Formula.
-
#path ⇒ Pathname
readonly
The full path to this Formula.
-
#revision ⇒ Integer
readonly
private
Used for creating new Homebrew versions of software without new upstream versions.
-
#source_modified_time ⇒ Time?
readonly
private
most recent modified time for source files.
-
#stable ⇒ SoftwareSpec?
readonly
internal
The stable (and default) SoftwareSpec for this Formula.
- #tap ⇒ Tap? readonly internal
-
#testpath ⇒ Pathname?
readonly
private
The current working directory during tests.
-
#version_scheme ⇒ Integer
readonly
private
Used to change version schemes for packages.
Class Method Summary collapse
-
.[](name) ⇒ Object
private
-
.alias_full_names ⇒ Object
private
an array of all aliases as fully-qualified names.
-
.aliases ⇒ Object
private
an array of all aliases.
-
.all(eval_all: false) ⇒ Object
private
an array of all Formula this should only be used when users specify
--all
to a command. -
.build ⇒ Object
private
-
.build_flags ⇒ Object
private
Get the
BUILD_FLAGS
from the formula’s namespace set inFormulary::load_formula
. -
.conflicts_with(*names) ⇒ Object
One or more formulae that conflict with this one and why.
-
.core_alias_files ⇒ Object
private
an array of all alias files of core Formula.
-
.core_aliases ⇒ Object
private
an array of all core aliases.
-
.core_names ⇒ Object
private
an array of all core Formula names.
-
.cxxstdlib_check(check_type) ⇒ Object
Pass
:skip
to this method to disable post-install stdlib checking. -
.depends_on(dep) ⇒ Object
The dependencies for this formula.
-
.deprecate!(date:, because:) ⇒ Object
Deprecates a Formula (on the given date) so a warning is shown on each installation.
-
.deprecated? ⇒ Boolean
private
Whether this Formula is deprecated (i.e. warns on installation).
-
.disable!(date:, because:) ⇒ Object
Disables a Formula (on the given date) so it cannot be installed.
-
.disabled? ⇒ Boolean
private
Whether this Formula is disabled (i.e. cannot be installed).
-
.fails_with(compiler, &block) ⇒ Object
Marks the Formula as failing with a particular compiler so it will fall back to others.
-
.freeze ⇒ Object
private
-
.full_names ⇒ Object
private
an array of all Formula names, which the tap formulae have the fully-qualified name.
-
.fuzzy_search(name) ⇒ Object
private
Returns a list of approximately matching formula names, but not the complete match.
-
.go_resource(name, &block) ⇒ Object
-
.inherited(child) ⇒ Object
private
Initialise instance variables for each subclass.
-
.installed ⇒ Object
private
An array of all installed Formula.
-
.installed_formula_names ⇒ Array<String>
private
An array of all currently installed formula names.
-
.installed_with_alias_path(alias_path) ⇒ Object
private
-
.keg_only(reason, explanation = "") ⇒ Object
Software that will not be symlinked into the
brew --prefix
and will only live in its Cellar. -
.link_overwrite(*paths) ⇒ Object
private
Permit overwriting certain files while linking.
-
.livecheckable? ⇒ Boolean
private
Whether a livecheck specification is defined or not.
-
.loaded_from_api? ⇒ Boolean
private
-
.names ⇒ Object
private
an array of all Formula names.
-
.needs(*standards) ⇒ Object
Marks the Formula as needing a certain standard, so Homebrew will fall back to other compilers if the default compiler does not implement that standard.
-
.network_access_allowed?(phase) ⇒ Boolean
private
Whether the specified phase should be forced offline.
-
.on_macos(&block) ⇒ Object
private
This method is included by
OnSystem
. -
.on_system_blocks_exist? ⇒ Boolean
private
-
.patch(strip = :p1, src = nil, &block) ⇒ Object
External patches can be declared using resource-style blocks.
-
.pour_bottle?(only_if: nil, &block) ⇒ Boolean
Defines whether the Formula’s bottle can be used on the given Homebrew installation.
-
.racks ⇒ Object
private
An array of all racks currently installed.
-
.resource(name, klass = Resource, &block) ⇒ Object
Additional downloads can be defined as Formula.resources and accessed in the install method.
-
.service? ⇒ Boolean
private
Whether a service specification is defined or not.
-
.skip_clean(*paths) ⇒ Object
Skip cleaning paths in a formula.
-
.spec_syms ⇒ Object
private
-
.specs ⇒ Object
private
A list of the Formula.stable and Formula.head SoftwareSpecs.
-
.tap_aliases ⇒ Object
private
an array of all tap aliases.
-
.tap_files ⇒ Object
private
an array of all tap Formula files.
-
.tap_names ⇒ Object
private
an array of all tap Formula names.
-
.test(&block) ⇒ Boolean
A test is required for new formulae and makes us happy.
-
.uses_from_macos(dep, bounds = {}) ⇒ void
Indicates use of dependencies provided by macOS.
Instance Method Summary collapse
-
#<=>(other) ⇒ Object
private
-
#==(other) ⇒ Object
(also: #eql?)
private
-
#active_log_prefix ⇒ String
private
The prefix, if any, to use in filenames for logging current activity.
-
#add_global_deps_to_spec(spec) ⇒ void
private
-
#alias_changed? ⇒ Boolean
private
Has the alias used to install the formula changed, or are different formulae already installed with this alias?.
-
#aliases ⇒ Array<String>
internal
All aliases for the formula.
-
#allow_network_access!(*args, **options, &block) ⇒ T.untyped
private
-
#any_installed_keg ⇒ Object
private
Returns a Keg for the opt_prefix or installed_prefix if they exist.
-
#any_installed_prefix ⇒ Pathname?
internal
Get the path of any installed prefix.
-
#any_installed_version ⇒ Object
private
Returns the PkgVersion for this formula if it is installed.
-
#any_version_installed? ⇒ Boolean
private
If at least one version of Formula is installed.
-
#bash_completion ⇒ Pathname
The directory where the formula’s Bash completion files should be installed.
-
#bin ⇒ Pathname
The directory where the formula’s binaries should be installed.
-
#bottle ⇒ Bottle?
private
The Bottle object for the currently active SoftwareSpec.
-
#bottle_defined?(*args, **options, &block) ⇒ Boolean
private
-
#bottle_for_tag(tag = nil) ⇒ Bottle?
private
The Bottle object for given tag.
-
#bottle_hash(compact_for_api: false) ⇒ Object
private
Returns the bottle information for a formula.
- #bottle_prefix ⇒ Pathname private
-
#bottle_specification(*args, **options, &block) ⇒ T.untyped
private
-
#bottle_tab_attributes ⇒ Hash
private
-
#bottle_tag?(*args, **options, &block) ⇒ Boolean
private
-
#bottled?(*args, **options, &block) ⇒ Boolean
private
-
#brew(fetch: true, keep_tmp: false, debug_symbols: false, interactive: false) ⇒ Object
private
Yields self,staging with current working directory set to the uncompressed tarball where staging is a Mktemp staging context. -
#cached_download(*args, **options, &block) ⇒ T.untyped
private
-
#caveats ⇒ String?
private
Warn the user about any Homebrew-specific issues or quirks for this package.
-
#caveats_with_placeholders ⇒ Object
private
-
#clear_cache(*args, **options, &block) ⇒ T.untyped
private
-
#compiler_failures(*args, **options, &block) ⇒ T.untyped
private
-
#conflicts(*args, **options, &block) ⇒ T.untyped
private
-
#core_formula? ⇒ Boolean
private
True if this formula is provided by Homebrew itself.
-
#current_installed_alias_target ⇒ Object
private
-
#declared_deps(*args, **options, &block) ⇒ T.untyped
private
-
#deny_network_access!(*args, **options, &block) ⇒ T.untyped
private
-
#dependencies_hash ⇒ Object
private
-
#deprecated? ⇒ Boolean
private
Whether this Formula is deprecated (i.e. warns on installation).
-
#deprecated_flags(*args, **options, &block) ⇒ T.untyped
private
-
#deprecated_options(*args, **options, &block) ⇒ T.untyped
private
-
#deprecation_date ⇒ T.untyped
private
The date that this Formula was or becomes deprecated.
-
#deprecation_reason ⇒ T.untyped
private
The reason this Formula is deprecated.
-
#deps(*args, **options, &block) ⇒ T.untyped
private
-
#desc ⇒ T.untyped
private
The description of the software.
-
#deuniversalize_machos(*targets) ⇒ void
private
Replaces a universal binary with its native slice.
-
#disable_date ⇒ T.untyped
private
The date that this Formula was or becomes disabled.
-
#disable_reason ⇒ T.untyped
private
The reason this Formula is disabled.
-
#disabled? ⇒ Boolean
private
Whether this Formula is disabled (i.e. cannot be installed).
-
#doc ⇒ Pathname
The directory where the formula’s documentation should be installed.
-
#downloader(*args, **options, &block) ⇒ T.untyped
private
-
#eligible_kegs_for_cleanup(quiet: false) ⇒ Object
private
-
#elisp ⇒ Pathname
The directory where Emacs Lisp files should be installed, with the formula name appended to avoid linking conflicts.
-
#env(*args, **options, &block) ⇒ T.untyped
private
-
#etc ⇒ Pathname
The directory where the formula’s configuration files should be installed.
-
#fetch(verify_download_integrity: true) ⇒ Object
private
-
#fetch_bottle_tab ⇒ void
private
-
#fetch_patches ⇒ Object
private
-
#fish_completion ⇒ Pathname
The directory where the formula’s fish completion files should be installed.
-
#fish_function ⇒ Pathname
The directory where the formula’s fish function files should be installed.
-
#frameworks ⇒ Pathname
The directory where the formula’s Frameworks should be installed.
-
#full_installed_alias_name ⇒ Object
private
-
#full_installed_specified_name ⇒ Object
private
The name (including tap) specified to install this formula.
-
#full_specified_name ⇒ Object
private
The name (including tap) specified to find this formula.
-
#generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) ⇒ void
private
Generate shell completions for a formula for bash, zsh, and fish, using the formula’s executable.
-
#hash ⇒ Object
private
-
#head? ⇒ Boolean
private
Is the currently active SoftwareSpec a #head build?.
-
#head_only? ⇒ Boolean
private
Is this formula HEAD-only?.
-
#head_version_outdated?(version, fetch_head: false) ⇒ Boolean
private
-
#homepage ⇒ T.untyped
private
The homepage for the software.
-
#include ⇒ Pathname
The directory where the formula’s headers should be installed.
-
#info ⇒ Pathname
The directory where the formula’s info files should be installed.
-
#initialize(name, path, spec, alias_path: nil, tap: nil, force_bottle: false) ⇒ void
constructor
private
-
#inreplace(paths, before = nil, after = nil, audit_result = true, &block) ⇒ void
Sometimes we have to change a bit before we install.
-
#install ⇒ Object
private
This method is overridden in Formula subclasses to provide the installation instructions.
-
#install_etc_var ⇒ void
private
-
#installed_alias_name ⇒ String?
private
-
#installed_alias_path ⇒ Pathname?
private
The alias path that was used to install this formula, if it exists.
-
#installed_alias_target_changed? ⇒ Boolean
private
Has the target of the alias used to install this formula changed? Returns false if the formula wasn’t installed with an alias.
-
#installed_kegs ⇒ Object
private
All currently installed kegs.
-
#installed_prefixes ⇒ Object
private
All currently installed prefix directories.
-
#installed_specified_name ⇒ Object
private
The name specified to install this formula.
-
#keg_only? ⇒ Boolean
internal
Rarely, you don’t want your library symlinked into the main prefix.
-
#keg_only_reason(*args, **options, &block) ⇒ T.untyped
private
-
#kext_prefix ⇒ Pathname
The directory where the formula’s kernel extensions should be installed.
-
#latest_formula ⇒ Object
private
If the alias has changed value, return the new formula.
-
#latest_head_prefix ⇒ Object
private
-
#latest_head_version ⇒ Object
private
-
#latest_installed_prefix ⇒ Object
private
The latest prefix for this formula.
-
#latest_version_installed? ⇒ Boolean
private
If this Formula is installed.
-
#launchd_service_path ⇒ Pathname
private
The generated launchd Formula.service file path.
-
#lib ⇒ Pathname
The directory where the formula’s libraries should be installed.
-
#libexec ⇒ Pathname
The directory where the formula’s binaries should be installed.
-
#license ⇒ T.untyped
private
The SPDX ID of the software license.
-
#link_overwrite?(path) ⇒ Boolean
private
-
#linked? ⇒ Boolean
internal
Is the formula linked?.
-
#linked_keg ⇒ Object
internal
The link status symlink directory for this Formula.
-
#linked_version ⇒ PkgVersion?
private
PkgVersion of the linked keg for the formula.
-
#livecheck ⇒ T.untyped
private
The livecheck specification for the software.
-
#livecheckable? ⇒ Boolean
private
Is a livecheck specification defined for the software?.
-
#loaded_from_api? ⇒ Boolean
private
Whether this formula was loaded using the formulae.brew.sh API.
-
#loader_path ⇒ String
private
-
#lock ⇒ Object
private
-
#logs ⇒ Pathname
private
The directory where the formula’s installation or test logs will be written.
-
#man ⇒ Pathname
The root directory where the formula’s manual pages should be installed.
-
#man1 ⇒ Pathname
The directory where the formula’s man1 pages should be installed.
-
#man2 ⇒ Pathname
The directory where the formula’s man2 pages should be installed.
-
#man3 ⇒ Pathname
The directory where the formula’s man3 pages should be installed.
-
#man4 ⇒ Pathname
The directory where the formula’s man4 pages should be installed.
-
#man5 ⇒ Pathname
The directory where the formula’s man5 pages should be installed.
-
#man6 ⇒ Pathname
The directory where the formula’s man6 pages should be installed.
-
#man7 ⇒ Pathname
The directory where the formula’s man7 pages should be installed.
-
#man8 ⇒ Pathname
The directory where the formula’s man8 pages should be installed.
-
#migration_needed? ⇒ Boolean
private
-
#missing_dependencies(hide: nil) ⇒ Object
private
Returns a list of formulae depended on by this formula that aren’t installed.
-
#mkdir(name, &block) ⇒ Object
private
A version of
FileUtils.mkdir
that also changes to that folder in a block. -
#mktemp(prefix = name, opts = {}, &block) ⇒ Object
private
Create a temporary directory then yield.
-
#network_access_allowed?(*args, **options, &block) ⇒ Boolean
private
-
#new_formula_available? ⇒ Boolean
private
-
#old_installed_formulae ⇒ Object
private
-
#oldname ⇒ String?
deprecated
private
Deprecated.
Use #oldnames instead.
-
#oldnames ⇒ Array<String>
internal
Old names for the formula.
-
#oldnames_to_migrate ⇒ Array<String>
private
-
#on_system_blocks_exist? ⇒ Boolean
private
-
#opt_bin ⇒ Pathname
Same as #bin, but relative to #opt_prefix instead of #prefix.
-
#opt_elisp ⇒ Pathname
Same as #elisp, but relative to #opt_prefix instead of #prefix.
-
#opt_frameworks ⇒ Pathname
Same as #frameworks, but relative to #opt_prefix instead of #prefix.
-
#opt_include ⇒ Pathname
Same as #include, but relative to #opt_prefix instead of #prefix.
-
#opt_lib ⇒ Pathname
Same as #lib, but relative to #opt_prefix instead of #prefix.
-
#opt_libexec ⇒ Pathname
Same as #libexec, but relative to #opt_prefix instead of #prefix.
-
#opt_pkgshare ⇒ Pathname
Same as #pkgshare, but relative to #opt_prefix instead of #prefix.
-
#opt_prefix ⇒ Pathname
A stable path for this formula, when installed.
-
#opt_sbin ⇒ Pathname
Same as #sbin, but relative to #opt_prefix instead of #prefix.
-
#opt_share ⇒ Pathname
Same as #share, but relative to #opt_prefix instead of #prefix.
-
#option_defined? ⇒ Boolean
private
If a named option is defined for the currently active SoftwareSpec.
-
#options(*args, **options, &block) ⇒ T.untyped
private
-
#optlinked? ⇒ Boolean
private
Is the formula linked to
opt
?. -
#outdated?(fetch_head: false) ⇒ Boolean
internal
Check whether the installed formula is outdated.
-
#outdated_kegs(fetch_head: false) ⇒ Object
private
-
#patch ⇒ Object
private
-
#pin(*args, **options, &block) ⇒ T.untyped
private
-
#pinnable?(*args, **options, &block) ⇒ Boolean
private
-
#pinned?(*args, **options, &block) ⇒ Boolean
private
-
#pinned_version(*args, **options, &block) ⇒ T.untyped
private
-
#pkg_version ⇒ PkgVersion
private
The PkgVersion for this formula with Formula.version and #revision information.
-
#pkgetc ⇒ Pathname
A subdirectory of
etc
with the formula name suffixed. -
#pkgshare ⇒ Pathname
The directory where the formula’s shared files should be installed, with the name of the formula appended to avoid linking conflicts.
-
#plist ⇒ Object
deprecated
private
Deprecated.
Please use Homebrew::Service instead.
-
#plist_name ⇒ String
private
The generated launchd #plist service name.
-
#possible_names ⇒ Object
private
-
#post_install ⇒ void
private
Can be overridden to run commands on both source and bottle installation.
-
#post_install_defined? ⇒ Boolean
private
-
#pour_bottle? ⇒ Boolean
private
Indicates that this formula supports bottles.
-
#pour_bottle_check_unsatisfied_reason(*args, **options, &block) ⇒ T.untyped
private
-
#prefix(version = pkg_version) ⇒ Object
private
The directory in the cellar that the formula is installed to.
-
#prefix_linked?(version = pkg_version) ⇒ Boolean
private
If a formula’s linked keg points to the prefix.
-
#print_tap_action(options = {}) ⇒ Object
private
-
#rack ⇒ Pathname
private
The parent of the prefix; the named directory in the cellar containing all installed versions of this software.
-
#recursive_dependencies(&block) ⇒ Object
internal
Returns a list of Dependency objects in an installable order, which means if a depends on b then b will be ordered before a in this list.
-
#recursive_requirements(&block) ⇒ Object
internal
The full set of Requirements for this formula’s dependency tree.
-
#require_universal_deps? ⇒ Boolean
private
-
#requirements(*args, **options, &block) ⇒ T.untyped
private
-
#resource ⇒ T.untyped
private
A named Resource for the currently active SoftwareSpec.
-
#resources ⇒ Object
private
The Resources for the currently active SoftwareSpec.
-
#rpath(source: bin, target: lib) ⇒ String
private
Executable/Library RPATH according to platform conventions.
-
#ruby_source_checksum ⇒ Checksum?
private
-
#ruby_source_path ⇒ String?
private
-
#run_post_install ⇒ void
private
-
#run_test(keep_tmp: false) ⇒ Object
private
-
#runtime_dependencies(read_from_tab: true, undeclared: true) ⇒ Object
internal
Returns a list of Dependency objects that are required at runtime.
-
#runtime_formula_dependencies(read_from_tab: true, undeclared: true) ⇒ Object
private
Returns a list of Formula objects that are required at runtime.
-
#runtime_installed_formula_dependents ⇒ Object
private
-
#sbin ⇒ Pathname
The directory where the formula’s
sbin
binaries should be installed. -
#serialized_requirements ⇒ Object
private
-
#service ⇒ Object
private
The service specification of the software.
-
#service? ⇒ Boolean
private
Is a service specification defined for the software?.
-
#service_name ⇒ String
private
The generated service name.
-
#share ⇒ Pathname
The directory where the formula’s shared files should be installed.
-
#shared_library(name, version = nil) ⇒ String
private
Shared library names according to platform conventions.
-
#skip_clean?(path) ⇒ Boolean
private
-
#skip_cxxstdlib_check? ⇒ Boolean
private
-
#specified_name ⇒ Object
private
The name specified to find this formula.
-
#specified_path ⇒ Object
private
The path that was specified to find this formula.
-
#stable? ⇒ Boolean
private
Is the currently active SoftwareSpec a #stable build?.
-
#std_cabal_v2_args ⇒ Array<String>
private
Standard parameters for cabal-v2 builds.
-
#std_cargo_args(root: prefix, path: ".") ⇒ Array<String>
private
Standard parameters for cargo builds.
-
#std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") ⇒ Array<String>
(also: #generic_std_cmake_args)
private
Standard parameters for CMake builds.
-
#std_configure_args(prefix: self.prefix, libdir: "lib") ⇒ Array<String>
private
Standard parameters for configure builds.
-
#std_go_args(output: bin/name, ldflags: nil) ⇒ Array<String>
private
Standard parameters for Go builds.
-
#std_meson_args ⇒ Array<String>
private
Standard parameters for meson builds.
-
#std_pip_args(prefix: self.prefix, build_isolation: false) ⇒ Array<String>
private
Standard parameters for pip builds.
-
#supersedes_an_installed_formula? ⇒ Boolean
private
Is this formula the target of an alias used to install an old formula?.
-
#synced_with_other_formulae? ⇒ Boolean
private
Whether this Formula is version-synced with other formulae.
-
#system(cmd, *args) ⇒ void
private
To call out to the system, we use the
system
method and we prefer you give the args separately as in the line below, otherwise a subshell has to be opened first. -
#systemd_service_path ⇒ Pathname
private
The generated systemd Formula.service file path.
-
#systemd_timer_path ⇒ Pathname
private
The generated systemd timer file path.
-
#tap? ⇒ Boolean
private
True if this formula is provided by external Tap.
-
#tap_git_head ⇒ Object
private
-
#test ⇒ Object
private
-
#test_defined? ⇒ Boolean
private
-
#test_fixtures(file) ⇒ Object
private
-
#time ⇒ Time
private
Creates a new
Time
object for use in the formula as the build time. -
#to_hash ⇒ Object
private
-
#to_hash_with_variations(hash_method: :to_hash) ⇒ Object
private
-
#to_internal_api_hash ⇒ Object
private
-
#unlock ⇒ Object
private
-
#unpin(*args, **options, &block) ⇒ T.untyped
private
-
#update_head_version ⇒ void
private
-
#urls_hash ⇒ Object
private
-
#uses_from_macos_elements(*args, **options, &block) ⇒ T.untyped
private
-
#uses_from_macos_names(*args, **options, &block) ⇒ T.untyped
private
-
#valid_platform? ⇒ Boolean
private
True if this formula can be installed on this platform Redefined in extend/os.
-
#var ⇒ Pathname
The directory where the formula’s variable files should be installed.
-
#verify_download_integrity(filename) ⇒ Object
private
-
#version ⇒ T.untyped
private
The version for the currently active SoftwareSpec.
-
#versioned_formula? ⇒ Boolean
private
If this is a
@
-versioned formula. -
#versioned_formulae ⇒ Array<Formula>
private
Returns any
@
-versioned Formula objects for any Formula (including versioned formulae). -
#versioned_formulae_names ⇒ Array<String>
private
Returns any other
@
-versioned formulae names for any formula (including versioned formulae). -
#with_logging(log_type) ⇒ Object
private
Runs a block with the given log type in effect for its duration.
-
#xcodebuild(*args) ⇒ void
private
Runs
xcodebuild
without Homebrew’s compiler environment variables set. -
#zsh_completion ⇒ Pathname
The directory where the formula’s zsh completion files should be installed.
-
#zsh_function ⇒ Pathname
The directory where the formula’s zsh function files should be installed.
Methods included from OnSystem::MacOSAndLinux
Methods included from BuildEnvironment::DSL
Methods included from Cachable
Methods included from Attrable
Methods included from APIHashable
generated_hash!, generating_hash!, generating_hash?
Methods included from Context
current, current=, #debug?, #quiet?, #verbose?, #with_context
Methods included from Utils::Shell
csh_quote, export_value, from_path, parent, preferred, preferred_path, prepend_path_in_profile, profile, set_variable_in_profile, sh_quote
Methods included from Kernel
#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path
Methods included from Utils::Shebang
Constructor Details
#initialize(name, path, spec, alias_path: nil, tap: nil, force_bottle: false) ⇒ 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.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 |
# File 'formula.rb', line 212 def initialize(name, path, spec, alias_path: nil, tap: nil, force_bottle: false) # Only allow instances of subclasses. The base class does not hold any spec information (URLs etc). raise "Do not call `Formula.new' directly without a subclass." unless self.class < Formula # Stop any subsequent modification of a formula's definition. # Changes do not propagate to existing instances of formulae. # Now that we have an instance, it's too late to make any changes to the class-level definition. self.class.freeze @name = name @unresolved_path = path @path = path.resolved_path @alias_path = alias_path @alias_name = (File.basename(alias_path) if alias_path) @revision = self.class.revision || 0 @version_scheme = self.class.version_scheme || 0 @force_bottle = force_bottle @tap = tap @tap ||= if path == Formulary.core_path(name) CoreTap.instance else Tap.from_path(path) end @full_name = full_name_with_optional_tap(name) @full_alias_name = full_name_with_optional_tap(@alias_name) self.class.spec_syms.each do |sym| spec_eval sym end @active_spec = determine_active_spec(spec) @active_spec_sym = if head? :head else :stable end validate_attributes! @build = active_spec.build @pin = FormulaPin.new(self) @follow_installed_alias = true @prefix_returns_versioned_prefix = false @oldname_locks = [] end |
Class Attribute Details
.allow_network_access!(phases = []) ⇒ 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.
The phases for which network access is allowed. By default, network
access is allowed for all phases. Valid phases are :build
, :test
,
and :postinstall
. When no argument is passed, network access will be
allowed for all phases.
allow_network_access!
allow_network_access! :build
allow_network_access! [:build, :test]
3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 |
# File 'formula.rb', line 3160 def allow_network_access!(phases = []) phases_array = Array(phases) if phases_array.empty? @network_access_allowed.each_key { |phase| @network_access_allowed[phase] = true } else phases_array.each do |phase| raise ArgumentError, "Unknown phase: #{phase}" unless SUPPORTED_NETWORK_ACCESS_PHASES.include?(phase) @network_access_allowed[phase] = true end end end |
.bottle(&block) ⇒ void
This method returns an undefined value.
Adds a bottle SoftwareSpec. This provides a pre-built binary package built by the Homebrew maintainers for you. It will be installed automatically if there is a binary package for your platform and you haven’t passed or previously used any options on this formula.
If you maintain your own repository, you can add your own bottle links. You can ignore this block entirely if submitting to Homebrew/homebrew-core. It’ll be handled for you by the Brew Test Bot.
bottle do
root_url "https://example.com" # Optional root to calculate bottle URLs.
rebuild 1 # Marks the old bottle as outdated without bumping the version/revision of the formula.
# Optionally specify the HOMEBREW_CELLAR in which the bottles were built.
sha256 cellar: "/brew/Cellar", catalina: "ef65c759c5097a36323fa9c77756468649e8d1980a3a4e05695c05e39568967c"
sha256 cellar: :any, mojave: "28f4090610946a4eb207df102d841de23ced0d06ba31cb79e040d883906dcd4f"
sha256 high_sierra: "91dd0caca9bd3f38c439d5a7b6f68440c4274945615fae035ff0a369264b8a2f"
end
Homebrew maintainers aim to bottle all formulae.
3361 3362 3363 |
# File 'formula.rb', line 3361 def bottle(&block) stable.bottle(&block) end |
.conflicts ⇒ Object (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.
3232 3233 3234 |
# File 'formula.rb', line 3232 def conflicts @conflicts end |
.deny_network_access!(phases = []) ⇒ 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.
The phases for which network access is denied. By default, network
access is allowed for all phases. Valid phases are :build
, :test
,
and :postinstall
. When no argument is passed, network access will be
denied for all phases.
deny_network_access!
deny_network_access! :build
deny_network_access! [:build, :test]
3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 |
# File 'formula.rb', line 3182 def deny_network_access!(phases = []) phases_array = Array(phases) if phases_array.empty? @network_access_allowed.each_key { |phase| @network_access_allowed[phase] = false } else phases_array.each do |phase| raise ArgumentError, "Unknown phase: #{phase}" unless SUPPORTED_NETWORK_ACCESS_PHASES.include?(phase) @network_access_allowed[phase] = false end end end |
.deprecated_option(hash) ⇒ 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.
Deprecated options are used to rename options and migrate users who used
them to newer ones. They are mostly used for migrating non-with
options
(e.g. enable-debug
) to with
options (e.g. with-debug
).
deprecated_option "enable-debug" => "with-debug"
3526 3527 3528 |
# File 'formula.rb', line 3526 def deprecated_option(hash) specs.each { |spec| spec.deprecated_option(hash) } end |
.deprecation_date ⇒ Object (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.
The date that this Formula was or becomes deprecated.
Returns nil
if no date is specified.
3811 3812 3813 |
# File 'formula.rb', line 3811 def deprecation_date @deprecation_date end |
.deprecation_reason ⇒ 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.
The reason for deprecation of a Formula.
3817 3818 3819 |
# File 'formula.rb', line 3817 def deprecation_reason @deprecation_reason end |
.desc(arg = T.unsafe(nil)) ⇒ 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.
174 |
# File 'sorbet/rbi/parlour.rbi', line 174 def self.desc(arg = T.unsafe(nil)); end |
.disable_date ⇒ Object (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.
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
3853 3854 3855 |
# File 'formula.rb', line 3853 def disable_date @disable_date end |
.disable_reason ⇒ 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.
The reason this Formula is disabled.
Returns nil
if no reason was provided or the formula is not disabled.
3859 3860 3861 |
# File 'formula.rb', line 3859 def disable_reason @disable_reason end |
.head(val = nil, specs = {}, &block) ⇒ 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.
Adds a head SoftwareSpec.
This can be installed by passing the --HEAD
option to allow
installing software directly from a branch of a version-control repository.
If called as a method this provides just the url for the SoftwareSpec.
If a block is provided you can also add depends_on and Patches just to the head SoftwareSpec.
The download strategies (e.g. :using =>
) are the same as for url.
master
is the default branch and doesn’t need stating with a branch:
parameter.
head "https://we.prefer.https.over.git.example.com/.git"
head "https://example.com/.git", branch: "name_of_branch"
or (if autodetect fails):
head "https://hg.is.awesome.but.git.has.won.example.com/", using: :hg
3410 3411 3412 3413 3414 3415 3416 3417 3418 |
# File 'formula.rb', line 3410 def head(val = nil, specs = {}, &block) if block @head.instance_eval(&block) elsif val @head.url(val, specs) else @head end end |
.homepage(arg = T.unsafe(nil)) ⇒ 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.
177 |
# File 'sorbet/rbi/parlour.rbi', line 177 def self.homepage(arg = T.unsafe(nil)); end |
.keg_only_reason ⇒ Object (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.
The reason for why this software is not linked (by default) to HOMEBREW_PREFIX.
3106 3107 3108 |
# File 'formula.rb', line 3106 def keg_only_reason @keg_only_reason end |
.license(args = nil) ⇒ 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.
The SPDX ID of the open-source license that the formula uses.
Shows when running brew info
.
Use :any_of
, :all_of
or :with
to describe complex license expressions.
:any_of
should be used when the user can choose which license to use.
:all_of
should be used when the user must use all licenses.
:with
should be used to specify a valid SPDX exception.
Add +
to an identifier to indicate that the formulae can be
licensed under later versions of the same license.
license "BSD-2-Clause"
license "EPL-1.0+"
license any_of: ["MIT", "GPL-2.0-only"]
license all_of: ["MIT", "GPL-2.0-only"]
license "GPL-2.0-only" => { with: "LLVM-exception" }
license :public_domain
license any_of: [
"MIT",
:public_domain,
all_of: ["0BSD", "Zlib", "Artistic-1.0+"],
"Apache-2.0" => { with: "LLVM-exception" },
]
3143 3144 3145 3146 3147 3148 3149 |
# File 'formula.rb', line 3143 def license(args = nil) if args.nil? @licenses else @licenses = args end end |
.link_overwrite_paths ⇒ Object (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.
3232 3233 3234 |
# File 'formula.rb', line 3232 def link_overwrite_paths @link_overwrite_paths end |
.livecheck(&block) ⇒ 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.
Livecheck can be used to check for newer versions of the software.
This method evaluates the DSL specified in the livecheck block of the
Formula (if it exists) and sets the instance variables of a Livecheck
object accordingly. This is used by brew livecheck
to check for newer
versions of the software.
livecheck do
skip "Not maintained"
url "https://example.com/foo/releases"
regex /foo-(\d+(?:\.\d+)+)\.tar/
end
3705 3706 3707 3708 3709 3710 |
# File 'formula.rb', line 3705 def livecheck(&block) return @livecheck unless block @livecheckable = true @livecheck.instance_eval(&block) end |
.mirror(val) ⇒ 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.
Additional URLs for the stable version of the formula. These are only used if the url fails to download. It’s optional and there can be more than one. Generally we add them when the main url is unreliable. If url is really unreliable then we may swap the mirror and url.
mirror "https://in.case.the.host.is.down.example.com"
mirror "https://in.case.the.mirror.is.down.example.com
3319 3320 3321 |
# File 'formula.rb', line 3319 def mirror(val) stable.mirror(val) end |
.option(name, description = "") ⇒ 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.
Options can be used as arguments to brew install
.
To switch features on/off: "with-something"
or "with-otherthing"
.
To use other software: "with-other-software"
or "without-foo"
.
Note that for depends_on that are :optional
or :recommended
, options
are generated automatically.
There are also some special options:
:universal
: build a universal binary/library (e.g. on newer Intel Macs this means a combined x86_64/x86 binary/library).
option "with-spam", "The description goes here without a dot at the end"
option "with-qt", "Text here overwrites what's autogenerated by 'depends_on "qt" => :optional'"
option :universal
3515 3516 3517 |
# File 'formula.rb', line 3515 def option(name, description = "") specs.each { |spec| spec.option(name, description) } end |
.pour_bottle_check_unsatisfied_reason ⇒ 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.
If pour_bottle?
returns false
the user-visible reason to display for
why they cannot use the bottle.
3236 3237 3238 |
# File 'formula.rb', line 3236 def pour_bottle_check_unsatisfied_reason @pour_bottle_check_unsatisfied_reason end |
.pour_bottle_only_if ⇒ Object (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.
3232 3233 3234 |
# File 'formula.rb', line 3232 def pour_bottle_only_if @pour_bottle_only_if end |
.revision(arg = T.unsafe(nil)) ⇒ 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.
180 |
# File 'sorbet/rbi/parlour.rbi', line 180 def self.revision(arg = T.unsafe(nil)); end |
.service(&block) ⇒ 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.
Service can be used to define services.
This method evaluates the DSL specified in the service block of the
Formula (if it exists) and sets the instance variables of a Service
object accordingly. This is used by brew install
to generate a service file.
service do
run [opt_bin/"foo"]
end
3723 3724 3725 3726 3727 |
# File 'formula.rb', line 3723 def service(&block) return @service_block unless block @service_block = block end |
.sha256(val) ⇒ 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.
To verify the cached download’s integrity and security we verify the
SHA-256 hash matches what we’ve declared in the Formula. To quickly fill
this value you can leave it blank and run brew fetch --force
and it’ll
tell you the currently valid value.
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
3333 3334 3335 |
# File 'formula.rb', line 3333 def sha256(val) stable.sha256(val) end |
.skip_clean_paths ⇒ Object (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.
3232 3233 3234 |
# File 'formula.rb', line 3232 def skip_clean_paths @skip_clean_paths end |
.stable(&block) ⇒ 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.
Allows adding depends_on and Patches just to the stable SoftwareSpec. This is required instead of using a conditional. It is preferable to also pull the url and sha256 into the block if one is added.
stable do
url "https://example.com/foo-1.0.tar.gz"
sha256 "2a2ba417eebaadcb4418ee7b12fe2998f26d6e6f7fda7983412ff66a741ab6f7"
depends_on "libxml2"
depends_on "libffi"
end
3392 3393 3394 3395 3396 |
# File 'formula.rb', line 3392 def stable(&block) return @stable unless block @stable.instance_eval(&block) end |
.url(val, specs = {}) ⇒ 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.
The URL used to download the source for the stable version of the formula.
We prefer https
for security and proxy reasons.
If not inferable, specify the download strategy with using: ...
.
:git
,:hg
,:svn
,:bzr
,:fossil
,:cvs
,:curl
(normal file download, will also extract):nounzip
(without extracting):post
(download via an HTTP POST)
url "https://packed.sources.and.we.prefer.https.example.com/archive-1.2.3.tar.bz2"
url "https://some.dont.provide.archives.example.com",
using: :git,
tag: "1.2.3",
revision: "db8e4de5b2d6653f66aea53094624468caad15d2"
3292 3293 3294 |
# File 'formula.rb', line 3292 def url(val, specs = {}) stable.url(val, specs) end |
.version(val = nil) ⇒ 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.
The version string for the stable version of the formula. The version is autodetected from the URL and/or tag so only needs to be declared if it cannot be autodetected correctly.
version "1.2-final"
3304 3305 3306 |
# File 'formula.rb', line 3304 def version(val = nil) stable.version(val) end |
.version_scheme(arg = T.unsafe(nil)) ⇒ 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.
183 |
# File 'sorbet/rbi/parlour.rbi', line 183 def self.version_scheme(arg = T.unsafe(nil)); end |
Instance Attribute Details
#active_log_type ⇒ 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.
When performing a build, test, or other loggable action, indicates which log file location to use.
187 188 189 |
# File 'formula.rb', line 187 def active_log_type @active_log_type end |
#active_spec=(spec_sym) ⇒ 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.
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'formula.rb', line 259 def active_spec=(spec_sym) spec = send(spec_sym) raise FormulaSpecificationError, "#{spec_sym} spec is not available for #{full_name}" unless spec old_spec_sym = @active_spec_sym @active_spec = spec @active_spec_sym = spec_sym validate_attributes! @build = active_spec.build return if spec_sym == old_spec_sym Dependency.clear_cache Requirement.clear_cache end |
#active_spec_sym ⇒ 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.
A symbol to indicate currently active SoftwareSpec. It’s either :stable or :head
152 153 154 |
# File 'formula.rb', line 152 def active_spec_sym @active_spec_sym end |
#alias_name ⇒ 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.
The name of the alias that was used to identify this Formula.
e.g. another-name-for-this-formula
93 94 95 |
# File 'formula.rb', line 93 def alias_name @alias_name end |
#alias_path ⇒ Pathname? (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.
The path to the alias that was used to identify this Formula.
e.g. /usr/local/Library/Taps/homebrew/homebrew-core/Aliases/another-name-for-this-formula
88 89 90 |
# File 'formula.rb', line 88 def alias_path @alias_path end |
#build ⇒ BuildOptions, Tab
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.
The BuildOptions or Tab for this Formula. Lists the arguments passed and any options in the Formula. Note that these may differ at different times during the installation of a Formula. This is annoying but the result of state that we’re trying to eliminate.
194 195 196 |
# File 'formula.rb', line 194 def build @build end |
#buildpath ⇒ Pathname? (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.
The current working directory during builds.
Will only be non-nil
inside #install.
172 173 174 |
# File 'formula.rb', line 172 def buildpath @buildpath end |
#follow_installed_alias ⇒ Boolean Also known as: follow_installed_alias?
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.
Whether this formula should be considered outdated if the target of the alias it was installed with has since changed. Defaults to true.
200 201 202 |
# File 'formula.rb', line 200 def follow_installed_alias @follow_installed_alias end |
#force_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.
Whether or not to force the use of a bottle.
206 207 208 |
# File 'formula.rb', line 206 def force_bottle @force_bottle end |
#full_alias_name ⇒ 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.
The fully-qualified alias referring to this Formula.
For core formulae it’s the same as #alias_name.
e.g. homebrew/tap-name/another-name-for-this-formula
107 108 109 |
# File 'formula.rb', line 107 def full_alias_name @full_alias_name end |
#full_name ⇒ String (readonly)
101 102 103 |
# File 'formula.rb', line 101 def full_name @full_name end |
#head ⇒ SoftwareSpec? (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.
The HEAD SoftwareSpec for this Formula.
Installed when using brew install --HEAD
.
This is always installed with the version HEAD
and taken from the latest
commit in the version control system.
nil
if there is no HEAD version.
139 140 141 |
# File 'formula.rb', line 139 def head @head end |
#local_bottle_path ⇒ Pathname?
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.
When installing a bottle (binary package) from a local path this will be
set to the full path to the bottle tarball. If not, it will be nil
.
182 183 184 |
# File 'formula.rb', line 182 def local_bottle_path @local_bottle_path end |
#name ⇒ String (readonly)
The name of this Formula.
e.g. this-formula
83 84 85 |
# File 'formula.rb', line 83 def name @name end |
#path ⇒ Pathname (readonly)
The full path to this Formula.
e.g. /usr/local/Library/Taps/homebrew/homebrew-core/Formula/t/this-formula.rb
114 115 116 |
# File 'formula.rb', line 114 def path @path end |
#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.
Used for creating new Homebrew versions of software without new upstream versions.
162 163 164 |
# File 'formula.rb', line 162 def revision @revision end |
#source_modified_time ⇒ Time? (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.
most recent modified time for source files
156 157 158 |
# File 'formula.rb', line 156 def source_modified_time @source_modified_time end |
#stable ⇒ SoftwareSpec? (readonly)
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
The stable (and default) SoftwareSpec for this Formula. This contains all the attributes (e.g. URL, checksum) that apply to the stable version of this formula.
129 130 131 |
# File 'formula.rb', line 129 def stable @stable end |
#tap ⇒ Tap? (readonly)
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
The Tap instance associated with this Formula.
If it’s nil
, then this formula is loaded from a path or URL.
121 122 123 |
# File 'formula.rb', line 121 def tap @tap end |
#testpath ⇒ Pathname? (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.
The current working directory during tests.
Will only be non-nil
inside test.
177 178 179 |
# File 'formula.rb', line 177 def testpath @testpath end |
#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.
Used to change version schemes for packages.
167 168 169 |
# File 'formula.rb', line 167 def version_scheme @version_scheme end |
Class Method Details
.[](name) ⇒ 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.
2090 2091 2092 |
# File 'formula.rb', line 2090 def self.[](name) Formulary.factory(name) end |
.alias_full_names ⇒ 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.
an array of all aliases as fully-qualified names
2080 2081 2082 |
# File 'formula.rb', line 2080 def self.alias_full_names @alias_full_names ||= core_aliases + tap_aliases end |
.aliases ⇒ 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.
an array of all aliases
2075 2076 2077 |
# File 'formula.rb', line 2075 def self.aliases @aliases ||= (core_aliases + tap_aliases.map { |name| name.split("/").last }).uniq.sort end |
.all(eval_all: false) ⇒ 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.
an array of all Formula
this should only be used when users specify --all
to a command
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 |
# File 'formula.rb', line 2011 def self.all(eval_all: false) if !eval_all && !Homebrew::EnvConfig.eval_all? raise ArgumentError, "Formula#all without `--eval-all` or HOMEBREW_EVAL_ALL" end (core_names + tap_files).filter_map do |name_or_file| Formulary.factory(name_or_file) rescue FormulaUnavailableError, FormulaUnreadableError => e # Don't let one broken formula break commands. But do complain. onoe "Failed to import: #{name_or_file}" $stderr.puts e nil end end |
.build ⇒ 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.
3365 3366 3367 |
# File 'formula.rb', line 3365 def build stable.build end |
.build_flags ⇒ 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.
Get the BUILD_FLAGS
from the formula’s namespace set in Formulary::load_formula
.
3370 3371 3372 3373 3374 3375 3376 |
# File 'formula.rb', line 3370 def build_flags namespace = T.must(to_s.split("::")[0..-2]).join("::") return [] if namespace.empty? mod = const_get(namespace) mod.const_get(:BUILD_FLAGS) end |
.conflicts_with(*names) ⇒ Object
One or more formulae that conflict with this one and why.
conflicts_with "imagemagick", because: "both install `convert` binaries"
3571 3572 3573 3574 |
# File 'formula.rb', line 3571 def conflicts_with(*names) opts = names.last.is_a?(Hash) ? names.pop : {} names.each { |name| conflicts << FormulaConflict.new(name, opts[:because]) } end |
.core_alias_files ⇒ 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.
an array of all alias files of core Formula
2060 2061 2062 |
# File 'formula.rb', line 2060 def self.core_alias_files CoreTap.instance.alias_files end |
.core_aliases ⇒ 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.
an array of all core aliases
2065 2066 2067 |
# File 'formula.rb', line 2065 def self.core_aliases CoreTap.instance.aliases end |
.core_names ⇒ 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.
an array of all core Formula names
1985 1986 1987 |
# File 'formula.rb', line 1985 def self.core_names CoreTap.instance.formula_names end |
.cxxstdlib_check(check_type) ⇒ Object
Pass :skip
to this method to disable post-install stdlib checking.
3611 3612 3613 |
# File 'formula.rb', line 3611 def cxxstdlib_check(check_type) define_method(:skip_cxxstdlib_check?) { true } if check_type == :skip end |
.depends_on(dep) ⇒ Object
The dependencies for this formula. Use strings for the names of other
formulae. Homebrew provides some :special
Requirements for stuff
that needs extra handling (often changing some ENV vars or
deciding whether to use the system provided version).
:build
means this dependency is only needed during build.
depends_on "cmake" => :build
:test
means this dependency is only needed during testing.
depends_on "node" => :test
:recommended
dependencies are built by default.
But a --without-...
option is generated to opt-out.
depends_on "readline" => :recommended
:optional
dependencies are NOT built by default unless the
auto-generated --with-...
option is passed.
depends_on "glib" => :optional
If you need to specify that another formula has to be built with/out
certain options (note, no --
needed before the option):
depends_on "zeromq" => "with-pgm"
depends_on "qt" => ["with-qtdbus", "developer"] # Multiple options.
Optional and enforce that “boost” is built using --with-c++11
.
depends_on "boost" => [:optional, "with-c++11"]
If a dependency is only needed in certain cases:
depends_on "sqlite" if MacOS.version >= :catalina
depends_on xcode: :build # If the formula really needs full Xcode to compile.
depends_on macos: :mojave # Needs at least macOS Mojave (10.14) to run.
It is possible to only depend on something if
build.with?
or build.without? "another_formula"
:
depends_on "postgresql" if build.without? "sqlite"
3479 3480 3481 |
# File 'formula.rb', line 3479 def depends_on(dep) specs.each { |spec| spec.depends_on(dep) } end |
.deprecate!(date:, because:) ⇒ Object
Deprecates a Formula (on the given date) so a warning is shown on each installation. If the date has not yet passed the formula will not be deprecated.
deprecate! date: "2020-08-27", because: :unmaintained
deprecate! date: "2020-08-27", because: "has been replaced by foo"
3791 3792 3793 3794 3795 3796 3797 |
# File 'formula.rb', line 3791 def deprecate!(date:, because:) @deprecation_date = Date.parse(date) return if @deprecation_date > Date.today @deprecation_reason = because @deprecated = true end |
.deprecated? ⇒ 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.
Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.
3803 3804 3805 |
# File 'formula.rb', line 3803 def deprecated? @deprecated == true end |
.disable!(date:, because:) ⇒ Object
Disables a Formula (on the given date) so it cannot be installed. If the date has not yet passed the formula will be deprecated instead of disabled.
disable! date: "2020-08-27", because: :does_not_build
disable! date: "2020-08-27", because: "has been replaced by foo"
3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 |
# File 'formula.rb', line 3828 def disable!(date:, because:) @disable_date = Date.parse(date) if @disable_date > Date.today @deprecation_reason = because @deprecated = true return end @disable_reason = because @disabled = true end |
.disabled? ⇒ 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.
Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.
3845 3846 3847 |
# File 'formula.rb', line 3845 def disabled? @disabled == true end |
.fails_with(compiler, &block) ⇒ Object
Marks the Formula as failing with a particular compiler so it will fall back to others. For Apple compilers, this should be in the format:
fails_with :clang do
build 600
cause "multiple configure and compile errors"
end
The block may be omitted, and if present the build may be omitted; if so, then the compiler will not be allowed for all versions.
major_version
should be the major release number only, for instance
‘7’ for the GCC 7 series (7.0, 7.1, etc.).
If version
or the block is omitted, then the compiler will
not be allowed for all compilers in that series.
For example, if a bug is only triggered on GCC 7.1 but is not encountered on 7.2:
fails_with :gcc => '7' do
version '7.1'
end
3638 3639 3640 |
# File 'formula.rb', line 3638 def fails_with(compiler, &block) specs.each { |spec| spec.fails_with(compiler, &block) } end |
.freeze ⇒ 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.
3089 3090 3091 3092 3093 3094 3095 3096 |
# File 'formula.rb', line 3089 def freeze specs.each(&:freeze) @livecheck.freeze @conflicts.freeze @skip_clean_paths.freeze @link_overwrite_paths.freeze super end |
.full_names ⇒ 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.
an array of all Formula names, which the tap formulae have the fully-qualified name
2005 2006 2007 |
# File 'formula.rb', line 2005 def self.full_names @full_names ||= core_names + tap_names end |
.fuzzy_search(name) ⇒ 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 a list of approximately matching formula names, but not the complete match
2085 2086 2087 2088 |
# File 'formula.rb', line 2085 def self.fuzzy_search(name) @spell_checker ||= DidYouMean::SpellChecker.new(dictionary: Set.new(names + full_names).to_a) @spell_checker.correct(name) end |
.go_resource(name, &block) ⇒ Object
3436 3437 3438 3439 |
# File 'formula.rb', line 3436 def go_resource(name, &block) # odeprecated "Formula#go_resource", "Go modules" specs.each { |spec| spec.go_resource(name, &block) } end |
.inherited(child) ⇒ 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.
Initialise instance variables for each subclass. These need to be initialised before the class is frozen, and some DSL may never be called so it can’t be done lazily.
3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 |
# File 'formula.rb', line 3061 def inherited(child) super child.instance_eval do # Ensure this is synced with `freeze` @stable = SoftwareSpec.new(flags: build_flags) @head = HeadSoftwareSpec.new(flags: build_flags) @livecheck = Livecheck.new(self) @conflicts = [] @skip_clean_paths = Set.new @link_overwrite_paths = Set.new @loaded_from_api = false @network_access_allowed = SUPPORTED_NETWORK_ACCESS_PHASES.to_h do |phase| [phase, DEFAULT_NETWORK_ACCESS_ALLOWED] end end end |
.installed ⇒ 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.
An array of all installed Formula
2045 2046 2047 2048 2049 2050 2051 |
# File 'formula.rb', line 2045 def self.installed Formula.cache[:installed] ||= racks.flat_map do |rack| Formulary.from_rack(rack) rescue [] end.uniq(&:name) end |
.installed_formula_names ⇒ 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.
An array of all currently installed formula names.
2040 2041 2042 |
# File 'formula.rb', line 2040 def self.installed_formula_names racks.map { |rack| rack.basename.to_s } end |
.installed_with_alias_path(alias_path) ⇒ 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.
2053 2054 2055 2056 2057 |
# File 'formula.rb', line 2053 def self.installed_with_alias_path(alias_path) return [] if alias_path.nil? installed.select { |f| f.installed_alias_path == alias_path } end |
.keg_only(reason, explanation = "") ⇒ Object
Software that will not be symlinked into the brew --prefix
and will
only live in its Cellar. Other formulae can depend on it and Homebrew
will add the necessary includes, libraries, and other paths while
building that other formula.
Keg-only formulae are not in your PATH and are not seen by compilers if you build your own software outside of Homebrew. This way, we don’t shadow software provided by macOS.
keg_only :provided_by_macos
keg_only :versioned_formulae
keg_only "because I want it so"
3604 3605 3606 |
# File 'formula.rb', line 3604 def keg_only(reason, explanation = "") @keg_only_reason = KegOnlyReason.new(reason, explanation) end |
.link_overwrite(*paths) ⇒ 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.
Permit overwriting certain files while linking.
Sometimes we accidentally install files outside prefix. Once we fix that, users will get a link conflict error. Overwrite those files with:
link_overwrite "bin/foo", "lib/bar"
link_overwrite "share/man/man1/baz-*"
3867 3868 3869 3870 |
# File 'formula.rb', line 3867 def link_overwrite(*paths) paths.flatten! link_overwrite_paths.merge(paths) end |
.livecheckable? ⇒ 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.
Whether a livecheck specification is defined or not. It returns true when a livecheck block is present in the Formula and false otherwise, and is used by livecheck.
3220 3221 3222 |
# File 'formula.rb', line 3220 def livecheckable? @livecheckable == true end |
.loaded_from_api? ⇒ 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.
168 |
# File 'sorbet/rbi/parlour.rbi', line 168 def self.loaded_from_api?; end |
.names ⇒ 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.
an array of all Formula names
2000 2001 2002 |
# File 'formula.rb', line 2000 def self.names @names ||= (core_names + tap_names.map { |name| name.split("/").last }).uniq.sort end |
.needs(*standards) ⇒ Object
Marks the Formula as needing a certain standard, so Homebrew will fall back to other compilers if the default compiler does not implement that standard.
We generally prefer to depends_on a desired compiler and to
explicitly use that compiler in a formula’s #install block,
rather than implicitly finding a suitable compiler with needs
.
3653 3654 3655 |
# File 'formula.rb', line 3653 def needs(*standards) specs.each { |spec| spec.needs(*standards) } end |
.network_access_allowed?(phase) ⇒ 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.
Whether the specified phase should be forced offline.
3197 3198 3199 3200 3201 3202 |
# File 'formula.rb', line 3197 def network_access_allowed?(phase) raise ArgumentError, "Unknown phase: #{phase}" unless SUPPORTED_NETWORK_ACCESS_PHASES.include?(phase) env_var = Homebrew::EnvConfig.send(:"formula_#{phase}_network") env_var.nil? ? @network_access_allowed[phase] : env_var == "allow" end |
.on_macos(&block) ⇒ 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.
This method is included by OnSystem
8 |
# File 'formula.rbi', line 8 def self.on_macos(&block); end |
.on_system_blocks_exist? ⇒ 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.
6 |
# File 'formula.rbi', line 6 def self.on_system_blocks_exist?; end |
.patch(strip = :p1, src = nil, &block) ⇒ Object
External patches can be declared using resource-style blocks.
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
A strip level of -p1
is assumed. It can be overridden using a symbol
argument:
patch :p0 do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
Patches can be declared in stable and head blocks. This form is preferred over using conditionals.
stable do
patch do
url "https://example.com/example_patch.diff"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
end
Embedded (__END__
) patches are declared like so:
patch :DATA
patch :p0, :DATA
Patches can also be embedded by passing a string. This makes it possible to provide multiple embedded patches while making only some of them conditional.
patch :p0, "..."
3563 3564 3565 |
# File 'formula.rb', line 3563 def patch(strip = :p1, src = nil, &block) specs.each { |spec| spec.patch(strip, src, &block) } end |
.pour_bottle?(only_if: nil, &block) ⇒ Boolean
Defines whether the Formula’s bottle can be used on the given Homebrew installation.
For example, if the bottle requires the Xcode CLT to be installed a Formula would declare:
pour_bottle? do
reason "The bottle needs the Xcode CLT to be installed."
satisfy { MacOS::CLT.installed? }
end
If satisfy
returns false
then a bottle will not be used and instead
the Formula will be built from source and reason
will be printed.
Alternatively, a preset reason can be passed as a symbol:
pour_bottle? only_if: :clt_installed
3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 |
# File 'formula.rb', line 3746 def pour_bottle?(only_if: nil, &block) @pour_bottle_check = PourBottleCheck.new(self) @pour_bottle_only_if = only_if if only_if.present? && block.present? raise ArgumentError, "Do not pass both a preset condition and a block to `pour_bottle?`" end block ||= case only_if when :clt_installed lambda do |_| on_macos do T.bind(self, PourBottleCheck) reason(+<<~EOS) The bottle needs the Apple Command Line Tools to be installed. You can install them, if desired, with: xcode-select --install EOS satisfy { MacOS::CLT.installed? } end end when :default_prefix lambda do |_| T.bind(self, PourBottleCheck) reason(+<<~EOS) The bottle (and many others) needs to be installed into #{Homebrew::DEFAULT_PREFIX}. EOS satisfy { HOMEBREW_PREFIX.to_s == Homebrew::DEFAULT_PREFIX } end else raise ArgumentError, "Invalid preset `pour_bottle?` condition" if only_if.present? end @pour_bottle_check.instance_eval(&block) end |
.racks ⇒ 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.
An array of all racks currently installed.
2028 2029 2030 2031 2032 2033 2034 2035 2036 |
# File 'formula.rb', line 2028 def self.racks Formula.cache[:racks] ||= if HOMEBREW_CELLAR.directory? HOMEBREW_CELLAR.subdirs.reject do |rack| rack.symlink? || rack.basename.to_s.start_with?(".") || rack.subdirs.empty? end else [] end end |
.resource(name, klass = Resource, &block) ⇒ Object
Additional downloads can be defined as resources and accessed in the install method. Resources can also be defined inside a stable or head block. This mechanism replaces ad-hoc “subformula” classes.
resource "additional_files" do
url "https://example.com/additional-stuff.tar.gz"
sha256 "c6bc3f48ce8e797854c4b865f6a8ff969867bbcaebd648ae6fd825683e59fef2"
end
3429 3430 3431 3432 3433 |
# File 'formula.rb', line 3429 def resource(name, klass = Resource, &block) specs.each do |spec| spec.resource(name, klass, &block) unless spec.resource_defined?(name) end 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.
Whether a service specification is defined or not. It returns true when a service block is present in the Formula and false otherwise, and is used by service.
3228 3229 3230 |
# File 'formula.rb', line 3228 def service? @service_block.present? end |
.skip_clean(*paths) ⇒ Object
Skip cleaning paths in a formula.
Sometimes the formula cleaner breaks things. Preserve cleaned paths with:
skip_clean "bin/foo", "lib/bar"
Keep .la files with:
skip_clean :la
3585 3586 3587 3588 3589 |
# File 'formula.rb', line 3585 def skip_clean(*paths) paths.flatten! # Specifying :all is deprecated and will become an error skip_clean_paths.merge(paths) end |
.spec_syms ⇒ 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.
3264 3265 3266 |
# File 'formula.rb', line 3264 def spec_syms [:stable, :head].freeze end |
.specs ⇒ 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.
A list of the stable and head SoftwareSpecs.
3269 3270 3271 3272 3273 |
# File 'formula.rb', line 3269 def specs spec_syms.map do |sym| send(sym) end.freeze end |
.tap_aliases ⇒ 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.
an array of all tap aliases
2070 2071 2072 |
# File 'formula.rb', line 2070 def self.tap_aliases @tap_aliases ||= Tap.reject(&:core_tap?).flat_map(&:aliases).sort end |
.tap_files ⇒ 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.
an array of all tap Formula files
1995 1996 1997 |
# File 'formula.rb', line 1995 def self.tap_files @tap_files ||= Tap.reject(&:core_tap?).flat_map(&:formula_files) end |
.tap_names ⇒ 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.
an array of all tap Formula names
1990 1991 1992 |
# File 'formula.rb', line 1990 def self.tap_names @tap_names ||= Tap.reject(&:core_tap?).flat_map(&:formula_names).sort end |
.test(&block) ⇒ Boolean
A test is required for new formulae and makes us happy. The block will create, run in and delete a temporary directory.
We want tests that don’t require any user input
and test the basic functionality of the application.
For example, foo build-foo input.foo
is a good test
and foo --version
or foo --help
are bad tests.
However, a bad test is better than no test at all.
(testpath/"test.file").write <<~EOS
writing some test file, if you need to
EOS
assert_equal "OK", shell_output("test_command test.file").strip
Need complete control over stdin, stdout?
require "open3"
Open3.popen3("#{bin}/example", "argument") do |stdin, stdout, _|
stdin.write("some text")
stdin.close
assert_equal "result", stdout.read
end
The test will fail if it returns false, or if an exception is raised.
Failed assertions and failed system
commands will raise exceptions.
3687 3688 3689 |
# File 'formula.rb', line 3687 def test(&block) define_method(:test, &block) end |
.uses_from_macos(dep, bounds = {}) ⇒ void
This method returns an undefined value.
Indicates use of dependencies provided by macOS.
On macOS this is a no-op (as we use the provided system libraries) unless
:since
specifies a minimum macOS version.
On Linux this will act as depends_on.
3495 3496 3497 |
# File 'formula.rb', line 3495 def uses_from_macos(dep, bounds = {}) specs.each { |spec| spec.uses_from_macos(dep, bounds) } end |
Instance Method Details
#<=>(other) ⇒ 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.
1678 1679 1680 1681 1682 |
# File 'formula.rb', line 1678 def <=>(other) return unless other.is_a?(Formula) name <=> other.name end |
#==(other) ⇒ Object Also known as: eql?
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.
1667 1668 1669 1670 1671 |
# File 'formula.rb', line 1667 def ==(other) self.class == other.class && name == other.name && active_spec_sym == other.active_spec_sym end |
#active_log_prefix ⇒ 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.
The prefix, if any, to use in filenames for logging current activity.
1118 1119 1120 1121 1122 1123 1124 |
# File 'formula.rb', line 1118 def active_log_prefix if active_log_type "#{active_log_type}." else "" end end |
#add_global_deps_to_spec(spec) ⇒ 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.
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'extend/os/linux/formula.rb', line 30 def add_global_deps_to_spec(spec) return unless DevelopmentTools.needs_build_formulae? @global_deps ||= begin dependency_collector = spec.dependency_collector = Set.new([ name, *aliases, *versioned_formulae_names, ]) [ dependency_collector.gcc_dep_if_needed(), dependency_collector.glibc_dep_if_needed(), ].compact.freeze end @global_deps.each { |dep| spec.dependency_collector.add(dep) } end |
#alias_changed? ⇒ 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.
Has the alias used to install the formula changed, or are different formulae already installed with this alias?
1627 1628 1629 |
# File 'formula.rb', line 1627 def alias_changed? installed_alias_target_changed? || supersedes_an_installed_formula? end |
#aliases ⇒ Array<String>
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
All aliases for the formula.
575 576 577 |
# File 'formula.rb', line 575 def aliases @aliases ||= tap&.alias_reverse_table&.dig(full_name)&.map { _1.split("/").last } || [] end |
#allow_network_access!(*args, **options, &block) ⇒ 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.
72 |
# File 'sorbet/rbi/parlour.rbi', line 72 def allow_network_access!(*args, **, &block); end |
#any_installed_keg ⇒ 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 a Keg for the opt_prefix or installed_prefix if they exist.
If not, return nil
.
2150 2151 2152 2153 2154 2155 |
# File 'formula.rb', line 2150 def any_installed_keg Formula.cache[:any_installed_keg] ||= {} Formula.cache[:any_installed_keg][full_name] ||= if (installed_prefix = any_installed_prefix) Keg.new(installed_prefix) end end |
#any_installed_prefix ⇒ Pathname?
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Get the path of any installed prefix.
2161 2162 2163 2164 2165 2166 2167 |
# File 'formula.rb', line 2161 def any_installed_prefix if optlinked? && opt_prefix.exist? opt_prefix elsif (latest_installed_prefix = installed_prefixes.last) latest_installed_prefix end end |
#any_installed_version ⇒ 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 the PkgVersion for this formula if it is installed.
If not, return nil
.
2171 2172 2173 |
# File 'formula.rb', line 2171 def any_installed_version any_installed_keg&.version end |
#any_version_installed? ⇒ 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.
If at least one version of Formula is installed.
637 638 639 |
# File 'formula.rb', line 637 def any_version_installed? installed_prefixes.any? { |keg| (keg/Tab::FILENAME).file? } end |
#bash_completion ⇒ Pathname
The directory where the formula’s Bash completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
1076 1077 1078 |
# File 'formula.rb', line 1076 def bash_completion prefix/"etc/bash_completion.d" end |
#bin ⇒ Pathname
The directory where the formula’s binaries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Need to install into the #bin but the makefile doesn’t mkdir -p prefix/bin
?
bin.mkpath
No make install
available?
bin.install "binary1"
770 771 772 |
# File 'formula.rb', line 770 def bin prefix/"bin" end |
#bottle ⇒ Bottle?
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.
The Bottle object for the currently active SoftwareSpec.
416 417 418 |
# File 'formula.rb', line 416 def bottle @bottle ||= Bottle.new(self, bottle_specification) if bottled? end |
#bottle_defined?(*args, **options, &block) ⇒ 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.
36 |
# File 'sorbet/rbi/parlour.rbi', line 36 def bottle_defined?(*args, **, &block); end |
#bottle_for_tag(tag = nil) ⇒ Bottle?
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.
The Bottle object for given tag.
422 423 424 |
# File 'formula.rb', line 422 def bottle_for_tag(tag = nil) Bottle.new(self, bottle_specification, tag) if bottled?(tag) end |
#bottle_hash(compact_for_api: false) ⇒ 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 the bottle information for a formula.
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 |
# File 'formula.rb', line 2468 def bottle_hash(compact_for_api: false) bottle_spec = T.must(stable).bottle_specification hash = {} hash["rebuild"] = bottle_spec.rebuild if !compact_for_api || !bottle_spec.rebuild.zero? hash["root_url"] = bottle_spec.root_url unless compact_for_api hash["files"] = {} bottle_spec.collector.each_tag do |tag| tag_spec = bottle_spec.collector.specification_for(tag, no_older_versions: true) os_cellar = tag_spec.cellar os_cellar = os_cellar.inspect if os_cellar.is_a?(Symbol) checksum = tag_spec.checksum.hexdigest file_hash = {} file_hash["cellar"] = os_cellar unless compact_for_api filename = Bottle::Filename.create(self, tag, bottle_spec.rebuild) path, = Utils::Bottles.path_resolved_basename(bottle_spec.root_url, name, checksum, filename) file_hash["url"] = "#{bottle_spec.root_url}/#{path}" end file_hash["sha256"] = checksum hash["files"][tag.to_sym] = file_hash end hash end |
#bottle_prefix ⇒ Pathname
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.
The directory used for as the prefix for #etc and #var files on
installation so, despite not being in HOMEBREW_CELLAR
, they are installed
there after pouring a bottle.
1106 1107 1108 |
# File 'formula.rb', line 1106 def bottle_prefix prefix/".bottle" end |
#bottle_specification(*args, **options, &block) ⇒ 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.
45 |
# File 'sorbet/rbi/parlour.rbi', line 45 def bottle_specification(*args, **, &block); end |
#bottle_tab_attributes ⇒ Hash
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.
2962 2963 2964 2965 2966 |
# File 'formula.rb', line 2962 def bottle_tab_attributes return {} unless bottled? T.must(bottle).tab_attributes end |
#bottle_tag?(*args, **options, &block) ⇒ 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.
39 |
# File 'sorbet/rbi/parlour.rbi', line 39 def bottle_tag?(*args, **, &block); end |
#bottled?(*args, **options, &block) ⇒ 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.
42 |
# File 'sorbet/rbi/parlour.rbi', line 42 def bottled?(*args, **, &block); end |
#brew(fetch: true, keep_tmp: false, debug_symbols: false, interactive: false) ⇒ 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.
Yields |self,staging| with current working directory set to the uncompressed tarball where staging is a Mktemp staging context.
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 |
# File 'formula.rb', line 1495 def brew(fetch: true, keep_tmp: false, debug_symbols: false, interactive: false) @prefix_returns_versioned_prefix = true active_spec.fetch if fetch stage(interactive:, debug_symbols:) do |staging| staging.retain! if keep_tmp || debug_symbols prepare_patches fetch_patches if fetch begin yield self, staging rescue staging.retain! if interactive || debug? raise ensure %w[ config.log CMakeCache.txt CMakeOutput.log CMakeError.log meson-log.txt ].each do |logfile| Dir["**/#{logfile}"].each do |logpath| destdir = logs/File.dirname(logpath) mkdir_p destdir cp logpath, destdir end end end end ensure @prefix_returns_versioned_prefix = false end |
#cached_download(*args, **options, &block) ⇒ 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.
102 |
# File 'sorbet/rbi/parlour.rbi', line 102 def cached_download(*args, **, &block); end |
#caveats ⇒ 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.
Warn the user about any Homebrew-specific issues or quirks for this package. These should not contain setup instructions that would apply to installation through a different package manager on a different OS.
def caveats
<<~EOS
Are optional. Something the user must be warned about?
EOS
end
def caveats
s = <<~EOS
Print some important notice to the user when `brew info [formula]` is
called or when brewing a formula.
This is optional. You can use all the vars like #{version} here.
EOS
s += "Some issue only on older systems" if MacOS.version < :el_capitan
s
end
1372 1373 1374 |
# File 'formula.rb', line 1372 def caveats nil end |
#caveats_with_placeholders ⇒ 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.
2546 2547 2548 2549 |
# File 'formula.rb', line 2546 def caveats_with_placeholders caveats&.gsub(HOMEBREW_PREFIX, HOMEBREW_PREFIX_PLACEHOLDER) &.gsub(HOMEBREW_CELLAR, HOMEBREW_CELLAR_PLACEHOLDER) end |
#clear_cache(*args, **options, &block) ⇒ 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.
105 |
# File 'sorbet/rbi/parlour.rbi', line 105 def clear_cache(*args, **, &block); end |
#compiler_failures(*args, **options, &block) ⇒ 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.
120 |
# File 'sorbet/rbi/parlour.rbi', line 120 def compiler_failures(*args, **, &block); end |
#conflicts(*args, **options, &block) ⇒ 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.
165 |
# File 'sorbet/rbi/parlour.rbi', line 165 def conflicts(*args, **, &block); end |
#core_formula? ⇒ 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.
True if this formula is provided by Homebrew itself
2096 2097 2098 |
# File 'formula.rb', line 2096 def core_formula? !!tap&.core_tap? end |
#current_installed_alias_target ⇒ 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.
1604 1605 1606 |
# File 'formula.rb', line 1604 def current_installed_alias_target Formulary.factory(T.must(installed_alias_name)) if installed_alias_path end |
#declared_deps(*args, **options, &block) ⇒ 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.
90 |
# File 'sorbet/rbi/parlour.rbi', line 90 def declared_deps(*args, **, &block); end |
#deny_network_access!(*args, **options, &block) ⇒ 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.
75 |
# File 'sorbet/rbi/parlour.rbi', line 75 def deny_network_access!(*args, **, &block); end |
#dependencies_hash ⇒ 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.
2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 |
# File 'formula.rb', line 2551 def dependencies_hash # Create a hash of spec names (stable/head) to the list of dependencies under each dependencies = self.class.spec_syms.to_h do |sym| [sym, send(sym)&.declared_deps] end dependencies.transform_values! { |deps| deps&.reject(&:implicit?) } # Remove all implicit deps from all lists hash = {} dependencies.each do |spec_sym, spec_deps| next if spec_deps.nil? dep_hash = if spec_sym == :stable hash else next if spec_deps == dependencies[:stable] hash["#{spec_sym}_dependencies"] ||= {} end dep_hash["build_dependencies"] = spec_deps.select(&:build?) .reject(&:uses_from_macos?) .map(&:name) .uniq dep_hash["dependencies"] = spec_deps.reject(&:optional?) .reject(&:recommended?) .reject(&:build?) .reject(&:test?) .reject(&:uses_from_macos?) .map(&:name) .uniq dep_hash["test_dependencies"] = spec_deps.select(&:test?) .reject(&:uses_from_macos?) .map(&:name) .uniq dep_hash["recommended_dependencies"] = spec_deps.select(&:recommended?) .reject(&:uses_from_macos?) .map(&:name) .uniq dep_hash["optional_dependencies"] = spec_deps.select(&:optional?) .reject(&:uses_from_macos?) .map(&:name) .uniq uses_from_macos_deps = spec_deps.select(&:uses_from_macos?).uniq dep_hash["uses_from_macos"] = uses_from_macos_deps.map do |dep| if dep..length >= 2 { dep.name => dep. } elsif dep..present? { dep.name => dep..first } else dep.name end end dep_hash["uses_from_macos_bounds"] = uses_from_macos_deps.map(&:bounds) end hash end |
#deprecated? ⇒ 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.
Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.
1439 |
# File 'formula.rb', line 1439 delegate deprecated?: :"self.class" |
#deprecated_flags(*args, **options, &block) ⇒ 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.
114 |
# File 'sorbet/rbi/parlour.rbi', line 114 def deprecated_flags(*args, **, &block); end |
#deprecated_options(*args, **options, &block) ⇒ 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.
111 |
# File 'sorbet/rbi/parlour.rbi', line 111 def (*args, **, &block); end |
#deprecation_date ⇒ 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.
The date that this Formula was or becomes deprecated.
Returns nil
if no date is specified.
1446 |
# File 'formula.rb', line 1446 delegate deprecation_date: :"self.class" |
#deprecation_reason ⇒ 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.
The reason this Formula is deprecated.
Returns nil
if no reason is specified or the formula is not deprecated.
1453 |
# File 'formula.rb', line 1453 delegate deprecation_reason: :"self.class" |
#deps(*args, **options, &block) ⇒ 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.
87 |
# File 'sorbet/rbi/parlour.rbi', line 87 def deps(*args, **, &block); end |
#desc ⇒ 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.
The description of the software.
429 |
# File 'formula.rb', line 429 delegate desc: :"self.class" |
#deuniversalize_machos(*targets) ⇒ 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.
Replaces a universal binary with its native slice.
If called with no parameters, does this with all compatible universal binaries in a Formula’s Keg.
27 |
# File 'extend/os/linux/formula.rb', line 27 def deuniversalize_machos(*targets); end |
#disable_date ⇒ 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.
The date that this Formula was or becomes disabled.
Returns nil
if no date is specified.
1467 |
# File 'formula.rb', line 1467 delegate disable_date: :"self.class" |
#disable_reason ⇒ 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.
The reason this Formula is disabled.
Returns nil
if no reason is specified or the formula is not disabled.
1474 |
# File 'formula.rb', line 1474 delegate disable_reason: :"self.class" |
#disabled? ⇒ 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.
Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.
1460 |
# File 'formula.rb', line 1460 delegate disabled?: :"self.class" |
#doc ⇒ Pathname
The directory where the formula’s documentation should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
780 781 782 |
# File 'formula.rb', line 780 def doc share/"doc"/name end |
#downloader(*args, **options, &block) ⇒ 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.
48 |
# File 'sorbet/rbi/parlour.rbi', line 48 def downloader(*args, **, &block); end |
#eligible_kegs_for_cleanup(quiet: false) ⇒ 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.
2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 |
# File 'formula.rb', line 2881 def eligible_kegs_for_cleanup(quiet: false) eligible_for_cleanup = [] if latest_version_installed? eligible_kegs = if head? && (head_prefix = latest_head_prefix) head, stable = installed_kegs.partition { |k| k.version.head? } # Remove newest head and stable kegs head - [Keg.new(head_prefix)] + stable.sort_by(&:scheme_and_version).slice(0...-1) else installed_kegs.select do |keg| tab = Tab.for_keg(keg) if version_scheme > tab.version_scheme true elsif version_scheme == tab.version_scheme pkg_version > keg.version else false end end end unless eligible_kegs.empty? eligible_kegs.each do |keg| if keg.linked? opoo "Skipping (old) #{keg} due to it being linked" unless quiet elsif pinned? && keg == Keg.new(@pin.path.resolved_path) opoo "Skipping (old) #{keg} due to it being pinned" unless quiet else eligible_for_cleanup << keg end end end elsif !installed_prefixes.empty? && !pinned? # If the cellar only has one version installed, don't complain # that we can't tell which one to keep. Don't complain at all if the # only installed version is a pinned formula. opoo "Skipping #{full_name}: most recent version #{pkg_version} not installed" unless quiet end eligible_for_cleanup end |
#elisp ⇒ Pathname
The directory where Emacs Lisp files should be installed, with the formula name appended to avoid linking conflicts.
To install an Emacs mode included with a software package:
elisp.install "contrib/emacs/example-mode.el"
988 989 990 |
# File 'formula.rb', line 988 def elisp prefix/"share/emacs/site-lisp"/name end |
#env(*args, **options, &block) ⇒ 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.
162 |
# File 'sorbet/rbi/parlour.rbi', line 162 def env(*args, **, &block); end |
#etc ⇒ Pathname
The directory where the formula’s configuration files should be installed.
Anything using etc.install
will not overwrite other files on e.g. upgrades
but will write a new file named *.default
.
This directory is not inside the HOMEBREW_CELLAR
so it persists
across upgrades.
1022 1023 1024 |
# File 'formula.rb', line 1022 def etc (HOMEBREW_PREFIX/"etc").extend(InstallRenamed) end |
#fetch(verify_download_integrity: true) ⇒ 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.
2615 2616 2617 |
# File 'formula.rb', line 2615 def fetch(verify_download_integrity: true) active_spec.fetch(verify_download_integrity:) end |
#fetch_bottle_tab ⇒ 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.
2955 2956 2957 2958 2959 |
# File 'formula.rb', line 2955 def fetch_bottle_tab return unless bottled? T.must(bottle).fetch_tab end |
#fetch_patches ⇒ 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.
2950 2951 2952 |
# File 'formula.rb', line 2950 def fetch_patches patchlist.select(&:external?).each(&:fetch) end |
#fish_completion ⇒ Pathname
The directory where the formula’s fish completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
1098 1099 1100 |
# File 'formula.rb', line 1098 def fish_completion share/"fish/vendor_completions.d" end |
#fish_function ⇒ Pathname
The directory where the formula’s fish function files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
1065 1066 1067 |
# File 'formula.rb', line 1065 def fish_function share/"fish/vendor_functions.d" end |
#frameworks ⇒ Pathname
The directory where the formula’s Frameworks should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
This is not symlinked into HOMEBREW_PREFIX
.
999 1000 1001 |
# File 'formula.rb', line 999 def frameworks prefix/"Frameworks" end |
#full_installed_alias_name ⇒ 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.
352 353 354 |
# File 'formula.rb', line 352 def full_installed_alias_name full_name_with_optional_tap(installed_alias_name) end |
#full_installed_specified_name ⇒ 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.
The name (including tap) specified to install this formula.
383 384 385 |
# File 'formula.rb', line 383 def full_installed_specified_name full_installed_alias_name || full_name end |
#full_specified_name ⇒ 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.
The name (including tap) specified to find this formula.
373 374 375 |
# File 'formula.rb', line 373 def full_specified_name full_alias_name || full_name end |
#generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) ⇒ 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.
Generate shell completions for a formula for bash, zsh, and fish, using the formula’s executable.
1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 |
# File 'formula.rb', line 1942 def generate_completions_from_executable(*commands, base_name: name, shells: [:bash, :zsh, :fish], shell_parameter_format: nil) completion_script_path_map = { bash: bash_completion/base_name, zsh: zsh_completion/"_#{base_name}", fish: fish_completion/"#{base_name}.fish", } shells.each do |shell| popen_read_env = { "SHELL" => shell.to_s } script_path = completion_script_path_map[shell] shell_parameter = if shell_parameter_format.nil? shell.to_s elsif shell_parameter_format == :flag "--#{shell}" elsif shell_parameter_format == :arg "--shell=#{shell}" elsif shell_parameter_format == :none nil elsif shell_parameter_format == :click prog_name = File.basename(commands.first.to_s).upcase.tr("-", "_") popen_read_env["_#{prog_name}_COMPLETE"] = "#{shell}_source" nil else "#{shell_parameter_format}#{shell}" end popen_read_args = %w[] popen_read_args << commands popen_read_args << shell_parameter if shell_parameter.present? popen_read_args.flatten! = {} [:err] = :err unless ENV["HOMEBREW_STDERR"] script_path.dirname.mkpath script_path.write Utils.safe_popen_read(popen_read_env, *popen_read_args, **) end end |
#hash ⇒ 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.
1674 1675 1676 |
# File 'formula.rb', line 1674 def hash name.hash 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.
Is the currently active SoftwareSpec a #head build?
395 396 397 |
# File 'formula.rb', line 395 def head? active_spec == head end |
#head_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.
Is this formula HEAD-only?
401 402 403 |
# File 'formula.rb', line 401 def head_only? !!head && !stable end |
#head_version_outdated?(version, fetch_head: false) ⇒ 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.
669 670 671 672 673 674 675 676 677 678 679 680 681 682 |
# File 'formula.rb', line 669 def head_version_outdated?(version, fetch_head: false) tab = Tab.for_keg(prefix(version)) return true if tab.version_scheme < version_scheme return true if stable && tab.stable_version && tab.stable_version < T.must(stable).version return false unless fetch_head return false unless head&.downloader.is_a?(VCSDownloadStrategy) downloader = T.must(head).downloader with_context quiet: true do downloader.commit_outdated?(version.version.commit) end end |
#homepage ⇒ 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.
The homepage for the software.
439 |
# File 'formula.rb', line 439 delegate homepage: :"self.class" |
#include ⇒ Pathname
The directory where the formula’s headers should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
include.install "example.h"
793 794 795 |
# File 'formula.rb', line 793 def include prefix/"include" end |
#info ⇒ Pathname
The directory where the formula’s info files should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
803 804 805 |
# File 'formula.rb', line 803 def info share/"info" end |
#inreplace(paths, before = nil, after = nil, audit_result = true, &block) ⇒ void
This method returns an undefined value.
Sometimes we have to change a bit before we install. Mostly we
prefer a patch, but if you need the prefix of
this formula in the patch you have to resort to inreplace
,
because in the patch you don’t have access to any variables
defined by the formula, as only HOMEBREW_PREFIX
is available
in the embedded patch.
inreplace
supports regular expressions:
inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"
inreplace
supports blocks:
inreplace "Makefile" do |s|
s.gsub! "/usr/local", HOMEBREW_PREFIX.to_s
end
2708 2709 2710 2711 2712 2713 |
# File 'formula.rb', line 2708 def inreplace(paths, before = nil, after = nil, audit_result = true, &block) # rubocop:disable Style/OptionalBooleanParameter Utils::Inreplace.inreplace(paths, before, after, audit_result:, &block) rescue Utils::Inreplace::Error => e onoe e.to_s raise BuildError.new(self, "inreplace", Array(paths), {}) end |
#install ⇒ 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.
This method is overridden in Formula subclasses to provide the installation instructions. The sources (from url) are downloaded, hash-checked and then Homebrew changes into a temporary directory where the archive is unpacked or repository cloned.
def install
system "./configure", "--prefix=#{prefix}"
system "make", "install"
end
2679 |
# File 'formula.rb', line 2679 def install; end |
#install_etc_var ⇒ 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.
1312 1313 1314 1315 1316 1317 1318 1319 |
# File 'formula.rb', line 1312 def install_etc_var etc_var_dirs = [bottle_prefix/"etc", bottle_prefix/"var"] Find.find(*etc_var_dirs.select(&:directory?)) do |path| path = Pathname.new(path) path.extend(InstallRenamed) path.cp_path_sub(bottle_prefix, HOMEBREW_PREFIX) end end |
#installed_alias_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.
348 349 350 |
# File 'formula.rb', line 348 def installed_alias_name installed_alias_path&.basename&.to_s end |
#installed_alias_path ⇒ Pathname?
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.
The alias path that was used to install this formula, if it exists. Can differ from #alias_path, which is the alias used to find the formula, and is specified to this instance.
335 336 337 338 339 340 341 342 343 344 345 |
# File 'formula.rb', line 335 def installed_alias_path build_tab = build path = build_tab.source["path"] if build_tab.is_a?(Tab) return unless path&.match?(%r{#{HOMEBREW_TAP_DIR_REGEX}/Aliases}o) path = Pathname(path) return unless path.symlink? path end |
#installed_alias_target_changed? ⇒ 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.
Has the target of the alias used to install this formula changed? Returns false if the formula wasn’t installed with an alias.
1611 1612 1613 1614 1615 1616 |
# File 'formula.rb', line 1611 def installed_alias_target_changed? target = current_installed_alias_target return false unless target target.name != name end |
#installed_kegs ⇒ 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.
All currently installed kegs.
754 755 756 |
# File 'formula.rb', line 754 def installed_kegs installed_prefixes.map { |dir| Keg.new(dir) } end |
#installed_prefixes ⇒ 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.
All currently installed prefix directories.
746 747 748 749 750 751 |
# File 'formula.rb', line 746 def installed_prefixes possible_names.map { |name| HOMEBREW_CELLAR/name } .select(&:directory?) .flat_map(&:subdirs) .sort_by(&:basename) end |
#installed_specified_name ⇒ 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.
The name specified to install this formula.
378 379 380 |
# File 'formula.rb', line 378 def installed_specified_name installed_alias_name || name end |
#keg_only? ⇒ Boolean
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Rarely, you don’t want your library symlinked into the main prefix.
See gettext.rb
for an example.
1382 1383 1384 1385 1386 |
# File 'formula.rb', line 1382 def keg_only? return false unless keg_only_reason keg_only_reason.applicable? end |
#keg_only_reason(*args, **options, &block) ⇒ 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.
126 |
# File 'sorbet/rbi/parlour.rbi', line 126 def keg_only_reason(*args, **, &block); end |
#kext_prefix ⇒ Pathname
The directory where the formula’s kernel extensions should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
This is not symlinked into HOMEBREW_PREFIX
.
1010 1011 1012 |
# File 'formula.rb', line 1010 def kext_prefix prefix/"Library/Extensions" end |
#latest_formula ⇒ 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.
If the alias has changed value, return the new formula. Otherwise, return self.
1633 1634 1635 |
# File 'formula.rb', line 1633 def latest_formula installed_alias_target_changed? ? current_installed_alias_target : self end |
#latest_head_prefix ⇒ 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.
664 665 666 667 |
# File 'formula.rb', line 664 def latest_head_prefix head_version = latest_head_version prefix(head_version) if head_version end |
#latest_head_version ⇒ 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.
653 654 655 656 657 658 659 660 661 662 |
# File 'formula.rb', line 653 def latest_head_version head_versions = installed_prefixes.filter_map do |pn| pn_pkgversion = PkgVersion.parse(pn.basename.to_s) pn_pkgversion if pn_pkgversion.head? end head_versions.max_by do |pn_pkgversion| [Tab.for_keg(prefix(pn_pkgversion)).source_modified_time, pn_pkgversion.revision] end end |
#latest_installed_prefix ⇒ 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.
The latest prefix for this formula. Checks for #head and then #stable’s #prefix
685 686 687 688 689 690 691 692 693 |
# File 'formula.rb', line 685 def latest_installed_prefix if head && (head_version = latest_head_version) && !head_version_outdated?(head_version) latest_head_prefix elsif stable && (stable_prefix = prefix(PkgVersion.new(T.must(stable).version, revision))).directory? stable_prefix else prefix end end |
#latest_version_installed? ⇒ 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.
If this Formula is installed. This is actually just a check for if the #latest_installed_prefix directory exists and is not empty.
631 632 633 |
# File 'formula.rb', line 631 def latest_version_installed? (dir = latest_installed_prefix).directory? && !dir.children.empty? end |
#launchd_service_path ⇒ Pathname
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.
The generated launchd service file path.
1182 1183 1184 |
# File 'formula.rb', line 1182 def launchd_service_path opt_prefix/"#{plist_name}.plist" end |
#lib ⇒ Pathname
The directory where the formula’s libraries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
lib.install "example.dylib"
816 817 818 |
# File 'formula.rb', line 816 def lib prefix/"lib" end |
#libexec ⇒ Pathname
The directory where the formula’s binaries should be installed.
This is not symlinked into HOMEBREW_PREFIX
.
It is commonly used to install files that we do not wish to be
symlinked into HOMEBREW_PREFIX
from one of the other directories and
instead manually create symlinks or wrapper scripts into e.g. #bin.
libexec.install "foo.jar"
bin.write_jar_script libexec/"foo.jar", "foo"
831 832 833 |
# File 'formula.rb', line 831 def libexec prefix/"libexec" end |
#license ⇒ 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.
The SPDX ID of the software license.
434 |
# File 'formula.rb', line 434 delegate license: :"self.class" |
#link_overwrite?(path) ⇒ 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.
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 |
# File 'formula.rb', line 1400 def link_overwrite?(path) # Don't overwrite files not created by Homebrew. return false if path.stat.uid != HOMEBREW_BREW_FILE.stat.uid # Don't overwrite files belong to other keg except when that # keg's formula is deleted. begin keg = Keg.for(path) rescue NotAKegError, Errno::ENOENT # file doesn't belong to any keg. else tab_tap = Tab.for_keg(keg).tap # this keg doesn't below to any core/tap formula, most likely coming from a DIY install. return false if tab_tap.nil? begin f = Formulary.factory(keg.name) rescue FormulaUnavailableError # formula for this keg is deleted, so defer to allowlist rescue TapFormulaAmbiguityError return false # this keg belongs to another formula else # this keg belongs to another unrelated formula return false unless f.possible_names.include?(keg.name) end end to_check = path.relative_path_from(HOMEBREW_PREFIX).to_s self.class.link_overwrite_paths.any? do |p| p == to_check || to_check.start_with?("#{p.chomp("/")}/") || /^#{Regexp.escape(p).gsub('\*', ".*?")}$/.match?(to_check) end end |
#linked? ⇒ Boolean
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Is the formula linked?
713 714 715 |
# File 'formula.rb', line 713 def linked? linked_keg.symlink? end |
#linked_keg ⇒ Object
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
The link status symlink directory for this Formula. You probably want #opt_prefix instead.
645 646 647 648 649 650 651 |
# File 'formula.rb', line 645 def linked_keg linked_keg = possible_names.map { |name| HOMEBREW_LINKED_KEGS/name } .find(&:directory?) return linked_keg if linked_keg.present? HOMEBREW_LINKED_KEGS/name end |
#linked_version ⇒ PkgVersion?
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.
PkgVersion of the linked keg for the formula.
732 733 734 735 736 |
# File 'formula.rb', line 732 def linked_version return unless linked? Keg.for(linked_keg).version end |
#livecheck ⇒ 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.
The livecheck specification for the software.
444 |
# File 'formula.rb', line 444 delegate livecheck: :"self.class" |
#livecheckable? ⇒ 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.
Is a livecheck specification defined for the software?
449 |
# File 'formula.rb', line 449 delegate livecheckable?: :"self.class" |
#loaded_from_api? ⇒ 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.
Whether this formula was loaded using the formulae.brew.sh API
473 |
# File 'formula.rb', line 473 delegate loaded_from_api?: :"self.class" |
#loader_path ⇒ 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.
22 23 24 |
# File 'extend/os/linux/formula.rb', line 22 def loader_path "$ORIGIN" end |
#lock ⇒ 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.
1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 |
# File 'formula.rb', line 1529 def lock @lock = FormulaLock.new(name) @lock.lock oldnames.each do |oldname| next unless (oldname_rack = HOMEBREW_CELLAR/oldname).exist? next if oldname_rack.resolved_path != rack oldname_lock = FormulaLock.new(oldname) oldname_lock.lock @oldname_locks << oldname_lock end end |
#logs ⇒ Pathname
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.
The directory where the formula’s installation or test logs will be written.
1112 1113 1114 |
# File 'formula.rb', line 1112 def logs HOMEBREW_LOGS + name end |
#man ⇒ Pathname
The root directory where the formula’s manual pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Often one of the more specific man
functions should be used instead,
e.g. #man1.
843 844 845 |
# File 'formula.rb', line 843 def man share/"man" end |
#man1 ⇒ Pathname
The directory where the formula’s man1 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
man1.install "example.1"
856 857 858 |
# File 'formula.rb', line 856 def man1 man/"man1" end |
#man2 ⇒ Pathname
The directory where the formula’s man2 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
866 867 868 |
# File 'formula.rb', line 866 def man2 man/"man2" end |
#man3 ⇒ Pathname
The directory where the formula’s man3 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
man3.install "man.3"
879 880 881 |
# File 'formula.rb', line 879 def man3 man/"man3" end |
#man4 ⇒ Pathname
The directory where the formula’s man4 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
889 890 891 |
# File 'formula.rb', line 889 def man4 man/"man4" end |
#man5 ⇒ Pathname
The directory where the formula’s man5 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
899 900 901 |
# File 'formula.rb', line 899 def man5 man/"man5" end |
#man6 ⇒ Pathname
The directory where the formula’s man6 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
909 910 911 |
# File 'formula.rb', line 909 def man6 man/"man6" end |
#man7 ⇒ Pathname
The directory where the formula’s man7 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
919 920 921 |
# File 'formula.rb', line 919 def man7 man/"man7" end |
#man8 ⇒ Pathname
The directory where the formula’s man8 pages should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
929 930 931 |
# File 'formula.rb', line 929 def man8 man/"man8" end |
#migration_needed? ⇒ 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.
1560 1561 1562 |
# File 'formula.rb', line 1560 def migration_needed? !oldnames_to_migrate.empty? && !rack.exist? end |
#missing_dependencies(hide: nil) ⇒ 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 a list of formulae depended on by this formula that aren’t installed.
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 |
# File 'formula.rb', line 2232 def missing_dependencies(hide: nil) hide ||= [] runtime_formula_dependencies.select do |f| hide.include?(f.name) || f.installed_prefixes.empty? end # If we're still getting unavailable formulae at this stage the best we can # do is just return no results. rescue FormulaUnavailableError [] end |
#mkdir(name, &block) ⇒ 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.
A version of FileUtils.mkdir
that also changes to that folder in
a block.
2931 2932 2933 2934 2935 2936 |
# File 'formula.rb', line 2931 def mkdir(name, &block) result = FileUtils.mkdir_p(name) return result unless block FileUtils.chdir(name, &block) end |
#mktemp(prefix = name, opts = {}, &block) ⇒ 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.
Create a temporary directory then yield. When the block returns,
recursively delete the temporary directory. Passing opts[:retain]
or calling do |staging| ... staging.retain!
in the block will skip
the deletion and retain the temporary directory’s contents.
2925 2926 2927 |
# File 'formula.rb', line 2925 def mktemp(prefix = name, opts = {}, &block) Mktemp.new(prefix, opts).run(&block) end |
#network_access_allowed?(*args, **options, &block) ⇒ 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.
78 |
# File 'sorbet/rbi/parlour.rbi', line 78 def network_access_allowed?(*args, **, &block); end |
#new_formula_available? ⇒ 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.
1600 1601 1602 |
# File 'formula.rb', line 1600 def new_formula_available? installed_alias_target_changed? && !latest_formula.latest_version_installed? end |
#old_installed_formulae ⇒ 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.
1637 1638 1639 1640 1641 1642 1643 1644 |
# File 'formula.rb', line 1637 def old_installed_formulae # If this formula isn't the current target of the alias, # it doesn't make sense to say that other formulae are older versions of it # because we don't know which came first. return [] if alias_path.nil? || installed_alias_target_changed? self.class.installed_with_alias_path(alias_path).reject { |f| f.name == name } end |
#oldname ⇒ 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.
Use #oldnames instead.
An old name for the formula.
553 554 555 556 |
# File 'formula.rb', line 553 def oldname odisabled "Formula#oldname", "Formula#oldnames" @oldname ||= oldnames.first end |
#oldnames ⇒ Array<String>
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Old names for the formula.
562 563 564 565 566 567 568 569 |
# File 'formula.rb', line 562 def oldnames @oldnames ||= if (tap = self.tap) Tap.tap_migration_oldnames(tap, name) + tap.formula_reverse_renames.fetch(name, []) else [] end end |
#oldnames_to_migrate ⇒ 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.
1549 1550 1551 1552 1553 1554 1555 1556 1557 |
# File 'formula.rb', line 1549 def oldnames_to_migrate oldnames.select do |oldname| old_rack = HOMEBREW_CELLAR/oldname next false unless old_rack.directory? next false if old_rack.subdirs.empty? tap == Tab.for_keg(old_rack.subdirs.min).tap end end |
#on_system_blocks_exist? ⇒ 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.
2611 2612 2613 |
# File 'formula.rb', line 2611 def on_system_blocks_exist? self.class.on_system_blocks_exist? || @on_system_blocks_exist end |
#opt_bin ⇒ Pathname
Same as #bin, but relative to #opt_prefix instead of #prefix.
1221 1222 1223 |
# File 'formula.rb', line 1221 def opt_bin opt_prefix/"bin" end |
#opt_elisp ⇒ Pathname
Same as #elisp, but relative to #opt_prefix instead of #prefix.
1277 1278 1279 |
# File 'formula.rb', line 1277 def opt_elisp opt_prefix/"share/emacs/site-lisp"/name end |
#opt_frameworks ⇒ Pathname
Same as #frameworks, but relative to #opt_prefix instead of #prefix.
1285 1286 1287 |
# File 'formula.rb', line 1285 def opt_frameworks opt_prefix/"Frameworks" end |
#opt_include ⇒ Pathname
Same as #include, but relative to #opt_prefix instead of #prefix.
1229 1230 1231 |
# File 'formula.rb', line 1229 def opt_include opt_prefix/"include" end |
#opt_lib ⇒ Pathname
Same as #lib, but relative to #opt_prefix instead of #prefix.
1237 1238 1239 |
# File 'formula.rb', line 1237 def opt_lib opt_prefix/"lib" end |
#opt_libexec ⇒ Pathname
Same as #libexec, but relative to #opt_prefix instead of #prefix.
1245 1246 1247 |
# File 'formula.rb', line 1245 def opt_libexec opt_prefix/"libexec" end |
#opt_pkgshare ⇒ Pathname
Same as #pkgshare, but relative to #opt_prefix instead of #prefix.
1269 1270 1271 |
# File 'formula.rb', line 1269 def opt_pkgshare opt_prefix/"share"/name end |
#opt_prefix ⇒ Pathname
A stable path for this formula, when installed. Contains the formula name but no version number. Only the active version will be linked here if multiple versions are installed.
This is the preferred way to refer to a formula in plists or from another formula, as the path is stable even when the software is updated.
args << "--with-readline=#{Formula["readline"].opt_prefix}" if build.with? "readline"
1213 1214 1215 |
# File 'formula.rb', line 1213 def opt_prefix HOMEBREW_PREFIX/"opt"/name end |
#opt_sbin ⇒ Pathname
Same as #sbin, but relative to #opt_prefix instead of #prefix.
1253 1254 1255 |
# File 'formula.rb', line 1253 def opt_sbin opt_prefix/"sbin" end |
#opt_share ⇒ Pathname
Same as #share, but relative to #opt_prefix instead of #prefix.
1261 1262 1263 |
# File 'formula.rb', line 1261 def opt_share opt_prefix/"share" end |
#option_defined? ⇒ 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.
If a named option is defined for the currently active SoftwareSpec.
622 |
# File 'formula.rb', line 622 delegate option_defined?: :active_spec |
#options(*args, **options, &block) ⇒ 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.
108 |
# File 'sorbet/rbi/parlour.rbi', line 108 def (*args, **, &block); end |
#optlinked? ⇒ 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.
Is the formula linked to opt
?
719 720 721 |
# File 'formula.rb', line 719 def optlinked? opt_prefix.symlink? end |
#outdated?(fetch_head: false) ⇒ Boolean
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Check whether the installed formula is outdated.
1650 1651 1652 1653 1654 |
# File 'formula.rb', line 1650 def outdated?(fetch_head: false) !outdated_kegs(fetch_head:).empty? rescue Migrator::MigrationNeededError true end |
#outdated_kegs(fetch_head: false) ⇒ 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.
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 |
# File 'formula.rb', line 1564 def outdated_kegs(fetch_head: false) raise Migrator::MigrationNeededError.new(oldnames_to_migrate.first, name) if migration_needed? cache_key = "#{full_name}-#{fetch_head}" Formula.cache[:outdated_kegs] ||= {} Formula.cache[:outdated_kegs][cache_key] ||= begin all_kegs = [] current_version = T.let(false, T::Boolean) installed_kegs.each do |keg| all_kegs << keg version = keg.version next if version.head? next if version_scheme > keg.version_scheme && pkg_version != version next if version_scheme == keg.version_scheme && pkg_version > version # don't consider this keg current if there's a newer formula available next if follow_installed_alias? && new_formula_available? # this keg is the current version of the formula, so it's not outdated current_version = true break end if current_version || ((head_version = latest_head_version) && !head_version_outdated?(head_version, fetch_head:)) [] else all_kegs += old_installed_formulae.flat_map(&:installed_kegs) all_kegs.sort_by(&:scheme_and_version) end end end |
#patch ⇒ 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.
1486 1487 1488 1489 1490 1491 |
# File 'formula.rb', line 1486 def patch return if patchlist.empty? ohai "Patching" patchlist.each(&:apply) end |
#pin(*args, **options, &block) ⇒ 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.
156 |
# File 'sorbet/rbi/parlour.rbi', line 156 def pin(*args, **, &block); end |
#pinnable?(*args, **options, &block) ⇒ 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.
147 |
# File 'sorbet/rbi/parlour.rbi', line 147 def pinnable?(*args, **, &block); end |
#pinned?(*args, **options, &block) ⇒ 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.
150 |
# File 'sorbet/rbi/parlour.rbi', line 150 def pinned?(*args, **, &block); end |
#pinned_version(*args, **options, &block) ⇒ 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.
153 |
# File 'sorbet/rbi/parlour.rbi', line 153 def pinned_version(*args, **, &block); end |
#pkg_version ⇒ PkgVersion
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.
The PkgVersion for this formula with version and #revision information.
496 497 498 |
# File 'formula.rb', line 496 def pkg_version PkgVersion.new(version, revision) end |
#pkgetc ⇒ Pathname
A subdirectory of etc
with the formula name suffixed.
e.g. $HOMEBREW_PREFIX/etc/openssl@1.1
Anything using pkgetc.install
will not overwrite other files on
e.g. upgrades but will write a new file named *.default
.
1033 1034 1035 |
# File 'formula.rb', line 1033 def pkgetc (HOMEBREW_PREFIX/"etc"/name).extend(InstallRenamed) end |
#pkgshare ⇒ Pathname
The directory where the formula’s shared files should be installed,
with the name of the formula appended to avoid linking conflicts.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
No make install
available?
pkgshare.install "examples"
976 977 978 |
# File 'formula.rb', line 976 def pkgshare prefix/"share"/name end |
#plist ⇒ 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.
Please use Homebrew::Service instead.
This method can be overridden to provide a plist.
def plist; <<~EOS
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>#{plist_name}</string>
<key>ProgramArguments</key>
<array>
<string>#{opt_bin}/example</string>
<string>--do-this</string>
</array>
<key>RunAtLoad</key>
<true />
<key>KeepAlive</key>
<true />
<key>StandardErrorPath</key>
<string>/dev/null</string>
<key>StandardOutPath</key>
<string>/dev/null</string>
</dict>
</plist>
EOS
end
1163 1164 1165 1166 |
# File 'formula.rb', line 1163 def plist # odeprecated: consider removing entirely in 4.3.0 nil end |
#plist_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.
The generated launchd #plist service name.
1170 1171 1172 |
# File 'formula.rb', line 1170 def plist_name service.plist_name end |
#possible_names ⇒ 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.
1684 1685 1686 |
# File 'formula.rb', line 1684 def possible_names [name, *oldnames, *aliases].compact end |
#post_install ⇒ 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.
Can be overridden to run commands on both source and bottle installation.
1304 |
# File 'formula.rb', line 1304 def post_install; end |
#post_install_defined? ⇒ 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.
1307 1308 1309 |
# File 'formula.rb', line 1307 def post_install_defined? method(:post_install).owner != Formula 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.
Indicates that this formula supports bottles. (Not necessarily that one
should be used in the current installation run.)
Can be overridden to selectively disable bottles from formulae.
Defaults to true so overridden version does not have to check if bottles
are supported.
Replaced by pour_bottle?’s satisfy
method if it is specified.
1296 1297 1298 |
# File 'formula.rb', line 1296 def pour_bottle? true end |
#pour_bottle_check_unsatisfied_reason(*args, **options, &block) ⇒ 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.
123 |
# File 'sorbet/rbi/parlour.rbi', line 123 def pour_bottle_check_unsatisfied_reason(*args, **, &block); end |
#prefix(version = pkg_version) ⇒ 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.
The directory in the cellar that the formula is installed to. This directory points to #opt_prefix if it exists and if #prefix is not called from within the same formula’s #install or #post_install methods. Otherwise, return the full path to the formula’s versioned cellar.
699 700 701 702 703 704 705 706 707 |
# File 'formula.rb', line 699 def prefix(version = pkg_version) versioned_prefix = versioned_prefix(version) if !@prefix_returns_versioned_prefix && version == pkg_version && versioned_prefix.directory? && Keg.new(versioned_prefix).optlinked? opt_prefix else versioned_prefix end end |
#prefix_linked?(version = pkg_version) ⇒ 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.
If a formula’s linked keg points to the prefix.
724 725 726 727 728 |
# File 'formula.rb', line 724 def prefix_linked?(version = pkg_version) return false unless linked? linked_keg.resolved_path == versioned_prefix(version) end |
#print_tap_action(options = {}) ⇒ 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.
2115 2116 2117 2118 2119 2120 |
# File 'formula.rb', line 2115 def print_tap_action( = {}) return unless tap? verb = [:verb] || "Installing" ohai "#{verb} #{name} from #{tap}" end |
#rack ⇒ Pathname
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.
The parent of the prefix; the named directory in the cellar containing all installed versions of this software.
741 742 743 |
# File 'formula.rb', line 741 def rack HOMEBREW_CELLAR/name end |
#recursive_dependencies(&block) ⇒ Object
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Returns a list of Dependency objects in an installable order, which means if a depends on b then b will be ordered before a in this list
2135 2136 2137 2138 |
# File 'formula.rb', line 2135 def recursive_dependencies(&block) cache_key = "Formula#recursive_dependencies" unless block Dependency.(self, cache_key:, &block) end |
#recursive_requirements(&block) ⇒ Object
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
The full set of Requirements for this formula’s dependency tree.
2143 2144 2145 2146 |
# File 'formula.rb', line 2143 def recursive_requirements(&block) cache_key = "Formula#recursive_requirements" unless block Requirement.(self, cache_key:, &block) end |
#require_universal_deps? ⇒ 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.
1482 1483 1484 |
# File 'formula.rb', line 1482 def require_universal_deps? false end |
#requirements(*args, **options, &block) ⇒ 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.
99 |
# File 'sorbet/rbi/parlour.rbi', line 99 def requirements(*args, **, &block); end |
#resource ⇒ 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.
A named Resource for the currently active SoftwareSpec. Additional downloads can be defined as #resources. Resource#stage will create a temporary directory and yield to a block.
resource("additional_files").stage { bin.install "my/extra/tool" }
548 |
# File 'formula.rb', line 548 delegate resource: :active_spec |
#resources ⇒ 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.
The Resources for the currently active SoftwareSpec.
581 |
# File 'formula.rb', line 581 def_delegator :"active_spec.resources", :values, :resources |
#rpath(source: bin, target: lib) ⇒ 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.
Executable/Library RPATH according to platform conventions.
Optionally specify a source
or target
depending on the location
of the file containing the RPATH command and where its target is located.
rpath #=> "@loader_path/../lib"
rpath(target: frameworks) #=> "@loader_path/../Frameworks"
rpath(source: libexec/"bin") #=> "@loader_path/../../lib"
1822 1823 1824 1825 1826 1827 1828 |
# File 'formula.rb', line 1822 def rpath(source: bin, target: lib) unless target.to_s.start_with?(HOMEBREW_PREFIX) raise "rpath `target` should only be used for paths inside HOMEBREW_PREFIX!" end "#{loader_path}/#{target.relative_path_from(source)}" end |
#ruby_source_checksum ⇒ Checksum?
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.
2249 2250 2251 |
# File 'formula.rb', line 2249 def ruby_source_checksum Checksum.new(Digest::SHA256.file(path).hexdigest) if path.exist? end |
#ruby_source_path ⇒ 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.
2244 2245 2246 |
# File 'formula.rb', line 2244 def ruby_source_path path.relative_path_from(T.must(tap).path).to_s if tap && path.exist? end |
#run_post_install ⇒ 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.
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 |
# File 'formula.rb', line 1322 def run_post_install @prefix_returns_versioned_prefix = true build = self.build begin self.build = Tab.for_formula(self) new_env = { TMPDIR: HOMEBREW_TEMP, TEMP: HOMEBREW_TEMP, TMP: HOMEBREW_TEMP, _JAVA_OPTIONS: "-Djava.io.tmpdir=#{HOMEBREW_TEMP}", HOMEBREW_PATH: nil, PATH: PATH.new(ORIGINAL_PATHS), } with_env(new_env) do ENV.clear_sensitive_environment! ENV.activate_extensions! with_logging("post_install") do post_install end end ensure self.build = build @prefix_returns_versioned_prefix = false end end |
#run_test(keep_tmp: false) ⇒ 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.
2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 |
# File 'formula.rb', line 2623 def run_test(keep_tmp: false) @prefix_returns_versioned_prefix = true test_env = { TMPDIR: HOMEBREW_TEMP, TEMP: HOMEBREW_TEMP, TMP: HOMEBREW_TEMP, TERM: "dumb", PATH: PATH.new(ENV.fetch("PATH"), HOMEBREW_PREFIX/"bin"), HOMEBREW_PATH: nil, }.merge(common_stage_test_env) test_env[:_JAVA_OPTIONS] += " -Djava.io.tmpdir=#{HOMEBREW_TEMP}" ENV.clear_sensitive_environment! Utils::Git.set_name_email! mktemp("#{name}-test") do |staging| staging.retain! if keep_tmp @testpath = staging.tmpdir test_env[:HOME] = @testpath setup_home @testpath begin with_logging("test") do with_env(test_env) do test end end rescue Exception # rubocop:disable Lint/RescueException staging.retain! if debug? raise end end ensure @prefix_returns_versioned_prefix = false @testpath = nil end |
#runtime_dependencies(read_from_tab: true, undeclared: true) ⇒ Object
This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Returns a list of Dependency objects that are required at runtime.
2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 |
# File 'formula.rb', line 2178 def runtime_dependencies(read_from_tab: true, undeclared: true) deps = if read_from_tab && undeclared && (tab_deps = any_installed_keg&.runtime_dependencies) tab_deps.filter_map do |d| full_name = d["full_name"] next unless full_name Dependency.new full_name end end begin deps ||= declared_runtime_dependencies unless undeclared deps ||= (declared_runtime_dependencies | undeclared_runtime_dependencies) rescue FormulaUnavailableError onoe "Could not get runtime dependencies from #{path}!" deps ||= [] end deps end |
#runtime_formula_dependencies(read_from_tab: true, undeclared: true) ⇒ 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 a list of Formula objects that are required at runtime.
2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 |
# File 'formula.rb', line 2199 def runtime_formula_dependencies(read_from_tab: true, undeclared: true) cache_key = "#{full_name}-#{read_from_tab}-#{undeclared}" Formula.cache[:runtime_formula_dependencies] ||= {} Formula.cache[:runtime_formula_dependencies][cache_key] ||= runtime_dependencies( read_from_tab:, undeclared:, ).filter_map do |d| d.to_formula rescue FormulaUnavailableError nil end end |
#runtime_installed_formula_dependents ⇒ 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.
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 |
# File 'formula.rb', line 2213 def runtime_installed_formula_dependents # `any_installed_keg` and `runtime_dependencies` `select`s ensure # that we don't end up with something `Formula#runtime_dependencies` can't # read from a `Tab`. Formula.cache[:runtime_installed_formula_dependents] ||= {} Formula.cache[:runtime_installed_formula_dependents][full_name] ||= Formula.installed .select(&:any_installed_keg) .select(&:runtime_dependencies) .select do |f| f.runtime_formula_dependencies.any? do |dep| full_name == dep.full_name rescue name == dep.name end end end |
#sbin ⇒ Pathname
The directory where the formula’s sbin
binaries should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Generally we try to migrate these to #bin instead.
940 941 942 |
# File 'formula.rb', line 940 def sbin prefix/"sbin" end |
#serialized_requirements ⇒ 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.
2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 |
# File 'formula.rb', line 2521 def serialized_requirements requirements = self.class.spec_syms.to_h do |sym| [sym, send(sym)&.requirements] end merge_spec_dependables(requirements).map do |data| req = data[:dependable] req_name = req.name.dup req_name.prepend("maximum_") if req.respond_to?(:comparator) && req.comparator == "<=" req_version = if req.respond_to?(:version) req.version elsif req.respond_to?(:arch) req.arch end { "name" => req_name, "cask" => req.cask, "download" => req.download, "version" => req_version, "contexts" => req., "specs" => data[:specs], } end end |
#service ⇒ 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.
The service specification of the software.
1199 1200 1201 |
# File 'formula.rb', line 1199 def service @service ||= Homebrew::Service.new(self, &self.class.service) 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.
Is a service specification defined for the software?
454 |
# File 'formula.rb', line 454 delegate service?: :"self.class" |
#service_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.
The generated service name.
1176 1177 1178 |
# File 'formula.rb', line 1176 def service_name service.service_name end |
#share ⇒ Pathname
The directory where the formula’s shared files should be installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
Need a custom directory?
(share/"concept").mkpath
Installing something into another custom directory?
(share/"concept2").install "ducks.txt"
Install ./example_code/simple/ones
to share/demos
:
(share/"demos").install "example_code/simple/ones"
Install ./example_code/simple/ones
to share/demos/examples
:
(share/"demos").install "example_code/simple/ones" => "examples"
962 963 964 |
# File 'formula.rb', line 962 def share prefix/"share" end |
#shared_library(name, version = nil) ⇒ 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.
Shared library names according to platform conventions.
Optionally specify a version
to restrict the shared library to a specific
version. The special string “*” matches any version.
If name
is specified as “*”, match any shared library of any version.
shared_library("foo") #=> foo.dylib
shared_library("foo", 1) #=> foo.1.dylib
shared_library("foo", "*") #=> foo.2.dylib, foo.1.dylib, foo.dylib
shared_library("*") #=> foo.dylib, bar.dylib
12 13 14 15 16 17 18 19 |
# File 'extend/os/linux/formula.rb', line 12 def shared_library(name, version = nil) suffix = if version == "*" || (name == "*" && version.blank?) "{,.*}" elsif version.present? ".#{version}" end "#{name}.so#{suffix}" end |
#skip_clean?(path) ⇒ 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.
1392 1393 1394 1395 1396 1397 |
# File 'formula.rb', line 1392 def skip_clean?(path) return true if path.extname == ".la" && self.class.skip_clean_paths.include?(:la) to_check = path.relative_path_from(prefix).to_s self.class.skip_clean_paths.include? to_check end |
#skip_cxxstdlib_check? ⇒ 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.
1477 1478 1479 |
# File 'formula.rb', line 1477 def skip_cxxstdlib_check? false end |
#specified_name ⇒ 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.
The name specified to find this formula.
368 369 370 |
# File 'formula.rb', line 368 def specified_name alias_name || name end |
#specified_path ⇒ 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.
The path that was specified to find this formula.
357 358 359 360 361 362 363 364 365 |
# File 'formula.rb', line 357 def specified_path return alias_path if alias_path&.exist? return @unresolved_path if @unresolved_path.exist? return local_bottle_path if local_bottle_path.presence&.exist? alias_path || @unresolved_path 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.
Is the currently active SoftwareSpec a #stable build?
389 390 391 |
# File 'formula.rb', line 389 def stable? active_spec == stable end |
#std_cabal_v2_args ⇒ 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.
Standard parameters for cabal-v2 builds.
1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 |
# File 'formula.rb', line 1758 def std_cabal_v2_args env = T.cast(ENV, T.any(Stdenv, Superenv)) # cabal-install's dependency-resolution backtracking strategy can # easily need more than the default 2,000 maximum number of # "backjumps," since Hackage is a fast-moving, rolling-release # target. The highest known needed value by a formula was 43,478 # for git-annex, so 100,000 should be enough to avoid most # gratuitous backjumps build failures. ["--jobs=#{env.make_jobs}", "--max-backjumps=100000", "--install-method=copy", "--installdir=#{bin}"] end |
#std_cargo_args(root: prefix, path: ".") ⇒ 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.
Standard parameters for cargo builds.
1715 1716 1717 |
# File 'formula.rb', line 1715 def std_cargo_args(root: prefix, path: ".") ["--locked", "--root=#{root}", "--path=#{path}"] end |
#std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") ⇒ Array<String> Also known as: generic_std_cmake_args
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.
Standard parameters for CMake builds.
Setting CMAKE_FIND_FRAMEWORK
to “LAST” tells CMake to search for our
libraries before trying to utilize Frameworks, many of which will be from
3rd party installs.
20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'extend/os/mac/formula.rb', line 20 def std_cmake_args(install_prefix: prefix, install_libdir: "lib", find_framework: "LAST") args = generic_std_cmake_args(install_prefix:, install_libdir:, find_framework:) # Avoid false positives for clock_gettime support on 10.11. # CMake cache entries for other weak symbols may be added here as needed. args << "-DHAVE_CLOCK_GETTIME:INTERNAL=0" if MacOS.version == "10.11" && MacOS::Xcode.version >= "8.0" # Ensure CMake is using the same SDK we are using. args << "-DCMAKE_OSX_SYSROOT=#{MacOS.sdk_for_formula(self).path}" if MacOS.sdk_root_needed? args end |
#std_configure_args(prefix: self.prefix, libdir: "lib") ⇒ 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.
Standard parameters for configure builds.
1706 1707 1708 1709 |
# File 'formula.rb', line 1706 def std_configure_args(prefix: self.prefix, libdir: "lib") libdir = Pathname(libdir).(prefix) ["--disable-debug", "--disable-dependency-tracking", "--prefix=#{prefix}", "--libdir=#{libdir}"] end |
#std_go_args(output: bin/name, ldflags: nil) ⇒ 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.
Standard parameters for Go builds.
1750 1751 1752 1753 1754 |
# File 'formula.rb', line 1750 def std_go_args(output: bin/name, ldflags: nil) args = ["-trimpath", "-o=#{output}"] args += ["-ldflags=#{Array(ldflags).join(" ")}"] if ldflags args end |
#std_meson_args ⇒ 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.
Standard parameters for meson builds.
1772 1773 1774 |
# File 'formula.rb', line 1772 def std_meson_args ["--prefix=#{prefix}", "--libdir=#{lib}", "--buildtype=release", "--wrap-mode=nofallback"] end |
#std_pip_args(prefix: self.prefix, build_isolation: false) ⇒ 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.
Standard parameters for pip builds.
1781 1782 1783 1784 1785 1786 |
# File 'formula.rb', line 1781 def std_pip_args(prefix: self.prefix, build_isolation: false) args = ["--verbose", "--no-deps", "--no-binary=:all:", "--ignore-installed", "--no-compile"] args << "--prefix=#{prefix}" if prefix args << "--no-build-isolation" unless build_isolation args end |
#supersedes_an_installed_formula? ⇒ 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.
Is this formula the target of an alias used to install an old formula?
1620 1621 1622 |
# File 'formula.rb', line 1620 def supersedes_an_installed_formula? old_installed_formulae.any? end |
#synced_with_other_formulae? ⇒ 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.
Whether this Formula is version-synced with other formulae.
537 538 539 540 541 |
# File 'formula.rb', line 537 def synced_with_other_formulae? return false if @tap.nil? @tap.synced_versions_formulae.any? { |synced_formulae| synced_formulae.include?(name) } end |
#system(cmd, *args) ⇒ 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.
To call out to the system, we use the system
method and we prefer
you give the args separately as in the line below, otherwise a subshell
has to be opened first.
system "./bootstrap.sh", "--arg1", "--prefix=#{prefix}"
For CMake and other build systems we have some necessary defaults in e.g. #std_cmake_args:
system "cmake", ".", *std_cmake_args
If the arguments given to configure
(or make
or cmake
) are depending
on options defined above, we usually make a list first and then
use the args << if <condition>
to append each:
args = ["--with-option1", "--with-option2"]
args << "--without-gcc" if ENV.compiler == :clang
# Most software still uses `configure` and `make`.
# Check with `./configure --help` for what our options are.
system "./configure", "--disable-debug", "--disable-dependency-tracking",
"--disable-silent-rules", "--prefix=#{prefix}",
*args # our custom arg list (needs `*` to unpack)
# If there is a "make install" available, please use it!
system "make", "install"
2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 |
# File 'formula.rb', line 2776 def system(cmd, *args) verbose_using_dots = Homebrew::EnvConfig.verbose_using_dots? # remove "boring" arguments so that the important ones are more likely to # be shown considering that we trim long ohai lines to the terminal width pretty_args = args.dup unless verbose? case cmd when "./configure" pretty_args -= std_configure_args when "cabal" pretty_args -= std_cabal_v2_args when "cargo" pretty_args -= std_cargo_args when "cmake" pretty_args -= std_cmake_args when "go" pretty_args -= std_go_args when "meson" pretty_args -= std_meson_args when %r{(^|/)(pip|python)(?:[23](?:\.\d{1,2})?)?$} pretty_args -= std_pip_args end end pretty_args.each_index do |i| pretty_args[i] = "import setuptools..." if pretty_args[i].to_s.start_with? "import setuptools" end ohai "#{cmd} #{pretty_args * " "}".strip @exec_count ||= 0 @exec_count += 1 logfn = format("#{logs}/#{active_log_prefix}%02<exec_count>d.%<cmd_base>s", exec_count: @exec_count, cmd_base: File.basename(cmd).split.first) logs.mkpath File.open(logfn, "w") do |log| log.puts Time.now, "", cmd, args, "" log.flush if verbose? rd, wr = IO.pipe begin pid = fork do rd.close log.close exec_cmd(cmd, args, wr, logfn) end wr.close if verbose_using_dots last_dot = Time.at(0) while (buf = rd.gets) log.puts buf # make sure dots printed with interval of at least 1 min. next if (Time.now - last_dot) <= 60 print "." $stdout.flush last_dot = Time.now end puts else while (buf = rd.gets) log.puts buf puts buf end end ensure rd.close end else pid = fork do exec_cmd(cmd, args, log, logfn) end end Process.wait(T.must(pid)) $stdout.flush unless $CHILD_STATUS.success? log_lines = Homebrew::EnvConfig.fail_log_lines log.flush if !verbose? || verbose_using_dots puts "Last #{log_lines} lines from #{logfn}:" Kernel.system "/usr/bin/tail", "-n", log_lines.to_s, logfn end log.puts require "system_config" require "build_environment" env = ENV.to_hash SystemConfig.dump_verbose_config(log) log.puts BuildEnvironment.dump env, log raise BuildError.new(self, cmd, args, env) end end end |
#systemd_service_path ⇒ Pathname
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.
The generated systemd service file path.
1188 1189 1190 |
# File 'formula.rb', line 1188 def systemd_service_path opt_prefix/"#{service_name}.service" end |
#systemd_timer_path ⇒ Pathname
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.
The generated systemd timer file path.
1194 1195 1196 |
# File 'formula.rb', line 1194 def systemd_timer_path opt_prefix/"#{service_name}.timer" end |
#tap? ⇒ 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.
True if this formula is provided by external Tap
2102 2103 2104 2105 2106 |
# File 'formula.rb', line 2102 def tap? return false unless tap !T.must(tap).core_tap? end |
#tap_git_head ⇒ 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.
2122 2123 2124 |
# File 'formula.rb', line 2122 def tap_git_head tap&.git_head end |
#test ⇒ 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.
2665 |
# File 'formula.rb', line 2665 def test; end |
#test_defined? ⇒ 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.
2661 2662 2663 |
# File 'formula.rb', line 2661 def test_defined? false end |
#test_fixtures(file) ⇒ 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.
2667 2668 2669 |
# File 'formula.rb', line 2667 def test_fixtures(file) HOMEBREW_LIBRARY_PATH/"test/support/fixtures"/file end |
#time ⇒ Time
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.
Creates a new Time
object for use in the formula as the build time.
1839 1840 1841 1842 1843 1844 1845 |
# File 'formula.rb', line 1839 def time if ENV["SOURCE_DATE_EPOCH"].present? Time.at(ENV["SOURCE_DATE_EPOCH"].to_i).utc else Time.now.utc end end |
#to_hash ⇒ 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.
2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 |
# File 'formula.rb', line 2268 def to_hash hsh = { "name" => name, "full_name" => full_name, "tap" => tap&.name, "oldname" => oldnames.first, # deprecated "oldnames" => oldnames, "aliases" => aliases.sort, "versioned_formulae" => versioned_formulae.map(&:name), "desc" => desc, "license" => SPDX.license_expression_to_string(license), "homepage" => homepage, "versions" => { "stable" => stable&.version&.to_s, "head" => head&.version&.to_s, "bottle" => bottle_defined?, }, "urls" => urls_hash, "revision" => revision, "version_scheme" => version_scheme, "bottle" => {}, "pour_bottle_only_if" => self.class.pour_bottle_only_if&.to_s, "keg_only" => keg_only?, "keg_only_reason" => keg_only_reason&.to_hash, "options" => [], "build_dependencies" => [], "dependencies" => [], "test_dependencies" => [], "recommended_dependencies" => [], "optional_dependencies" => [], "uses_from_macos" => [], "uses_from_macos_bounds" => [], "requirements" => serialized_requirements, "conflicts_with" => conflicts.map(&:name), "conflicts_with_reasons" => conflicts.map(&:reason), "link_overwrite" => self.class.link_overwrite_paths.to_a, "caveats" => caveats_with_placeholders, "installed" => T.let([], T::Array[T::Hash[String, T.untyped]]), "linked_keg" => linked_version&.to_s, "pinned" => pinned?, "outdated" => outdated?, "deprecated" => deprecated?, "deprecation_date" => deprecation_date, "deprecation_reason" => deprecation_reason, "disabled" => disabled?, "disable_date" => disable_date, "disable_reason" => disable_reason, "post_install_defined" => post_install_defined?, "service" => (service.to_hash if service?), "tap_git_head" => tap_git_head, "ruby_source_path" => ruby_source_path, "ruby_source_checksum" => {}, } hsh["bottle"]["stable"] = bottle_hash if stable && bottle_defined? hsh["options"] = .map do |opt| { "option" => opt.flag, "description" => opt.description } end hsh.merge!(dependencies_hash) hsh["installed"] = installed_kegs.sort_by(&:scheme_and_version).map do |keg| tab = Tab.for_keg keg { "version" => keg.version.to_s, "used_options" => tab..as_flags, "built_as_bottle" => tab.built_as_bottle, "poured_from_bottle" => tab.poured_from_bottle, "time" => tab.time, "runtime_dependencies" => tab.runtime_dependencies, "installed_as_dependency" => tab.installed_as_dependency, "installed_on_request" => tab.installed_on_request, } end if (source_checksum = ruby_source_checksum) hsh["ruby_source_checksum"] = { "sha256" => source_checksum.hexdigest, } end hsh end |
#to_hash_with_variations(hash_method: :to_hash) ⇒ 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.
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 |
# File 'formula.rb', line 2414 def to_hash_with_variations(hash_method: :to_hash) if loaded_from_api? && hash_method == :to_internal_api_hash raise ArgumentError, "API Hash must be generated from Ruby source files" end namespace_prefix = case hash_method when :to_hash "Variations" when :to_internal_api_hash "APIVariations" else raise ArgumentError, "Unknown hash method #{hash_method.inspect}" end hash = public_send(hash_method) # Take from API, merging in local install status. if loaded_from_api? && !Homebrew::EnvConfig.no_install_from_api? json_formula = Homebrew::API::Formula.all_formulae.fetch(name).dup return json_formula.merge( hash.slice("name", "installed", "linked_keg", "pinned", "outdated"), ) end variations = {} if path.exist? && on_system_blocks_exist? formula_contents = path.read OnSystem::ALL_OS_ARCH_COMBINATIONS.each do |os, arch| bottle_tag = Utils::Bottles::Tag.new(system: os, arch:) next unless bottle_tag.valid_combination? Homebrew::SimulateSystem.with(os:, arch:) do variations_namespace = Formulary.class_s("#{namespace_prefix}#{bottle_tag.to_sym.capitalize}") variations_formula_class = Formulary.load_formula(name, path, formula_contents, variations_namespace, flags: self.class.build_flags, ignore_errors: true) variations_formula = variations_formula_class.new(name, path, :stable, alias_path:, force_bottle:) variations_formula.public_send(hash_method).each do |key, value| next if value.to_s == hash[key].to_s variations[bottle_tag.to_sym] ||= {} variations[bottle_tag.to_sym][key] = value end end end end hash["variations"] = variations if hash_method != :to_internal_api_hash || variations.present? hash end |
#to_internal_api_hash ⇒ 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.
2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 |
# File 'formula.rb', line 2353 def to_internal_api_hash api_hash = { "desc" => desc, "license" => SPDX.license_expression_to_string(license), "homepage" => homepage, "urls" => urls_hash.transform_values(&:compact), "post_install_defined" => post_install_defined?, "ruby_source_path" => ruby_source_path, "ruby_source_sha256" => ruby_source_checksum&.hexdigest, } dep_hash = dependencies_hash .except("recommended_dependencies", "optional_dependencies") .transform_values(&:presence) .compact api_hash.merge!(dep_hash) # Exclude default values. api_hash["revision"] = revision unless revision.zero? api_hash["version_scheme"] = version_scheme unless version_scheme.zero? # Optional values. api_hash["keg_only_reason"] = keg_only_reason.to_hash if keg_only_reason api_hash["pour_bottle_only_if"] = self.class.pour_bottle_only_if.to_s if self.class.pour_bottle_only_if api_hash["link_overwrite"] = self.class.link_overwrite_paths.to_a if self.class.link_overwrite_paths.present? api_hash["caveats"] = caveats_with_placeholders if caveats api_hash["service"] = service.to_hash if service? if stable api_hash["version"] = stable&.version&.to_s api_hash["bottle"] = bottle_hash(compact_for_api: true) if bottle_defined? end if (versioned_formulae_list = versioned_formulae.presence) # Could we just use `versioned_formulae_names` here instead? api_hash["versioned_formulae"] = versioned_formulae_list.map(&:name) end if (requirements_array = serialized_requirements.presence) api_hash["requirements"] = requirements_array end if conflicts.present? api_hash["conflicts_with"] = conflicts.map(&:name) api_hash["conflicts_with_reasons"] = conflicts.map(&:reason) end if deprecation_date api_hash["deprecation_date"] = deprecation_date api_hash["deprecation_reason"] = deprecation_reason end if disable_date api_hash["disable_date"] = disable_date api_hash["disable_reason"] = disable_reason end api_hash end |
#unlock ⇒ 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.
1543 1544 1545 1546 |
# File 'formula.rb', line 1543 def unlock @lock&.unlock @oldname_locks.each(&:unlock) end |
#unpin(*args, **options, &block) ⇒ 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.
159 |
# File 'sorbet/rbi/parlour.rbi', line 159 def unpin(*args, **, &block); end |
#update_head_version ⇒ 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.
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'formula.rb', line 476 def update_head_version return unless head? head_spec = T.must(head) return unless head_spec.downloader.is_a?(VCSDownloadStrategy) return unless head_spec.downloader.cached_location.exist? path = if ENV["HOMEBREW_ENV"] ENV.fetch("PATH") else PATH.new(ORIGINAL_PATHS) end with_env(PATH: path) do head_spec.version.update_commit(head_spec.downloader.last_commit) end end |
#urls_hash ⇒ 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.
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 |
# File 'formula.rb', line 2496 def urls_hash hash = {} if stable stable_spec = T.must(stable) hash["stable"] = { "url" => stable_spec.url, "tag" => stable_spec.specs[:tag], "revision" => stable_spec.specs[:revision], "using" => (stable_spec.using if stable_spec.using.is_a?(Symbol)), "checksum" => stable_spec.checksum&.to_s, } end if head hash["head"] = { "url" => T.must(head).url, "branch" => T.must(head).specs[:branch], "using" => (T.must(head).using if T.must(head).using.is_a?(Symbol)), } end hash end |
#uses_from_macos_elements(*args, **options, &block) ⇒ 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.
93 |
# File 'sorbet/rbi/parlour.rbi', line 93 def uses_from_macos_elements(*args, **, &block); end |
#uses_from_macos_names(*args, **options, &block) ⇒ 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.
96 |
# File 'sorbet/rbi/parlour.rbi', line 96 def uses_from_macos_names(*args, **, &block); end |
#valid_platform? ⇒ 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.
True if this formula can be installed on this platform Redefined in extend/os.
9 10 11 |
# File 'extend/os/mac/formula.rb', line 9 def valid_platform? requirements.none?(LinuxRequirement) end |
#var ⇒ Pathname
The directory where the formula’s variable files should be installed.
This directory is not inside the HOMEBREW_CELLAR
so it persists
across upgrades.
1043 1044 1045 |
# File 'formula.rb', line 1043 def var HOMEBREW_PREFIX/"var" end |
#verify_download_integrity(filename) ⇒ 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.
2619 2620 2621 |
# File 'formula.rb', line 2619 def verify_download_integrity(filename) active_spec.verify_download_integrity(filename) end |
#version ⇒ 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.
The version for the currently active SoftwareSpec. The version is autodetected from the URL and/or tag so only needs to be declared if it cannot be autodetected correctly.
461 |
# File 'formula.rb', line 461 delegate version: :active_spec |
#versioned_formula? ⇒ 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.
If this is a @
-versioned formula.
502 503 504 |
# File 'formula.rb', line 502 def versioned_formula? name.include?("@") end |
#versioned_formulae ⇒ Array<Formula>
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 any @
-versioned Formula objects for any Formula (including versioned formulae).
527 528 529 530 531 532 533 |
# File 'formula.rb', line 527 def versioned_formulae versioned_formulae_names.filter_map do |name| Formula[name] rescue FormulaUnavailableError nil end.sort_by(&:version).reverse end |
#versioned_formulae_names ⇒ 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 any other @
-versioned formulae names for any formula (including versioned formulae).
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'formula.rb', line 508 def versioned_formulae_names versioned_names = if tap name_prefix = name.gsub(/(@[\d.]+)?$/, "") T.must(tap).prefix_to_versioned_formulae_names.fetch(name_prefix, []) elsif path.exist? Pathname.glob(path.to_s.gsub(/(@[\d.]+)?\.rb$/, "@*.rb")) .map { |path| path.basename(".rb").to_s } .sort else raise "Either tap or path is required to list versioned formulae" end versioned_names.reject do |versioned_name| versioned_name == name end end |
#with_logging(log_type) ⇒ 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.
Runs a block with the given log type in effect for its duration.
1127 1128 1129 1130 1131 1132 1133 |
# File 'formula.rb', line 1127 def with_logging(log_type) old_log_type = @active_log_type @active_log_type = log_type yield ensure @active_log_type = old_log_type end |
#xcodebuild(*args) ⇒ 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.
Runs xcodebuild
without Homebrew’s compiler environment variables set.
2940 2941 2942 2943 2944 2945 2946 2947 2948 |
# File 'formula.rb', line 2940 def xcodebuild(*args) removed = ENV.remove_cc_etc begin T.unsafe(self).system("xcodebuild", *args) ensure ENV.update(removed) end end |
#zsh_completion ⇒ Pathname
The directory where the formula’s zsh completion files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
1087 1088 1089 |
# File 'formula.rb', line 1087 def zsh_completion share/"zsh/site-functions" end |
#zsh_function ⇒ Pathname
The directory where the formula’s zsh function files should be
installed.
This is symlinked into HOMEBREW_PREFIX
after installation or with
brew link
for formulae that are not keg-only.
1054 1055 1056 |
# File 'formula.rb', line 1054 def zsh_function share/"zsh/site-functions" end |