class Gem::Ext::Builder - Documentation for Ruby 4.0
Description: Documentation for the Gem::Ext::Builder class
Keywords: ruby,class,Gem::Ext::Builder

🔍

No recent searches

# class Gem::Ext::Builder

### Public Class Methods

class_name ()
Source

    # File lib/rubygems/ext/builder.rb, line 19
    def self.class_name
      name =~ /Ext::(.*)Builder/
      $1.downcase
    end

make (dest_path, results, make_dir = Dir.pwd, sitedir = nil, targets = ["clean", "", "install"], target_rbconfig: Gem.target_rbconfig, n_jobs: nil)
Source

    # File lib/rubygems/ext/builder.rb, line 24
    def self.make(dest_path, results, make_dir = Dir.pwd, sitedir = nil, targets = ["clean", "", "install"],
      target_rbconfig: Gem.target_rbconfig, n_jobs: nil)
      unless File.exist? File.join(make_dir, "Makefile")
        # No makefile exists, nothing to do.
        raise NoMakefileError, "No Makefile found in #{make_dir}"
      end

      # try to find make program from Ruby configure arguments first
      target_rbconfig["configure_args"] =~ /with-make-prog\=(\w+)/
      make_program_name = ENV["MAKE"] || ENV["make"] || $1
      make_program_name ||= RUBY_PLATFORM.include?("mswin") ? "nmake" : "make"
      make_program = shellsplit(make_program_name)

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

      # nmake doesn't support parallel build
      unless is_nmake
        have_make_arguments = make_program.size > 1

        if !have_make_arguments && !ENV["MAKEFLAGS"] && n_jobs
          make_program << "-j#{n_jobs}"
        end
      end

      env = [destdir]

      if sitedir
        env << format("sitearchdir=%s", sitedir)
        env << format("sitelibdir=%s", sitedir)
      end

      targets.each do |target|
        # Pass DESTDIR via command line to override what's in MAKEFLAGS
        cmd = [
          *make_program,
          *env,
          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, target_rbconfig = Gem.target_rbconfig, build_jobs = nil)
Source

    # File lib/rubygems/ext/builder.rb, line 161
    def initialize(spec, build_args = spec.build_args, target_rbconfig = Gem.target_rbconfig, build_jobs = nil)
      @spec       = spec
      @build_args = build_args
      @gem_dir    = spec.full_gem_path
      @target_rbconfig = target_rbconfig
      @build_jobs = build_jobs
    end

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.

ruby ()
Source

    # File lib/rubygems/ext/builder.rb, line 72
    def self.ruby
      # Gem.ruby is quoted if it contains whitespace
      cmd = shellsplit(Gem.ruby)

      # This load_path is only needed when running rubygems test without a proper installation.
      # Prepending it in a normal installation will cause problem with order of $LOAD_PATH.
      # Therefore only add load_path if it is not present in the default $LOAD_PATH.
      load_path = File.expand_path("../..", __dir__)
      case load_path
      when RbConfig::CONFIG["sitelibdir"], RbConfig::CONFIG["vendorlibdir"], RbConfig::CONFIG["rubylibdir"]
        cmd
      else
        cmd << "-I#{load_path}"
      end
    end

run (command, results, command_name = nil, dir = Dir.pwd, env = {}) { |status, results| ... }
Source

    # File lib/rubygems/ext/builder.rb, line 88
    def self.run(command, results, command_name = nil, dir = Dir.pwd, env = {})
      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}"
        results << shelljoin(command)

        require "open3"
        # Set $SOURCE_DATE_EPOCH for the subprocess.
        build_env = { "SOURCE_DATE_EPOCH" => Gem.source_date_epoch_string }.merge(env)
        output, status = begin
                           Open3.popen2e(build_env, *command, chdir: dir) do |stdin, stdouterr, wait_thread|
                             stdin.close
                             output = String.new
                             while line = stdouterr.gets
                               output << line
                               if verbose
                                 print line
                               end
                             end
                             [output, wait_thread.value]
                           end
                         rescue StandardError => error
                           raise Gem::InstallError, "#{command_name || class_name} failed#{error.message}"
                         end
        unless verbose
          results << output
        end
      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

shelljoin (command)
Source

    # File lib/rubygems/ext/builder.rb, line 150
    def self.shelljoin(command)
      require "shellwords"

      Shellwords.join(command)
    end

shellsplit (command)
Source

    # File lib/rubygems/ext/builder.rb, line 144
    def self.shellsplit(command)
      require "shellwords"

      Shellwords.split(command)
    end

### Public Instance Methods

build_extensions ()
Source

    # File lib/rubygems/ext/builder.rb, line 235
    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|
        build_extension extension, dest_path
      end

      FileUtils.touch @spec.gem_build_complete_path
    end

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