/
gem_spec.rb
1420 lines (1090 loc) · 45.8 KB
/
gem_spec.rb
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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# typed: true
# frozen_string_literal: true
require "spec_helper"
require "tapioca/helpers/test/template"
module Tapioca
class GemSpec < SpecWithProject
include Tapioca::Helpers::Test::Template
FOO_RB = <<~RB
module Foo
PI = 3.1415
def self.bar(a = 1, b: 2, **opts)
number = opts[:number] || 0
39 + a + b + number
end
end
RB
FOO_RBI = <<~RBI
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `foo` gem.
# Please instead update this file by running `bin/tapioca gem foo`.
module Foo
class << self
def bar(a = T.unsafe(nil), b: T.unsafe(nil), **opts); end
end
end
Foo::PI = T.let(T.unsafe(nil), Float)
RBI
BAR_RB = <<~RB
module Bar
PI = 3.1415
def self.bar(a = 1, b: 2, **opts)
number = opts[:number] || 0
39 + a + b + number
end
end
RB
BAR_RBI = <<~RBI
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `bar` gem.
# Please instead update this file by running `bin/tapioca gem bar`.
module Bar
class << self
def bar(a = T.unsafe(nil), b: T.unsafe(nil), **opts); end
end
end
Bar::PI = T.let(T.unsafe(nil), Float)
RBI
BAZ_RB = <<~RB
module Baz
class Test
def fizz
"abc" * 10
end
end
end
RB
BAZ_RBI = <<~RBI
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `baz` gem.
# Please instead update this file by running `bin/tapioca gem baz`.
module Baz; end
class Baz::Test
def fizz; end
end
RBI
describe "cli::gem" do
before(:all) do
@project.bundle_install
end
before do
@project.reset_bundler_version
end
it "must support 'gems' as an alias to the command" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gems foo")
assert_includes(result.out, <<~OUT)
Compiled foo
create sorbet/rbi/gems/foo@0.0.1.rbi
OUT
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_empty_stderr(result)
assert_success_status(result)
end
describe "flags" do
it "must show an error if --all is supplied with arguments" do
result = @project.tapioca("gem --all foo")
assert_equal(<<~ERR, result.err)
Option '--all' must be provided without any other arguments
ERR
assert_empty_stdout(result)
refute_success_status(result)
end
it "must show an error if --verify is supplied with arguments" do
result = @project.tapioca("gem --verify foo")
assert_equal(<<~ERR, result.err)
Option '--verify' must be provided without any other arguments
ERR
assert_empty_stdout(result)
refute_success_status(result)
end
it "must show an error if both --all and --verify are supplied" do
result = @project.tapioca("gem --all --verify")
assert_equal(<<~ERR, result.err)
Options '--all' and '--verify' are mutually exclusive
ERR
assert_empty_stdout(result)
refute_success_status(result)
end
end
describe "generate" do
before(:all) do
@project.tapioca("init")
end
after do
project.gemfile(project.tapioca_gemfile)
project.remove("sorbet/rbi")
project.remove("../gems")
end
it "must generate a single gem RBI" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
bar = mock_gem("bar", "0.3.0") do
write("lib/bar.rb", BAR_RB)
end
@project.gemfile(<<~GEMFILE, append: true)
#{foo.gemfile_line}
#{bar.gemfile_line}
GEMFILE
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, <<~OUT)
Compiled foo
create sorbet/rbi/gems/foo@0.0.1.rbi
OUT
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
refute_project_file_exist("sorbet/rbi/gems/bar@0.3.0.rbi")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate RBI for a default gem" do
gem_name = "ostruct"
gem_top_level_constant = "class OpenStruct"
# `default_stubs` is a private method on Ruby 2.6
gem_spec = ::Gem::Specification.send(:default_stubs, "*.gemspec").find do |spec|
spec.name == gem_name && spec.default_gem?
end
assert(gem_spec, "Cannot find default '#{gem_name}' gem")
gem_version = gem_spec.version.to_s
@project.require_real_gem(gem_name, gem_version)
@project.bundle_install
result = @project.tapioca("gem #{gem_name}")
assert_includes(result.out, <<~OUT)
Compiled #{gem_name}
create sorbet/rbi/gems/#{gem_name}@#{gem_version}.rbi
OUT
rbi_contents = @project.read("sorbet/rbi/gems/#{gem_name}@#{gem_version}.rbi")
assert_includes(rbi_contents, gem_top_level_constant)
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate gem RBI in correct output directory" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo --outdir rbis/")
assert_includes(result.out, <<~OUT)
Compiled foo
OUT
assert_project_file_equal("rbis/foo@0.0.1.rbi", FOO_RBI)
assert_empty_stderr(result)
assert_success_status(result)
@project.remove("rbis/")
end
it "must generate a gem RBI with the ones exported from the gem by default" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("rbi/foo.rbi", <<~RBI)
module Foo
sig { params(a: String, b: Integer, opts: T.untyped).void }
def self.bar(a = T.unsafe(nil), b: T.unsafe(nil), **opts); end
end
RBI
write("rbi/foo/bar.rbi", <<~RBI)
module Foo
def foo; end
end
RBI
write("rbi/foo/bar/baz.rbi", <<~RBI)
module Foo:: Bar
def bar; end
end
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", <<~RBI)
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `foo` gem.
# Please instead update this file by running `bin/tapioca gem foo`.
module Foo
def foo; end
class << self
sig { params(a: String, b: Integer, opts: T.untyped).void }
def bar(a = T.unsafe(nil), b: T.unsafe(nil), **opts); end
end
end
module Foo::Bar
def bar; end
end
Foo::PI = T.let(T.unsafe(nil), Float)
RBI
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate a gem RBI without the ones exported from the gem when called with `--no-exported-gem-rbis`" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("rbi/foo.rbi", <<~RBI)
module RBI::Foo
sig { void }
def foo; end
end
RBI
write("rbi/foo/bar.rbi", <<~RBI)
module RBI::Bar
def bar; end
end
RBI
write("rbi/foo/bar/baz.rbi", <<~RBI)
module RBI::Bar::Baz
def baz; end
end
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo --no-exported-gem-rbis")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate a gem RBI and skip exported gem RBIs if they contain errors" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("rbi/foo.rbi", <<~RBI)
module Foo # Syntax error
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
assert_includes(result.err, "RBIs exported by `foo` contain errors and can't be used:")
assert_includes(result.err, "Cause: unexpected token $end")
assert_includes(result.err, "foo/rbi/foo.rbi:2:0-2:0")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_success_status(result)
end
it "must generate a gem RBI and skip exported gem RBIs if they contain conflicts" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("rbi/foo.rbi", <<~RBI)
module RBI::Foo
def foo(x); end
end
RBI
write("rbi/bar.rbi", <<~RBI)
module RBI::Foo
def foo(a, b, c); end
end
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
assert_includes(result.err, "RBIs exported by `foo` contain conflicts and can't be used:")
assert_includes(result.err, "Conflicting definitions for `::RBI::Foo#foo(a, b, c)`")
assert_includes(result.err, "Found at:")
assert_includes(result.err, "foo/rbi/bar.rbi:2:2-2:23")
assert_includes(result.err, "foo/rbi/foo.rbi:2:2-2:17")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_success_status(result)
end
it "must generate a gem RBI and resolves conflicts with exported gem RBIs by keeping the generated RBI" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("rbi/foo.rbi", <<~RBI)
module Foo
class << self
def bar; end
end
end
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_empty_stderr(result)
assert_success_status(result)
end
it "must remove outdated RBIs" do
@project.require_mock_gem(mock_gem("foo", "0.0.1"))
@project.require_mock_gem(mock_gem("bar", "0.3.0"))
@project.require_mock_gem(mock_gem("baz", "0.0.2"))
@project.bundle_install
@project.write("sorbet/rbi/gems/foo@0.0.1.rbi")
@project.write("sorbet/rbi/gems/bar@0.3.0.rbi")
@project.write("sorbet/rbi/gems/baz@0.0.2.rbi")
@project.write("sorbet/rbi/gems/outdated@5.0.0.rbi")
result = @project.tapioca("gem --all")
assert_includes(result.out, "remove sorbet/rbi/gems/outdated@5.0.0.rbi\n")
refute_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi")
refute_includes(result.out, "create sorbet/rbi/gems/bar@0.3.0.rbi")
refute_includes(result.out, "create sorbet/rbi/gems/baz@0.0.2.rbi")
refute_includes(result.out, "-> Moving:")
assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_exist("sorbet/rbi/gems/bar@0.3.0.rbi")
assert_project_file_exist("sorbet/rbi/gems/baz@0.0.2.rbi")
refute_project_file_exist("sorbet/rbi/gems/outdated@5.0.0.rbi")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must perform postrequire properly" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("lib/foo/secret.rb", "class Foo::Secret; end")
end
@project.require_mock_gem(foo)
@project.bundle_install
@project.write("sorbet/tapioca/require.rb", <<~RB)
require "foo/secret"
RB
result = @project.tapioca("gem foo")
assert_includes(result.out, <<~OUT)
Compiled foo
OUT
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", template(<<~RBI))
#{FOO_RBI.rstrip}
class Foo::Secret; end
RBI
assert_empty_stderr(result)
assert_success_status(result)
@project.remove("sorbet/tapioca/require.rb")
end
it "loads gems that are marked `require: false`" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
write("lib/foo/secret.rb", "class Foo::Secret; end")
end
bar = mock_gem("bar", "1.0.0") do
write("lib/bar.rb", <<~RUBY)
module Foo
MY_CONSTANT = 42
end
RUBY
end
@project.require_mock_gem(foo, require: false)
@project.require_mock_gem(bar, require: false)
@project.bundle_install
@project.write("sorbet/tapioca/require.rb", <<~RB)
require "foo/secret"
RB
result = @project.tapioca("gem --exclude bar")
refute_includes(result.out, <<~OUT)
Compiled bar
OUT
assert_includes(result.out, <<~OUT)
Compiled foo
OUT
refute_project_file_exist("sorbet/rbi/gems/bar@1.0.0.rbi")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", template(<<~RBI))
#{FOO_RBI.rstrip}
class Foo::Secret; end
RBI
assert_empty_stderr(result)
assert_success_status(result)
@project.remove("sorbet/tapioca/require.rb")
end
it "explains what went wrong when it can't load the postrequire properly" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
@project.require_mock_gem(foo)
@project.bundle_install
@project.write("sorbet/tapioca/require.rb", <<~RB)
require "foo/will_fail"
RB
result = @project.tapioca("gem foo")
assert_includes(result.err, <<~ERR)
LoadError: cannot load such file -- foo/will_fail
Tapioca could not load all the gems required by your application.
If you populated sorbet/tapioca/require.rb with `bin/tapioca require`
you should probably review it and remove the faulty line.
ERR
refute_success_status(result)
@project.remove("sorbet/tapioca/require.rb")
end
it "must not include `rbi` definitions into `tapioca` RBI" do
result = @project.tapioca("gem tapioca")
assert_includes(result.out, <<~OUT)
Compiled tapioca
OUT
tapioca_rbi_file = T.must(Dir.glob("#{@project.path}/sorbet/rbi/gems/tapioca@*.rbi").first)
refute_includes(File.read(tapioca_rbi_file), "class RBI::Module")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate multiple gem RBIs" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
bar = mock_gem("bar", "0.3.0") do
write("lib/bar.rb", BAR_RB)
end
baz = mock_gem("baz", "0.0.2") do
write("lib/baz.rb", BAZ_RB)
end
@project.require_mock_gem(foo)
@project.require_mock_gem(bar)
@project.require_mock_gem(baz)
@project.bundle_install
result = @project.tapioca("gem foo bar")
assert_includes(result.out, "Compiled foo")
assert_includes(result.out, "Compiled bar")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_project_file_equal("sorbet/rbi/gems/bar@0.3.0.rbi", BAR_RBI)
refute_project_file_exist("sorbet/rbi/gems/baz@0.0.2.rbi")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must generate RBIs for all gems in the Gemfile" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
bar = mock_gem("bar", "0.3.0") do
write("lib/bar.rb", BAR_RB)
end
baz = mock_gem("baz", "0.0.2") do
write("lib/baz.rb", BAZ_RB)
end
@project.require_mock_gem(foo)
@project.require_mock_gem(bar)
@project.require_mock_gem(baz)
@project.bundle_install
result = @project.tapioca("gem --all")
assert_includes(result.out, "Compiled bar")
assert_includes(result.out, "Compiled baz")
assert_includes(result.out, "Compiled foo")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_project_file_equal("sorbet/rbi/gems/bar@0.3.0.rbi", BAR_RBI)
assert_project_file_equal("sorbet/rbi/gems/baz@0.0.2.rbi", BAZ_RBI)
assert_empty_stderr(result)
assert_success_status(result)
end
it "must not generate RBIs for missing gem specs" do
@project.gemfile(<<~GEMFILE, append: true)
platform :rbx do
gem "ruby2_keywords", "0.0.5"
end
GEMFILE
@project.bundle_install
result = @project.tapioca("gem --all")
assert_includes(result.out, "completed with missing specs: ruby2_keywords (0.0.5)")
refute_includes(result.out, "Compiled ruby2_keywords")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must not generate RBIs for missing gem specs on Bundler 2.2.22" do
@project.gemfile(<<~GEMFILE, append: true)
platform :rbx do
gem "ruby2_keywords", "0.0.5"
end
GEMFILE
@project.bundle_install(version: "2.2.22")
result = @project.tapioca("gem --all")
assert_includes(result.out, "completed with missing specs: ruby2_keywords (0.0.5)")
refute_includes(result.out, "Compiled ruby2_keywords")
# StdErr will have some messages about incompatibilities, so we don't check for clean err
assert_success_status(result)
end
it "must generate git gem RBIs with source revision numbers" do
@project.gemfile(<<~GEMFILE, append: true)
gem("faraday", git: "https://github.com/lostisland/faraday", ref: "23e249563613971ced8f851230c46b9eeeefe931")
GEMFILE
@project.bundle_install
result = @project.tapioca("gem faraday")
assert_includes(result.out, "Compiled faraday")
assert_project_file_exist(
"sorbet/rbi/gems/faraday@2.0.0.alpha.pre.4-23e249563613971ced8f851230c46b9eeeefe931.rbi"
)
assert_empty_stderr(result)
assert_success_status(result)
end
it "must respect exclude option" do
@project.require_mock_gem(mock_gem("foo", "0.0.1"))
@project.require_mock_gem(mock_gem("bar", "0.3.0"))
@project.require_mock_gem(mock_gem("baz", "0.0.2"))
@project.bundle_install
result = @project.tapioca("gem --all --exclude foo bar")
refute_includes(result.out, "Compiled bar")
assert_includes(result.out, "Compiled baz")
refute_includes(result.out, "Compiled foo")
refute_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
refute_project_file_exist("sorbet/rbi/gems/bar@0.3.0.rbi")
assert_project_file_exist("sorbet/rbi/gems/baz@0.0.2.rbi")
assert_empty_stderr(result)
assert_success_status(result)
end
it "does not crash when the extras gem is loaded" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", FOO_RB)
end
@project.require_real_gem("extras")
@project.require_mock_gem(foo)
@project.bundle_install
@project.write("sorbet/tapioca/require.rb", <<~RB)
require "extras/shell"
RB
result = @project.tapioca("gem foo")
assert_includes(result.out, "Compiled foo")
assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", FOO_RBI)
assert_empty_stderr(result)
assert_success_status(result)
@project.remove("sorbet/tapioca/require.rb")
end
it "generate an empty RBI file" do
@project.require_mock_gem(mock_gem("foo", "0.0.1"))
@project.bundle_install
result = @project.tapioca("gem foo")
assert_includes(result.out, "Compiled foo (empty output)")
assert_includes(result.out, "create sorbet/rbi/gems/foo@0.0.1.rbi\n")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", <<~RBI)
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `foo` gem.
# Please instead update this file by running `bin/tapioca gem foo`.
# THIS IS AN EMPTY RBI FILE.
# see https://github.com/Shopify/tapioca/wiki/Manual-Gem-Requires
RBI
assert_empty_stderr(result)
assert_success_status(result)
end
it "generate an empty RBI file without header" do
@project.require_mock_gem(mock_gem("foo", "0.0.1"))
@project.bundle_install
result = @project.tapioca("gem foo --no-file-header")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", <<~RBI)
# typed: true
# THIS IS AN EMPTY RBI FILE.
# see https://github.com/Shopify/tapioca/wiki/Manual-Gem-Requires
RBI
assert_empty_stderr(result)
assert_success_status(result)
end
it "generates the correct RBIs when running generate in parallel" do
@project.require_mock_gem(mock_gem("foo", "0.0.1"))
@project.require_mock_gem(mock_gem("bar", "0.3.0"))
@project.require_mock_gem(mock_gem("baz", "0.0.2"))
@project.bundle_install
result = @project.tapioca("gem --all --workers 3")
assert_empty_stderr(result)
assert_success_status(result)
assert_project_file_exist("sorbet/rbi/gems/foo@0.0.1.rbi")
assert_project_file_exist("sorbet/rbi/gems/bar@0.3.0.rbi")
assert_project_file_exist("sorbet/rbi/gems/baz@0.0.2.rbi")
end
it "eagerly loads autoloaded constants" do
# Let's recreate the autoload situation that was happening with
# Yard and Rake here.
#
# Yard registers an autoload for `YardocTask``, which, when loaded
# ends up requiring the optional "rake/tasklib" file, which
# in turn loads `Rake::TaskLib`. Thus, `Rake::TaskLib` would only
# get loaded if we generated an RBI for Yard first and then we
# generated it for Rake.
#
# If we do eagerloading properly, then we should be loading `YardocTask`
# early, so that even if we only generate an RBI for Rake only, we should
# get `Rake::TaskLib` in the output.
fake_yard = mock_gem("fake_yard", "0.0.1") do
# Top-level autoloads `FakeYard::Rake` module.
write("lib/fake_yard.rb", <<~RB)
module FakeYard
autoload :Rake, __dir__ + "/fake_yard/rake.rb"
end
RB
# `FakeYard::Rake` module autoloads `FakeYard::Rake::YardocTask` class.
#
# This file is mostly here to make sure that we handle autoloads
# inside autoloaded files properly.
write("lib/fake_yard/rake.rb", <<~RB)
module FakeYard
module Rake
autoload :YardocTask, __dir__ + "/yardoc_task.rb"
end
end
RB
# Finally `FakeYard::Rake::YardocTask` requires a non-default path from
# `fake_rake` gem, `fake_rake/tasklib`, and subclasses from `FakeRake::TaskLib`
write("lib/fake_yard/yardoc_task.rb", <<~RB)
require 'fake_rake'
require 'fake_rake/tasklib'
module FakeYard
module Rake
class YardocTask < ::FakeRake::TaskLib
end
end
end
RB
end
fake_rake = mock_gem("fake_rake", "0.0.1") do
# The default require does nothing but define the gem namespace.
write("lib/fake_rake.rb", <<~RB)
module FakeRake
end
RB
# The non-default require defines `FakeRake::TaskLib`
write("lib/fake_rake/tasklib.rb", <<~RB)
module FakeRake
class TaskLib
end
end
RB
end
@project.require_mock_gem(fake_yard)
@project.require_mock_gem(fake_rake)
@project.bundle_install
result = @project.tapioca("gem fake_rake")
assert_empty_stderr(result)
assert_success_status(result)
# We expect to see both `FakeRake` (coming from the default require of `fake_rake`)
# and `FakeRake::TaskLib` in the RBI file. The latter should be loaded as part
# of the eagerloading we have for autoloads, otherwise, nothing else would have
# required the non-default `fake_rake/task_lib.rb` file.
assert_project_file_equal("sorbet/rbi/gems/fake_rake@0.0.1.rbi", <<~RBI)
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `fake_rake` gem.
# Please instead update this file by running `bin/tapioca gem fake_rake`.
module FakeRake; end
class FakeRake::TaskLib; end
RBI
end
it "uses the correct autoload, even when a gem redefines it via alias-method-chain" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", <<~RB)
class Module
alias_method :autoload_without_foo, :autoload
def autoload(const, path)
autoload_without_foo(const, path)
end
end
RB
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_empty_stderr(result)
assert_success_status(result)
end
it "uses ignores `abort` and `exit` calls inside autoloaded files" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", <<~RB)
module Foo
autoload :Bar, __dir__ + "/foo/bar.rb"
autoload :Baz, __dir__ + "/foo/baz.rb"
end
RB
write("lib/foo/bar.rb", <<~RB)
begin
abort("Cannot continue")
rescue
# To make sure that we handle errors in our Kernel hooks
Process.exit(1)
end
RB
write("lib/foo/baz.rb", <<~RB)
begin
exit 2
rescue
# To make sure that we handle errors in our Kernel hooks
Process.exit(1)
end
RB
end
@project.require_mock_gem(foo)
# We know RDoc is problematic with respect to calling `abort` in an autoload
@project.require_real_gem("rdoc")
# Just so that we have something else we can generate for.
@project.require_real_gem("json")
@project.bundle_install
result = @project.tapioca("gem json")
assert_empty_stderr(result)
assert_success_status(result)
end
it "must wrap long signatures to 120 chars by default" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", <<~RBI)
module Foo
extend T::Sig
sig { params(a: T.untyped, b: T.untyped, c: T.untyped, d: T.untyped, e: T.untyped, f: T.untyped, g: T.untyped).void }
def bar(a, b, c, d, e, f, g); end
sig { params(a: T.untyped, b: T.untyped, c: T.untyped, d: T.untyped, e: T.untyped, f: T.untyped, g: T.untyped, h: T.untyped).void }
def foo(a, b, c, d, e, f, g, h); end
end
RBI
end
@project.require_mock_gem(foo)
@project.bundle_install
result = @project.tapioca("gem foo")
assert_project_file_equal("sorbet/rbi/gems/foo@0.0.1.rbi", <<~RBI)
# typed: true
# DO NOT EDIT MANUALLY
# This is an autogenerated file for types exported from the `foo` gem.
# Please instead update this file by running `bin/tapioca gem foo`.
module Foo
sig { params(a: T.untyped, b: T.untyped, c: T.untyped, d: T.untyped, e: T.untyped, f: T.untyped, g: T.untyped).void }
def bar(a, b, c, d, e, f, g); end
sig do
params(
a: T.untyped,
b: T.untyped,
c: T.untyped,
d: T.untyped,
e: T.untyped,
f: T.untyped,
g: T.untyped,
h: T.untyped
).void
end
def foo(a, b, c, d, e, f, g, h); end
end
RBI
assert_empty_stderr(result)
assert_success_status(result)
end
it "must wrap long signatures to specified chars" do
foo = mock_gem("foo", "0.0.1") do
write("lib/foo.rb", <<~RBI)
module Foo
extend T::Sig
sig { params(a: T.untyped, b: T.untyped, c: T.untyped, d: T.untyped, e: T.untyped, f: T.untyped, g: T.untyped).void }
def bar(a, b, c, d, e, f, g); end
sig { params(a: T.untyped, b: T.untyped, c: T.untyped, d: T.untyped, e: T.untyped, f: T.untyped, g: T.untyped, h: T.untyped).void }
def foo(a, b, c, d, e, f, g, h); end
end
RBI
end
@project.require_mock_gem(foo)