1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
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
57
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
|
require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
require 'rake/extensiontask'
require 'rbconfig'
describe Rake::ExtensionTask do
context '#new' do
context '(basic)' do
it 'should raise an error if no name is provided' do
lambda {
Rake::ExtensionTask.new
}.should raise_error(RuntimeError, /Extension name must be provided/)
end
it 'should allow string as extension name assignation' do
ext = Rake::ExtensionTask.new('extension_one')
ext.name.should == 'extension_one'
end
it 'should allow symbol as extension name assignation' do
ext = Rake::ExtensionTask.new(:extension_one)
ext.name.should == 'extension_one'
end
it 'should allow string as extension name using block assignation' do
ext = Rake::ExtensionTask.new do |ext|
ext.name = 'extension_two'
end
ext.name.should == 'extension_two'
end
it 'should return itself for the block' do
from_block = nil
from_lasgn = Rake::ExtensionTask.new('extension_three') do |ext|
from_block = ext
end
from_block.should == from_lasgn
end
it 'should accept a gem specification as parameter' do
spec = mock_gem_spec
ext = Rake::ExtensionTask.new('extension_three', spec)
ext.gem_spec.should == spec
end
it 'should allow gem specification be defined using block assignation' do
spec = mock_gem_spec
ext = Rake::ExtensionTask.new('extension_four') do |ext|
ext.gem_spec = spec
end
ext.gem_spec.should == spec
end
it 'should allow forcing of platform' do
ext = Rake::ExtensionTask.new('weird_extension') do |ext|
ext.platform = 'universal-foo-bar-10.5'
end
ext.platform.should == 'universal-foo-bar-10.5'
end
end
end
context '(defaults)' do
before :each do
@ext = Rake::ExtensionTask.new('extension_one')
end
it 'should look for extconf script' do
@ext.config_script.should == 'extconf.rb'
end
it 'should dump intermediate files to tmp/' do
@ext.tmp_dir.should == 'tmp'
end
it 'should copy build extension into lib/' do
@ext.lib_dir.should == 'lib'
end
it 'should look for C files pattern (.c)' do
@ext.source_pattern.should == "*.c"
end
it 'should have no configuration options preset to delegate' do
@ext.config_options.should be_empty
end
it "should have no includes preset to delegate" do
@ext.config_includes.should be_empty
end
it 'should default to current platform' do
@ext.platform.should == RUBY_PLATFORM
end
it 'should default to no cross compilation' do
@ext.cross_compile.should be_false
end
it 'should have no configuration options for cross compilation' do
@ext.cross_config_options.should be_empty
end
it "should have cross platform defined to 'i386-mingw32'" do
@ext.cross_platform.should == 'i386-mingw32'
end
end
context '(tasks)' do
before :each do
Rake.application.clear
CLEAN.clear
CLOBBER.clear
end
context '(one extension)' do
before :each do
Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"], [])
@ext = Rake::ExtensionTask.new('extension_one')
@ext_bin = ext_bin('extension_one')
@platform = RUBY_PLATFORM
@ruby_ver = RUBY_VERSION
end
context 'compile' do
it 'should define as task' do
Rake::Task.task_defined?('compile').should be_true
end
it "should depend on 'compile:{platform}'" do
Rake::Task['compile'].prerequisites.should include("compile:#{@platform}")
end
end
context 'compile:extension_one' do
it 'should define as task' do
Rake::Task.task_defined?('compile:extension_one').should be_true
end
it "should depend on 'compile:extension_one:{platform}'" do
Rake::Task['compile:extension_one'].prerequisites.should include("compile:extension_one:#{@platform}")
end
end
context 'lib/extension_one.{so,bundle}' do
it 'should define as task' do
Rake::Task.task_defined?("lib/#{@ext_bin}").should be_true
end
it "should depend on 'copy:extension_one:{platform}:{ruby_ver}'" do
Rake::Task["lib/#{@ext_bin}"].prerequisites.should include("copy:extension_one:#{@platform}:#{@ruby_ver}")
end
end
context 'tmp/{platform}/extension_one/{ruby_ver}/extension_one.{so,bundle}' do
it 'should define as task' do
Rake::Task.task_defined?("tmp/#{@platform}/extension_one/#{@ruby_ver}/#{@ext_bin}").should be_true
end
it "should depend on 'tmp/{platform}/extension_one/{ruby_ver}/Makefile'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/#{@ext_bin}"].prerequisites.should include("tmp/#{@platform}/extension_one/#{@ruby_ver}/Makefile")
end
it "should depend on 'ext/extension_one/source.c'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/#{@ext_bin}"].prerequisites.should include("ext/extension_one/source.c")
end
it "should not depend on 'ext/extension_one/source.h'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/#{@ext_bin}"].prerequisites.should_not include("ext/extension_one/source.h")
end
end
context 'tmp/{platform}/extension_one/{ruby_ver}/Makefile' do
it 'should define as task' do
Rake::Task.task_defined?("tmp/#{@platform}/extension_one/#{@ruby_ver}/Makefile").should be_true
end
it "should depend on 'tmp/{platform}/extension_one/{ruby_ver}'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/Makefile"].prerequisites.should include("tmp/#{@platform}/extension_one/#{@ruby_ver}")
end
it "should depend on 'ext/extension_one/extconf.rb'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/Makefile"].prerequisites.should include("ext/extension_one/extconf.rb")
end
end
context 'clean' do
it "should include 'tmp/{platform}/extension_one/{ruby_ver}' in the pattern" do
CLEAN.should include("tmp/#{@platform}/extension_one/#{@ruby_ver}")
end
end
context 'clobber' do
it "should include 'lib/extension_one.{so,bundle}'" do
CLOBBER.should include("lib/#{@ext_bin}")
end
it "should include 'tmp'" do
CLOBBER.should include('tmp')
end
end
it "should warn when pre-compiled files exist in extension directory" do
Rake::FileList.stub!(:[]).
and_return(["ext/extension_one/source.c"],
["ext/extension_one/source.o"])
_, err = capture_output do
Rake::ExtensionTask.new('extension_one')
end
err.should match(/rake-compiler found compiled files in 'ext\/extension_one' directory. Please remove them./)
end
end
context '(extension in custom location)' do
before :each do
Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"], [])
@ext = Rake::ExtensionTask.new('extension_one') do |ext|
ext.ext_dir = 'custom/ext/foo'
end
@ext_bin = ext_bin('extension_one')
@platform = RUBY_PLATFORM
@ruby_ver = RUBY_VERSION
end
context 'tmp/{platform}/extension_one/{ruby_ver}/Makefile' do
it "should depend on 'custom/ext/foo/extconf.rb'" do
Rake::Task["tmp/#{@platform}/extension_one/#{@ruby_ver}/Makefile"].prerequisites.should include("custom/ext/foo/extconf.rb")
end
end
end
context '(native tasks)' do
before :each do
Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"], [])
@spec = mock_gem_spec
@ext_bin = ext_bin('extension_one')
@platform = RUBY_PLATFORM
@ruby_ver = RUBY_VERSION
end
context 'native' do
before :each do
@spec.stub!(:platform=).and_return('ruby')
end
it 'should define a task for building the supplied gem' do
Rake::ExtensionTask.new('extension_one', @spec)
Rake::Task.task_defined?('native:my_gem').should be_true
end
it 'should define as task for pure ruby gems' do
Rake::Task.task_defined?('native').should be_false
Rake::ExtensionTask.new('extension_one', @spec)
Rake::Task.task_defined?('native').should be_true
end
it 'should not define a task for already native gems' do
@spec.stub!(:platform).and_return('current')
Rake::ExtensionTask.new('extension_one', @spec)
Rake::Task.task_defined?('native').should be_false
end
it 'should depend on platform specific native tasks' do
Rake::ExtensionTask.new('extension_one', @spec)
Rake::Task["native"].prerequisites.should include("native:#{@platform}")
end
context 'native:my_gem:{platform}' do
it 'should depend on binary extension' do
Rake::ExtensionTask.new('extension_one', @spec)
Rake::Task["native:my_gem:#{@platform}"].prerequisites.should include("tmp/#{@platform}/stage/lib/#{@ext_bin}")
end
end
end
end
context '(one extension whose name with directory prefixes)' do
before :each do
Rake::FileList.stub!(:[]).and_return(["ext/prefix1/prefix2/extension_one/source.c"], [])
@ext = Rake::ExtensionTask.new('prefix1/prefix2/extension_one')
@ext_bin = ext_bin('extension_one')
@platform = RUBY_PLATFORM
@ruby_ver = RUBY_VERSION
end
context 'compile' do
it 'should define as task' do
Rake::Task.task_defined?('compile').should be_true
end
it "should depend on 'compile:{platform}'" do
Rake::Task['compile'].prerequisites.should include("compile:#{@platform}")
end
end
context 'compile:prefix1/prefix2/extension_one' do
it 'should define as task' do
Rake::Task.task_defined?('compile:prefix1/prefix2/extension_one').should be_true
end
it "should depend on 'compile:prefix1/prefix2/extension_one:{platform}'" do
Rake::Task['compile:prefix1/prefix2/extension_one'].prerequisites.should include("compile:prefix1/prefix2/extension_one:#{@platform}")
end
end
context 'lib/prefix1/prefix2/extension_one.{so,bundle}' do
it 'should define as task' do
Rake::Task.task_defined?("lib/prefix1/prefix2/#{@ext_bin}").should be_true
end
it "should depend on 'copy:prefix1/prefix2/extension_one:{platform}:{ruby_ver}'" do
Rake::Task["lib/prefix1/prefix2/#{@ext_bin}"].prerequisites.should include("copy:prefix1/prefix2/extension_one:#{@platform}:#{@ruby_ver}")
end
end
context 'tmp/{platform}/prefix1/prefix2/extension_one/{ruby_ver}/prefix1/prefix2/extension_one.{so,bundle}' do
it 'should define as task' do
Rake::Task.task_defined?("tmp/#{@platform}/prefix1/prefix2/extension_one/#{@ruby_ver}/prefix1/prefix2/#{@ext_bin}").should be_true
end
it "should depend on 'tmp/{platform}/prefix1/prefix2/extension_one/{ruby_ver}/Makefile'" do
Rake::Task["tmp/#{@platform}/prefix1/prefix2/extension_one/#{@ruby_ver}/prefix1/prefix2/#{@ext_bin}"].prerequisites.should include("tmp/#{@platform}/prefix1/prefix2/extension_one/#{@ruby_ver}/Makefile")
end
it "should depend on 'ext/extension_one/source.c'" do
Rake::Task["tmp/#{@platform}/prefix1/prefix2/extension_one/#{@ruby_ver}/prefix1/prefix2/#{@ext_bin}"].prerequisites.should include("ext/prefix1/prefix2/extension_one/source.c")
end
it "should not depend on 'ext/extension_one/source.h'" do
Rake::Task["tmp/#{@platform}/prefix1/prefix2/extension_one/#{@ruby_ver}/prefix1/prefix2/#{@ext_bin}"].prerequisites.should_not include("ext/prefix1/prefix2/extension_one/source.h")
end
end
end
context '(cross platform tasks)' do
before :each do
File.stub!(:exist?).and_return(true)
YAML.stub!(:load_file).and_return(mock_config_yml)
Rake::FileList.stub!(:[]).and_return(["ext/extension_one/source.c"], [])
@spec = mock_gem_spec
@config_file = File.expand_path("~/.rake-compiler/config.yml")
@ruby_ver = RUBY_VERSION
@platform = 'i386-mingw32'
@config_path = mock_config_yml["rbconfig-#{@platform}-#{@ruby_ver}"]
File.stub!(:open).and_yield(mock_fake_rb)
end
context 'if no rake-compiler configuration exists' do
before :each do
File.should_receive(:exist?).with(@config_file).and_return(false)
_, @err = capture_output do
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
end
end
end
it 'should not generate a warning' do
@err.should eq("")
end
it 'should create a dummy nested cross-compile target that raises an error' do
Rake::Task.should have_defined("cross")
Rake::Task["cross"].invoke
lambda {
Rake::Task["compile"].invoke
}.should raise_error(RuntimeError,
/rake-compiler must be configured first to enable cross-compilation/)
end
end
it 'should parse the config file using YAML' do
YAML.should_receive(:load_file).with(@config_file).and_return(mock_config_yml)
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
end
end
it 'should warn if no section of config file defines running version of ruby' do
config = mock(Hash)
config.should_receive(:[]).with("rbconfig-#{@platform}-#{@ruby_ver}").and_return(nil)
YAML.stub!(:load_file).and_return(config)
out, err = capture_output do
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
end
end
err.should match(/no configuration section for specified version of Ruby/)
end
it 'should capture an action block to be executed when cross compiling' do
lambda {
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compiling do |gem_spec|
gem_spec.post_install_message = "Cross compiled gem"
end
end
}.should_not raise_error
end
it 'should generate additional rake tasks if files are added when cross compiling' do
config = mock(Hash)
config.stub!(:[]).and_return('/rubies/1.9.1/rbconfig.rb')
YAML.stub!(:load_file).and_return(config)
# Use a real spec instead of a mock because define_native_tasks dups and
# calls methods on Gem::Specification, which is more than mock can do.
spec = Gem::Specification.new do |s|
s.name = 'my_gem'
s.platform = Gem::Platform::RUBY
end
# Gem::PackageTask calls Rake::PackageTask which sets Gem.configuration.verbose,
# which initializes Gem::ConfigFile,
# which gets mad if it cannot find `sysconfdir`/gemrc
Gem.stub_chain(:configuration, :verbose=).and_return(true)
ENV['RUBY_CC_VERSION'] = '1.9.1'
Rake::ExtensionTask.new('extension_one', spec) do |ext|
ext.cross_compile = true
ext.cross_platform = 'universal-unknown'
ext.cross_compiling do |gem_spec|
gem_spec.files << 'somedir/somefile'
end
end
Rake::Task['native:my_gem:universal-unknown'].execute
Rake::Task.should have_defined("tmp/universal-unknown/stage/somedir")
Rake::Task.should have_defined("tmp/universal-unknown/stage/somedir/somefile")
end
it 'should allow usage of RUBY_CC_VERSION to indicate a different version of ruby' do
config = mock(Hash)
config.should_receive(:[]).with("rbconfig-i386-mingw32-1.9.1").and_return('/rubies/1.9.1/rbconfig.rb')
YAML.stub!(:load_file).and_return(config)
ENV['RUBY_CC_VERSION'] = '1.9.1'
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
end
end
it 'should allow multiple versions be supplied to RUBY_CC_VERSION' do
config = mock(Hash)
config.should_receive(:[]).once.with("rbconfig-i386-mingw32-1.8.6").and_return('/rubies/1.8.6/rbconfig.rb')
config.should_receive(:[]).once.with("rbconfig-i386-mingw32-1.9.1").and_return('/rubies/1.9.1/rbconfig.rb')
YAML.stub!(:load_file).and_return(config)
ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
end
end
after :each do
ENV.delete('RUBY_CC_VERSION')
end
context "(cross compile for multiple versions)" do
before :each do
config = mock(Hash)
config.stub!(:[]).and_return('/rubies/1.8.6/rbconfig.rb', '/rubies/1.9.1/rbconfig.rb')
YAML.stub!(:load_file).and_return(config)
ENV['RUBY_CC_VERSION'] = '1.8.6:1.9.1'
@ext = Rake::ExtensionTask.new('extension_one') do |ext|
ext.cross_compile = true
ext.cross_platform = 'universal-unknown'
end
end
it 'should create specific copy of binaries for each version' do
Rake::Task.should have_defined("copy:extension_one:universal-unknown:1.8.6")
Rake::Task.should have_defined("copy:extension_one:universal-unknown:1.9.1")
end
end
context "(cross for 'universal-unknown' platform)" do
before :each do
@ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
ext.cross_compile = true
ext.cross_platform = 'universal-unknown'
end
end
context 'fake' do
it 'should chain fake task to Makefile generation' do
Rake::Task["tmp/universal-unknown/extension_one/#{@ruby_ver}/Makefile"].prerequisites.should include("tmp/universal-unknown/extension_one/#{@ruby_ver}/fake.rb")
end
it 'should chain rbconfig tasks to fake.rb generation' do
Rake::Task["tmp/universal-unknown/extension_one/#{@ruby_ver}/fake.rb"].prerequisites.should include(@config_path)
end
end
context 'mkmf' do
it 'should chain mkmf tasks to Makefile generation' do
Rake::Task["tmp/universal-unknown/extension_one/#{@ruby_ver}/Makefile"].prerequisites.should include("tmp/universal-unknown/extension_one/#{@ruby_ver}/mkmf.rb")
end
it 'should take mkmf from rake-compiler configuration' do
mkmf_path = File.expand_path(File.join(File.dirname(@config_path), '..', 'mkmf.rb'))
Rake::Task["tmp/universal-unknown/extension_one/#{@ruby_ver}/mkmf.rb"].prerequisites.should include(mkmf_path)
end
end
context 'compile:universal-unknown' do
it "should be defined" do
Rake::Task.task_defined?('compile:universal-unknown').should be_true
end
it "should depend on 'compile:extension_one:universal-unknown'" do
Rake::Task['compile:universal-unknown'].prerequisites.should include('compile:extension_one:universal-unknown')
end
end
context 'native:universal-unknown' do
it "should be defined" do
Rake::Task.task_defined?('native:universal-unknown').should be_true
end
it "should depend on 'native:my_gem:universal-unknown'" do
Rake::Task['native:universal-unknown'].prerequisites.should include('native:my_gem:universal-unknown')
end
end
end
context '(cross for multiple platforms)' do
before :each do
@ext = Rake::ExtensionTask.new('extension_one', @spec) do |ext|
ext.cross_compile = true
ext.cross_platform = ['universal-known', 'universal-unknown']
ext.cross_config_options << '--with-something'
ext.cross_config_options << {'universal-known' => '--with-known'}
end
end
it 'should define task for each supplied platform' do
Rake::Task.should have_defined('compile:universal-known')
Rake::Task.should have_defined('compile:universal-unknown')
end
it 'should filter options for each supplied platform' do
@ext.cross_config_options('universal-unknown').should eq(%w[--with-something])
@ext.cross_config_options('universal-known').should eq(%w[--with-something --with-known])
end
end
end
end
private
def ext_bin(extension_name)
"#{extension_name}.#{RbConfig::CONFIG['DLEXT']}"
end
def mock_gem_spec(stubs = {})
mock(Gem::Specification,
{ :name => 'my_gem', :platform => 'ruby', :files => [] }.merge(stubs)
)
end
def mock_config_yml
return @mock_config_yml if @mock_config_yml
versions = {
"1.8.6" => "1.8",
"1.8.7" => "1.8",
"1.9.3" => "1.9.1",
"2.0.0" => "2.0.0",
"2.1.2" => "2.1.0",
RUBY_VERSION => RbConfig::CONFIG["ruby_version"]
}
platforms = [
"i386-mingw32",
"universal-known",
"universal-unknown",
"x64-mingw32",
RUBY_PLATFORM
]
@mock_config_yml = {}
platforms.collect do |platform|
versions.each do |version, api_version|
@mock_config_yml["rbconfig-#{platform}-#{version}"] = "/rubies/#{api_version}/rbconfig.rb"
end
end
@mock_config_yml
end
def mock_fake_rb
mock(File, :write => 45)
end
end
|