Class: Requirement Private

Inherits:
Object
  • Object
show all
Extended by:
BuildEnvironment::DSL
Includes:
Dependable
Defined in:
Library/Homebrew/requirement.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

A base class for non-formula requirements needed by formulae. A fatal requirement is one that will fail the build if it is not present. By default, requirements are non-fatal.

Constant Summary

Constants included from Dependable

Dependable::RESERVED_TAGS

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dependable

#build?, #option_tags, #optional?, #options, #prune_from_option?, #prune_if_build_and_not_dependent?, #recommended?, #required?, #test?

Constructor Details

#initialize(tags = []) ⇒ Requirement

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Requirement.


18
19
20
21
22
23
24
25
26
27
28
29
30
# File 'Library/Homebrew/requirement.rb', line 18

def initialize(tags = [])
  @cask = self.class.cask
  @download = self.class.download
  tags.each do |tag|
    next unless tag.is_a? Hash

    @cask ||= tag[:cask]
    @download ||= tag[:download]
  end
  @tags = tags
  @tags << :build if self.class.build
  @name ||= infer_name
end

Class Attribute Details

.buildObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


159
160
161
# File 'Library/Homebrew/requirement.rb', line 159

def build
  @build
end

.env_procObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


159
160
161
# File 'Library/Homebrew/requirement.rb', line 159

def env_proc
  @env_proc
end

Instance Attribute Details

#caskObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


16
17
18
# File 'Library/Homebrew/requirement.rb', line 16

def cask
  @cask
end

#downloadObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


16
17
18
# File 'Library/Homebrew/requirement.rb', line 16

def download
  @download
end

#nameObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


16
17
18
# File 'Library/Homebrew/requirement.rb', line 16

def name
  @name
end

#tagsObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


16
17
18
# File 'Library/Homebrew/requirement.rb', line 16

def tags
  @tags
end

Class Method Details

