Class: Tab

Inherits:
OpenStruct
  • Object
show all
Extended by:
Cachable, T::Sig
Defined in:
tab.rb

Overview

Inherit from OpenStruct to gain a generic initialization method that takes a hash and creates an attribute for each key and value. Rather than calling new directly, use one of the class methods like Tab.create.

Constant Summary collapse

FILENAME =
"INSTALL_RECEIPT.json"

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

.create(formula, compiler, stdlib) ⇒ Object

Instantiates a Tab for a new installation of a formula.



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
# File 'tab.rb', line 22

def self.create(formula, compiler, stdlib)
  build = formula.build
  runtime_deps = formula.runtime_dependencies(undeclared: false)
  attributes = {
    "homebrew_version"        => HOMEBREW_VERSION,
    "used_options"            => build.used_options.as_flags,
    "unused_options"          => build.unused_options.as_flags,
    "tabfile"                 => formula.prefix/FILENAME,
    "built_as_bottle"         => build.bottle?,
    "installed_as_dependency" => false,
    "installed_on_request"    => false,
    "poured_from_bottle"      => false,
    "time"                    => Time.now.to_i,
    "source_modified_time"    => formula.source_modified_time.to_i,
    "compiler"                => compiler,
    "stdlib"                  => stdlib,
    "aliases"                 => formula.aliases,
    "runtime_dependencies"    => Tab.runtime_deps_hash(formula, runtime_deps),
    "arch"                    => Hardware::CPU.arch,
    "source"                  => {
      "path"         => formula.specified_path.to_s,
      "tap"          => formula.tap&.name,
      "tap_git_head" => nil, # Filled in later if possible
      "spec"         => formula.active_spec_sym.to_s,
      "versions"     => {
        "stable"         => formula.stable&.version.to_s,
        "head"           => formula.head&.version.to_s,
        "version_scheme" => formula.version_scheme,
      },
    },
    "built_on"                => DevelopmentTools.build_system_info,
  }

  # We can only get `tap_git_head` if the tap is installed locally
  attributes["source"]["tap_git_head"] = formula.tap.git_head if formula.tap&.installed?

  new(attributes)
end

.emptyObject



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
# File 'tab.rb', line 183

def self.empty
  attributes = {
    "homebrew_version"        => HOMEBREW_VERSION,
    "used_options"            => [],
    "unused_options"          => [],
    "built_as_bottle"         => false,
    "installed_as_dependency" => false,
    "installed_on_request"    => false,
    "poured_from_bottle"      => false,
    "time"                    => nil,
    "source_modified_time"    => 0,
    "stdlib"                  => nil,
    "compiler"                => DevelopmentTools.default_compiler,
    "aliases"                 => [],
    "runtime_dependencies"    => nil,
    "arch"                    => nil,
    "source"                  => {
      "path"         => nil,
      "tap"          => nil,
      "tap_git_head" => nil,
      "spec"         => "stable",
      "versions"     => {
        "stable"         => nil,
        "head"           => nil,
        "version_scheme" => 0,
      },
    },
    "built_on"                => DevelopmentTools.generic_build_system_info,
  }

  new(attributes)
end

.for_formula(f) ⇒ Object

Returns a Tab for an already installed formula, or a fake one if the formula is not installed.



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
# File 'tab.rb', line 145

def self.for_formula(f)
  paths = []

  paths << f.opt_prefix.resolved_path if f.opt_prefix.symlink? && f.opt_prefix.directory?

  paths << f.linked_keg.resolved_path if f.linked_keg.symlink? && f.linked_keg.directory?

  if (dirs = f.installed_prefixes).length == 1
    paths << dirs.first
  end

  paths << f.latest_installed_prefix

  path = paths.map { |pn| pn/FILENAME }.find(&:file?)

  if path
    tab = from_file(path)
    used_options = remap_deprecated_options(f.deprecated_options, tab.used_options)
    tab.used_options = used_options.as_flags
  else
    # Formula is not installed. Return a fake tab.
    tab = empty
    tab.unused_options = f.options.as_flags
    tab.source = {
      "path"     => f.specified_path.to_s,
      "tap"      => f.tap&.name,
      "spec"     => f.active_spec_sym.to_s,
      "versions" => {
        "stable"         => f.stable&.version.to_s,
        "head"           => f.head&.version.to_s,
        "version_scheme" => f.version_scheme,
      },
    }
  end

  tab
end

.for_keg(keg) ⇒ Object



113
114
115
116
117
118
119
120
121
122
123
124
# File 'tab.rb', line 113

