Module: T::Private::Methods

Defined in:
lib/types/private/methods/_methods.rb,
lib/types/private/methods/decl_builder.rb

Overview

typed: true

Defined Under Namespace

Modules: ARG_NOT_PROVIDED, CallValidation, MethodHooks, Modes, PROC_TYPE, SignatureValidation, SingletonMethodHooks Classes: DeclBuilder, Declaration, DeclarationBlock, Signature

Constant Summary collapse

TOP_SELF =

This has to be here, and can't be nested inside T::Private::Methods, because the value of self depends on lexical (nesting) scope, and we specifically need a reference to the file-level self, i.e. main:Object

self

Class Method Summary collapse

Class Method Details

._check_final_ancestors(target, source_method_names, source) ⇒ Object

when target includes a module with instance methods source_method_names, ensure there is zero intersection between the final instance methods of target and source_method_names. so, for every m in source_method_names, check if there is already a method defined on one of target_ancestors with the same name that is final.

we assume that source_method_names has already been filtered to only include method names that were declared final at one point.

Returns a boolean indicating whether it's okay to define any of source_method_names in target (e.g. true if no final method violations)



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

def self._check_final_ancestors(target, source_method_names, source)
  source_ancestors = nil
  if T::Private::IS_TYPECHECKING
    # Need to avoid a pinning error, but don't want to use runtime types in _methods.rb
    source_ancestors = T.let(nil, T.nilable(T::Array[T::Module[T.anything]]))
    found_error = T.let(false, T::Boolean)
  end
  found_error = false
  # use reverse_each to check farther-up ancestors first, for better error messages.
  target.ancestors.reverse_each do |ancestor|
    final_methods = @modules_with_final.fetch(ancestor, nil)
    # In this case, either ancestor didn't have any final methods anywhere in its
    # ancestor chain, or ancestor did have final methods somewhere in its ancestor
    # chain, but no final methods defined in ancestor itself.  Either way, there
    # are no final methods to check here, so we can move on to the next ancestor.
    next unless final_methods
    source_method_names.each do |method_name|
      next unless final_methods.include?(method_name)

      # If we get here, we are defining a method that some ancestor declared as
      # final.  however, we permit a final method to be defined multiple
      # times if it is the same final method being defined each time.
      if source
        if !source_ancestors
          source_ancestors = source.ancestors
          # filter out things without actual final methods just to make sure that
          # the below checks (which should be uncommon) go as quickly as possible.
          source_ancestors.select! do |a|
            @modules_with_final.fetch(a, nil)
          end
        end
        # final-ness means that there should be no more than one index for which
        # the below block returns true.
        defining_ancestor_idx = source_ancestors.index do |a|
          @modules_with_final.fetch(a).include?(method_name)
        end
        next if defining_ancestor_idx && source_ancestors[defining_ancestor_idx] == ancestor
      end

      found_error = true

      final_sig = T::Private::Methods.signature_for_method(ancestor.instance_method(method_name))
      definition_file, definition_line = final_sig&.method&.source_location
      is_redefined = target == ancestor
      caller_loc = T::Private::CallerUtils.find_caller { |loc| !loc.path.to_s.start_with?(SORBET_RUNTIME_LIB_PATH) }
      extra_info = "\n"
      if caller_loc
        extra_info = (is_redefined ? "Redefined" : "Overridden") + " here: #{caller_loc.path}:#{caller_loc.lineno}\n"
      end

      error_message = "The method `#{method_name}` on #{ancestor} was declared as final and cannot be " +
                      (is_redefined ? "redefined" : "overridden in #{target}")
      pretty_message = "#{error_message}\n" \
                       "Made final here: #{definition_file}:#{definition_line}\n" \
                       "#{extra_info}"

      begin
        # raise + rescue to populate the backtrace
        raise pretty_message
      rescue => e
        T::Configuration.sig_validation_error_handler(e, {})
      end
    end
  end
  !found_error
end

._hook_impl(target, source) ⇒ Object

the module target is adding the methods from the module source to itself. we need to check that for all instance methods M on source, M is not defined on any of target's ancestors.



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/types/private/methods/_methods.rb', line 692

def self._hook_impl(target, source)
  # we do not need to call add_was_ever_final here, because we have already marked
  # any such methods when source was originally defined.
  if !@modules_with_final.include?(target)
    if !@modules_with_final.include?(source)
      return
    end
    # Side-effectfully initialize the value if it's not already there
    @modules_with_final[target]
    install_hooks(target)
    return
  end

  methods = source.instance_methods
  methods.select! do |method_name|
    @was_ever_final_names.include?(method_name)
  end
  if methods.empty?
    return
  end

  _check_final_ancestors(target, methods, source)
  nil
