Class: Pathname Private
- Includes:
- DiskUsageExtension, ELFShim, MachOShim, SystemCommand::Mixin
- Defined in:
- extend/pathname.rb,
extend/os/mac/extend/pathname.rb,
extend/os/linux/extend/pathname.rb,
extend/os/mac/extend/pathname.rbi,
extend/os/linux/extend/pathname.rbi
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.
Instance Method Summary collapse
-
#append_lines(content, **open_args) ⇒ void
Only appends to a file that is already created.
-
#atomic_write(content) ⇒ void
-
#binary_executable? ⇒ Boolean
private
-
#cd(&_block) ⇒ T.type_parameter(:U)
Change to this directory, optionally executing the given block.
-
#cp_path_sub(pattern, replacement) ⇒ Object
private
-
#ds_store? ⇒ Boolean
private
-
#dylib? ⇒ Boolean
private
-
#ensure_writable ⇒ Object
private
-
#env_script_all_files(dst, env) ⇒ Object
private
Writes a wrapper env script and moves all files to the dst.
-
#extname ⇒ String
Extended to support common double extensions.
-
#file_type ⇒ String
private
-
#install(*sources) ⇒ void
Moves a file from the original location to the Pathname’s.
-
#install_info ⇒ Object
private
-
#install_metafiles(from = Pathname.pwd) ⇒ Object
private
-
#install_symlink(*sources) ⇒ void
Creates symlinks to sources in this folder.
-
#mach_o_bundle? ⇒ Boolean
private
-
#magic_number ⇒ String
private
-
#make_relative_symlink(src) ⇒ Object
private
-
#resolved_path ⇒ Pathname
private
-
#resolved_path_exists? ⇒ Boolean
private
-
#rmdir_if_possible ⇒ Boolean
private
I don’t trust the children.length == 0 check particularly, not to mention it is slow to enumerate the whole directory just to see if it is empty, instead rely on good ol’ libc and the filesystem.
-
#rpaths ⇒ Array<String>
private
-
#sha256 ⇒ String
private
-
#stem ⇒ String
For filetypes we support, returns basename without extension.
-
#subdirs ⇒ Array<Pathname>
Get all sub-directories of this directory.
-
#text_executable? ⇒ Boolean
private
-
#uninstall_info ⇒ Object
private
-
#verify_checksum(expected) ⇒ void
private
-
#version ⇒ Version
private
-
#which_install_info ⇒ Object
private
-
#write_env_script(target, args, env = nil) ⇒ Object
private
Writes an exec script that sets environment variables.
-
#write_exec_script(*targets) ⇒ Object
private
Writes an exec script in this folder for each target pathname.
-
#write_jar_script(target_jar, script_name, java_opts = "", java_version: nil) ⇒ Integer
private
Writes an exec script that invokes a Java jar.
-
#zipinfo ⇒ Array<String>
private
Methods included from DiskUsageExtension
#abv, #disk_usage, #file_count
Methods included from SystemCommand::Mixin
#system_command, #system_command!
Methods included from MachOShim
#arch, #archs, #change_dylib_id, #change_install_name, #change_rpath, #delete_rpath, #dylib_id, #dynamically_linked_libraries, #i386?, #mach_o_executable?, #ppc64?, #ppc7400?, #resolve_rpath, #resolve_variable_name, #universal?, #x86_64?
Methods included from Kernel
#disk_usage_readable, #ensure_executable!, #ensure_formula_installed!, #exec_browser, #exec_editor, #ignore_interrupts, #interactive_shell, #number_readable, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #paths, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #quiet_system, #redact_secrets, #redirect_stdout, #require?, #safe_system, #tap_and_name_comparison, #truncate_text_to_approximate_size, #which, #which_all, #which_editor, #with_custom_locale, #with_env, #with_homebrew_path
Methods included from ELFShim
#arch, #dylib_id, #dynamic_elf?, #dynamically_linked_libraries, #elf?, #elf_type, #interpreter, #patch!, #patchelf_patcher, #read_uint16, #read_uint8, #rpath, #rpath_using_patchelf_rb, #save_using_patchelf_rb
Instance Method Details
#append_lines(content, **open_args) ⇒ void
This method returns an undefined value.
Only appends to a file that is already created.
175 176 177 178 179 |
# File 'extend/pathname.rb', line 175 def append_lines(content, **open_args) raise "Cannot append file that doesn't exist: #{self}" unless exist? T.unsafe(self).open("a", **open_args) { |f| f.puts(content) } end |
#atomic_write(content) ⇒ void
This always overwrites.
This method returns an undefined value.
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 |
# File 'extend/pathname.rb', line 185 def atomic_write(content) old_stat = stat if exist? File.atomic_write(self) do |file| file.write(content) end return unless old_stat # Try to restore original file's permissions separately # atomic_write does it itself, but it actually erases # them if chown fails begin # Set correct permissions on new file chown(old_stat.uid, nil) chown(nil, old_stat.gid) rescue Errno::EPERM, Errno::EACCES # Changing file ownership failed, moving on. nil end begin # This operation will affect filesystem ACL's chmod(old_stat.mode) rescue Errno::EPERM, Errno::EACCES # Changing file permissions failed, moving on. nil end end |
#binary_executable? ⇒ 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.
454 455 456 |
# File 'extend/pathname.rb', line 454 def binary_executable? false end |
#cd(&_block) ⇒ T.type_parameter(:U)
Change to this directory, optionally executing the given block.
309 310 311 |
# File 'extend/pathname.rb', line 309 def cd(&_block) Dir.chdir(self) { yield self } end |
#cp_path_sub(pattern, replacement) ⇒ 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.
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'extend/pathname.rb', line 213 def cp_path_sub(pattern, replacement) raise "#{self} does not exist" unless exist? dst = sub(pattern, replacement) raise "#{self} is the same file as #{dst}" if self == dst if directory? dst.mkpath else dst.dirname.mkpath dst = yield(self, dst) if block_given? FileUtils.cp(self, dst) end end |
#ds_store? ⇒ 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.
449 450 451 |
# File 'extend/pathname.rb', line 449 def ds_store? basename.to_s == ".DS_Store" end |
#dylib? ⇒ 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.
464 465 466 |
# File 'extend/pathname.rb', line 464 def dylib? false end |
#ensure_writable ⇒ 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.
341 342 343 344 345 346 347 348 349 350 |
# File 'extend/pathname.rb', line 341 def ensure_writable saved_perms = nil unless writable? saved_perms = stat.mode FileUtils.chmod "u+rw", to_path end yield ensure chmod saved_perms if saved_perms end |
#env_script_all_files(dst, env) ⇒ 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.
Writes a wrapper env script and moves all files to the dst.
402 403 404 405 406 407 408 409 410 411 |
# File 'extend/pathname.rb', line 402 def env_script_all_files(dst, env) dst.mkpath Pathname.glob("#{self}/*") do |file| next if file.directory? dst.install(file) new_file = dst.join(file.basename) file.write_env_script(new_file, env) end end |
#extname ⇒ String
Extended to support common double extensions.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'extend/pathname.rb', line 233 def extname basename = File.basename(self) bottle_ext, = HOMEBREW_BOTTLES_EXTNAME_REGEX.match(basename).to_a return bottle_ext if bottle_ext archive_ext = basename[/(\.(tar|cpio|pax)\.(gz|bz2|lz|xz|zst|Z))\Z/, 1] return archive_ext if archive_ext # Don't treat version numbers as extname. return "" if basename.match?(/\b\d+\.\d+[^.]*\Z/) && !basename.end_with?(".7z") File.extname(basename) end |
#file_type ⇒ 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.
485 486 487 488 |
# File 'extend/pathname.rb', line 485 def file_type @file_type ||= system_command("file", args: ["-b", self], print_stderr: false) .stdout.chomp end |
#install(*sources) ⇒ void
This method returns an undefined value.
Moves a file from the original location to the Pathname’s.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'extend/pathname.rb', line 93 def install(*sources) sources.each do |src| case src when Resource src.stage(self) when Resource::Partial src.resource.stage { install(*src.files) } when Array if src.empty? opoo "Tried to install empty array to #{self}" break end src.each { |s| install_p(s, File.basename(s)) } when Hash if src.empty? opoo "Tried to install empty hash to #{self}" break end src.each { |s, new_basename| install_p(s, new_basename) } else install_p(src, File.basename(src)) end end end |
#install_info ⇒ 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.
361 362 363 |
# File 'extend/pathname.rb', line 361 def install_info quiet_system(which_install_info, "--quiet", to_s, "#{dirname}/dir") end |
#install_metafiles(from = Pathname.pwd) ⇒ 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.
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'extend/pathname.rb', line 431 def (from = Pathname.pwd) Pathname(from).children.each do |p| next if p.directory? next if File.empty?(p) next unless Metafiles.copy?(p.basename.to_s) # Some software symlinks these files (see help2man.rb) filename = p.resolved_path # Some software links metafiles together, so by the time we iterate to one of them # we may have already moved it. libxml2's COPYING and Copyright are affected by this. next unless filename.exist? filename.chmod 0644 install(filename) end end |
#install_symlink(*sources) ⇒ void
This method returns an undefined value.
Creates symlinks to sources in this folder.
149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'extend/pathname.rb', line 149 def install_symlink(*sources) sources.each do |src| case src when Array src.each { |s| install_symlink_p(s, File.basename(s)) } when Hash src.each { |s, new_basename| install_symlink_p(s, new_basename) } else install_symlink_p(src, File.basename(src)) end end end |
#mach_o_bundle? ⇒ 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.
459 460 461 |
# File 'extend/pathname.rb', line 459 def mach_o_bundle? false end |
#magic_number ⇒ 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.
474 475 476 477 478 479 480 481 482 |
# File 'extend/pathname.rb', line 474 def magic_number @magic_number ||= if directory? "" else # Length of the longest regex (currently Tar). max_magic_number_length = 262 binread(max_magic_number_length) || "" end end |
#make_relative_symlink(src) ⇒ 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.
336 337 338 339 |
# File 'extend/pathname.rb', line 336 def make_relative_symlink(src) dirname.mkpath File.symlink(src.relative_path_from(dirname), self) end |
#resolved_path ⇒ Pathname
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.
322 323 324 |
# File 'extend/pathname.rb', line 322 def resolved_path symlink? ? dirname.join(readlink) : self end |
#resolved_path_exists? ⇒ 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.
327 328 329 330 331 332 333 334 |
# File 'extend/pathname.rb', line 327 def resolved_path_exists? link = readlink rescue ArgumentError # The link target contains NUL bytes false else dirname.join(link).exist? end |
#rmdir_if_possible ⇒ 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.
I don’t trust the children.length == 0 check particularly, not to mention it is slow to enumerate the whole directory just to see if it is empty, instead rely on good ol’ libc and the filesystem
260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'extend/pathname.rb', line 260 def rmdir_if_possible rmdir true rescue Errno::ENOTEMPTY if (ds_store = join(".DS_Store")).exist? && children.length == 1 ds_store.unlink retry else false end rescue Errno::EACCES, Errno::ENOENT, Errno::EBUSY, Errno::EPERM false end |
#rpaths ⇒ Array<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.
469 470 471 |
# File 'extend/pathname.rb', line 469 def rpaths [] end |
#sha256 ⇒ 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.
286 287 288 289 |
# File 'extend/pathname.rb', line 286 def sha256 require "digest/sha2" Digest::SHA256.file(self).hexdigest end |
#stem ⇒ String
For filetypes we support, returns basename without extension.
252 253 254 |
# File 'extend/pathname.rb', line 252 def stem File.basename(self, extname) end |
#subdirs ⇒ Array<Pathname>
Get all sub-directories of this directory.
317 318 319 |
# File 'extend/pathname.rb', line 317 def subdirs children.select(&:directory?) end |
#text_executable? ⇒ 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.
281 282 283 |
# File 'extend/pathname.rb', line 281 def text_executable? /\A#!\s*\S+/.match?(open("r") { |f| f.read(1024) }) end |
#uninstall_info ⇒ 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.
365 366 367 |
# File 'extend/pathname.rb', line 365 def uninstall_info quiet_system(which_install_info, "--delete", "--quiet", to_s, "#{dirname}/dir") end |
#verify_checksum(expected) ⇒ 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.
292 293 294 295 296 297 |
# File 'extend/pathname.rb', line 292 def verify_checksum(expected) raise ChecksumMissingError if expected.blank? actual = Checksum.new(sha256.downcase) raise ChecksumMismatchError.new(self, expected, actual) if expected != actual end |
#version ⇒ 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.
275 276 277 278 |
# File 'extend/pathname.rb', line 275 def version require "version" Version.parse(basename) end |
#which_install_info ⇒ 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.
352 353 354 355 356 357 358 359 |
# File 'extend/pathname.rb', line 352 def which_install_info @which_install_info ||= if File.executable?("/usr/bin/install-info") "/usr/bin/install-info" elsif Formula["texinfo"].any_version_installed? Formula["texinfo"].opt_bin/"install-info" end end |
#write_env_script(target, args, env = nil) ⇒ 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.
Writes an exec script that sets environment variables.
387 388 389 390 391 392 393 394 395 396 397 398 399 |
# File 'extend/pathname.rb', line 387 def write_env_script(target, args, env = nil) unless env env = args args = nil end env_export = +"" env.each { |key, value| env_export << "#{key}=\"#{value}\" " } dirname.mkpath write <<~SH #!/bin/bash #{env_export}exec "#{target}" #{args} "$@" SH end |
#write_exec_script(*targets) ⇒ 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.
Writes an exec script in this folder for each target pathname.
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'extend/pathname.rb', line 370 def write_exec_script(*targets) targets.flatten! if targets.empty? opoo "Tried to write exec scripts to #{self} for an empty list of targets" return end mkpath targets.each do |target| target = Pathname.new(target) # allow pathnames or strings join(target.basename).write <<~SH #!/bin/bash exec "#{target}" "$@" SH end end |
#write_jar_script(target_jar, script_name, java_opts = "", java_version: nil) ⇒ Integer
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.
Writes an exec script that invokes a Java jar.
422 423 424 425 426 427 428 429 |
# File 'extend/pathname.rb', line 422 def write_jar_script(target_jar, script_name, java_opts = "", java_version: nil) mkpath (self/script_name).write <<~EOS #!/bin/bash export JAVA_HOME="#{Language::Java.overridable_java_home_env(java_version)[:JAVA_HOME]}" exec "${JAVA_HOME}/bin/java" #{java_opts} -jar "#{target_jar}" "$@" EOS end |
#zipinfo ⇒ Array<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.
491 492 493 494 495 496 |
# File 'extend/pathname.rb', line 491 def zipinfo @zipinfo ||= system_command("zipinfo", args: ["-1", self], print_stderr: false) .stdout .encode(Encoding::UTF_8, invalid: :replace) .split("\n") end |