def self.for_keg(keg)
  path = keg/FILENAME

  tab = if path.exist?
    from_file(path)
  else
    empty
  end

  tab["tabfile"] = path
  tab
end

.for_name(name) ⇒ Object

Returns a Tab for the named formula’s installation, or a fake one if the formula is not installed.



128
129
130
# File 'tab.rb', line 128

def self.for_name(name)
  for_formula(Formulary.factory(name))
end

.from_file(path) ⇒ Object

Returns the Tab for an install receipt at path. Results are cached.



63
64
65
66
67
68
69
70
# File 'tab.rb', line 63

def self.from_file(path)
  cache.fetch(path) do |p|
    content = File.read(p)
    return empty if content.blank?

    cache[p] = from_file_content(content, p)
  end
end

.from_file_content(content, path) ⇒ Object

Like from_file, but bypass the cache.



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
# File 'tab.rb', line 73

def self.from_file_content(content, path)
  attributes = begin
    JSON.parse(content)
  rescue JSON::ParserError => e
    raise e, "Cannot parse #{path}: #{e}", e.backtrace
  end
  attributes["tabfile"] = path
  attributes["source_modified_time"] ||= 0
  attributes["source"] ||= {}

  tapped_from = attributes["tapped_from"]
  if !tapped_from.nil? && tapped_from != "path or URL"
    attributes["source"]["tap"] = attributes.delete("tapped_from")
  end

  if attributes["source"]["tap"] == "mxcl/master" ||
     attributes["source"]["tap"] == "Homebrew/homebrew"
    attributes["source"]["tap"] = "homebrew/core"
  end

  if attributes["source"]["spec"].nil?
    version = PkgVersion.parse path.to_s.split("/").second_to_last
    attributes["source"]["spec"] = if version.head?
      "head"
    else
      "stable"
    end
  end

  if attributes["source"]["versions"].nil?
    attributes["source"]["versions"] = {
      "stable"         => nil,
      "head"           => nil,
      "version_scheme" => 0,
    }
  end

  new(attributes)
end

.remap_deprecated_options(deprecated_options, options) ⇒ Object



132
133
134
135
136
137
138
139
140
141
# File 'tab.rb', line 132

def self.remap_deprecated_options(deprecated_options, options)
  deprecated_options.each do |deprecated_option|
    option = options.find { |o| o.name == deprecated_option.old }
    next unless option

    options -= [option]
    options << Option.new(deprecated_option.current, option.description)
  end
  options
end

.runtime_deps_hash(formula, deps) ⇒ Object



216
217
218
219
220
221
222
223
224
225
# File 'tab.rb', line 216

def self.runtime_deps_hash(formula, deps)
  deps.map do |dep|
    f = dep.to_formula
    {
      "full_name"         => f.full_name,
      "version"           => f.version.to_s,
      "declared_directly" => formula.deps.include?(dep),
    }
  end
end

Instance Method Details

#any_args_or_options?Boolean

Returns:

  • (Boolean)


227
228
229
# File 'tab.rb', line 227

def any_args_or_options?
  !used_options.empty? || !unused_options.empty?
end

#bottle?Boolean

Returns:

  • (Boolean)


289
290
291
# File 'tab.rb', line 289

def bottle?
  built_as_bottle
end

#built_bottle?Boolean

Returns:

  • (Boolean)


285
286
287
# File 'tab.rb', line 285

def built_bottle?
  built_as_bottle && !poured_from_bottle
end

#compilerObject



263
264
265
# File 'tab.rb', line 263

def compiler
  super || DevelopmentTools.default_compiler
end

#cxxstdlibObject



279
280
281
282
283
# File 'tab.rb', line 279

def cxxstdlib
  # Older tabs won't have these values, so provide sensible defaults
  lib = stdlib.to_sym if stdlib
  CxxStdlib.create(lib, compiler.to_sym)
end

#head?Boolean

Returns:

  • (Boolean)


247
248
249
# File 'tab.rb', line 247

def head?
  spec == :head
end

#head_versionObject



315
316
317
# File 'tab.rb', line 315

def head_version
  Version.create(versions["head"]) if versions["head"]
end

#include?(opt) ⇒ Boolean

Returns:

  • (Boolean)


243
244
245
# File 'tab.rb', line 243

def include?(opt)
  used_options.include? opt
end

#parsed_homebrew_versionObject



267
268
269
270
271
# File 'tab.rb', line 267

def parsed_homebrew_version
  return Version::NULL if homebrew_version.nil?

  Version.new(homebrew_version)
end

#runtime_dependenciesObject