end

._on_method_added(hook_mod, mod, method_name) ⇒ Object

Only public because it needs to get called below inside the replace_method blocks below.



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

def self._on_method_added(hook_mod, mod, method_name)
  # The thread-local DeclState object is stable for the duration of this call
  # (nothing reassigns `DeclState.current=`), so fetch it once.
  decl_state = T::Private::DeclState.current
  if decl_state.skip_on_method_added
    return
  end

  current_declaration = decl_state.consume!

  if T::Private::Final.final_module?(mod) && (current_declaration.nil? || !current_declaration.final)
    raise "#{mod} was declared as final but its method `#{method_name}` was not declared as final"
  end
  # Don't compute mod.ancestors if we don't need to bother checking final-ness.
  if @was_ever_final_names.include?(method_name) && @modules_with_final.include?(mod) &&
     !_check_final_ancestors(mod, [method_name], nil)
    # We want to pretend like the method did not have a sig, so return.
    # (This code is not dead, because some `sig_validation_error_handler`'s do not raise.)
    return
  end

  if current_declaration.nil?
    key = method_owner_and_name_to_key(mod, method_name)
    # Drop any existing sig, because the `sig_block` closes over the
    # `original_method` at the time that the sig wrapper was registered, and
    # forcing the sig would thus redefine the the redefined method back to
    # the original method.
    old_sig = @sig_wrappers.delete(key)

    # Ruby only reports method redefinitions if `$VERBOSE` is truthy. Let's
    # do the same for sigs.
    if old_sig && $VERBOSE
      # We can probably get away with not printing any location information
      # (like the Ruby VM would for method redefinition warnings) because the
      # Ruby VM itself will have printed the location information in its
      # method redefinition warning (and it does that faster, using functions
      # that constult the CFP directly).
      Warning.warn(
        "sorbet-runtime: warning: Dropping unevaluated signature for #{mod}##{method_name} because it was redefined\n"
      )
    end

    return
  end

  current_declaration.method_name = method_name

  if method_name == :method_added || method_name == :singleton_method_added
    raise(
      "Putting a `sig` on `#{method_name}` is not supported" \
      " (sorbet-runtime uses this method internally to perform `sig` validation logic)"
    )
  end

  # We allow `sig` in the current module's context (normal case) and
  if hook_mod != current_declaration.mod &&
     # inside `class << self`, and
     hook_mod.singleton_class != current_declaration.mod &&
     # on `self` at the top level of a file
     current_declaration.mod != TOP_SELF
    raise "A method (#{method_name}) is being added on a different class/module (#{hook_mod}) than the " \
          "last call to `sig` (#{current_declaration.mod}). Make sure each call " \
          "to `sig` is immediately followed by a method definition on the same " \
          "class/module."
  end
  # Overwrite the DeclarationBlock mod with `mod`, which is the Module that owns the method.
  current_declaration.mod = mod

  original_method = mod.instance_method(method_name)
  sig_block = lambda do
    T::Private::Methods.run_sig(method_name, original_method, current_declaration, unwrap: true)
  end

  # Always replace the original method with this wrapper,
  # which is called only on the *first* invocation.
  # This wrapper is very slow, so it will subsequently re-wrap with a much faster wrapper
  # (or unwrap back to the original method).
  key = method_owner_and_name_to_key(mod, method_name)
  built_sig = nil
  if T::Private::IS_TYPECHECKING
    built_sig = T.let(nil, T.nilable(Signature))
  end
  T::Private::ClassUtils.replace_method(original_method, mod, method_name) do |*args, &blk|
    callee = Kernel.__callee__ || raise("Unknown __callee__ for method without a signature")
    method_sig = built_sig
    if !method_sig
      # Check if this wrapper's sig_block is still the active one for this key
      #
      # If not, the method was redefined and this wrapper is being called via
      # a captured method object from reflection (e.g., `instance_method` or
      # `method` from before the redefinition).
      #
      # We can only use maybe_run_sig_block_for_key if there was no
      # redefinition, because it would otherwise call unwrap_method,
      # overwriting the redefinition.
      method_sig =
        if T::Private::Methods._sig_block_is_current?(key, sig_block)
          T::Private::Methods.maybe_run_sig_block_for_key(key)
        elsif !(method_sig = current_declaration.sig_state).is_a?(Signature)
          # This is essentially a permanent slow path: since the method was
          # redefined before the sig block had a chance to run, we can't unwrap
          # the method, as that would overwrite the redefinition, effectively
          # putting the method back to its original definition. (Note that
          # `run_sig` is what we call in the `sig_block`, but this one just
          # doesn't unwrap.)
          T::Private::Methods.run_sig(method_name, original_method, current_declaration, unwrap: false)
        else
          # The declaration was already consumed (e.g., module_function copies
          # the first-call wrapper to the singleton class, sharing the same
          # DeclarationBlock; if the instance method's sig is evaluated first,
          # sig_state is a Signature when the singleton copy runs).
          method_sig
        end
      if !method_sig
        method_sig = T::Private::Methods.signature_for_method(original_method)
        if !method_sig
          raise "`sig` not present for method `#{callee}` on #{self.inspect} but you're trying to run it anyways. " \
            "This should only be executed if you used `alias_method` to grab a handle to a method after `sig`ing it, but that clearly isn't what you are doing. " \
            "Maybe look to see if an exception was thrown in your `sig` lambda or somehow else your `sig` wasn't actually applied to the method."
        end
      end
      built_sig = method_sig
    end

    # If this wrapper is being called via an alias, unwrap the alias so
    # subsequent calls bypass the wrapper entirely.
    if callee != method_name
      T::Private::Methods._unwrap_alias(method_sig, self, original_method, callee)
    end

    # Should be the same logic as CallValidation.wrap_method_if_needed but we
    # don't want that extra layer of indirection in the callstack
    if method_sig.mode == T::Private::Methods::Modes.abstract
      # We're in an interface method, keep going up the chain
      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
    # Note, this logic is duplicated (intentionally, for micro-perf) at `CallValidation.wrap_method_if_needed`,
    # make sure to keep changes in sync.
    elsif method_sig.check_level == :always || (method_sig.check_level == :tests && T::Private::RuntimeLevels.check_tests?)
      CallValidation.validate_call(self, original_method, method_sig, args, blk)
    else
      original_method.bind_call(self, *args, &blk)
    end
  end

  @sig_wrappers[key] = sig_block
  if current_declaration.final
    add_module_with_final_method(mod, method_name)
  end
