Class: Gem::Ext::ExtConfBuilder

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, Builder
Instance Chain: self, Builder, ::Gem::UserInteraction, ::Gem::DefaultUserInteraction, ::Gem::Text
Inherits:	Gem::Ext::Builder Object Gem::Ext::Builder Gem::Ext::ExtConfBuilder
Defined in:	lib/rubygems/ext/ext_conf_builder.rb

Constant Summary

FileEntry = Internal use only
# File 'lib/rubygems/ext/ext_conf_builder.rb', line 12
```
FileUtils::Entry_
```

Builder - Inherited

CHDIR_MUTEX

Class Method Summary

.build(extension, directory, dest_path, results, args = [], lib_dir = nil)
.get_relative_path(path) private

Builder - Inherited

.class_name, .make,
.new	Creates a new extension builder for `spec`.
.redirector, .run

Instance Attribute Summary

Builder - Inherited

#build_args

::Gem::DefaultUserInteraction - Included

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

Builder - Inherited

#build_extensions	Builds extensions.
#build_error	Logs the build `output` in `build_dir`, then raises BuildError.
#build_extension,
#builder_for	Chooses the extension builder class for `extension`
#write_gem_make_out	Writes `output` to gem_make.out in the extension install directory.

::Gem::UserInteraction - Included

#alert	Displays an alert `statement`.
#alert_error	Displays an error `statement` to the error output location.
#alert_warning	Displays a warning `statement` to the warning output location.
#ask	Asks a `question` and returns the answer.
#ask_for_password	Asks for a password with a `prompt`
#ask_yes_no	Asks a yes or no `question`.
#choose_from_list	Asks the user to answer `question` with an answer from the given `list`.
#say	Displays the given `statement` on the standard output (or equivalent).
#terminate_interaction	Terminates the RubyGems process with the given `exit_code`
#verbose	Calls `say` with `msg` or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

#use_ui

See DefaultUserInteraction.use_ui

::Gem::Text - Included

#clean_text	Remove any non-printable characters and make the text suitable for printing.
#format_text	Wraps `text` to `wrap` characters and optionally indents by `indent` characters.
#levenshtein_distance	This code is based directly on the ::Gem::Text gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

This class inherits a constructor from Gem::Ext::Builder

Class Method Details

.build(extension, directory, dest_path, results, args = [], lib_dir = nil)

[ GitHub ]

# File 'lib/rubygems/ext/ext_conf_builder.rb', line 14


def self.build(extension, directory, dest_path, results, args=[], lib_dir=nil)
  tmp_dest = Dir.mktmpdir(".gem.", ".")

  # 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
  #
  # TODO: Make this unconditional when rubygems no longer supports Ruby 1.9.x.
  tmp_dest = get_relative_path(tmp_dest) unless Gem.win_platform? && RUBY_VERSION <= '2.0'

  Tempfile.open %w"siteconf .rb", "." do |siteconf|
    siteconf.puts "require 'rbconfig'"
    siteconf.puts "dest_path = #{tmp_dest.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
      cmd = [Gem.ruby, "-r", get_relative_path(siteconf.path), File.basename(extension), *args].join ' '

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

      ENV["DESTDIR"] = nil

      make dest_path, results

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

        FileEntry.new(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

.get_relative_path(path) (private)

[ GitHub ]

# File 'lib/rubygems/ext/ext_conf_builder.rb', line 89


def self.get_relative_path(path)
  path[0..Dir.pwd.length-1] = '.' if path.start_with?(Dir.pwd)
  path
end