Class: Formula Abstract

Inherits:
Object
  • Object
show all
Extended by:
BuildEnvironment::DSL, Cachable, Enumerable, Forwardable, Predicable
Includes:
Context, FileUtils, Utils::Inreplace, Utils::Shebang, Utils::Shell
Defined in:
brew/Library/Homebrew/formula.rb,
brew/Library/Homebrew/extend/os/mac/formula.rb,
brew/Library/Homebrew/extend/os/linux/formula.rb

Overview

This class is abstract.

A formula provides instructions and metadata for Homebrew to install a piece of software. Every Homebrew formula is a Formula. All subclasses of Formula (and all Ruby classes) have to be named UpperCase and not-use-dashes. A formula specified in this-formula.rb should have a class named ThisFormula. Homebrew does enforce that the name of the file and the class correspond. Make sure you check with brew search that the name is free!

class Wget < Formula
  homepage "https://www.gnu.org/software/wget/"
  url "https://ftp.gnu.org/gnu/wget/wget-1.15.tar.gz"
  sha256 "52126be8cf1bddd7536886e74c053ad7d0ed2aa89b4b630f76785bac21695fcd"

  def install
    system "./configure", "--prefix=#{prefix}"
    system "make", "install"
  end
end

Constant Summary

Constants included from Utils::Shell

Utils::Shell::SHELL_PROFILE_MAP, Utils::Shell::UNSAFE_SHELL_CHAR

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BuildEnvironment::DSL

env

Methods included from Predicable

attr_predicate

Methods included from Cachable

cache, clear_cache

Methods included from Context

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

Methods included from Utils::Shell

csh_quote, export_value, from_path, parent, preferred, prepend_path_in_profile, profile, set_variable_in_profile, sh_quote

Methods included from Utils::Shebang

rewrite_shebang

Methods included from Utils::Inreplace

inreplace, inreplace_pairs

Class Attribute Details

.args=(value) ⇒ Object (writeonly)

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" },
]


2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
# File 'brew/Library/Homebrew/formula.rb', line 2234

def license(args = nil)
  if args.nil?
    @licenses
  else
    if args.is_a? Array
      odeprecated "`license [...]`", "`license any_of: [...]`"
      args = { any_of: args }
    end
    @licenses = args
  end
end

.bottle(*args, &block) ⇒ Object

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
  prefix "/opt/homebrew" # Optional HOMEBREW_PREFIX in which the bottles were built.
  cellar "/opt/homebrew/Cellar" # Optional HOMEBREW_CELLAR in which the bottles were built.
  rebuild 1 # Making the old bottle outdated without bumping the version/revision of the formula.
  sha256 "ef65c759c5097a36323fa9c77756468649e8d1980a3a4e05695c05e39568967c" => :catalina
  sha256 "28f4090610946a4eb207df102d841de23ced0d06ba31cb79e040d883906dcd4f" => :mojave
  sha256 "91dd0caca9bd3f38c439d5a7b6f68440c4274945615fae035ff0a369264b8a2f" => :high_sierra
end

Only formulae where the upstream URL breaks or moves frequently, require compiling or have a reasonable amount of patches/resources should be bottled. Formulae which do not meet the above requirements should not be bottled.

Formulae which should not be bottled and can be installed without any compile required should be tagged with:

bottle :unneeded

Otherwise formulae which do not meet the above requirements and should not be bottled should be tagged with:

bottle :disable, "reasons"


2390
2391
2392
# File 'brew/Library/Homebrew/formula.rb', line 2390

def bottle(*args, &block)
  stable.bottle(*args, &block)
end

.deprecated_option(hash) ⇒ Object

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"


2550
2551
2552
# File 'brew/Library/Homebrew/formula.rb', line 2550

def deprecated_option(hash)
  specs.each { |spec| spec.deprecated_option(hash) }
end

.deprecation_reasonString, Symbol (readonly)

The reason for deprecation of a Formula. Returns nil if no reason was provided or the formula is not deprecated.

Returns:



2765
2766
2767
# File 'brew/Library/Homebrew/formula.rb', line 2765

def deprecation_reason
  @deprecation_reason
end

.desc=(value) ⇒ Object (writeonly)

A one-line description of the software. Used by users to get an overview of the software and Homebrew maintainers. Shows when running brew info.

desc "Example formula"


2209
# File 'brew/Library/Homebrew/formula.rb', line 2209

attr_rw :desc

.disable_reasonString, Symbol (readonly)

The reason for a Formula is disabled. Returns nil if no reason was provided or the formula is not disabled.

Returns:



2795
2796
2797
# File 'brew/Library/Homebrew/formula.rb', line 2795

def disable_reason
  @disable_reason
end

.head(val = nil, specs = {}, &block) ⇒ Object

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", :revision => "abc123"

or (if autodetect fails):

head "https://hg.is.awesome.but.git.has.won.example.com/", :using => :hg


2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
# File 'brew/Library/Homebrew/formula.rb', line 2445

def head(val = nil, specs = {}, &block)
  @head ||= HeadSoftwareSpec.new(flags: build_flags)
  if block_given?
    @head.instance_eval(&block)
  elsif val
    @head.url(val, specs)
  else
    @head
  end
end

.homepage=(value) ⇒ Object (writeonly)

The homepage for the software. Used by users to get more information about the software and Homebrew maintainers as a point of contact for e.g. submitting patches. Can be opened with running brew home.

homepage "https://www.example.com"


2253
# File 'brew/Library/Homebrew/formula.rb', line 2253

attr_rw :homepage

.livecheck(&block) ⇒ Object

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


2716
2717
2718
2719
2720
2721
2722
# File 'brew/Library/Homebrew/formula.rb', line 2716