end

._sig_block_is_current?(key, sig_block) ⇒ Boolean

Only public because it needs to get called inside the first-call wrapper closure.

Returns:



604
605
606
 
# File 'lib/types/private/methods/_methods.rb', line 604

def self._sig_block_is_current?(key, sig_block)
  @sig_wrappers[key].equal?(sig_block)
end

._unwrap_alias(method_sig, receiver, original_method, callee) ⇒ Object

Only public so that it can be accessed in the closure for _on_method_added



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

def self._unwrap_alias(method_sig, receiver, original_method, callee)
  if receiver.class <= original_method.owner
    receiving_class = receiver.class
  elsif receiver.singleton_class <= original_method.owner
    receiving_class = receiver.singleton_class
  elsif receiver.is_a?(Module) && receiver <= original_method.owner
    receiving_class = receiver
  else
    raise "#{receiver} is not related to #{original_method} - how did we get here?"
  end

  # Check for a case where `alias` or `alias_method` was called for a
  # method which had already had a `sig` applied. In that case, we want
  # to avoid hitting this slow path again, by moving to a faster validator
  # just like we did or will for the original method.
  #
  # If this isn't an `alias` or `alias_method` case, we're probably in the
  # middle of some metaprogramming using a Method object, e.g. a pattern like
  # `arr.map(&method(:foo))`. There's nothing really we can do to optimize
  # that here.
  receiving_method = receiving_class.instance_method(callee)
  if receiving_method != original_method && receiving_method.original_name == original_method.name
    aliasing_mod = receiving_method.owner
    method_sig = method_sig.as_alias(callee)
    unwrap_method(aliasing_mod, method_sig, original_method)
  end

  method_sig
end

.add_module_with_final_method(mod, method_name) ⇒ Object 



290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/types/private/methods/_methods.rb', line 290

def self.add_module_with_final_method(mod, method_name)
  @was_ever_final_names[method_name] = true

  # Side-effectfully initializes the value if it's not already there
  methods = @modules_with_final[mod]
  if methods.nil?
    methods = {}
    @modules_with_final[mod] = methods
  end
  methods[method_name] = true
  nil
