class Gem::Ext::ExtConfBuilder

Public Class Methods

build(extension, dest_path, results, args=[], lib_dir=nil, extension_dir=Dir.pwd) click to toggle source
# File rubygems/ext/ext_conf_builder.rb, line 9
def self.build(extension, dest_path, results, args=[], lib_dir=nil, extension_dir=Dir.pwd)
  require 'fileutils'
  require 'tempfile'

  tmp_dest = Dir.mktmpdir(".gem.", extension_dir)

  # Some versions of `mktmpdir` return absolute paths, which will break make
  # if the paths contain spaces. However, on Ruby 1.9.x on Windows, relative
  # paths cause all C extension builds to fail.
  #
  # As such, we convert to a relative path unless we are using Ruby 1.9.x on
  # Windows. This means that when using Ruby 1.9.x on Windows, paths with
  # spaces do not work.
  #
  # Details: https://github.com/rubygems/rubygems/issues/977#issuecomment-171544940
  tmp_dest_relative = get_relative_path(tmp_dest.clone, extension_dir)

  Tempfile.open %w[siteconf .rb], extension_dir do |siteconf|
    siteconf.puts "require 'rbconfig'"
    siteconf.puts "dest_path = #{tmp_dest_relative.dump}"
    %w[sitearchdir sitelibdir].each do |dir|
      siteconf.puts "RbConfig::MAKEFILE_CONFIG['#{dir}'] = dest_path"
      siteconf.puts "RbConfig::CONFIG['#{dir}'] = dest_path"
    end

    siteconf.close

    destdir = ENV["DESTDIR"]

    begin
      # workaround for https://github.com/oracle/truffleruby/issues/2115
      siteconf_path = RUBY_ENGINE == "truffleruby" ? siteconf.path.dup : siteconf.path
      require "shellwords"
      cmd = Gem.ruby.shellsplit << "-I" << File.expand_path("../../..", __FILE__) <<
            "-r" << get_relative_path(siteconf_path, extension_dir) << File.basename(extension)
      cmd.push(*args)

      begin
        run(cmd, results, class_name, extension_dir) do |s, r|
          mkmf_log = File.join(extension_dir, 'mkmf.log')
          if File.exist? mkmf_log
            unless s.success?
              r << "To see why this extension failed to compile, please check" \
                " the mkmf.log which can be found here:\n"
              r << "  " + File.join(dest_path, 'mkmf.log') + "\n"
            end
            FileUtils.mv mkmf_log, dest_path
          end
        end
        siteconf.unlink
      end

      ENV["DESTDIR"] = nil

      make dest_path, results, extension_dir

      if tmp_dest_relative
        full_tmp_dest = File.join(extension_dir, tmp_dest_relative)

        # TODO remove in RubyGems 3
        if Gem.install_extension_in_lib and lib_dir
          FileUtils.mkdir_p lib_dir
          entries = Dir.entries(full_tmp_dest) - %w[. ..]
          entries = entries.map {|entry| File.join full_tmp_dest, entry }
          FileUtils.cp_r entries, lib_dir, :remove_destination => true
        end

        FileUtils::Entry_.new(full_tmp_dest).traverse do |ent|
          destent = ent.class.new(dest_path, ent.rel)
          destent.exist? or FileUtils.mv(ent.path, destent.path)
        end
      end
    ensure
      ENV["DESTDIR"] = destdir
      siteconf.close!
    end
  end

  results
ensure
  FileUtils.rm_rf tmp_dest if tmp_dest
end

Private Class Methods

get_relative_path(path, base) click to toggle source
# File rubygems/ext/ext_conf_builder.rb, line 94
def self.get_relative_path(path, base)
  path[0..base.length - 1] = '.' if path.start_with?(base)
  path
end