def livecheck(&block)
  @livecheck ||= Livecheck.new(self)
  return @livecheck unless block_given?

  @livecheckable = true
  @livecheck.instance_eval(&block)
end

.mirror(val) ⇒ Object

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


2342
2343
2344
# File 'brew/Library/Homebrew/formula.rb', line 2342

def mirror(val)
  stable.mirror(val)
end

.option(name, description = "") ⇒ Object

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 the autogenerated one from 'depends_on "qt" => :optional'"
option :universal


2541
2542
2543
# File 'brew/Library/Homebrew/formula.rb', line 2541

def option(name, description = "")
  specs.each { |spec| spec.option(name, description) }
end

.revision=(value) ⇒ Object (writeonly)

Used for creating new Homebrew versions of software without new upstream versions. For example, if we bump the major version of a library this Formula depends_on then we may need to update the revision of this Formula to install a new version linked against the new library version. 0 if unset.

revision 1


2283
# File 'brew/Library/Homebrew/formula.rb', line 2283

attr_rw :revision

.sha256=(value) ⇒ Object (writeonly)

To verify the cached download’s integrity and security we verify the SHA-256 hash matches which 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"


2354
2355
2356
# File 'brew/Library/Homebrew/formula.rb', line 2354

Checksum::TYPES.each do |type|
  define_method(type) { |val| stable.send(type, val) }
end

.stable(&block) ⇒ Object

Allows adding depends_on and Patches just to the stable SoftwareSpec. This is required instead of using a conditional. It is preferrable 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


2421
2422
2423
2424
2425
2426
# File 'brew/Library/Homebrew/formula.rb', line 2421

def stable(&block)
  @stable ||= SoftwareSpec.new(flags: build_flags)
  return @stable unless block_given?

  @stable.instance_eval(&block)
end

.url(val, specs = {}) ⇒ Object

The URL used to download the source for the stable version of the formula. We prefer https for security and proxy reasons. If not inferrable, 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)
  • :s3 (download from S3 using signed request)
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"


2319
2320
2321
# File 'brew/Library/Homebrew/formula.rb', line 2319

def url(val, specs = {})
  stable.url(val, specs)
end

.version(val = nil) ⇒ Object

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"


2329
2330
2331
# File 'brew/Library/Homebrew/formula.rb', line 2329

def version(val = nil)
  stable.version(val)
end

.version_scheme=(value) ⇒ Object (writeonly)

Used for creating new Homebrew version schemes. For example, if we want to change version scheme from one to another, then we may need to update version_scheme of this Formula to be able to use new version scheme. e.g. to move from 20151020 scheme to 1.0.0 we need to increment version_scheme. Without this, the prior scheme will always equate to a higher version. 0 if unset.

version_scheme 1


2295
# File 'brew/Library/Homebrew/formula.rb', line 2295

attr_rw :version_scheme

Instance Attribute Details

#alias_nameObject (readonly)

The name of the alias that was used to identify this Formula. e.g. another-name-for-this-formula



86
87
88
# File 'brew/Library/Homebrew/formula.rb', line 86

def alias_name
  @alias_name
end

#alias_pathObject (readonly)

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



82
83
84
# File 'brew/Library/Homebrew/formula.rb', line 82

def alias_path
  @alias_path
end

#buildBuildOptions

The BuildOptions 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.

Returns:



178
179
180
# File 'brew/Library/Homebrew/formula.rb', line 178

def build
  @build
end

#buildpathObject (readonly)

The current working directory during builds. Will only be non-nil inside #install.



157
158
159
# File 'brew/Library/Homebrew/formula.rb', line 157

def buildpath
  @buildpath
end

#follow_installed_aliasBoolean Also known as: follow_installed_alias?

A Boolean indicating whether this formula should be considered outdated if the target of the alias it was installed with has since changed. Defaults to true.

Returns:

  • (Boolean)


184
185
186
# File 'brew/Library/Homebrew/formula.rb', line 184

def follow_installed_alias
  @follow_installed_alias
end

#full_alias_nameObject (readonly)

The fully-qualified alias referring to this Formula. For core formula it’s the same as #alias_name. e.g. homebrew/tap-name/another-name-for-this-formula



96
97
98
# File 'brew/Library/Homebrew/formula.rb', line 96

def full_alias_name
  @full_alias_name
end

#full_nameObject (readonly)

The fully-qualified name of this Formula. For core formula it’s the same as #name. e.g. homebrew/tap-name/this-formula



91
92
93
# File 'brew/Library/Homebrew/formula.rb', line 91

def full_name
  @full_name
end

#nameObject (readonly)

The name of this Formula. e.g. this-formula



78
79
80
# File 'brew/Library/Homebrew/formula.rb', line 78

def name
  @name
end

#pathObject (readonly)

The full path to this Formula. e.g. /usr/local/Library/Taps/homebrew/homebrew-core/Formula/this-formula.rb



100
101
102
# File 'brew/Library/Homebrew/formula.rb', line 100

def path
  @path
end

#revisionObject (readonly)

Used for creating new Homebrew versions of software without new upstream versions.

See Also:



150
151
152
# File 'brew/Library/Homebrew/formula.rb', line 150

def revision
  @revision
end

#testpathObject (readonly)

The current working directory during tests. Will only be non-nil inside test.



161
162
163
# File 'brew/Library/Homebrew/formula.rb', line 161

def testpath
  @testpath
end

#version_schemeObject (readonly)

Used to change version schemes for packages



153
154
155
# File 'brew/Library/Homebrew/formula.rb', line 153

def version_scheme
  @version_scheme
end

Class Method Details

.[](name) ⇒ Object



1554
1555
1556
# File 'brew/Library/Homebrew/formula.rb', line 1554

