-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
requirement.rb
262 lines (214 loc) 路 6.26 KB
/
requirement.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
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
258
259
260
261
262
# typed: true
# frozen_string_literal: true
require "dependable"
require "dependency"
require "dependencies"
require "build_environment"
# 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.
#
# @api private
class Requirement
extend T::Sig
include Dependable
extend Cachable
attr_reader :tags, :name, :cask, :download
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
def option_names
[name]
end
# The message to show when the requirement is not met.
sig { returns(String) }
def message
_, _, class_name = self.class.to_s.rpartition "::"
s = "#{class_name} unsatisfied!\n"
if cask
s += <<~EOS
You can install the necessary cask with:
brew install --cask #{cask}
EOS
end
if download
s += <<~EOS
You can download from:
#{Formatter.url(download)}
EOS
end
s
end
# Overriding {#satisfied?} is unsupported.
# Pass a block or boolean to the satisfy DSL method instead.
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
# Overriding {#fatal?} is unsupported.
# Pass a boolean to the fatal DSL method instead.
def fatal?
self.class.fatal || false
end
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)}/([\w+-.@]+)/[^/]+/(s?bin)/?$}o
parent = HOMEBREW_PREFIX/"opt/#{Regexp.last_match(1)}/#{Regexp.last_match(2)}"
end
parent
end
# Overriding {#modify_build_environment} is unsupported.
# Pass a block to the env DSL method instead.
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
def env
self.class.env
end
def env_proc
self.class.env_proc
end
def ==(other)
instance_of?(other.class) && name == other.name && tags == other.tags
end
alias eql? ==
def hash
name.hash ^ tags.hash
end
sig { returns(String) }
def inspect
"#<#{self.class.name}: #{tags.inspect}>"
end
def display_s
name.capitalize
end
def mktemp(&block)
Mktemp.new(name).run(&block)
end
private
def infer_name
klass = self.class.name || self.class.to_s
klass.sub!(/(Dependency|Requirement)$/, "")
klass.sub!(/^(\w+::)*/, "")
return klass.downcase if klass.present?
return @cask if @cask.present?
""
end
def which(cmd)
super(cmd, PATH.new(ORIGINAL_PATHS))
end
def which_all(cmd)
super(cmd, PATH.new(ORIGINAL_PATHS))
end
class << self
extend T::Sig
include BuildEnvironment::DSL
attr_reader :env_proc, :build
attr_rw :fatal, :cask, :download
def satisfy(options = nil, &block)
return @satisfied if options.nil? && !block
options = {} if options.nil?
@satisfied = Satisfier.new(options, &block)
end
def env(*settings, &block)
if block
@env_proc = block
else
super
end
end
end
# Helper class for evaluating whether a requirement is satisfied.
class Satisfier
def initialize(options, &block)
case options
when Hash
@options = { build_env: true }
@options.merge!(options)
else
@satisfied = options
end
@proc = block
end
def yielder(env: nil, cc: nil, build_bottle: false, bottle_arch: nil)
if instance_variable_defined?(:@satisfied)
@satisfied
elsif @options[:build_env]
require "extend/ENV"
ENV.with_build_environment(
env: env, cc: cc, build_bottle: build_bottle, bottle_arch: bottle_arch,
) do
yield @proc
end
else
yield @proc
end
end
end
private_constant :Satisfier
class << self
# 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.
def expand(dependent, cache_key: nil, &block)
if cache_key.present?
cache[cache_key] ||= {}
return cache[cache_key][dependent.full_name].dup if cache[cache_key][dependent.full_name]
end
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
cache[cache_key][dependent.full_name] = reqs.dup if cache_key.present?
reqs
end
def prune?(dependent, req, &block)
catch(:prune) do
if block
yield dependent, req
elsif req.optional? || req.recommended?
prune unless dependent.build.with?(req)
end
end
end
# Used to prune requirements when calling expand with a block.
sig { void }
def prune
throw(:prune, true)
end
end
end