Module: Utils Private

Defined in:
extend/os/mac/utils/bottles.rb,
utils.rb,
utils/ast.rb,
utils/git.rb,
utils/svn.rb,
utils/tar.rb,
utils/uid.rb,
utils/curl.rb,
utils/fork.rb,
utils/gzip.rb,
utils/link.rb,
utils/path.rb,
utils/popen.rb,
utils/shell.rb,
utils/timer.rb,
utils/socket.rb,
utils/bottles.rb,
utils/service.rb,
utils/shebang.rb,
utils/analytics.rb,
utils/backtrace.rb,
utils/inreplace.rb,
utils/autoremove.rb,
utils/git_repository.rb,
utils/topological_hash.rb,
utils/ast.rbi

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.

Defined Under Namespace

Modules: AST, Analytics, Backtrace, Bottles, Curl, Git, Gzip, Inreplace, Link, Path, Service, Shebang, Shell, Svn, Tar, Timer, UID, UNIXSocketExt Classes: TopologicalHash, UNIXServerExt

Class Method Summary collapse

Class Method Details

.deconstantize(path) ⇒ 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.

Removes the rightmost segment from the constant expression in the string.

deconstantize('Net::HTTP') # => "Net" deconstantize('::Net::HTTP') # => "::Net" deconstantize('String') # => "" deconstantize('::String') # => "" deconstantize('') # => ""

See also #demodulize.

Parameters:

Returns:

See Also:



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

def self.deconstantize(path)
  T.must(path[0, path.rindex("::") || 0]) # implementation based on the one in facets' Module#spacename
end

.demodulize(path) ⇒ 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.

Removes the module part from the expression in the string.

demodulize('ActiveSupport::Inflector::Inflections') # => "Inflections" demodulize('Inflections') # => "Inflections" demodulize('::Inflections') # => "Inflections" demodulize('') # => ""

See also #deconstantize.

Parameters:

Returns:

See Also:



100
101
102
103
104
105
106
 
# File 'utils.rb', line 100

def self.demodulize(path)
  if (i = path.rindex("::"))
    T.must(path[(i + 2)..])
  else
    path
  end
end

.git_branch(repo = Pathname.pwd, safe: true) ⇒ 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.

Gets the name of the currently checked-out branch, or HEAD if the repository is in a detached HEAD state.

Parameters:

  • repo (String, Pathname) (defaults to: Pathname.pwd)
  • safe (Boolean) (defaults to: true)

Returns:



38
39
40
 
# File 'utils/git_repository.rb', line 38

def self.git_branch(repo = Pathname.pwd, safe: true)
  GitRepository.new(Pathname(repo)).branch_name(safe:)
end

.git_commit_message(repo = Pathname.pwd, commit: "HEAD", safe: true) ⇒ 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.

Gets the full commit message of the specified commit, or of the HEAD commit if unspecified.

Parameters:

  • repo (String, Pathname) (defaults to: Pathname.pwd)
  • commit (String) (defaults to: "HEAD")
  • safe (Boolean) (defaults to: true)

Returns:



50
51
52
 
# File 'utils/git_repository.rb', line 50

def self.git_commit_message(repo = Pathname.pwd, commit: "HEAD", safe: true)
  GitRepository.new(Pathname(repo)).commit_message(commit, safe:)
end

.git_head(repo = Pathname.pwd, length: nil, safe: true) ⇒ 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.

Gets the full commit hash of the HEAD commit.

Parameters:

  • repo (String, Pathname) (defaults to: Pathname.pwd)
  • length (Integer, nil) (defaults to: nil)
  • safe (Boolean) (defaults to: true)

Returns:



13
14
15
16
17
 
# File 'utils/git_repository.rb', line 13

def self.git_head(repo = Pathname.pwd, length: nil, safe: true)
  return git_short_head(repo, length:) if length

  GitRepository.new(Pathname(repo)).head_ref(safe:)
end

.git_short_head(repo = Pathname.pwd, length: nil, safe: true) ⇒ 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.

Gets a short commit hash of the HEAD commit.

Parameters:

  • repo (String, Pathname) (defaults to: Pathname.pwd)
  • length (Integer, nil) (defaults to: nil)
  • safe (Boolean) (defaults to: true)

Returns:



27
28
29
 
# File 'utils/git_repository.rb', line 27

def self.git_short_head(repo = Pathname.pwd, length: nil, safe: true)
  GitRepository.new(Pathname(repo)).short_head_ref(length:, safe:)