end

.all_checked_tests_sigs ⇒ Object 



686
687
688
 
# File 'lib/types/private/methods/_methods.rb', line 686

def self.all_checked_tests_sigs
  @signatures_by_method.values.select { |sig| sig.check_level == :tests }
end

.build_sig(method_name, original_method, current_declaration) ⇒ Object 



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

def self.build_sig(method_name, original_method, current_declaration)
  begin
    signature = Signature.new(
      method: original_method,
      method_name: method_name,
      raw_arg_types: current_declaration.params,
      raw_return_type: current_declaration.returns,
      bind: current_declaration.bind,
      mode: current_declaration.mode,
      check_level: current_declaration.checked,
      on_failure: current_declaration.on_failure,
      override_allow_incompatible: current_declaration.override_allow_incompatible,
      defined_raw: current_declaration.raw,
    )

    SignatureValidation.validate(signature)
    signature
  rescue => e
    super_method = original_method.super_method
    super_signature = signature_for_method(super_method) if super_method

    T::Configuration.sig_validation_error_handler(
      e,
      method: original_method,
      declaration: current_declaration,
      signature: signature,
      super_signature: super_signature
    )

    Signature.new_untyped(method: original_method)
  end
end

.declare_abstract(mod, method_name) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/types/private/methods/_methods.rb', line 100

def self.declare_abstract(mod, method_name)
  previous_declaration = ensure_valid_declare_dsl!(mod, method_name, :abstract)
  return unless previous_declaration

  if previous_declaration.abstract
    raise DeclBuilder::BuilderError.new("Cannot call `abstract` twice for the method `#{method_name}`")
  end

  previous_declaration.abstract = true

  # # TODO(jez) In the future, we will want some logic like this, but ONLY if
  # # the method did not have a sig. The first-call sig wrapper is normally in
  # # charge of running the sig block (even for abstract methods) If we know
  # # for sure that we're not going to have a sig, but we want the runtime
  # # `super` logic (possibly because there is an RBS method annotation), we
  # # are safe to eagerly call `create_abstract_wrapper` to overwrite the
  # # user's method.
  # #
  # # (Omitting this until we support DSL methods without runtime `sig`'s)
  # original_visibility = T::Private::ClassUtils.visibility_method_name(mod, method_name)
  # T::Private::Methods::CallValidation.create_abstract_wrapper(mod, method_name, original_visibility)

  nil
end

.declare_final(mod, method_name) ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/types/private/methods/_methods.rb', line 145

def self.declare_final(mod, method_name)
  previous_declaration = ensure_valid_declare_dsl!(mod, method_name, :final)
  return unless previous_declaration

  if previous_declaration.final
    raise DeclBuilder::BuilderError.new("Cannot declare `#{method_name}` final twice (from `sig(:final)` nor `final def`)")
  end

  previous_declaration.final = true

  # Register final bookkeeping that _on_method_added would have done if it
  # had seen final=true at that time. Use previous_declaration.mod (the actual
  # method owner, which is the singleton_class for `def self.foo`).
  add_module_with_final_method(previous_declaration.mod, method_name)

  nil
end

.declare_overridable(mod, method_name) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/types/private/methods/_methods.rb', line 163

def self.declare_overridable(mod, method_name)
  previous_declaration = ensure_valid_declare_dsl!(mod, method_name, :overridable)
  return unless previous_declaration

  if previous_declaration.overridable
    raise DeclBuilder::BuilderError.new("Cannot call `overridable` twice for the method `#{method_name}`")
  end

  previous_declaration.overridable = true

  nil
end

.declare_override(mod, method_name, allow_incompatible:) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/types/private/methods/_methods.rb', line 125

def self.declare_override(mod, method_name, allow_incompatible:)
  previous_declaration = ensure_valid_declare_dsl!(mod, method_name, :override)
  return unless previous_declaration

  if previous_declaration.override
    raise DeclBuilder::BuilderError.new("Cannot call `override` twice for the method `#{method_name}`")
  end

  method = mod.instance_method(method_name)
  super_method = method.super_method
  if super_method.nil?
    source_loc = Kernel.caller_locations(2, 1)&.map { |loc| [loc.path || "<unknown>", loc.lineno] }&.first
    T::Private::Methods::SignatureValidation.validate_non_override_mode(Modes.override, method_name, method, source_loc)
  end

  previous_declaration.override = {allow_incompatible: allow_incompatible}

  nil
