class Gem::Ext::Builder

Public Class Methods

class_name() click to toggle source
# File lib/rubygems/ext/builder.rb, line 15
def self.class_name
  name =~ /Ext::(.*)Builder/
  $1.downcase
end
make(dest_path, results, make_dir = Dir.pwd) click to toggle source
# File lib/rubygems/ext/builder.rb, line 20
def self.make(dest_path, results, make_dir = Dir.pwd)
  unless File.exist? File.join(make_dir, 'Makefile')
    raise Gem::InstallError, 'Makefile not found'
  end

  # try to find make program from Ruby configure arguments first
  RbConfig::CONFIG['configure_args'] =~ /with-make-prog\=(\w+)/
  make_program_name = ENV['MAKE'] || ENV['make'] || $1
  unless make_program_name
    make_program_name = (/mswin/ =~ RUBY_PLATFORM) ? 'nmake' : 'make'
  end
  make_program = Shellwords.split(make_program_name)

  # The installation of the bundled gems is failed when DESTDIR is empty in mswin platform.
  destdir = (/\bnmake/i !~ make_program_name || ENV['DESTDIR'] && ENV['DESTDIR'] != "") ? 'DESTDIR=%s' % ENV['DESTDIR'] : ''

  ['clean', '', 'install'].each do |target|
    # Pass DESTDIR via command line to override what's in MAKEFLAGS
    cmd = [
      *make_program,
      destdir,
      target,
    ].reject(&:empty?)
    begin
      run(cmd, results, "make #{target}".rstrip, make_dir)
    rescue Gem::InstallError
      raise unless target == 'clean' # ignore clean failure
    end
  end
end
new(spec, build_args = spec.build_args) click to toggle source

Creates a new extension builder for spec. If the spec does not yet have build arguments, saved, set build_args which is an ARGV-style array.

# File lib/rubygems/ext/builder.rb, line 102
def initialize(spec, build_args = spec.build_args)
  @spec       = spec
  @build_args = build_args
  @gem_dir    = spec.full_gem_path

  @ran_rake = false
end
run(command, results, command_name = nil, dir = Dir.pwd) { |status, results| ... } click to toggle source
# File lib/rubygems/ext/builder.rb, line 51
def self.run(command, results, command_name = nil, dir = Dir.pwd)
  verbose = Gem.configuration.really_verbose

  begin
    rubygems_gemdeps, ENV['RUBYGEMS_GEMDEPS'] = ENV['RUBYGEMS_GEMDEPS'], nil
    if verbose
      puts("current directory: #{dir}")
      p(command)
    end
    results << "current directory: #{dir}"
    require "shellwords"
    results << command.shelljoin

    require "open3"
    # Set $SOURCE_DATE_EPOCH for the subprocess.
    env = {'SOURCE_DATE_EPOCH' => Gem.source_date_epoch_string}
    output, status = Open3.capture2e(env, *command, :chdir => dir)
    if verbose
      puts output
    else
      results << output
    end
  rescue => error
    raise Gem::InstallError, "#{command_name || class_name} failed#{error.message}"
  ensure
    ENV['RUBYGEMS_GEMDEPS'] = rubygems_gemdeps
  end

  unless status.success?
    results << "Building has failed. See above output for more information on the failure." if verbose
  end

  yield(status, results) if block_given?

  unless status.success?
    exit_reason =
      if status.exited?
        ", exit code #{status.exitstatus}"
      elsif status.signaled?
        ", uncaught signal #{status.termsig}"
      end

    raise Gem::InstallError, "#{command_name || class_name} failed#{exit_reason}"
  end
end

Public Instance Methods

build_extensions() click to toggle source

Builds extensions. Valid types of extensions are extconf.rb files, configure scripts and rakefiles or mkrf_conf files.

# File lib/rubygems/ext/builder.rb, line 175
def build_extensions
  return if @spec.extensions.empty?

  if @build_args.empty?
    say "Building native extensions. This could take a while..."
  else
    say "Building native extensions with: '#{@build_args.join ' '}'"
    say "This could take a while..."
  end

  dest_path = @spec.extension_dir

  require "fileutils"
  FileUtils.rm_f @spec.gem_build_complete_path

  @spec.extensions.each do |extension|
    break if @ran_rake

    build_extension extension, dest_path
  end

  FileUtils.touch @spec.gem_build_complete_path
end