Module: SystemConfig Private

Extended by:
SystemCommand::Mixin
Defined in:
system_config.rb

Overview

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

Helper module for querying information about the system configuration.

Class Method Summary collapse

Methods included from SystemCommand::Mixin

system_command, system_command!

Class Method Details

.branch ⇒ String

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:



54
55
56
 
# File 'system_config.rb', line 54

def branch
  homebrew_head_info[2] || "(none)"
end

.clang ⇒ Version

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:



23
24
25
26
27
28
29
 
# File 'system_config.rb', line 23

def clang
  @clang ||= if DevelopmentTools.installed?
    DevelopmentTools.clang_version
  else
    Version::NULL
  end
end

.clang_build ⇒ Version

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:



32
33
34
35
36
37
38
 
# File 'system_config.rb', line 32

def clang_build
  @clang_build ||= if DevelopmentTools.installed?
    DevelopmentTools.clang_build_version
  else
    Version::NULL
  end
end

.config_sections ⇒ Array<Symbol>

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:



212
213
214
 
# File 'system_config.rb', line 212

def config_sections
  [:homebrew_config, :core_tap_config, :homebrew_env_config, :hardware_config, :host_software_config]
end

.core_tap_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


154
155
156
 
# File 'system_config.rb', line 154

def core_tap_config(out = $stdout)
  dump_tap_config(CoreTap.instance, out)
end

.describe_clang ⇒ String

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:



74
75
76
77
78
79
80
81
82
 
# File 'system_config.rb', line 74

def describe_clang
  return "N/A" if clang.null?

  if clang_build.null?
    clang.to_s
  else
    "#{clang} build #{clang_build}"
  end
end

.describe_curl ⇒ String

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:



112
113
114
115
116
117
118
119
120
121
 
# File 'system_config.rb', line 112

def describe_curl
  out = system_command(Utils::Curl.curl_executable, args: ["--version"], verbose: false).stdout

  match_data = /^curl (?<curl_version>[\d.]+)/.match(out)
  if match_data
    "#{match_data[:curl_version]} => #{Utils::Curl.curl_path}"
  else
    "N/A"
  end
end

.describe_git ⇒ String

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:



105
106
107
108
109
 
# File 'system_config.rb', line 105

def describe_git
  return "N/A" unless Utils::Git.available?

  "#{Utils::Git.version} => #{Utils::Git.path}"
end

.describe_homebrew_ruby ⇒ String

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:



85
86
87
 
# File 'system_config.rb', line 85

def describe_homebrew_ruby
  "#{RUBY_VERSION} => #{RUBY_PATH}"
end

.dump_tap_config(tap, out = $stdout) ⇒ 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:

  • tap (Tap)
  • out (File, StringIO, IO) (defaults to: $stdout) 


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
 
# File 'system_config.rb', line 124

def dump_tap_config(tap, out = $stdout)
  case tap
  when CoreTap
    tap_name = "Core tap"
    json_file_name = "formula.jws.json"
  when CoreCaskTap
    tap_name = "Core cask tap"
    json_file_name = "cask.jws.json"
  else
    raise ArgumentError, "Unknown tap: #{tap}"
  end

  if tap.installed?
    out.puts "#{tap_name} origin: #{tap.remote}" if tap.remote != tap.default_remote
    head, last_commit, branch = tap.git_repository.head_info
    out.puts "#{tap_name} HEAD: #{head || "(none)"}"
    out.puts "#{tap_name} last commit: #{last_commit || "never"}"
    default_branches = %w[main master].freeze
    out.puts "#{tap_name} branch: #{branch || "(none)"}" if default_branches.exclude?(branch)
  end

  json_file = Homebrew::API::HOMEBREW_CACHE_API/json_file_name
  if json_file.exist?
    out.puts "#{tap_name} JSON: #{json_file.mtime.utc.strftime("%d %b %H:%M UTC")}"
  elsif !tap.installed?
    out.puts "#{tap_name}: N/A"
  end
end

.dump_verbose_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


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

def dump_verbose_config(out = $stdout)
  # Most sections shell out for their values (Git, compilers, curl,
  # etc.), so render them concurrently and print them in order.
  sections = Utils.parallel_map(config_sections) do |section|
    io = StringIO.new
    public_send(section, io)
    io.string
  end
  sections.each { |section| out.print section }