end

.parse_author!(author) ⇒ Hash

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.

Parameters:

Returns:

Raises:



121
122
123
124
125
126
127
128
129
130
 
# File 'utils.rb', line 121

def self.parse_author!(author)
  match_data = /^(?<name>[^<]+?)[ \t]*<(?<email>[^>]+?)>$/.match(author)
  if match_data
    name = match_data[:name]
    email = match_data[:email]
  end
  raise UsageError, "Unable to parse name and email." if name.blank? && email.blank?

  { name: T.must(name), email: T.must(email) }
end

.pluralize(stem, count, plural: "s", singular: "", include_count: false) ⇒ 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.

A lightweight alternative to ActiveSupport::Inflector.pluralize: Combines stem with the singular or plural suffix based on count. Adds a prefix of the count value if include_count is set to true.

Parameters:

  • stem (String)
  • count (Integer)
  • plural (String) (defaults to: "s")
  • singular (String) (defaults to: "")
  • include_count (Boolean) (defaults to: false)

Returns:



114
115
116
117
118
 
# File 'utils.rb', line 114

def self.pluralize(stem, count, plural: "s", singular: "", include_count: false)
  prefix = include_count ? "#{count} " : ""
  suffix = (count == 1) ? singular : plural
  "#{prefix}#{stem}#{suffix}"
end

.popen(args, mode, options = {}) ⇒ 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. 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'utils/popen.rb', line 46

def self.popen(args, mode, options = {})
  IO.popen("-", mode) do |pipe|
    if pipe
      return pipe.read unless block_given?

      yield pipe
    else
      options[:err] ||= File::NULL unless ENV["HOMEBREW_STDERR"]
      begin
        exec(*args, options)
      rescue Errno::ENOENT
        $stderr.puts "brew: command not found: #{args[0]}" if options[:err] != :close
        exit! 127
      rescue SystemCallError
        $stderr.puts "brew: exec failed: #{args[0]}" if options[:err] != :close
        exit! 1
      end
    end
  end
end