end

.declare_sig(mod, loc, arg, &blk) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/types/private/methods/_methods.rb', line 56

def self.declare_sig(mod, loc, arg, &blk)
  if T::Private::DeclState.current.active_declaration
    T::Private::DeclState.current.reset!
    raise "You called sig twice without declaring a method in between"
  end

  if !arg.nil? && arg != :final
    raise "Invalid argument to `sig`: #{arg}"
  end

  method_name = nil # will be filled in once the next method is defined
  abstract = nil
  override = nil
  overridable = nil
  T::Private::DeclState.current.active_declaration = DeclarationBlock.new(mod, method_name, loc, blk, arg == :final, abstract, override, overridable)

  nil
end

.finalize_proc(decl) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/types/private/methods/_methods.rb', line 184

def self.finalize_proc(decl)
  decl.finalized = true

  if decl.mode != Modes.standard
    raise "Procs cannot have override/abstract modifiers"
  end
  if decl.mod != PROC_TYPE
    raise "You are passing a DeclBuilder as a type. Did you accidentally use `self` inside a `sig` block? Perhaps you wanted the `T.self_type` instead: https://sorbet.org/docs/self-type"
  end
  if decl.returns == ARG_NOT_PROVIDED
    raise "Procs must specify a return type"
  end
  if decl.on_failure != ARG_NOT_PROVIDED
    raise "Procs cannot use .on_failure"
  end

  if decl.params == ARG_NOT_PROVIDED
    decl.params = {}
  end

  T::Types::Proc.new(decl.params, decl.returns)
end

.has_sig_block_for_method(method) ⇒ Object 



599
600
601
 
# File 'lib/types/private/methods/_methods.rb', line 599

def self.has_sig_block_for_method(method)
  has_sig_block_for_key(method_to_key(method))
end

.install_hooks(mod) ⇒ Object

Normally, this should be taken care of by simply extend T::Sig.

But there are a few cases where we actually want the hooks to be "viral" for final modules and final methods, such that we actually want to forcibly install the hooks even if they would not have naturally been there via inheritance.

As such, we don't have to handle quite as many edge cases as lib/types/sig.rb does



777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
 
# File 'lib/types/private/methods/_methods.rb', line 777

def self.install_hooks(mod)
  return if @installed_hooks.include?(mod)
  @installed_hooks[mod] = true

  # See https://github.com/sorbet/sorbet/pull/3964 for an explanation of why this
  # check (which theoretically should not be needed) is actually needed.
  if !mod.is_a?(Module)
    return
  end

  if mod.singleton_class?
    mod.include(SingletonMethodHooks)
  else
    mod.extend(MethodHooks)
  end
  mod.extend(SingletonMethodHooks)
end

.maybe_run_sig_block_for_key(key) ⇒ Object

Only public so that it can be accessed in the closure for _on_method_added



617
618
619
 
# File 'lib/types/private/methods/_methods.rb', line 617

def self.maybe_run_sig_block_for_key(key)
  run_sig_block_for_key(key) if has_sig_block_for_key(key)
end

.maybe_run_sig_block_for_method(method) ⇒ Object 



612
613
614
 
# File 'lib/types/private/methods/_methods.rb', line 612

def self.maybe_run_sig_block_for_method(method)
  maybe_run_sig_block_for_key(method_to_key(method))
end

.run_all_sig_blocks(force_type_init: true) ⇒ Object 



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/types/private/methods/_methods.rb', line 667

def self.run_all_sig_blocks(force_type_init: true)
  current_declaration = T::Private::DeclState.current.active_declaration
  if !current_declaration.nil?
    T::Private::DeclState.current.reset!
    raise "Cannot call `run_all_sig_blocks` while there is a pending `sig` block in #{current_declaration.mod} at #{current_declaration.loc}"
  end

  loop do
    first_wrapper = @sig_wrappers.first
    break unless first_wrapper
    key, = first_wrapper
    run_sig_block_for_key(key, force_type_init: force_type_init)
  end

  # Make sure that there are no lingering declaration blocks being kept alive
  # (so we're not retaining any extra references for a possible GC)
  T::Private::DeclState.current.reset!
end

.run_builder(declaration_block) ⇒ Object 



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/types/private/methods/_methods.rb', line 529

