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:



38
39
40
 
# File 'system_config.rb', line 38

def branch
  homebrew_repo.branch_name || "(none)"
end

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



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

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

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



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

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

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



143
144
145
 
# File 'system_config.rb', line 143

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:



58
59
60
61
62
63
64
65
66
 
# File 'system_config.rb', line 58

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:



104
105
106
107
108
109
110
111
112
113
 
# File 'system_config.rb', line 104

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

  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:



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

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:



80
81
82
 
# File 'system_config.rb', line 80

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

.describe_path(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. 



68
69
70
71
72
73
74
75
76
77
 
# File 'system_config.rb', line 68

def describe_path(path)
  return "N/A" if path.nil?

  realpath = path.realpath
  if realpath == path
    path
  else
    "#{path} => #{realpath}"
  end
end

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



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

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
    out.puts "#{tap_name} HEAD: #{tap.git_head || "(none)"}"
    out.puts "#{tap_name} last commit: #{tap.git_last_commit || "never"}"
    default_branches = %w[main master].freeze
    out.puts "#{tap_name} branch: #{tap.git_branch || "(none)"}" if default_branches.exclude?(tap.git_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) ⇒ 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
197
198
 
# File 'system_config.rb', line 192

def dump_verbose_config(out = $stdout)
  homebrew_config(out)
  core_tap_config(out)
  homebrew_env_config(out)
  out.puts hardware if hardware
  host_software_config(out)
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:



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

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

  "CPU: #{Hardware.cores_as_words}-core #{Hardware::CPU.bits}-bit #{Hardware::CPU.family}"
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:



43
44
45
 
# File 'system_config.rb', line 43

def head
  homebrew_repo.head_ref || "(none)"
end

.homebrew_config(out = $stdout) ⇒ 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
 
# File 'system_config.rb', line 147

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



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

def homebrew_env_config(out = $stdout)
  out.puts "HOMEBREW_PREFIX: #{HOMEBREW_PREFIX}"
  {
    HOMEBREW_REPOSITORY: Homebrew::DEFAULT_REPOSITORY,
    HOMEBREW_CELLAR:     Homebrew::DEFAULT_CELLAR,
  }.freeze.each do |key, default|
    value = Object.const_get(key)
    out.puts "#{key}: #{value}" if value.to_s != default.to_s
  end

  Homebrew::EnvConfig::ENVS.each do |env, hash|
    method_name = Homebrew::EnvConfig.env_method_name(env, hash)

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

    value = Homebrew::EnvConfig.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_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:



33
34
35
 
# File 'system_config.rb', line 33

def homebrew_repo
  GitRepository.new(HOMEBREW_REPOSITORY)
end

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



186
187
188
189
190
 
# File 'system_config.rb', line 186

def host_software_config(out = $stdout)
  out.puts "Clang: #{describe_clang}"
  out.puts "Git: #{describe_git}"
  out.puts "Curl: #{describe_curl}"
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:



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

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:



48
49
50
 
# File 'system_config.rb', line 48

def last_commit
  homebrew_repo.last_committed || "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:



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

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