Module: T::Private::Methods::CallValidation

Defined in:
lib/types/private/methods/call_validation.rb,
lib/types/private/methods/call_validation_2_6.rb,
lib/types/private/methods/call_validation_2_7.rb

Overview

DO NOT EDIT. This file is autogenerated. To regenerate, run:

bazel test //gems/sorbet-runtime:update_call_validation

Constant Summary collapse

CallValidation = 
T::Private::Methods::CallValidation
Modes = 
T::Private::Methods::Modes

Class Method Summary collapse

Class Method Details

.create_validator_method(mod, original_method, method_sig, original_visibility) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation.rb', line 60

def self.create_validator_method(mod, original_method, method_sig, original_visibility)
  has_fixed_arity = method_sig.kwarg_types.empty? && !method_sig.has_rest && !method_sig.has_keyrest &&
    original_method.parameters.all? {|(kind, _name)| kind == :req || kind == :block}
  can_skip_block_type = method_sig.block_type.nil? || method_sig.block_type.valid?(nil)
  ok_for_fast_path = has_fixed_arity && can_skip_block_type && !method_sig.bind && method_sig.arg_types.length < 5 && is_allowed_to_have_fast_path

  all_args_are_simple = ok_for_fast_path && method_sig.arg_types.all? {|_name, type| type.is_a?(T::Types::Simple)}
  simple_method = all_args_are_simple && method_sig.return_type.is_a?(T::Types::Simple)
  simple_procedure = all_args_are_simple && method_sig.return_type.is_a?(T::Private::Types::Void)

  T::Configuration.without_ruby_warnings do
    T::Private::DeclState.current.without_on_method_added do
      if simple_method
        create_validator_method_fast(mod, original_method, method_sig, original_visibility)
      elsif simple_procedure
        create_validator_procedure_fast(mod, original_method, method_sig, original_visibility)
      elsif ok_for_fast_path && method_sig.return_type.is_a?(T::Private::Types::Void)
        create_validator_procedure_medium(mod, original_method, method_sig, original_visibility)
      elsif ok_for_fast_path
        create_validator_method_medium(mod, original_method, method_sig, original_visibility)
      elsif can_skip_block_type
        # The Ruby VM already validates that any block passed to a method
        # must be either `nil` or a `Proc` object, so there's no need to also
        # have sorbet-runtime check that.
        create_validator_slow_skip_block_type(mod, original_method, method_sig, original_visibility)
      else
        create_validator_slow(mod, original_method, method_sig, original_visibility)
      end
    end
    mod.send(original_visibility, method_sig.method_name)
  end
end

.create_validator_method_fast(mod, original_method, method_sig, original_visibility) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 9

def self.create_validator_method_fast(mod, original_method, method_sig, original_visibility)
  if method_sig.return_type.is_a?(T::Private::Types::Void)
    raise 'Should have used create_validator_procedure_fast'
  end
  # trampoline to reduce stack frame size
  arg_types = method_sig.arg_types
  case arg_types.length
  when 0
    create_validator_method_fast0(mod, original_method, method_sig, original_visibility, method_sig.return_type.raw_type)
  when 1
    create_validator_method_fast1(mod, original_method, method_sig, original_visibility, method_sig.return_type.raw_type,
                                  arg_types[0][1].raw_type)
  when 2
    create_validator_method_fast2(mod, original_method, method_sig, original_visibility, method_sig.return_type.raw_type,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type)
  when 3
    create_validator_method_fast3(mod, original_method, method_sig, original_visibility, method_sig.return_type.raw_type,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type,
                                  arg_types[2][1].raw_type)
  when 4
    create_validator_method_fast4(mod, original_method, method_sig, original_visibility, method_sig.return_type.raw_type,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type,
                                  arg_types[2][1].raw_type,
                                  arg_types[3][1].raw_type)
  else
    raise 'should not happen'
  end
end