def self.[](name)
  Formulary.factory(name)
end

.clear_installed_formulae_cacheObject

Clear caches of .racks and .installed.



1479
1480
1481
1482
# File 'brew/Library/Homebrew/formula.rb', line 1479

def self.clear_installed_formulae_cache
  clear_racks_cache
  @installed = nil
end

.clear_racks_cacheObject

Clear cache of .racks



1474
1475
1476
# File 'brew/Library/Homebrew/formula.rb', line 1474

def self.clear_racks_cache
  @racks = nil
end

.conflicts_with(*names) ⇒ Object

If this formula conflicts with another one.

conflicts_with "imagemagick", :because => "because both install 'convert' binaries"


2610
2611
2612
2613
# File 'brew/Library/Homebrew/formula.rb', line 2610

def conflicts_with(*names)
  opts = names.last.is_a?(Hash) ? names.pop : {}
  names.each { |name| conflicts << FormulaConflict.new(name, opts[:because]) }
end

.cxxstdlib_check(check_type) ⇒ Object

Pass :skip to this method to disable post-install stdlib checking



2639
2640
2641
# File 'brew/Library/Homebrew/formula.rb', line 2639

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 dependencies for stuff that requires certain extra handling (often changing some ENV vars or deciding if to use the system provided version or not.)

# `:build` means this dep is only needed during build.
depends_on "cmake" => :build
depends_on "homebrew/dupes/tcl-tk" => :optional
# `: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.
# But a `--with-...` options is generated.
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 with `--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 # If the formula really needs full Xcode.
depends_on :macos => :mojave # Needs at least macOS Mojave (10.14).
depends_on :x11 => :optional # X11/XQuartz components.
depends_on :osxfuse # Permits the use of the upstream signed binary or our source package.
depends_on :tuntap # Does the same thing as above. This is vital for Yosemite and above.
# It is possible to only depend on something if
# `build.with?` or `build.without? "another_formula"`:
depends_on "postgresql" if build.without? "sqlite"
# Python 3.x if the `--with-python` is given to `brew install example`
depends_on "python3" => :optional


2504
2505
2506
# File 'brew/Library/Homebrew/formula.rb', line 2504

def depends_on(dep)
  specs.each { |spec| spec.depends_on(dep) }
end

.deprecate!(date: nil, because: nil) ⇒ Object

Deprecates a Formula (on a given date, if provided) 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: "it has been replaced by"


2746
2747
2748
2749
2750
2751
2752
2753
# File 'brew/Library/Homebrew/formula.rb', line 2746

def deprecate!(date: nil, because: nil)
  odeprecated "`deprecate!` without a reason", "`deprecate! because: \"reason\"`" if because.blank?

  return if date.present? && Date.parse(date) > Date.today

  @deprecation_reason = because if because.present?
  @deprecated = true
end

.deprecated?Boolean

Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.

Returns:

  • (Boolean)


2758
2759
2760
# File 'brew/Library/Homebrew/formula.rb', line 2758

def deprecated?
  @deprecated == true
end

.disable!(date: nil, because: nil) ⇒ Object

Disables a Formula (on a given date, if provided) 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"


2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
# File 'brew/Library/Homebrew/formula.rb', line 2772

def disable!(date: nil, because: nil)
  odeprecated "`disable!` without a reason", "`disable! because: \"reason\"`" if because.blank?

  if date.present? && Date.parse(date) > Date.today
    @deprecation_reason = because if because.present?
    @deprecated = true
    return
  end

  @disable_reason = because if because.present?
  @disabled = true
end

.disabled?Boolean

Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.

Returns:

  • (Boolean)


2788
2789
2790
# File 'brew/Library/Homebrew/formula.rb', line 2788

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


2664
2665
2666
# File 'brew/Library/Homebrew/formula.rb', line 2664

def fails_with(compiler, &block)
  specs.each { |spec| spec.fails_with(compiler, &block) }
end

.go_resource(name, &block) ⇒ Object



2469
2470
2471
# File 'brew/Library/Homebrew/formula.rb', line 2469

def go_resource(name, &block)
  specs.each { |spec| spec.go_resource(name, &block) }
end

.ignore_missing_libraries(*libs) ⇒ Object



2808
2809
2810
# File 'brew/Library/Homebrew/formula.rb', line 2808

def ignore_missing_libraries(*)
  raise FormulaSpecificationError, "#{__method__} is available on Linux only"
end

.installed_with_alias_path(alias_path) ⇒ Object



1506
1507
1508
1509
1510
# File 'brew/Library/Homebrew/formula.rb', line 1506

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 will only live in its Cellar. Other formulae can depend on it and then brew will add the necessary includes and libs (etc.) during the brewing of that other formula. But generally, keg-only formulae are not in your PATH and 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 "because I want it so"


2634
2635
2636
# File 'brew/Library/Homebrew/formula.rb', line 2634

def keg_only(reason, explanation = "")
  @keg_only_reason = KegOnlyReason.new(reason, explanation)
end

.license(args = nil) ⇒ Object

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" },
]


2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
# File 'brew/Library/Homebrew/formula.rb', line 2234

def license(args = nil)
  if args.nil?
    @licenses
  else
    if args.is_a? Array
      odeprecated "`license [...]`", "`license any_of: [...]`"
      args = { any_of: args }
    end
    @licenses = args
  end
end

.livecheckable?Boolean

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.

Returns:

  • (Boolean)


2258
2259
2260
# File 'brew/Library/Homebrew/formula.rb', line 2258

def livecheckable?
  @livecheckable == true
end

.needs(*standards) ⇒ Object



2668
2669
2670
# File 'brew/Library/Homebrew/formula.rb', line 2668