def self.run_builder(declaration_block)
  sig_state = declaration_block.sig_state
  return sig_state if sig_state.is_a?(Declaration)
  if !sig_state.is_a?(Proc)
    raise "DeclarationBlock for #{declaration_block.mod} at #{declaration_block.loc} should have already been unwrapped"
  end

  builder = DeclBuilder.new(
    declaration_block.mod,
    declaration_block.abstract,
    declaration_block.override,
    declaration_block.overridable
  )
  decl = builder.instance_exec(&sig_state).finalize!.decl
  # Record that we've already run `blk` once and constructed a `Declaration`
  declaration_block.sig_state = decl
  decl
end

.run_sig(method_name, original_method, declaration_block, unwrap:) ⇒ Object

Executes the sig block, and converts the resulting Declaration to a Signature.



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

def self.run_sig(method_name, original_method, declaration_block, unwrap:)
  current_declaration =
    begin
      run_builder(declaration_block)
    rescue DeclBuilder::BuilderError => e
      T::Configuration.sig_builder_error_handler(e, declaration_block.loc)
      nil
    end

  # Release location information sooner
  declaration_block.loc = nil

  signature =
    if current_declaration
      build_sig(method_name, original_method, current_declaration)
    else
      Signature.new_untyped(method: original_method)
    end

  if unwrap
    unwrap_method(signature.method.owner, signature, original_method)
  end

  # Store the finished signature (dropping the Declaration in the process).
  # Only do this after we've actually wrapped the method and recorded the
  # signature, because that might raise an exception, leaving the
  # declaration in a weird state if the program rescues that exception and
  # continues.
  #
  # Storing the signature here allows the first-call wrapper to find its
  # own signature even if it was evaluated externally (e.g., by
  # run_all_sig_blocks) and @signatures_by_method[key] was later overwritten
  # by a redefinition.
  declaration_block.sig_state = signature

  signature
end

.run_sig_block_for_method(method) ⇒ Object 



621
622
623
 
# File 'lib/types/private/methods/_methods.rb', line 621

def self.run_sig_block_for_method(method)
  run_sig_block_for_key(method_to_key(method))
end

.set_final_checks_on_hooks(enable) ⇒ Object 



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

def self.set_final_checks_on_hooks(enable)
  is_enabled = !@old_hooks.nil?
  if enable == is_enabled
    return
  end
  if is_enabled
    # A cut-down version of T::Private::ClassUtils::ReplacedMethod#restore, because we
    # should only be resetting final hooks during tests.
    T::Configuration.without_ruby_warnings do
      Module.define_method(:included, @old_hooks[0])
      Module.define_method(:extended, @old_hooks[1])
      Class.define_method(:inherited, @old_hooks[2])
    end
    @old_hooks = nil
  else
    # Grab the original methods before replacing them, so that each block
    # closure can reference a variable that is already assigned.
    # (Do this directly, to avoid pinning errors)
    old_included = Module.instance_method(:included)
    T::Private::ClassUtils.replace_method(old_included, Module, :included) do |arg|
      old_included.bind_call(self, arg)
      ::T::Private::Methods._hook_impl(arg, self)
    end
    old_extended = Module.instance_method(:extended)
    T::Private::ClassUtils.replace_method(old_extended, Module, :extended) do |arg|
      old_extended.bind_call(self, arg)
      ::T::Private::Methods._hook_impl(arg.singleton_class, self)
    end
    old_inherited = Class.instance_method(:inherited)
    T::Private::ClassUtils.replace_method(old_inherited, Class, :inherited) do |arg|
      old_inherited.bind_call(self, arg)
      ::T::Private::Methods._hook_impl(arg, self)
      ::T::Private::Methods._hook_impl(arg.singleton_class, self.singleton_class)
    end
    @old_hooks = [old_included, old_extended, old_inherited]
  end
end

.signature_for_method(method) ⇒ T::Private::Methods::Signature

Returns the signature for a method whose definition was preceded by sig.

Parameters:

  • method (UnboundMethod)

Returns:



585
586
587
 
# File 'lib/types/private/methods/_methods.rb', line 585

def self.signature_for_method(method)
  signature_for_key(method_to_key(method))
end

.start_proc ⇒ Object 



176
177
178
179
180
181
182
 
# File 'lib/types/private/methods/_methods.rb', line 176

def self.start_proc
  # abstract/override/overridable don't make sense on procs
  abstract = false
  override = nil
  overridable = false
  DeclBuilder.new(PROC_TYPE, abstract, override, overridable)
end