end

.hardware ⇒ String?

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:



90
91
92
93
94
 
# File 'system_config.rb', line 90

def hardware
  return if Hardware::CPU.type == :dunno

  "CPU: #{Hardware.cores_as_words}-core #{Hardware::CPU.bits}-bit #{Hardware::CPU.family}"
end

.hardware_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


206
207
208
209
 
# File 'system_config.rb', line 206

def hardware_config(out = $stdout)
  hardware = self.hardware
  out.puts hardware if hardware
end

.head ⇒ String

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:



59
60
61
 
# File 'system_config.rb', line 59

def head
  homebrew_head_info[0] || "(none)"
end

.homebrew_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


159
160
161
162
163
164
165
 
# File 'system_config.rb', line 159

def homebrew_config(out = $stdout)
  out.puts "HOMEBREW_VERSION: #{HOMEBREW_VERSION}"
  out.puts "ORIGIN: #{origin}"
  out.puts "HEAD: #{head}"
  out.puts "Last commit: #{last_commit}"
  out.puts "Branch: #{branch}"
end

.homebrew_env_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


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
 
# File 'system_config.rb', line 168

def homebrew_env_config(out = $stdout)
  out.puts "HOMEBREW_PREFIX: #{HOMEBREW_PREFIX}"
  repository = HOMEBREW_REPOSITORY
  cellar = HOMEBREW_CELLAR
  out.puts "HOMEBREW_REPOSITORY: #{repository}" if repository.to_s != Homebrew::DEFAULT_REPOSITORY.to_s
  out.puts "HOMEBREW_CELLAR: #{cellar}" if cellar.to_s != Homebrew::DEFAULT_CELLAR.to_s

  Homebrew::EnvConfig::ENVS.each do |env, hash|
    next if Homebrew::EnvConfig.hidden?(hash) && !ENV.key?(env.to_s)

    method_name = Homebrew::EnvConfig.env_method_name(env, hash)

    if hash[:boolean]
      out.puts "#{env}: set" if Homebrew::EnvConfig.public_send(method_name)
      next
    end

    value = Homebrew::EnvConfig.public_send(method_name)
    next unless value
    next if (default = hash[:default].presence) && value.to_s == default.to_s

    if ENV.sensitive?(env)
      out.puts "#{env}: set"
    else
      out.puts "#{env}: #{value}"
    end
  end
  out.puts "Homebrew Ruby: #{describe_homebrew_ruby}"
end

.homebrew_head_info ⇒ Array<([String, nil], [String, nil], [String, nil])>

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:



46
47
48
49
50
51
 
# File 'system_config.rb', line 46

def homebrew_head_info
  @homebrew_head_info ||= T.let(
    homebrew_repo.head_info,
    T.nilable([T.nilable(String), T.nilable(String), T.nilable(String)]),
  )
end

.homebrew_repo ⇒ GitRepository

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:



41
42
43
 
# File 'system_config.rb', line 41

def homebrew_repo
  GitRepository.new(HOMEBREW_REPOSITORY)
end

.host_software_config(out = $stdout) ⇒ 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:

  • out (File, StringIO, IO) (defaults to: $stdout) 


199
200
201
202
203
 
# File 'system_config.rb', line 199

def host_software_config(out = $stdout)
  out.puts "Clang: #{describe_clang}"
  out.puts "Git: #{describe_git}"
  out.puts "Curl: #{describe_curl}"
end

.initialize ⇒ 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.



17
18
19
20
 
# File 'system_config.rb', line 17

def initialize
  @clang = T.let(nil, T.nilable(Version))
  @clang_build = T.let(nil, T.nilable(Version))
end

.kernel ⇒ String

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:



97
98
99
 
# File 'system_config.rb', line 97

def kernel
  `uname -m`.chomp
end

.last_commit ⇒ String

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:



64
65
66
 
# File 'system_config.rb', line 64

def last_commit
  homebrew_head_info[1] || "never"
end

.origin ⇒ String

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:



69
70
71
 
# File 'system_config.rb', line 69

def origin
  homebrew_repo.origin_url || "(none)"
end

.windows_version ⇒ String?

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:



102
 
# File 'system_config.rb', line 102

def windows_version; end