def needs(*standards)
  specs.each { |spec| spec.needs(*standards) }
end

.on_linux(&_block) ⇒ Object

Block only executed on Linux. No-op on macOS.

on_linux do
  depends_on "linux_only_dep"
end


2525
# File 'brew/Library/Homebrew/formula.rb', line 2525

def on_linux(&_block); end

.on_macos(&_block) ⇒ Object

Block only executed on macOS. No-op on Linux.

on_macos do
  depends_on "mac_only_dep"
end


2519
# File 'brew/Library/Homebrew/formula.rb', line 2519

def on_macos(&_block); 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, "..."


2584
2585
2586
# File 'brew/Library/Homebrew/formula.rb', line 2584

def patch(strip = :p1, src = nil, &block)
  specs.each { |spec| spec.patch(strip, src, &block) }
end

.plist_options(options) ⇒ Object

Defines launchd plist handling.

Does your plist need to be loaded at startup?

plist_options :startup => true

Or only when necessary or desired by the user?

plist_options :manual => "foo"

Or perhaps you’d like to give the user a choice? Ooh fancy.

plist_options :startup => true, :manual => "foo start"


2598
2599
2600
2601
# File 'brew/Library/Homebrew/formula.rb', line 2598

def plist_options(options)
  @plist_startup = options[:startup]
  @plist_manual = options[:manual]
end

