123456789_123456789_123456789_123456789_123456789_

Class: Gem::Ext::Builder

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Inherits: Object
Defined in: lib/rubygems/ext/builder.rb

Constant Summary

  • CHDIR_MUTEX = Internal use only

    The builder shells-out to run various commands after changing the directory. This means multiple installations cannot be allowed to build extensions in parallel as they may change each other's directories leading to broken extensions or failed installations.

    # File 'lib/rubygems/ext/builder.rb', line 21
    Mutex.new

Class Method Summary

Instance Attribute Summary

Instance Method Summary

::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

::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

.new(spec, build_args = spec.build_args) ⇒ Builder

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.

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 101

def initialize spec, build_args = spec.build_args
  @spec       = spec
  @build_args = build_args
  @gem_dir    = spec.full_gem_path

  @ran_rake   = nil
end

Class Method Details

.class_name

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 25

def self.class_name
  name =~ /Ext::(.*)Builder/
  $1.downcase
end

.make(dest_path, results)

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 30

def self.make(dest_path, results)
  unless File.exist? 'Makefile' then
    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 = ENV['MAKE'] || ENV['make'] || $1
  unless make_program then
    make_program = (/mswin/ =~ RUBY_PLATFORM) ? 'nmake' : 'make'
  end

  destdir = '"DESTDIR=%s"' % ENV['DESTDIR'] if RUBY_VERSION > '2.0'

  ['clean', '', 'install'].each do |target|
    # Pass DESTDIR via command line to override what's in MAKEFLAGS
    cmd = [
      make_program,
      destdir,
      target
    ].join(' ').rstrip
    begin
      run(cmd, results, "make #{target}".rstrip)
    rescue Gem::InstallError
      raise unless target == 'clean' # ignore clean failure
    end
  end
end

.redirector

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 59

def self.redirector
  '2>&1'
end

.run(command, results, command_name = nil)

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 63

def self.run(command, results, command_name = nil)
  verbose = Gem.configuration.really_verbose

  begin
    # TODO use Process.spawn when ruby 1.8 support is dropped.
    rubygems_gemdeps, ENV['RUBYGEMS_GEMDEPS'] = ENV['RUBYGEMS_GEMDEPS'], nil
    if verbose
      puts("current directory: #{Dir.pwd}")
      puts(command)
      system(command)
    else
      results << "current directory: #{Dir.pwd}"
      results << command
      results << `#{command} #{redirector}`
    end
  ensure
    ENV['RUBYGEMS_GEMDEPS'] = rubygems_gemdeps
  end

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

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

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

Instance Attribute Details

#build_args (rw)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 23

attr_accessor :build_args # :nodoc:

Instance Method Details

#build_error(build_dir, output, backtrace = nil)

This method is for internal use only.

Logs the build output in build_dir, then raises BuildError.

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 134

def build_error build_dir, output, backtrace = nil # :nodoc:
  gem_make_out = write_gem_make_out output

  message = <<-EOF
ERROR: Failed to build gem native extension.

  #{output}

Gem files will remain installed in #{@gem_dir} for inspection.
Results logged to #{gem_make_out}
EOF

  raise Gem::Ext::BuildError, message, backtrace
end

#build_extension(extension, dest_path)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 149

def build_extension extension, dest_path # :nodoc:
  results = []

  extension ||= '' # I wish I knew why this line existed
  extension_dir =
    File.expand_path File.join @gem_dir, File.dirname(extension)
  lib_dir = File.join @spec.full_gem_path, @spec.raw_require_paths.first

  builder = builder_for extension

  begin
    FileUtils.mkdir_p dest_path

    CHDIR_MUTEX.synchronize do
      Dir.chdir extension_dir do
        results = builder.build(extension, @gem_dir, dest_path,
                                results, @build_args, lib_dir)

        verbose { results.join("\n") }
      end
    end

    write_gem_make_out results.join "\n"
  rescue => e
    results << e.message
    build_error extension_dir, results.join("\n"), $@
  end
end

#build_extensions

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

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 182

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

  FileUtils.rm_f @spec.gem_build_complete_path

  @ran_rake = false # only run rake once

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

    build_extension extension, dest_path
  end

  FileUtils.touch @spec.gem_build_complete_path
end

#builder_for(extension)

This method is for internal use only.

Chooses the extension builder class for extension

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 112

def builder_for extension # :nodoc:
  case extension
  when /extconf/ then
    Gem::Ext::ExtConfBuilder
  when /configure/ then
    Gem::Ext::ConfigureBuilder
  when /rakefile/i, /mkrf_conf/i then
    @ran_rake = true
    Gem::Ext::RakeBuilder
  when /CMakeLists.txt/ then
    Gem::Ext::CmakeBuilder
  else
    extension_dir = File.join @gem_dir, File.dirname(extension)

    message = "No builder for extension '#{extension}'"
    build_error extension_dir, message
  end
end

#write_gem_make_out(output)

This method is for internal use only.

Writes output to gem_make.out in the extension install directory.

[ GitHub ]

  
# File 'lib/rubygems/ext/builder.rb', line 210

def write_gem_make_out output # :nodoc:
  destination = File.join @spec.extension_dir, 'gem_make.out'

  FileUtils.mkdir_p @spec.extension_dir

  File.open destination, 'wb' do |io| io.puts output end

  destination
end