273
274
275
276
277
# File 'tab.rb', line 273

def runtime_dependencies
  # Homebrew versions prior to 1.1.6 generated incorrect runtime dependency
  # lists.
  super unless parsed_homebrew_version < "1.1.6"
end

#source_modified_timeTime

Returns:

  • (Time)


324
325
326
# File 'tab.rb', line 324

def source_modified_time
  Time.at(super || 0)
end

#specObject



303
304
305
# File 'tab.rb', line 303

def spec
  source["spec"].to_sym
end

#stable?Boolean

Returns:

  • (Boolean)


251
252
253
# File 'tab.rb', line 251

def stable?
  spec == :stable
end

#stable_versionObject



311
312
313
# File 'tab.rb', line 311

def stable_version
  Version.create(versions["stable"]) if versions["stable"]
end

#tapObject



293
294
295
296
# File 'tab.rb', line 293

def tap
  tap_name = source["tap"]
  Tap.fetch(tap_name) if tap_name
end

#tap=(tap) ⇒ Object



298
299
300
301
# File 'tab.rb', line 298

def tap=(tap)
  tap_name = tap.respond_to?(:name) ? tap.name : tap
  source["tap"] = tap_name
end

#to_bottle_hashObject

a subset of to_json that we care about for bottles



354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'tab.rb', line 354

def to_bottle_hash
  attributes = {
    "homebrew_version"     => homebrew_version,
    "changed_files"        => changed_files&.map(&:to_s),
    "source_modified_time" => source_modified_time.to_i,
    "stdlib"               => stdlib&.to_s,
    "compiler"             => compiler&.to_s,
    "runtime_dependencies" => runtime_dependencies,
    "arch"                 => arch,
    "built_on"             => built_on,
  }
  attributes.delete("stdlib") if attributes["stdlib"].blank?
  attributes
end

#to_json(options = nil) ⇒ Object



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'tab.rb', line 328

def to_json(options = nil)
  attributes = {
    "homebrew_version"        => homebrew_version,
    "used_options"            => used_options.as_flags,
    "unused_options"          => unused_options.as_flags,
    "built_as_bottle"         => built_as_bottle,
    "poured_from_bottle"      => poured_from_bottle,
    "installed_as_dependency" => installed_as_dependency,
    "installed_on_request"    => installed_on_request,
    "changed_files"           => changed_files&.map(&:to_s),
    "time"                    => time,
    "source_modified_time"    => source_modified_time.to_i,
    "stdlib"                  => stdlib&.to_s,
    "compiler"                => compiler&.to_s,
    "aliases"                 => aliases,
    "runtime_dependencies"    => runtime_dependencies,
    "source"                  => source,
    "arch"                    => arch,
    "built_on"                => built_on,
  }
  attributes.delete("stdlib") if attributes["stdlib"].blank?

  JSON.pretty_generate(attributes, options)
end

#to_sString

Returns:



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
# File 'tab.rb', line 379

def to_s
  s = []
  s << if poured_from_bottle
    "Poured from bottle"
  else
    "Built from source"
  end

  s << Time.at(time).strftime("on %Y-%m-%d at %H:%M:%S") if time

  unless used_options.empty?
    s << "with:"
    s << used_options.to_a.join(" ")
  end
  s.join(" ")
end

#unused_optionsObject



259
260
261
# File 'tab.rb', line 259

def unused_options
  Options.create(super)
end

#used_optionsObject



255
256
257
# File 'tab.rb', line 255

def used_options
  Options.create(super)
end

#version_schemeObject



319
320
321
# File 'tab.rb', line 319

def version_scheme
  versions["version_scheme"] || 0
end

#versionsObject



307
308
309
# File 'tab.rb', line 307

def versions
  source["versions"]
end

#with?(val) ⇒ Boolean

Returns:

  • (Boolean)


231
232
233
234
235
236
237
# File 'tab.rb', line 231

def with?(val)
  option_names = val.respond_to?(:option_names) ? val.option_names : [val]

  option_names.any? do |name|
    include?("with-#{name}") || unused_options.include?("without-#{name}")
  end
end

#without?(val) ⇒ Boolean

Returns:

  • (Boolean)


239
240
241
# File 'tab.rb', line 239

def without?(val)
  !with?(val)
end

#writeObject



369
370
371
372
373
374
375
376
# File 'tab.rb', line 369

def write
  # If this is a new installation, the cache of installed formulae
  # will no longer be valid.
  Formula.clear_cache unless tabfile.exist?

  self.class.cache[tabfile] = self
  tabfile.atomic_write(to_json)
end