.pour_bottle?(&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.

Returns:

  • (Boolean)


2736
2737
2738
2739
# File 'brew/Library/Homebrew/formula.rb', line 2736

def pour_bottle?(&block)
  @pour_bottle_check = PourBottleCheck.new(self)
  @pour_bottle_check.instance_eval(&block)
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


2463
2464
2465
2466
2467
# File 'brew/Library/Homebrew/formula.rb', line 2463

def resource(name, klass = Resource, &block)
  specs.each do |spec|
    spec.resource(name, klass, &block) unless spec.resource_defined?(name)
  end
end

.skip_clean(*paths) ⇒ Object



2615
2616
2617
2618
2619
# File 'brew/Library/Homebrew/formula.rb', line 2615

def skip_clean(*paths)
  paths.flatten!
  # Specifying :all is deprecated and will become an error
  skip_clean_paths.merge(paths)
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 and foo –help are bad tests. However, a bad test is better than no test at all.

See: https://docs.brew.sh/Formula-Cookbook#add-a-test-to-the-formula

(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.

Returns:

  • (Boolean)


2700
2701
2702
# File 'brew/Library/Homebrew/formula.rb', line 2700

def test(&block)
  define_method(:test, &block)
end

.uses_from_macos(dep, bounds = {}) ⇒ Object

Indicates use of dependencies provided by macOS. On macOS this is a no-op (as we use the system libraries there). On Linux this will act as depends_on.



2511
2512
2513
# File 'brew/Library/Homebrew/formula.rb', line 2511

def uses_from_macos(dep, bounds = {})
  specs.each { |spec| spec.uses_from_macos(dep, bounds) }
end

Instance Method Details

#active_log_prefixObject

The prefix, if any, to use in filenames for logging current activity



882
883
884
885
886
887
888
# File 'brew/Library/Homebrew/formula.rb', line 882

def active_log_prefix
  if active_log_type
    "#{active_log_type}."
  else
    ""
  end
end

#alias_changed?Boolean

Has the alias used to install the formula changed, or are different formulae already installed with this alias?

Returns:

  • (Boolean)


1287
1288
1289
# File 'brew/Library/Homebrew/formula.rb', line 1287

def alias_changed?
  installed_alias_target_changed? || supersedes_an_installed_formula?
end

#aliasesObject

All aliases for the formula



437
438
439
440
441
442
443
444
445
# File 'brew/Library/Homebrew/formula.rb', line 437

def aliases
  @aliases ||= if tap
    tap.alias_reverse_table[full_name].to_a.map do |a|
      a.split("/").last
    end
  else
    []
  end
end

#any_installed_prefixObject



1609
1610
1611
1612
1613
1614
1615
# File 'brew/Library/Homebrew/formula.rb', line 1609

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_versionObject



1617
1618
1619
# File 'brew/Library/Homebrew/formula.rb', line 1617

def any_installed_version
  any_installed_keg&.version
end

#bash_completionObject

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.



847
848
849
# File 'brew/Library/Homebrew/formula.rb', line 847

def bash_completion
  prefix/"etc/bash_completion.d"
end

#binObject

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"


622
623
624
# File 'brew/Library/Homebrew/formula.rb', line 622

def bin
  prefix/"bin"
end

#caveatsString

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

Returns:



1061
1062
1063
# File 'brew/Library/Homebrew/formula.rb', line 1061

def caveats
  nil
end

#current_installed_alias_targetObject



1267
1268
1269
# File 'brew/Library/Homebrew/formula.rb', line 1267

def current_installed_alias_target
  Formulary.factory(installed_alias_path) if installed_alias_path
end

#deprecated?Boolean

Whether this Formula is deprecated (i.e. warns on installation). Defaults to false.

Returns:

  • (Boolean)


1133
# File 'brew/Library/Homebrew/formula.rb', line 1133

delegate deprecated?: :"self.class"

#deprecation_reasonString, Symbol

The reason this Formula is deprecated. Returns nil if no reason is specified or the formula is not deprecated.

Returns:



1139
# File 'brew/Library/Homebrew/formula.rb', line 1139

delegate deprecation_reason: :"self.class"

#descObject

The description of the software.

See Also:



355
# File 'brew/Library/Homebrew/formula.rb', line 355

delegate desc: :"self.class"

#disable_reasonString, Symbol

The reason this Formula is disabled. Returns nil if no reason is specified or the formula is not disabled.

Returns:



1151
# File 'brew/Library/Homebrew/formula.rb', line 1151

delegate disable_reason: :"self.class"

#disabled?Boolean

Whether this Formula is disabled (i.e. cannot be installed). Defaults to false.

Returns:

  • (Boolean)


1145
# File 'brew/Library/Homebrew/formula.rb', line 1145

delegate disabled?: :"self.class"

#docObject

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.



629
630
631
# File 'brew/Library/Homebrew/formula.rb', line 629

def doc
  share/"doc"/name
end

#elispObject

The directory where Emacs Lisp files should be installed, with the formula name appended to avoid linking conflicts.

Install an Emacs mode included with a software package:

elisp.install "contrib/emacs/example-mode.el"


783
784
785
# File 'brew/Library/Homebrew/formula.rb', line 783

def elisp
  prefix/"share/emacs/site-lisp"/name
end

#etcObject

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.



808
809
810
# File 'brew/Library/Homebrew/formula.rb', line 808

def etc
  (HOMEBREW_PREFIX/"etc").extend(InstallRenamed)
end

#fetch_patchesObject



2095
2096
2097
# File 'brew/Library/Homebrew/formula.rb', line 2095

def fetch_patches
  patchlist.select(&:external?).each(&:fetch)
end

#fish_completionObject

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.



863
864
865
# File 'brew/Library/Homebrew/formula.rb', line 863

def fish_completion
  share/"fish/vendor_completions.d"
end

#fish_functionObject

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.



839
840
841
# File 'brew/Library/Homebrew/formula.rb', line 839

def fish_function
  share/"fish/vendor_functions.d"
end

#frameworksObject

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.



791
792
793
# File 'brew/Library/Homebrew/formula.rb', line 791

def frameworks
  prefix/"Frameworks"
end

#full_installed_alias_nameObject



290
291
292
# File 'brew/Library/Homebrew/formula.rb', line 290

def full_installed_alias_name
  full_name_with_optional_tap(installed_alias_name)
end

#full_installed_specified_nameObject

The name (including tap) specified to install this formula.



315
316
317
# File 'brew/Library/Homebrew/formula.rb', line 315

def full_installed_specified_name
  full_installed_alias_name || full_name
end

#full_specified_nameObject

The name (including tap) specified to find this formula.



305
306
307
# File 'brew/Library/Homebrew/formula.rb', line 305

def full_specified_name
  full_alias_name || full_name
end

#head_version_outdated?(version, fetch_head: false) ⇒ Boolean

Returns:

  • (Boolean)


526
527
528
529
530
531
532
533
534
535
536
537
538
539
# File 'brew/Library/Homebrew/formula.rb', line 526

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 < stable.version
  return false unless fetch_head
  return false unless head&.downloader.is_a?(VCSDownloadStrategy)

  downloader = head.downloader

  with_context quiet: true do
    downloader.commit_outdated?(version.version.commit)
  end
end

#homepageObject

The homepage for the software.

See Also:



365
# File 'brew/Library/Homebrew/formula.rb', line 365

delegate homepage: :"self.class"

#includeObject

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"


639
640
641
# File 'brew/Library/Homebrew/formula.rb', line 639

def include
  prefix/"include"
end

#infoObject

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.



646
647
648
# File 'brew/Library/Homebrew/formula.rb', line 646

def info
  share/"info"
end

#inreplace(paths, before = nil, after = nil) ⇒ Object

Actually implemented in Utils::Inreplace.inreplace. 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 var defined by the formula. Only HOMEBREW_PREFIX is available in the embedded patch.

inreplace supports regular expressions:

inreplace "somefile.cfg", /look[for]what?/, "replace by #{bin}/tool"


# File 'brew/Library/Homebrew/formula.rb', line 64

#installObject

This method is overridden in Formula subclasses to provide the installation instructions. The sources (from url) are downloaded, hash-checked and Homebrew changes into a temporary directory where the archive was unpacked or repository cloned.

def install
  system "./configure", "--prefix=#{prefix}"
  system "make", "install"
end


1869
# File 'brew/Library/Homebrew/formula.rb', line 1869

def install; end

#installed_alias_nameObject



286
287
288
# File 'brew/Library/Homebrew/formula.rb', line 286

def installed_alias_name
  File.basename(installed_alias_path) if installed_alias_path
end

#installed_alias_pathObject

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.



278
279
280
281
282
283
284
# File 'brew/Library/Homebrew/formula.rb', line 278

def installed_alias_path
  path = build.source["path"] if build.is_a?(Tab)
  return unless path&.match?(%r{#{HOMEBREW_TAP_DIR_REGEX}/Aliases})
  return unless File.symlink?(path)

  path
end

#installed_alias_target_changed?Boolean

Has the target of the alias used to install this formula changed? Returns false if the formula wasn’t installed with an alias.

Returns:

  • (Boolean)


1273
1274
1275
1276
1277
1278
# File 'brew/Library/Homebrew/formula.rb', line 1273

def installed_alias_target_changed?
  target = current_installed_alias_target
  return false unless target

  target.name != name
end

#installed_specified_nameObject

The name specified to install this formula.



310
311
312
# File 'brew/Library/Homebrew/formula.rb', line 310

def installed_specified_name
  installed_alias_name || name
end

#keg_only?Boolean

Rarely, you don’t want your library symlinked into the main prefix. See gettext.rb for an example.

Returns:

  • (Boolean)


1067
1068
1069
1070
1071
# File 'brew/Library/Homebrew/formula.rb', line 1067

def keg_only?
  return false unless keg_only_reason

  keg_only_reason.applicable?
end

#kext_prefixObject

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.



799
800
801
# File 'brew/Library/Homebrew/formula.rb', line 799

def kext_prefix
  prefix/"Library/Extensions"
end

#latest_formulaObject

If the alias has changed value, return the new formula. Otherwise, return self.



1293
1294
1295
# File 'brew/Library/Homebrew/formula.rb', line 1293

def latest_formula
  installed_alias_target_changed? ? current_installed_alias_target : self
end

#latest_head_prefixObject



521
522
523
524
# File 'brew/Library/Homebrew/formula.rb', line 521

def latest_head_prefix
  head_version = latest_head_version
  prefix(head_version) if head_version
end

#latest_head_versionObject



510
511
512
513
514
515
516
517
518
519
# File 'brew/Library/Homebrew/formula.rb', line 510

def latest_head_version
  head_versions = installed_prefixes.map do |pn|
    pn_pkgversion = PkgVersion.parse(pn.basename.to_s)
    pn_pkgversion if pn_pkgversion.head?
  end.compact

  head_versions.max_by do |pn_pkgversion|
    [Tab.for_keg(prefix(pn_pkgversion)).source_modified_time, pn_pkgversion.revision]
  end
end

#libObject

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"


656
657
658
# File 'brew/Library/Homebrew/formula.rb', line 656

def lib
  prefix/"lib"
end

#libexecObject

The directory where the formula’s binaries should be installed. This is not symlinked into HOMEBREW_PREFIX. It is also 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.



665
666
667
# File 'brew/Library/Homebrew/formula.rb', line 665

def libexec
  prefix/"libexec"
end

#licenseObject

The SPDX ID of the software license.

See Also:

  • license=


360
# File 'brew/Library/Homebrew/formula.rb', line 360

delegate license: :"self.class"

#linked?Boolean

Is the formula linked?

Returns:

  • (Boolean)


568
569
570
# File 'brew/Library/Homebrew/formula.rb', line 568

def linked?
  linked_keg.symlink?
end

#linked_versionObject

PkgVersion of the linked keg for the formula.



585
586
587
588
589
# File 'brew/Library/Homebrew/formula.rb', line 585

def linked_version
  return unless linked?

  Keg.for(linked_keg).version
end

#livecheckObject

The livecheck specification for the software.

See Also:



370
# File 'brew/Library/Homebrew/formula.rb', line 370

delegate livecheck: :"self.class"

#livecheckable?Object

Is a livecheck specification defined for the software?

See Also:



375
# File 'brew/Library/Homebrew/formula.rb', line 375

delegate livecheckable?: :"self.class"

#manObject

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



674
675
676
# File 'brew/Library/Homebrew/formula.rb', line 674

def man
  share/"man"
end

#man1Object

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"


684
685
686
# File 'brew/Library/Homebrew/formula.rb', line 684

def man1
  man/"man1"
end

#man2Object

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.



691
692
693
# File 'brew/Library/Homebrew/formula.rb', line 691

def man2
  man/"man2"
end

#man3Object

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"


701
702
703
# File 'brew/Library/Homebrew/formula.rb', line 701

def man3
  man/"man3"
end

#man4Object

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.



708
709
710
# File 'brew/Library/Homebrew/formula.rb', line 708

def man4
  man/"man4"
end

#man5Object

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.



715
716
717
# File 'brew/Library/Homebrew/formula.rb', line 715

def man5
  man/"man5"
end

#man6Object

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.



722
723
724
# File 'brew/Library/Homebrew/formula.rb', line 722

def man6
  man/"man6"
end

#man7Object

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.



729
730
731
# File 'brew/Library/Homebrew/formula.rb', line 729

def man7
  man/"man7"
end

#man8Object

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.



736
737
738
# File 'brew/Library/Homebrew/formula.rb', line 736

def man8
  man/"man8"
end

#migration_needed?Boolean

Returns:

  • (Boolean)


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
# File 'brew/Library/Homebrew/formula.rb', line 1213

def migration_needed?
  return false unless oldname
  return false if rack.exist?

  old_rack = HOMEBREW_CELLAR/oldname
  return false unless old_rack.directory?
  return false if old_rack.subdirs.empty?

  tap == Tab.for_keg(old_rack.subdirs.min).tap
end

#missing_dependencies(hide: nil) ⇒ Object

Returns a list of formulae depended on by this formula that aren’t installed



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
# File 'brew/Library/Homebrew/formula.rb', line 1678

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

A version of FileUtils.mkdir that also changes to that folder in a block.



2080
2081
2082
2083
2084
2085
# File 'brew/Library/Homebrew/formula.rb', line 2080

def mkdir(name, &block)
  result = FileUtils.mkdir_p(name)
  return result unless block_given?

  FileUtils.chdir(name, &block)
end

#mktemp(prefix = name, opts = {}, &block) ⇒ Object

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.



2074
2075
2076
# File 'brew/Library/Homebrew/formula.rb', line 2074

def mktemp(prefix = name, opts = {}, &block)
  Mktemp.new(prefix, opts).run(&block)
end

#new_formula_available?Boolean

Returns:

  • (Boolean)


1263
1264
1265
# File 'brew/Library/Homebrew/formula.rb', line 1263

def new_formula_available?
  installed_alias_target_changed? && !latest_formula.latest_version_installed?
end

#old_installed_formulaeObject



1297
1298
1299
1300
1301
1302
1303
1304
# File 'brew/Library/Homebrew/formula.rb', line 1297

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

#oldnameObject

An old name for the formula



429
430
431
432
433
434
# File 'brew/Library/Homebrew/formula.rb', line 429

def oldname
  @oldname ||= if tap
    formula_renames = tap.formula_renames
    formula_renames.to_a.rassoc(name).first if formula_renames.value?(name)
  end
end

#opt_binObject



956
957
958
# File 'brew/Library/Homebrew/formula.rb', line 956

def opt_bin
  opt_prefix/"bin"
end

#opt_elispObject



984
985
986
# File 'brew/Library/Homebrew/formula.rb', line 984

def opt_elisp
  opt_prefix/"share/emacs/site-lisp"/name
end

#opt_frameworksObject



988
989
990
# File 'brew/Library/Homebrew/formula.rb', line 988

def opt_frameworks
  opt_prefix/"Frameworks"
end

#opt_includeObject



960
961
962
# File 'brew/Library/Homebrew/formula.rb', line 960

def opt_include
  opt_prefix/"include"
end

#opt_libObject



964
965
966
# File 'brew/Library/Homebrew/formula.rb', line 964

def opt_lib
  opt_prefix/"lib"
end

#opt_libexecObject



968
969
970
# File 'brew/Library/Homebrew/formula.rb', line 968

def opt_libexec
  opt_prefix/"libexec"
end

#opt_pkgshareObject



980
981
982
# File 'brew/Library/Homebrew/formula.rb', line 980

def opt_pkgshare
  opt_prefix/"share"/name
end

#opt_prefixObject

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"


952
953
954
# File 'brew/Library/Homebrew/formula.rb', line 952

def opt_prefix
  Pathname.new("#{HOMEBREW_PREFIX}/opt/#{name}")
end

#opt_sbinObject



972
973
974
# File 'brew/Library/Homebrew/formula.rb', line 972

def opt_sbin
  opt_prefix/"sbin"
end

#opt_shareObject



976
977
978
# File 'brew/Library/Homebrew/formula.rb', line 976

def opt_share
  opt_prefix/"share"
end

#option_defined?Object

If a named option is defined for the currently active SoftwareSpec.



480
# File 'brew/Library/Homebrew/formula.rb', line 480

delegate option_defined?: :active_spec

#optlinked?Boolean

Is the formula linked to opt?

Returns:

  • (Boolean)


573
574
575
# File 'brew/Library/Homebrew/formula.rb', line 573

def optlinked?
  opt_prefix.symlink?
end

#pkg_versionObject

The PkgVersion for this formula with version and #revision information.



401
402
403
# File 'brew/Library/Homebrew/formula.rb', line 401

def pkg_version
  PkgVersion.new(version, revision)
end

#pkgetcObject

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.



816
817
818
# File 'brew/Library/Homebrew/formula.rb', line 816

def pkgetc
  (HOMEBREW_PREFIX/"etc"/name).extend(InstallRenamed)
end

#pkgshareObject

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"


774
775
776
# File 'brew/Library/Homebrew/formula.rb', line 774

def pkgshare
  prefix/"share"/name
end

#plistObject

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


925
926
927
# File 'brew/Library/Homebrew/formula.rb', line 925

def plist
  nil
end

#plist_nameObject

The generated launchd #plist service name.



930
931
932
# File 'brew/Library/Homebrew/formula.rb', line 930

def plist_name
  "homebrew.mxcl.#{name}"
end

#plist_pathObject

The generated launchd #plist file path.



935
936
937
# File 'brew/Library/Homebrew/formula.rb', line 935

def plist_path
  prefix/"#{plist_name}.plist"
end

#post_installObject

Can be overridden to run commands on both source and bottle installation.



1006
# File 'brew/Library/Homebrew/formula.rb', line 1006

def post_install; end

#pour_bottle?Boolean

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.

Returns:

  • (Boolean)


998
999
1000
# File 'brew/Library/Homebrew/formula.rb', line 998

def pour_bottle?
  true
end

#prefix(v = pkg_version) ⇒ Object

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.



557
558
559
560
561
562
563
564
565
# File 'brew/Library/Homebrew/formula.rb', line 557

def prefix(v = pkg_version)
  versioned_prefix = versioned_prefix(v)
  if !@prefix_returns_versioned_prefix && v == pkg_version &&
     versioned_prefix.directory? && Keg.new(versioned_prefix).optlinked?
    opt_prefix
  else
    versioned_prefix
  end
end

#prefix_linked?(v = pkg_version) ⇒ Boolean

If a formula’s linked keg points to the prefix.

Returns:

  • (Boolean)


578
579
580
581
582
# File 'brew/Library/Homebrew/formula.rb', line 578

def prefix_linked?(v = pkg_version)
  return false unless linked?

  linked_keg.resolved_path == versioned_prefix(v)
end

#resourceObject

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" }


426
# File 'brew/Library/Homebrew/formula.rb', line 426

delegate resource: :active_spec

#resourcesObject

The Resources for the currently active SoftwareSpec.



449
# File 'brew/Library/Homebrew/formula.rb', line 449

def_delegator :"active_spec.resources", :values, :resources

#runtime_installed_formula_dependentsObject



1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
# File 'brew/Library/Homebrew/formula.rb', line 1659

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

#sbinObject

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.



744
745
746
# File 'brew/Library/Homebrew/formula.rb', line 744

def sbin
  prefix/"sbin"
end

#shareObject

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"


763
764
765
# File 'brew/Library/Homebrew/formula.rb', line 763

def share
  prefix/"share"
end

#shared_library(name, version = nil) ⇒ Object



1415
1416
1417
# File 'brew/Library/Homebrew/formula.rb', line 1415

def shared_library(name, version = nil)
  "#{name}.#{version}#{"." unless version.nil?}dylib"
end

#skip_cxxstdlib_check?Boolean

Returns:

  • (Boolean)


1153
1154
1155
# File 'brew/Library/Homebrew/formula.rb', line 1153

def skip_cxxstdlib_check?
  false
end

#specified_nameObject

The name specified to find this formula.



300
301
302
# File 'brew/Library/Homebrew/formula.rb', line 300

def specified_name
  alias_name || name
end

#specified_pathObject

The path that was specified to find this formula.



295
296
297
# File 'brew/Library/Homebrew/formula.rb', line 295

def specified_path
  alias_path || path
end

#std_cabal_v2_argsObject

Standard parameters for cabal-v2 builds.



1400
1401
1402
1403
1404
1405
1406
1407
1408
# File 'brew/Library/Homebrew/formula.rb', line 1400

def std_cabal_v2_args
  # 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_argsObject

Standard parameters for cargo builds.



1363
1364
1365
# File 'brew/Library/Homebrew/formula.rb', line 1363

def std_cargo_args
  ["--locked", "--root", prefix, "--path", "."]
end

#std_cmake_argsObject

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. Note: there isn’t a std_autotools variant because autotools is a lot less consistent and the standard parameters are more memorable.



1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
# File 'brew/Library/Homebrew/formula.rb', line 1373

def std_cmake_args
  args = %W[
    -DCMAKE_C_FLAGS_RELEASE=-DNDEBUG
    -DCMAKE_CXX_FLAGS_RELEASE=-DNDEBUG
    -DCMAKE_INSTALL_PREFIX=#{prefix}
    -DCMAKE_BUILD_TYPE=Release
    -DCMAKE_FIND_FRAMEWORK=LAST
    -DCMAKE_VERBOSE_MAKEFILE=ON
    -Wno-dev
  ]

  # 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_go_argsObject

Standard parameters for Go builds.



1395
1396
1397
# File 'brew/Library/Homebrew/formula.rb', line 1395

def std_go_args
  ["-trimpath", "-o", bin/name]
end

#std_meson_argsObject

Standard parameters for meson builds.



1411
1412
1413
# File 'brew/Library/Homebrew/formula.rb', line 1411

def std_meson_args
  ["--prefix=#{prefix}", "--libdir=#{lib}", "--buildtype=release", "--wrap-mode=nofallback"]
end

#supersedes_an_installed_formula?Boolean

Is this formula the target of an alias used to install an old formula?

Returns:

  • (Boolean)


1281
1282
1283
# File 'brew/Library/Homebrew/formula.rb', line 1281

def supersedes_an_installed_formula?
  old_installed_formulae.any?
end

#system(cmd, *args) ⇒ Object

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 we have some necessary defaults in #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 to:

args = ["--with-option1", "--with-option2"]

# Most software still uses `configure` and `make`.
# Check with `./configure --help` 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"


1934
1935
1936
1937
1938
1939
1940
1941
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
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
# File 'brew/Library/Homebrew/formula.rb', line 1934

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 -= %w[--disable-dependency-tracking --disable-debug --disable-silent-rules]
    when "cargo"
      pretty_args -= std_cargo_args
    when "cmake"
      pretty_args -= std_cmake_args
    when "go"
      pretty_args -= std_go_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 unless (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 { exec_cmd(cmd, args, log, logfn) }
    end

    Process.wait(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, 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

#to_sObject



1353
1354
1355
# File 'brew/Library/Homebrew/formula.rb', line 1353

def to_s
  name
end

#update_head_versionObject



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
# File 'brew/Library/Homebrew/formula.rb', line 384

def update_head_version
  return unless head?
  return unless head.downloader.is_a?(VCSDownloadStrategy)
  return unless head.downloader.cached_location.exist?

  path = if ENV["HOMEBREW_ENV"]
    ENV["PATH"]
  else
    ENV["HOMEBREW_PATH"]
  end

  with_env(PATH: path) do
    head.version.update_commit(head.downloader.last_commit)
  end
end

#varObject

The directory where the formula’s variable files should be installed. This directory is not inside the HOMEBREW_CELLAR so it persists across upgrades.



823
824
825
# File 'brew/Library/Homebrew/formula.rb', line 823

def var
  HOMEBREW_PREFIX/"var"
end

#versionObject

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.

See Also:



382
# File 'brew/Library/Homebrew/formula.rb', line 382

delegate version: :active_spec

#versioned_formula?Boolean

If this is a @-versioned formula.

Returns:

  • (Boolean)


406
407
408
# File 'brew/Library/Homebrew/formula.rb', line 406

def versioned_formula?
  name.include?("@")
end

#versioned_formulaeObject

Returns any @-versioned formulae for an non-@-versioned formula.



411
412
413
414
415
416
417
418
419
# File 'brew/Library/Homebrew/formula.rb', line 411

def versioned_formulae
  return [] if versioned_formula?

  Pathname.glob(path.to_s.gsub(/\.rb$/, "@*.rb")).map do |path|
    Formula[path.basename(".rb").to_s]
  rescue FormulaUnavailableError
    nil
  end.compact.sort_by(&:version).reverse
end

#with_logging(log_type) ⇒ Object

Runs a block with the given log type in effect for its duration



891
892
893
894
895
896
897
# File 'brew/Library/Homebrew/formula.rb', line 891

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) ⇒ Object

Run xcodebuild without Homebrew’s compiler environment variables set.



2088
2089
2090
2091
2092
2093
# File 'brew/Library/Homebrew/formula.rb', line 2088

def xcodebuild(*args)
  removed = ENV.remove_cc_etc
  system "xcodebuild", *args
ensure
  ENV.update(removed)
end

#zsh_completionObject

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.



855
856
857
# File 'brew/Library/Homebrew/formula.rb', line 855

def zsh_completion
  share/"zsh/site-functions"
end

#zsh_functionObject

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.



831
832
833
# File 'brew/Library/Homebrew/formula.rb', line 831

def zsh_function
  share/"zsh/site-functions"
end