Class: Cask::DSL
Private
- Inherits:
-
Object
show all
- Extended by:
- Predicable
- Includes:
- OnSystem::MacOSOnly
- Defined in:
- cask/dsl.rb,
cask/dsl/base.rb,
cask/dsl/caveats.rb,
cask/dsl/version.rb,
cask/dsl/container.rb,
cask/dsl/preflight.rb,
cask/dsl/depends_on.rb,
cask/dsl/postflight.rb,
cask/dsl/conflicts_with.rb,
cask/dsl/uninstall_preflight.rb,
cask/dsl/uninstall_postflight.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.
Class representing the domain-specific language used for casks.
Defined Under Namespace
Classes: Base, Caveats, ConflictsWith, Container, DependsOn, Postflight, Preflight, UninstallPostflight, UninstallPreflight, Version
Constant Summary
collapse
- ORDINARY_ARTIFACT_CLASSES =
This constant is part of a private API.
This constant may only be used in the Homebrew/brew repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[
Artifact::Installer,
Artifact::App,
Artifact::Artifact,
Artifact::AudioUnitPlugin,
Artifact::Binary,
Artifact::Colorpicker,
Artifact::Dictionary,
Artifact::Font,
Artifact::InputMethod,
Artifact::InternetPlugin,
Artifact::KeyboardLayout,
Artifact::Manpage,
Artifact::Pkg,
Artifact::Prefpane,
Artifact::Qlplugin,
Artifact::Mdimporter,
Artifact::ScreenSaver,
Artifact::Service,
Artifact::StageOnly,
Artifact::Suite,
Artifact::VstPlugin,
Artifact::Vst3Plugin,
Artifact::Uninstall,
Artifact::Zap,
].freeze
- ACTIVATABLE_ARTIFACT_CLASSES =
This constant is part of a private API.
This constant may only be used in the Homebrew/brew repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
(ORDINARY_ARTIFACT_CLASSES - [Artifact::StageOnly]).freeze
- ARTIFACT_BLOCK_CLASSES =
This constant is part of a private API.
This constant may only be used in the Homebrew/brew repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[
Artifact::PreflightBlock,
Artifact::PostflightBlock,
].freeze
- DSL_METHODS =
This constant is part of a private API.
This constant may only be used in the Homebrew/brew repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
Set.new([
:appcast,
:arch,
:artifacts,
:auto_updates,
:caveats,
:conflicts_with,
:container,
:desc,
:depends_on,
:homepage,
:language,
:name,
:sha256,
:staged_path,
:url,
:version,
:appdir,
:discontinued?,
:livecheck,
:livecheckable?,
:on_system_blocks_exist?,
*ORDINARY_ARTIFACT_CLASSES.map(&:dsl_key),
*ACTIVATABLE_ARTIFACT_CLASSES.map(&:dsl_key),
*ARTIFACT_BLOCK_CLASSES.flat_map { |klass| [klass.dsl_key, klass.uninstall_dsl_key] },
]).freeze
Instance Attribute Summary collapse
Instance Method Summary
collapse
-
#appcast(*args, **kwargs) ⇒ Object
-
#appdir ⇒ Object
-
#arch(arm: nil, intel: nil) ⇒ Object
-
#artifacts ⇒ Object
private
-
#auto_updates(auto_updates = nil) ⇒ Object
-
#caskroom_path ⇒ Object
private
-
#caveats(*strings, &block) ⇒ Object
-
#conflicts_with(**kwargs) ⇒ Object
-
#container(**kwargs) ⇒ Object
-
#depends_on(**kwargs) ⇒ Object
depends_on
uses a load method so that multiple stanzas can be merged.
-
#desc(description = nil) ⇒ Object
-
#discontinued? ⇒ Boolean
private
-
#homepage(homepage = nil) ⇒ Object
-
#initialize(cask) ⇒ DSL
constructor
private
-
#language(*args, default: false, &block) ⇒ Object
private
-
#language_eval ⇒ Object
private
-
#languages ⇒ Object
private
-
#livecheck(&block) ⇒ Object
-
#livecheckable? ⇒ Boolean
private
-
#method_missing(method) ⇒ Object
private
-
#name(*args) ⇒ Object
-
#respond_to_missing? ⇒ Boolean
private
-
#set_unique_stanza(stanza, should_return) ⇒ Object
private
-
#sha256(arg = nil, arm: nil, intel: nil) ⇒ Object
-
#staged_path ⇒ Object
-
#url(*args, **options, &block) ⇒ Object
-
#version(arg = nil) ⇒ Object
Methods included from Predicable
attr_predicate
included
Constructor Details
#initialize(cask) ⇒ DSL
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 new instance of DSL.
103
104
105
106
|
# File 'cask/dsl.rb', line 103
def initialize(cask)
@cask = cask
@token = cask.token
end
|
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method) ⇒ 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.
369
370
371
372
373
374
375
376
|
# File 'cask/dsl.rb', line 369
def method_missing(method, *)
if method
Utils.method_missing_message(method, token)
nil
else
super
end
end
|
Instance Attribute Details
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
100
101
|
# File 'cask/dsl.rb', line 99
def cask
@cask
end
|
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
100
101
|
# File 'cask/dsl.rb', line 99
def token
@token
end
|
Instance Method Details
#appcast(*args, **kwargs) ⇒ Object
212
213
214
215
216
217
|
# File 'cask/dsl.rb', line 212
def appcast(*args, **kwargs)
set_unique_stanza(:appcast, args.empty? && kwargs.empty?) do
odeprecated "the `appcast` stanza", "the `livecheck` stanza"
true
end
end
|
#arch(arm: nil, intel: nil) ⇒ Object
257
258
259
260
261
262
263
264
265
|
# File 'cask/dsl.rb', line 257
def arch(arm: nil, intel: nil)
should_return = arm.nil? && intel.nil?
set_unique_stanza(:arch, should_return) do
@on_system_blocks_exist = true
on_arch_conditional(arm: arm, intel: intel)
end
end
|
#artifacts ⇒ 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.
287
288
289
|
# File 'cask/dsl.rb', line 287
def artifacts
@artifacts ||= ArtifactSet.new
end
|
#auto_updates(auto_updates = nil) ⇒ Object
323
324
325
|
# File 'cask/dsl.rb', line 323
def auto_updates(auto_updates = nil)
set_unique_stanza(:auto_updates, auto_updates.nil?) { auto_updates }
end
|
#caskroom_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.
291
292
293
|
# File 'cask/dsl.rb', line 291
def caskroom_path
cask.caskroom_path
end
|
#caveats(*strings, &block) ⇒ Object
304
305
306
307
308
309
310
311
312
313
314
315
316
|
# File 'cask/dsl.rb', line 304
def caveats(*strings, &block)
@caveats ||= DSL::Caveats.new(cask)
if block
@caveats.eval_caveats(&block)
elsif strings.any?
strings.each do |string|
@caveats.eval_caveats { string }
end
else
return @caveats.to_s
end
@caveats
end
|
#conflicts_with(**kwargs) ⇒ Object
282
283
284
285
|
# File 'cask/dsl.rb', line 282
def conflicts_with(**kwargs)
set_unique_stanza(:conflicts_with, kwargs.empty?) { DSL::ConflictsWith.new(**kwargs) }
end
|
#container(**kwargs) ⇒ Object
220
221
222
223
224
|
# File 'cask/dsl.rb', line 220
def container(**kwargs)
set_unique_stanza(:container, kwargs.empty?) do
DSL::Container.new(**kwargs)
end
end
|
#depends_on(**kwargs) ⇒ Object
depends_on
uses a load method so that multiple stanzas can be merged.
269
270
271
272
273
274
275
276
277
278
279
|
# File 'cask/dsl.rb', line 269
def depends_on(**kwargs)
@depends_on ||= DSL::DependsOn.new
return @depends_on if kwargs.empty?
begin
@depends_on.load(**kwargs)
rescue RuntimeError => e
raise CaskInvalidError.new(cask, e)
end
@depends_on
end
|
#desc(description = nil) ⇒ Object
117
118
119
|
# File 'cask/dsl.rb', line 117
def desc(description = nil)
set_unique_stanza(:desc, description.nil?) { description }
end
|
#discontinued? ⇒ 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.
318
319
320
|
# File 'cask/dsl.rb', line 318
def discontinued?
@caveats&.discontinued? == true
end
|
#homepage(homepage = nil) ⇒ Object
143
144
145
|
# File 'cask/dsl.rb', line 143
def homepage(homepage = nil)
set_unique_stanza(:homepage, homepage.nil?) { homepage }
end
|
#language(*args, default: false, &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.
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
# File 'cask/dsl.rb', line 147
def language(*args, default: false, &block)
if args.empty?
language_eval
elsif block
@language_blocks ||= {}
@language_blocks[args] = block
return unless default
if !@cask.allow_reassignment && @language_blocks.default.present?
raise CaskInvalidError.new(cask, "Only one default language may be defined.")
end
@language_blocks.default = block
else
raise CaskInvalidError.new(cask, "No block given to language stanza.")
end
end
|
#language_eval ⇒ 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.
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
|
# File 'cask/dsl.rb', line 166
def language_eval
return @language_eval if defined?(@language_eval)
return @language_eval = nil if @language_blocks.blank?
raise CaskInvalidError.new(cask, "No default language specified.") if @language_blocks.default.nil?
locales = cask.config.languages
.map do |language|
Locale.parse(language)
rescue Locale::ParserError
nil
end
.compact
locales.each do |locale|
key = locale.detect(@language_blocks.keys)
next if key.nil?
return @language_eval = @language_blocks[key].call
end
@language_eval = @language_blocks.default.call
end
|
#languages ⇒ 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.
192
193
194
195
196
|
# File 'cask/dsl.rb', line 192
def languages
return [] if @language_blocks.nil?
@language_blocks.keys.flatten
end
|
#livecheck(&block) ⇒ Object
328
329
330
331
332
333
334
335
336
337
338
|
# File 'cask/dsl.rb', line 328
def livecheck(&block)
@livecheck ||= Livecheck.new(cask)
return @livecheck unless block
if !@cask.allow_reassignment && @livecheckable
raise CaskInvalidError.new(cask, "'livecheck' stanza may only appear once.")
end
@livecheckable = true
@livecheck.instance_eval(&block)
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.
340
341
342
|
# File 'cask/dsl.rb', line 340
def livecheckable?
@livecheckable == true
end
|
#name(*args) ⇒ Object
109
110
111
112
113
114
|
# File 'cask/dsl.rb', line 109
def name(*args)
@name ||= []
return @name if args.empty?
@name.concat(args.flatten)
end
|
#respond_to_missing? ⇒ 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.
378
379
380
|
# File 'cask/dsl.rb', line 378
def respond_to_missing?(*)
true
end
|
#set_unique_stanza(stanza, should_return) ⇒ 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.
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# File 'cask/dsl.rb', line 121
def set_unique_stanza(stanza, should_return)
return instance_variable_get("@#{stanza}") if should_return
unless @cask.allow_reassignment
if instance_variable_defined?("@#{stanza}") && !@called_in_on_system_block
raise CaskInvalidError.new(cask, "'#{stanza}' stanza may only appear once.")
end
if instance_variable_defined?("@#{stanza}_set_in_block") && @called_in_on_system_block
raise CaskInvalidError.new(cask, "'#{stanza}' stanza may only be overridden once.")
end
end
instance_variable_set("@#{stanza}_set_in_block", true) if @called_in_on_system_block
instance_variable_set("@#{stanza}", yield)
rescue CaskInvalidError
raise
rescue => e
raise CaskInvalidError.new(cask, "'#{stanza}' stanza failed with: #{e}")
end
|
#sha256(arg = nil, arm: nil, intel: nil) ⇒ Object
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
# File 'cask/dsl.rb', line 238
def sha256(arg = nil, arm: nil, intel: nil)
should_return = arg.nil? && arm.nil? && intel.nil?
set_unique_stanza(:sha256, should_return) do
@on_system_blocks_exist = true if arm.present? || intel.present?
val = arg || on_arch_conditional(arm: arm, intel: intel)
case val
when :no_check
val
when String
Checksum.new(val)
else
raise CaskInvalidError.new(cask, "invalid 'sha256' value: #{val.inspect}")
end
end
end
|
#staged_path ⇒ Object
296
297
298
299
300
301
|
# File 'cask/dsl.rb', line 296
def staged_path
return @staged_path if @staged_path
cask_version = version || :unknown
@staged_path = caskroom_path.join(cask_version.to_s)
end
|
#url(*args, **options, &block) ⇒ Object
199
200
201
202
203
204
205
206
207
208
209
|
# File 'cask/dsl.rb', line 199
def url(*args, **options, &block)
caller_location = T.must(caller_locations).fetch(0)
set_unique_stanza(:url, args.empty? && options.empty? && !block) do
if block
URL.new(*args, **options, caller_location: caller_location, dsl: self, &block)
else
URL.new(*args, **options, caller_location: caller_location)
end
end
end
|
#version(arg = nil) ⇒ Object
227
228
229
230
231
232
233
234
235
|
# File 'cask/dsl.rb', line 227
def version(arg = nil)
set_unique_stanza(:version, arg.nil?) do
if !arg.is_a?(String) && arg != :latest
raise CaskInvalidError.new(cask, "invalid 'version' value: #{arg.inspect}")
end
DSL::Version.new(arg)
end
end
|