Class: Gem::Ext::Builder

Inherits:
Object
  • Object
show all
Includes:
UserInteraction
Defined in:
lib/rubygems/ext/builder.rb

Constant Summary collapse

CHDIR_MUTEX =

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.

Mutex.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose

Methods included from DefaultUserInteraction

ui, #ui, #ui=, ui=, use_ui, #use_ui

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initialize(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.


106
107
108
109
110
111
112
# File 'lib/rubygems/ext/builder.rb', line 106

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

  @ran_rake = false
end

Instance Attribute Details

#build_argsObject

:nodoc:


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

def build_args
  @build_args
end

Class Method Details

.class_nameObject


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

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

.make(dest_path, results) ⇒ Object


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/rubygems/ext/builder.rb', line 29

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

  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
    ].join(' ').rstrip
    begin
      run(cmd, results, "make #{target}".rstrip)
    rescue Gem::InstallError
      raise unless target == 'clean' # ignore clean failure
    end
  end
end

.run(command, results, command_name = nil) {|status, results| ... } ⇒ Object

Yields:

  • (status, results)

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/rubygems/ext/builder.rb', line 58

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

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

    require "open3"
    output, status = Open3.capture2e(*command)
    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

Instance Method Details

#build_error(output, backtrace = nil) ⇒ Object

Logs the build output, then raises Gem::Ext::BuildError.


136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/rubygems/ext/builder.rb', line 136

def build_error(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) ⇒ Object

:nodoc:


151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# File 'lib/rubygems/ext/builder.rb', line 151

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

  builder = builder_for(extension)

  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

  begin
    FileUtils.mkdir_p dest_path

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

        verbose { results.join("\n") }
      ensure
        begin
          Dir.chdir pwd
        rescue SystemCallError
          Dir.chdir dest_path
        end
      end
    end

    write_gem_make_out results.join "\n"
  rescue => e
    results << e.message
    build_error(results.join("\n"), [email protected])
  end
end

#build_extensionsObject

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


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/rubygems/ext/builder.rb', line 191

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

  @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) ⇒ Object

Chooses the extension builder class for extension


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/rubygems/ext/builder.rb', line 117

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
    build_error("No builder for extension '#{extension}'")
  end
end

#write_gem_make_out(output) ⇒ Object

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


217
218
219
220
221
222
223
224
225
226
227
# File 'lib/rubygems/ext/builder.rb', line 217

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