.popen_read(*args, safe: false, **options, &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.

Raises:



8
9
10
11
12
13
 
# File 'utils/popen.rb', line 8

def self.popen_read(*args, safe: false, **options, &block)
  output = popen(args, "rb", options, &block)
  return output if !safe || $CHILD_STATUS.success?

  raise ErrorDuringExecution.new(args, status: $CHILD_STATUS, output: [[:stdout, output]])
end

.popen_write(*args, safe: false, **options) ⇒ 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.

Raises:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'utils/popen.rb', line 19

def self.popen_write(*args, safe: false, **options)
  output = ""
  popen(args, "w+b", options) do |pipe|
    # Before we yield to the block, capture as much output as we can
    loop do
      output += pipe.read_nonblock(IO_DEFAULT_BUFFER_SIZE)
    rescue IO::WaitReadable, EOFError
      break
    end

    yield pipe
    pipe.close_write
    pipe.wait_readable

    # Capture the rest of the output
    output += pipe.read
    output.freeze
  end
  return output if !safe || $CHILD_STATUS.success?

  raise ErrorDuringExecution.new(args, status: $CHILD_STATUS, output: [[:stdout, output]])
end

.rewrite_child_error(child_error) ⇒ 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. 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'utils/fork.rb', line 8

def self.rewrite_child_error(child_error)
  inner_class = Object.const_get(child_error["json_class"])
  error = if child_error["cmd"] && inner_class == ErrorDuringExecution
    ErrorDuringExecution.new(child_error["cmd"],
                             status: child_error["status"],
                             output: child_error["output"])
  elsif child_error["cmd"] && inner_class == BuildError
    # We fill `BuildError#formula` and `BuildError#options` in later,
    # when we rescue this in `FormulaInstaller#build`.
    BuildError.new(nil, child_error["cmd"], child_error["args"], child_error["env"])
  elsif inner_class == Interrupt
    Interrupt.new
  else
    # Everything other error in the child just becomes a RuntimeError.
    RuntimeError.new <<~EOS
      An exception occurred within a child process:
        #{inner_class}: #{child_error["m"]}
    EOS
  end

  error.set_backtrace child_error["b"]

  error
end

.safe_filename(basename) ⇒ 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.

Parameters:

Returns:



163
164
165
 
# File 'utils.rb', line 163

def self.safe_filename(basename)
  basename.gsub(SAFE_FILENAME_REGEX, "")
end

.safe_filename?(basename) ⇒ 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.

Parameters:

Returns:

  • (Boolean) 


158
159
160
 
# File 'utils.rb', line 158

def self.safe_filename?(basename)
  !SAFE_FILENAME_REGEX.match?(basename)
end

.safe_fork(directory: nil, yield_parent: false) ⇒ 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.

When using this function, remember to call exec as soon as reasonably possible. This function does not protect against the pitfalls of what you can do pre-exec in a fork. See man fork for more information.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
112
113
114
115
116
117
118
119
120
121
 
# File 'utils/fork.rb', line 36

def self.safe_fork(directory: nil, yield_parent: false)
  require "json/add/exception"

  block = proc do |tmpdir|
    UNIXServerExt.open("#{tmpdir}/socket") do |server|
      read, write = IO.pipe

      pid = fork do
        # bootsnap doesn't like these forked processes
        ENV["HOMEBREW_NO_BOOTSNAP"] = "1"
        error_pipe = server.path
        ENV["HOMEBREW_ERROR_PIPE"] = error_pipe
        server.close
        read.close
        write.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)

        Process::UID.change_privilege(Process.euid) if Process.euid != Process.uid

        yield(error_pipe)
      rescue Exception => e # rubocop:disable Lint/RescueException
        error_hash = JSON.parse e.to_json

        # Special case: We need to recreate ErrorDuringExecutions
        # for proper error messages and because other code expects
        # to rescue them further down.
        if e.is_a?(ErrorDuringExecution)
          error_hash["cmd"] = e.cmd
          error_hash["status"] = if e.status.is_a?(Process::Status)
            {
              exitstatus: e.status.exitstatus,
              termsig:    e.status.termsig,
            }
          else
            e.status
          end
          error_hash["output"] = e.output
        end

        write.puts error_hash.to_json
        write.close

        exit!
      else
        exit!(true)
      end

      pid = T.must(pid)

      begin
        yield(nil) if yield_parent

        begin
          socket = server.accept_nonblock
        rescue Errno::EAGAIN, Errno::EWOULDBLOCK, Errno::ECONNABORTED, Errno::EPROTO, Errno::EINTR
          retry unless Process.waitpid(pid, Process::WNOHANG)
        else
          socket.send_io(write)
          socket.close
        end
        write.close
        data = read.read
        read.close
        Process.waitpid(pid) unless socket.nil?
      rescue Interrupt
        Process.waitpid(pid)
      end

      # 130 is the exit status for a process interrupted via Ctrl-C.
      raise Interrupt if $CHILD_STATUS.exitstatus == 130
      raise Interrupt if $CHILD_STATUS.termsig == Signal.list["INT"]

      if data.present?
        error_hash = JSON.parse(T.must(data.lines.first))
        raise rewrite_child_error(error_hash)
      end

      raise ChildProcessError, $CHILD_STATUS unless $CHILD_STATUS.success?
    end
  end

  if directory
    block.call(directory)
  else
    Dir.mktmpdir("homebrew-fork", HOMEBREW_TEMP, &block)
  end
end

.safe_popen_read(*args, **options, &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. 



15
16
17
 
# File 'utils/popen.rb', line 15

def self.safe_popen_read(*args, **options, &block)
  popen_read(*args, safe: true, **options, &block)
end

.safe_popen_write(*args, **options, &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. 



42
43
44
 
# File 'utils/popen.rb', line 42

def self.safe_popen_write(*args, **options, &block)
  popen_write(*args, safe: true, **options, &block)
end

.underscore(camel_cased_word) ⇒ 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.

Makes an underscored, lowercase form from the expression in the string.

Changes '::' to '/' to convert namespaces to paths.

underscore('ActiveModel') # => "active_model" underscore('ActiveModel::Errors') # => "active_model/errors"

Parameters:

Returns:

See Also:



142
143
144
145
146
147
148
149
150
151
152
 
# File 'utils.rb', line 142

def self.underscore(camel_cased_word)
  return camel_cased_word.to_s unless /[A-Z-]|::/.match?(camel_cased_word)

  word = camel_cased_word.to_s.gsub("::", "/")
  word.gsub!(/([A-Z])(?=[A-Z][a-z])|([a-z\d])(?=[A-Z])/) do
    T.must(::Regexp.last_match(1) || ::Regexp.last_match(2)) << "_"
  end
  word.tr!("-", "_")
  word.downcase!
  word
end