Class: FormulaPin Private

Inherits:

Object

• Object
• FormulaPin

Defined in:

formula_pin.rb

Overview

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

Helper functions for pinning a formula.

Instance Method Summary

• #initialize(formula) ⇒ void constructor private
• #path ⇒ Pathname private
• #pin ⇒ void private
• #pin_at(version) ⇒ void private
• #pinnable? ⇒ Boolean private
• #pinned? ⇒ Boolean private
• #pinned_version ⇒ PkgVersion^? private
• #unpin ⇒ void private

Constructor Details

#initialize(formula) ⇒ void

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

Parameters:

• formula (Formula)

# File 'formula_pin.rb', line 9

def initialize(formula)
  @formula = formula
end

Instance Method Details

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

Returns:

• (Pathname)

# File 'formula_pin.rb', line 14

def path
  HOMEBREW_PINNED_KEGS/@formula.name
end

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

# File 'formula_pin.rb', line 26

def pin
  latest_keg = @formula.installed_kegs.max_by(&:scheme_and_version)
  return if latest_keg.nil?

  pin_at(latest_keg.version)
end

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

Parameters:

• version (PkgVersion)

# File 'formula_pin.rb', line 19

def pin_at(version)
  HOMEBREW_PINNED_KEGS.mkpath
  version_path = @formula.rack/version.to_s
  path.make_relative_symlink(version_path) if !pinned? && version_path.exist?
end

#pinnable? ⇒ Boolean

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

Returns:

• (Boolean)

# File 'formula_pin.rb', line 45

def pinnable?
  !@formula.installed_prefixes.empty?
end

#pinned? ⇒ Boolean

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

Returns:

• (Boolean)

# File 'formula_pin.rb', line 40

def pinned?
  path.symlink?
end

#pinned_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.

Returns:

• (PkgVersion, nil)

# File 'formula_pin.rb', line 50

def pinned_version
  Keg.new(path.resolved_path).version if pinned?
end

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

# File 'formula_pin.rb', line 34

def unpin
  path.unlink if pinned?
  HOMEBREW_PINNED_KEGS.rmdir_if_possible
end