Module: HMap::Executable

Defined in:
lib/hmap/helper/executable.rb

Defined Under Namespace

Classes: Indenter

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.capture_command(executable, command, capture: :merge, env: {}, **kwargs) ⇒ (String, Process::Status)

Runs the given command, capturing the desired output.

Parameters:

  • executable (String) —

    The binary to use.

  • command (Array<#to_s>) —

    The command to send to the binary.

  • capture (Symbol) (defaults to: :merge) —

    Whether it should raise if the command fails.

  • env (Hash) (defaults to: {}) —

    Environment variables to be set for the command.

Returns:

  • ((String, Process::Status)) —

    The desired captured output from the command, and the status from running the command.

Raises:

  • If the executable could not be located.



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/hmap/helper/executable.rb', line 126

def self.capture_command(executable, command, capture: :merge, env: {}, **kwargs)
  bin = which!(executable)

  require 'open3'
  command = command.map(&:to_s)
  case capture
  when :merge then Open3.capture2e(env, [bin, bin], *command, **kwargs)
  when :both then Open3.capture3(env, [bin, bin], *command, **kwargs)
  when :out then Open3.capture3(env, [bin, bin], *command, **kwargs).values_at(0, -1)
  when :err then Open3.capture3(env, [bin, bin], *command, **kwargs).drop(1)
  when :none then Open3.capture3(env, [bin, bin], *command, **kwargs).last
  end
end

.capture_command!(executable, command, **kwargs) ⇒ (String, Process::Status)

Runs the given command, capturing the desired output.

Parameters:

  • executable (String) —

    The binary to use.

  • command (Array<#to_s>) —

    The command to send to the binary.

  • capture (Symbol) —

    Whether it should raise if the command fails.

  • env (Hash) —

    Environment variables to be set for the command.

Returns:

  • ((String, Process::Status)) —

    The desired captured output from the command, and the status from running the command.

Raises:

  • If the executable could not be located.

  • If running the command fails



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/hmap/helper/executable.rb', line 144

def self.capture_command!(executable, command, **kwargs)
  capture_command(executable, command, **kwargs).tap do |result|
    result = Array(result)
    status = result.last
    unless status.success?
      output = result[0..-2].join
      raise Informative, "#{executable} #{command.join(' ')}\n\n#{output}".strip
    end
  end
end

.execute_command(executable, command, raise_on_failure = true) ⇒ String

Executes the given command displaying it if in verbose mode.

Parameters:

  • executable (String) —

    The binary to use.

  • command (Array<#to_s>) —

    The command to send to the binary.

  • raise_on_failure (Bool) (defaults to: true) —

    Whether it should raise if the command fails.

Returns:

  • (String) —

    the output of the command (STDOUT and STDERR).

Raises:

  • If the executable could not be located.

  • If the command fails and the ‘raise_on_failure` is set to true.



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
 
# File 'lib/hmap/helper/executable.rb', line 37

def self.execute_command(executable, command, raise_on_failure = true)
  bin = which!(executable)

  command = command.map(&:to_s)
  if File.basename(bin) == 'tar.exe'
    # Tar on Windows needs --force-local
    command.push('--force-local')
  end
  full_command = "#{bin} #{command.join(' ')}"

  if Resolver.instance.verbose?
    p("$ #{full_command}")
    stdout = Indenter.new($stdout)
    stderr = Indenter.new($stderr)
  else
    stdout = Indenter.new
    stderr = Indenter.new
  end

  status = popen3(bin, command, stdout, stderr)
  stdout = stdout.join
  stderr = stderr.join
  output = stdout + stderr
  unless status.success?
    if raise_on_failure
      raise Informative, "#{full_command}\n\n#{output}"
    else
      p("[!] Failed: #{full_command}".red)
    end
  end
  stdout
end

.popen3(bin, command, stdout, stderr) ⇒ Object 



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/hmap/helper/executable.rb', line 155

def self.popen3(bin, command, stdout, stderr)
  require 'open3'
  Open3.popen3(bin, *command) do |i, o, e, t|
    reader(o, stdout)
    reader(e, stderr)
    i.close

    status = t.value

    o.flush
    e.flush
    sleep(0.01)

    status
  end
end

.reader(input, output) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/hmap/helper/executable.rb', line 172

def self.reader(input, output)
  Thread.new do
    buf = ''
    begin
      loop do
        buf << input.readpartial(4096)
        loop do
          string, separator, buf = buf.partition(/[\r\n]/)
          if separator.empty?
            buf = string
            break
          end
          output << (string << separator)
        end
      end
    rescue IOError, EOFError
      output << (buf << $RS) unless buf.empty?
    end
  end
end

.which(program) ⇒ String, Nil

Returns the absolute path to the binary with the given name on the current ‘PATH`, or `nil` if none is found.

Parameters:

  • program (String) —

    The name of the program being searched for.

Returns:

  • (String, Nil) —

    The absolute path to the given program, or ‘nil` if it wasn’t found in the current ‘PATH`.



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/hmap/helper/executable.rb', line 79

def self.which(program)
  program = program.to_s
  paths = ENV.fetch('PATH') { '' }.split(File::PATH_SEPARATOR)
  paths.unshift('./')
  paths.uniq!
  paths.each do |path|
    bin = File.expand_path(program, path)
    bin += '.exe' if Gem.win_platform?
    return bin if File.file?(bin) && File.executable?(bin)
  end
  nil
end

.which!(program) ⇒ String

Returns the absolute path to the binary with the given name on the current ‘PATH`, or raises if none is found.

Parameters:

  • program (String) —

    The name of the program being searched for.

Returns:

  • (String) —

    The absolute path to the given program.



100
101
102
103
104
 
# File 'lib/hmap/helper/executable.rb', line 100

def self.which!(program)
  which(program).tap do |bin|
    raise Informative, "Unable to locate the executable `#{program}`" unless bin
  end
end

Instance Method Details

#executable(name) ⇒ void

This method returns an undefined value.

Creates the methods for the executable with the given name.

Parameters:

  • name (Symbol) —

    the name of the executable.



10
11
12
13
14
15
16
17
18
 
# File 'lib/hmap/helper/executable.rb', line 10

def executable(name)
  define_method(name) do |*command|
    Executable.execute_command(name, Array(command).flatten, false)
  end

  define_method(name.to_s + '!') do |*command|
    Executable.execute_command(name, Array(command).flatten, true)
  end
end