.env(*settings, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


170
171
172
173
174
175
176
# File 'Library/Homebrew/requirement.rb', line 170

def env(*settings, &block)
  if block_given?
    @env_proc = block
  else
    super
  end
end

.expand(dependent, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Expand the requirements of dependent recursively, optionally yielding [dependent, req] pairs to allow callers to apply arbitrary filters to the list. The default filter, which is applied when a block is not given, omits optionals and recommendeds based on what the dependent has asked for.


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'Library/Homebrew/requirement.rb', line 215

def expand(dependent, &block)
  reqs = Requirements.new

  formulae = dependent.recursive_dependencies.map(&:to_formula)
  formulae.unshift(dependent)

  formulae.each do |f|
    f.requirements.each do |req|
      next if prune?(f, req, &block)

      reqs << req
    end
  end

  reqs
end

.pruneObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Used to prune requirements when calling expand with a block.


243
244
245
# File 'Library/Homebrew/requirement.rb', line 243

def prune
  throw(:prune, true)
end

.prune?(dependent, req, &_block) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

232
233
234
235
236
237
238
239
240
# File 'Library/Homebrew/requirement.rb', line 232

def prune?(dependent, req, &_block)
  catch(:prune) do
    if block_given?
      yield dependent, req
    elsif req.optional? || req.recommended?
      prune unless dependent.build.with?(req)
    end
  end
end

.satisfy(options = nil, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


163
164
165
166
167
168
# File 'Library/Homebrew/requirement.rb', line 163

def satisfy(options = nil, &block)
  return @satisfied if options.nil? && !block_given?

  options = {} if options.nil?
  @satisfied = Satisfier.new(options, &block)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


114
115
116
# File 'Library/Homebrew/requirement.rb', line 114

def ==(other)
  instance_of?(other.class) && name == other.name && tags == other.tags
end

#display_sObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


127
128
129
# File 'Library/Homebrew/requirement.rb', line 127

def display_s
  name
end

#envObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


106
107
108
# File 'Library/Homebrew/requirement.rb', line 106

def env
  self.class.env
end

#env_procObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


110
111
112
# File 'Library/Homebrew/requirement.rb', line 110

def env_proc
  self.class.env_proc
end

#fatal?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Overriding #fatal? is unsupported. Pass a boolean to the fatal DSL method instead.

Returns:

  • (Boolean)

73
74
75
# File 'Library/Homebrew/requirement.rb', line 73

def fatal?
  self.class.fatal || false
end

#hashObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


119
120
121
# File 'Library/Homebrew/requirement.rb', line 119

def hash
  name.hash ^ tags.hash
end

#inspectObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


123
124
125
# File 'Library/Homebrew/requirement.rb', line 123

def inspect
  "#<#{self.class.name}: #{name.inspect} #{tags.inspect}>"
end

#messageObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The message to show when the requirement is not met.


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'Library/Homebrew/requirement.rb', line 37

def message
  _, _, class_name = self.class.to_s.rpartition "::"
  s = "#{class_name} unsatisfied!\n"
  if cask
    s += <<~EOS
      You can install with Homebrew Cask:
        brew cask install #{cask}
    EOS
  end

  if download
    s += <<~EOS
      You can download from:
        #{download}
    EOS
  end
  s
end

#mktemp(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


131
132
133
# File 'Library/Homebrew/requirement.rb', line 131

def mktemp(&block)
  Mktemp.new(name).run(&block)
end

#modify_build_environment(env: nil, cc: nil, build_bottle: false, bottle_arch: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Overriding #modify_build_environment is unsupported. Pass a block to the env DSL method instead.


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'Library/Homebrew/requirement.rb', line 89

def modify_build_environment(env: nil, cc: nil, build_bottle: false, bottle_arch: nil)
  satisfied?(env: env, cc: cc, build_bottle: build_bottle, bottle_arch: bottle_arch)
  instance_eval(&env_proc) if env_proc

  # XXX If the satisfy block returns a Pathname, then make sure that it
  # remains available on the PATH. This makes requirements like
  #   satisfy { which("executable") }
  # work, even under superenv where "executable" wouldn't normally be on the
  # PATH.
  parent = satisfied_result_parent
  return unless parent
  return if ["#{HOMEBREW_PREFIX}/bin", "#{HOMEBREW_PREFIX}/bin"].include?(parent.to_s)
  return if PATH.new(ENV["PATH"]).include?(parent.to_s)

  ENV.prepend_path("PATH", parent)
end

#option_namesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


32
33
34
# File 'Library/Homebrew/requirement.rb', line 32

def option_names
  [name]
end

#satisfied?(env: nil, cc: nil, build_bottle: false, bottle_arch: nil) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Overriding #satisfied? is unsupported. Pass a block or boolean to the satisfy DSL method instead.

Returns:

  • (Boolean)

58
59
60
61
62
63
64
65
66
67
68
69
# File 'Library/Homebrew/requirement.rb', line 58

def satisfied?(env: nil, cc: nil, build_bottle: false, bottle_arch: nil)
  satisfy = self.class.satisfy
  return true unless satisfy

  @satisfied_result =
    satisfy.yielder(env: env, cc: cc, build_bottle: build_bottle, bottle_arch: bottle_arch) do |p|
      instance_eval(&p)
    end
  return false unless @satisfied_result

  true
end

#satisfied_result_parentObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


77
78
79
80
81
82
83
84
85
# File 'Library/Homebrew/requirement.rb', line 77

def satisfied_result_parent
  return unless @satisfied_result.is_a?(Pathname)

  parent = @satisfied_result.resolved_path.parent
  if parent.to_s =~ %r{^#{Regexp.escape(HOMEBREW_CELLAR)}/([\[email protected]]+)/[^/]+/(s?bin)/?$}
    parent = HOMEBREW_PREFIX/"opt/#{Regexp.last_match(1)}/#{Regexp.last_match(2)}"
  end
  parent
end