.create_validator_method_fast0(mod, original_method, method_sig, original_visibility, return_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 41

def self.create_validator_method_fast0(mod, original_method, method_sig, original_visibility, return_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |&blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(&blk)
    unless return_value.is_a?(return_type)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_fast1(mod, original_method, method_sig, original_visibility, return_type, arg0_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 78

def self.create_validator_method_fast1(mod, original_method, method_sig, original_visibility, return_type, arg0_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, &blk)
    unless return_value.is_a?(return_type)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_fast2(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 127

def self.create_validator_method_fast2(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, &blk)
    unless return_value.is_a?(return_type)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_fast3(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 188

def self.create_validator_method_fast3(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2.is_a?(arg2_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, arg2, &blk)
    unless return_value.is_a?(return_type)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_fast4(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type, arg3_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 261

def self.create_validator_method_fast4(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type, arg3_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, arg3, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2.is_a?(arg2_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    unless arg3.is_a?(arg3_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[3][1].error_message_for_obj(arg3),
        'Parameter',
        method_sig.arg_types[3][0],
        arg3_type,
        arg3,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, arg2, arg3, &blk)
    unless return_value.is_a?(return_type)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_medium(mod, original_method, method_sig, original_visibility) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 610

def self.create_validator_method_medium(mod, original_method, method_sig, original_visibility)
  if method_sig.return_type.is_a?(T::Private::Types::Void)
    raise 'Should have used create_validator_procedure_medium'
  end
  # trampoline to reduce stack frame size
  arg_types = method_sig.arg_types
  case arg_types.length
  when 0
    create_validator_method_medium0(mod, original_method, method_sig, original_visibility, method_sig.return_type)
  when 1
    create_validator_method_medium1(mod, original_method, method_sig, original_visibility, method_sig.return_type,
                                  arg_types[0][1])
  when 2
    create_validator_method_medium2(mod, original_method, method_sig, original_visibility, method_sig.return_type,
                                  arg_types[0][1],
                                  arg_types[1][1])
  when 3
    create_validator_method_medium3(mod, original_method, method_sig, original_visibility, method_sig.return_type,
                                  arg_types[0][1],
                                  arg_types[1][1],
                                  arg_types[2][1])
  when 4
    create_validator_method_medium4(mod, original_method, method_sig, original_visibility, method_sig.return_type,
                                  arg_types[0][1],
                                  arg_types[1][1],
                                  arg_types[2][1],
                                  arg_types[3][1])
  else
    raise 'should not happen'
  end
end

.create_validator_method_medium0(mod, original_method, method_sig, original_visibility, return_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 642

def self.create_validator_method_medium0(mod, original_method, method_sig, original_visibility, return_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |&blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(&blk)
    unless return_type.valid?(return_value)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_medium1(mod, original_method, method_sig, original_visibility, return_type, arg0_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 679

def self.create_validator_method_medium1(mod, original_method, method_sig, original_visibility, return_type, arg0_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, &blk)
    unless return_type.valid?(return_value)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_medium2(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 728

def self.create_validator_method_medium2(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, &blk)
    unless return_type.valid?(return_value)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_medium3(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 789

def self.create_validator_method_medium3(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2_type.valid?(arg2)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, arg2, &blk)
    unless return_type.valid?(return_value)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_method_medium4(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type, arg3_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 862

def self.create_validator_method_medium4(mod, original_method, method_sig, original_visibility, return_type, arg0_type, arg1_type, arg2_type, arg3_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, arg3, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2_type.valid?(arg2)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    unless arg3_type.valid?(arg3)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[3][1].error_message_for_obj(arg3),
        'Parameter',
        method_sig.arg_types[3][0],
        arg3_type,
        arg3,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    return_value = original_method.bind(self).call(arg0, arg1, arg2, arg3, &blk)
    unless return_type.valid?(return_value)
      message = method_sig.return_type.error_message_for_obj(return_value)
      if message
        CallValidation.report_error(
          method_sig,
          message,
          'Return value',
          nil,
          method_sig.return_type,
          return_value,
          caller_offset: -1
        )
      end
    end
    return_value
  end
end

.create_validator_procedure_fast(mod, original_method, method_sig, original_visibility) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 346

def self.create_validator_procedure_fast(mod, original_method, method_sig, original_visibility)
  # trampoline to reduce stack frame size
  arg_types = method_sig.arg_types
  case arg_types.length
  when 0
    create_validator_procedure_fast0(mod, original_method, method_sig, original_visibility)
  when 1
    create_validator_procedure_fast1(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1].raw_type)
  when 2
    create_validator_procedure_fast2(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type)
  when 3
    create_validator_procedure_fast3(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type,
                                  arg_types[2][1].raw_type)
  when 4
    create_validator_procedure_fast4(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1].raw_type,
                                  arg_types[1][1].raw_type,
                                  arg_types[2][1].raw_type,
                                  arg_types[3][1].raw_type)
  else
    raise 'should not happen'
  end
end

.create_validator_procedure_fast0(mod, original_method, method_sig, original_visibility) ⇒ Object 



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 375

def self.create_validator_procedure_fast0(mod, original_method, method_sig, original_visibility)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |&blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(&blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_fast1(mod, original_method, method_sig, original_visibility, arg0_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 398

def self.create_validator_procedure_fast1(mod, original_method, method_sig, original_visibility, arg0_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_fast2(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 433

def self.create_validator_procedure_fast2(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_fast3(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 480

def self.create_validator_procedure_fast3(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2.is_a?(arg2_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, arg2, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_fast4(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type, arg3_type) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 539

def self.create_validator_procedure_fast4(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type, arg3_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, arg3, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0.is_a?(arg0_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1.is_a?(arg1_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2.is_a?(arg2_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    unless arg3.is_a?(arg3_type)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[3][1].error_message_for_obj(arg3),
        'Parameter',
        method_sig.arg_types[3][0],
        arg3_type,
        arg3,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, arg2, arg3, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_medium(mod, original_method, method_sig, original_visibility) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 947

def self.create_validator_procedure_medium(mod, original_method, method_sig, original_visibility)
  # trampoline to reduce stack frame size
  arg_types = method_sig.arg_types
  case arg_types.length
  when 0
    create_validator_procedure_medium0(mod, original_method, method_sig, original_visibility)
  when 1
    create_validator_procedure_medium1(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1])
  when 2
    create_validator_procedure_medium2(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1],
                                  arg_types[1][1])
  when 3
    create_validator_procedure_medium3(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1],
                                  arg_types[1][1],
                                  arg_types[2][1])
  when 4
    create_validator_procedure_medium4(mod, original_method, method_sig, original_visibility,
                                  arg_types[0][1],
                                  arg_types[1][1],
                                  arg_types[2][1],
                                  arg_types[3][1])
  else
    raise 'should not happen'
  end
end

.create_validator_procedure_medium0(mod, original_method, method_sig, original_visibility) ⇒ Object 



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 976

def self.create_validator_procedure_medium0(mod, original_method, method_sig, original_visibility)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |&blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(&blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_medium1(mod, original_method, method_sig, original_visibility, arg0_type) ⇒ Object 



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 999

def self.create_validator_procedure_medium1(mod, original_method, method_sig, original_visibility, arg0_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_medium2(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type) ⇒ Object 



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 1034

def self.create_validator_procedure_medium2(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_medium3(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type) ⇒ Object 



1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 1081

def self.create_validator_procedure_medium3(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2_type.valid?(arg2)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, arg2, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_procedure_medium4(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type, arg3_type) ⇒ Object 



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/types/private/methods/call_validation_2_6.rb', line 1140

def self.create_validator_procedure_medium4(mod, original_method, method_sig, original_visibility, arg0_type, arg1_type, arg2_type, arg3_type)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |arg0, arg1, arg2, arg3, &blk|
    # This method is a manually sped-up version of more general code in `validate_call`
    unless arg0_type.valid?(arg0)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[0][1].error_message_for_obj(arg0),
        'Parameter',
        method_sig.arg_types[0][0],
        arg0_type,
        arg0,
        caller_offset: -1
      )
    end

    unless arg1_type.valid?(arg1)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[1][1].error_message_for_obj(arg1),
        'Parameter',
        method_sig.arg_types[1][0],
        arg1_type,
        arg1,
        caller_offset: -1
      )
    end

    unless arg2_type.valid?(arg2)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[2][1].error_message_for_obj(arg2),
        'Parameter',
        method_sig.arg_types[2][0],
        arg2_type,
        arg2,
        caller_offset: -1
      )
    end

    unless arg3_type.valid?(arg3)
      CallValidation.report_error(
        method_sig,
        method_sig.arg_types[3][1].error_message_for_obj(arg3),
        'Parameter',
        method_sig.arg_types[3][0],
        arg3_type,
        arg3,
        caller_offset: -1
      )
    end

    # The following line breaks are intentional to show nice pry message










    # PRY note:
    # this code is sig validation code.
    # Please issue `finish` to step out of it

    original_method.bind(self).call(arg0, arg1, arg2, arg3, &blk)
    T::Private::Types::Void::VOID
  end
end

.create_validator_slow(mod, original_method, method_sig, original_visibility) ⇒ Object 



175
176
177
178
179
 
# File 'lib/types/private/methods/call_validation.rb', line 175

def self.create_validator_slow(mod, original_method, method_sig, original_visibility)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |*args, &blk|
    CallValidation.validate_call(self, original_method, method_sig, args, blk)
  end
end

.create_validator_slow_skip_block_type(mod, original_method, method_sig, original_visibility) ⇒ Object 



93
94
95
96
97
 
# File 'lib/types/private/methods/call_validation.rb', line 93

def self.create_validator_slow_skip_block_type(mod, original_method, method_sig, original_visibility)
  T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility) do |*args, &blk|
    CallValidation.validate_call_skip_block_type(self, original_method, method_sig, args, blk)
  end
end

.disable_fast_path ⇒ Object 



56
57
58
 
# File 'lib/types/private/methods/call_validation.rb', line 56

def self.disable_fast_path
  @is_allowed_to_have_fast_path = false
end

.is_allowed_to_have_fast_path ⇒ Object 



52
53
54
 
# File 'lib/types/private/methods/call_validation.rb', line 52

def self.is_allowed_to_have_fast_path
  @is_allowed_to_have_fast_path
end

.report_error(method_sig, error_message, kind, name, type, value, caller_offset: 0) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/types/private/methods/call_validation.rb', line 278

def self.report_error(method_sig, error_message, kind, name, type, value, caller_offset: 0)
  caller_loc = T.must(caller_locations(3 + caller_offset, 1))[0]
  definition_file, definition_line = method_sig.method.source_location

  pretty_message = "#{kind}#{name ? " '#{name}'" : ''}: #{error_message}\n" \
    "Caller: #{caller_loc.path}:#{caller_loc.lineno}\n" \
    "Definition: #{definition_file}:#{definition_line}"

  T::Configuration.call_validation_error_handler(
    method_sig,
    message: error_message,
    pretty_message: pretty_message,
    kind: kind,
    name: name,
    type: type,
    value: value,
    location: caller_loc
  )
end

.validate_call(instance, original_method, method_sig, args, blk) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation.rb', line 181

def self.validate_call(instance, original_method, method_sig, args, blk)
  # This method is called for every `sig`. It's critical to keep it fast and
  # reduce number of allocations that happen here.

  if method_sig.bind
    message = method_sig.bind.error_message_for_obj(instance)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Bind',
        nil,
        method_sig.bind,
        instance
      )
    end
  end

  # NOTE: We don't bother validating for missing or extra kwargs;
  # the method call itself will take care of that.
  method_sig.each_args_value_type(args) do |name, arg, type|
    message = type.error_message_for_obj(arg)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Parameter',
        name,
        type,
        arg,
        caller_offset: 2
      )
    end
  end

  # The Ruby VM already checks that `&blk` is either a `Proc` type or `nil`:
  # https://github.com/ruby/ruby/blob/v2_7_6/vm_args.c#L1150-L1154
  # And `T.proc` types don't (can't) do any runtime arg checking, so we can
  # save work by simply checking that `blk` is non-nil (if the method allows
  # `nil` for the block, it would not have used this validate_call path).
  unless blk
    # Have to use `&.` here, because it's technically a public API that
    # people can _always_ call `validate_call` to validate any signature
    # (i.e., the faster validators are merely optimizations).
    # In practice, this only affects the first call to the method (before the
    # optimized validators have a chance to replace the initial, slow
    # wrapper).
    message = method_sig.block_type&.error_message_for_obj(blk)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Block parameter',
        method_sig.block_name,
        method_sig.block_type,
        blk
      )
    end
  end

  # The following line breaks are intentional to show nice pry message










  # PRY note:
  # this code is sig validation code.
  # Please issue `finish` to step out of it

  return_value = T::Configuration::AT_LEAST_RUBY_2_7 ? original_method.bind_call(instance, *args, &blk) : original_method.bind(instance).call(*args, &blk)

  # The only type that is allowed to change the return value is `.void`.
  # It ignores what you returned and changes it to be a private singleton.
  if method_sig.return_type.is_a?(T::Private::Types::Void)
    T::Private::Types::Void::VOID
  else
    message = method_sig.return_type.error_message_for_obj(return_value)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Return value',
        nil,
        method_sig.return_type,
        return_value,
      )
    end
    return_value
  end
end

.validate_call_skip_block_type(instance, original_method, method_sig, args, blk) ⇒ Object 



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
 
# File 'lib/types/private/methods/call_validation.rb', line 99

def self.validate_call_skip_block_type(instance, original_method, method_sig, args, blk)
  # This method is called for every `sig`. It's critical to keep it fast and
  # reduce number of allocations that happen here.

  if method_sig.bind
    message = method_sig.bind.error_message_for_obj(instance)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Bind',
        nil,
        method_sig.bind,
        instance
      )
    end
  end

  # NOTE: We don't bother validating for missing or extra kwargs;
  # the method call itself will take care of that.
  method_sig.each_args_value_type(args) do |name, arg, type|
    message = type.error_message_for_obj(arg)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Parameter',
        name,
        type,
        arg,
        caller_offset: 2
      )
    end
  end

  # The original method definition allows passing `nil` for the `&blk`
  # argument, so we do not have to do any method_sig.block_type type checks
  # of our own.

  # The following line breaks are intentional to show nice pry message










  # PRY note:
  # this code is sig validation code.
  # Please issue `finish` to step out of it

  return_value = T::Configuration::AT_LEAST_RUBY_2_7 ? original_method.bind_call(instance, *args, &blk) : original_method.bind(instance).call(*args, &blk)

  # The only type that is allowed to change the return value is `.void`.
  # It ignores what you returned and changes it to be a private singleton.
  if method_sig.return_type.is_a?(T::Private::Types::Void)
    T::Private::Types::Void::VOID
  else
    message = method_sig.return_type.error_message_for_obj(return_value)
    if message
      CallValidation.report_error(
        method_sig,
        message,
        'Return value',
        nil,
        method_sig.return_type,
        return_value,
      )
    end
    return_value
  end
end

.wrap_method_if_needed(mod, method_sig, original_method) ⇒ UnboundMethod

Wraps a method with a layer of validation for the given type signature. This wrapper is meant to be fast, and is applied by a previous wrapper, which was placed by ‘_on_method_added`.

Parameters:

Returns:

  • (UnboundMethod) —

    the new wrapper method (or the original one if we didn’t wrap it)



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
 
# File 'lib/types/private/methods/call_validation.rb', line 14

def self.wrap_method_if_needed(mod, method_sig, original_method)
  original_visibility = visibility_method_name(mod, method_sig.method_name)
  if method_sig.mode == T::Private::Methods::Modes.abstract
    T::Private::ClassUtils.replace_method(mod, method_sig.method_name, true) do |*args, &blk|
      # TODO: write a cop to ensure that abstract methods have an empty body
      #
      # We allow abstract methods to be implemented by things further down the ancestor chain.
      # So, if a super method exists, call it.
      if defined?(super)
        super(*args, &blk)
      else
        raise NotImplementedError.new(
          "The method `#{method_sig.method_name}` on #{mod} is declared as `abstract`. It does not have an implementation."
        )
      end
    end
  # Do nothing in this case; this method was not wrapped in _on_method_added.
  elsif method_sig.defined_raw
  # Note, this logic is duplicated (intentionally, for micro-perf) at `Methods._on_method_added`,
  # make sure to keep changes in sync.
  # This is a trapdoor point for each method:
  # if a given method is wrapped, it stays wrapped; and if not, it's never wrapped.
  # (Therefore, we need the `@wrapped_tests_with_validation` check in `T::RuntimeLevels`.)
  elsif method_sig.check_level == :always || (method_sig.check_level == :tests && T::Private::RuntimeLevels.check_tests?)
    create_validator_method(mod, original_method, method_sig, original_visibility)
  else
    T::Configuration.without_ruby_warnings do
      # get all the shims out of the way and put back the original method
      T::Private::DeclState.current.without_on_method_added do
        T::Private::ClassUtils.def_with_visibility(mod, method_sig.method_name, original_visibility, original_method)
      end
    end
  end
  # Return the newly created method (or the original one if we didn't replace it)
  mod.instance_method(method_sig.method_name)
end