Module: Tapioca::Runtime::Reflection

Extended by:
T::Sig, Reflection
Includes:
AttachedClassOf
Included in:
Dsl::Compiler, Dsl::Compiler, Gem::Listeners::DynamicMixins, Gem::Listeners::ForeignConstants, Gem::Listeners::Methods, Gem::Listeners::Mixins, Gem::Listeners::RemoveEmptyPayloadScopes, Gem::Listeners::SorbetHelpers, Gem::Listeners::SorbetSignatures, Gem::Listeners::SorbetTypeVariables, Gem::Listeners::Subconstants, Gem::Pipeline, DynamicMixinCompiler, Reflection, Trackers::ConstantDefinition, Static::SymbolLoader
Defined in:
lib/tapioca/runtime/reflection.rb

Constant Summary collapse

CLASS_METHOD =

: UnboundMethod

Kernel.instance_method(:class)
CONSTANTS_METHOD =

: UnboundMethod

Module.instance_method(:constants)
NAME_METHOD =

: UnboundMethod

Module.instance_method(:name)
SINGLETON_CLASS_METHOD =

: UnboundMethod

Object.instance_method(:singleton_class)
ANCESTORS_METHOD =

: UnboundMethod

Module.instance_method(:ancestors)
SUPERCLASS_METHOD =

: UnboundMethod

Class.instance_method(:superclass)
OBJECT_ID_METHOD =

: UnboundMethod

BasicObject.instance_method(:__id__)
EQUAL_METHOD =

: UnboundMethod

BasicObject.instance_method(:equal?)
PUBLIC_INSTANCE_METHODS_METHOD =

: UnboundMethod

Module.instance_method(:public_instance_methods)
PROTECTED_INSTANCE_METHODS_METHOD =

: UnboundMethod

Module.instance_method(:protected_instance_methods)
PRIVATE_INSTANCE_METHODS_METHOD =

: UnboundMethod

Module.instance_method(:private_instance_methods)
METHOD_METHOD =

: UnboundMethod

Kernel.instance_method(:method)
UNDEFINED_CONSTANT =

: Module

Module.new.freeze
REQUIRED_FROM_LABELS =

: Array

["<top (required)>", "<main>", "<compiled>"].freeze
SignatureBlockError = 
Class.new(Tapioca::Error)

Instance Method Summary collapse

Methods included from AttachedClassOf

#attached_class_of

Instance Method Details

#abstract_type_of(constant) ⇒ Object

: (Module constant) -> untyped



228
229
230
231
 
# File 'lib/tapioca/runtime/reflection.rb', line 228

def abstract_type_of(constant)
  T::Private::Abstract::Data.get(constant, :abstract_type) ||
    T::Private::Abstract::Data.get(singleton_class_of(constant), :abstract_type)
end

#ancestors_of(constant) ⇒ Object

: (Module constant) -> Array



75
76
77
 
# File 'lib/tapioca/runtime/reflection.rb', line 75

def ancestors_of(constant)
  ANCESTORS_METHOD.bind_call(constant)
end

#are_equal?(object, other) ⇒ Boolean

: (BasicObject object, BasicObject other) -> bool

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/tapioca/runtime/reflection.rb', line 90

def are_equal?(object, other)
  EQUAL_METHOD.bind_call(object, other)
end

#class_of(object) ⇒ Object

: (BasicObject object) -> Class



54
55
56
 
# File 'lib/tapioca/runtime/reflection.rb', line 54

def class_of(object)
  CLASS_METHOD.bind_call(object)
end

#const_source_location(constant_name) ⇒ Object

: ((String | Symbol) constant_name) -> SourceLocation?



179
180
181
182
183
184
185
 
# File 'lib/tapioca/runtime/reflection.rb', line 179

def const_source_location(constant_name)
  return unless Object.respond_to?(:const_source_location)

  file, line = Object.const_source_location(constant_name)

  SourceLocation.from_loc([file, line]) if file && line
end

#constant_defined?(constant) ⇒ Boolean

: (BasicObject constant) -> bool

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/tapioca/runtime/reflection.rb', line 41

def constant_defined?(constant)
  !UNDEFINED_CONSTANT.eql?(constant)
end

#constantize(symbol, inherit: false, namespace: Object) ⇒ Object

: (String symbol, ?inherit: bool, ?namespace: Module) -> BasicObject



47
48
49
50
51
 
# File 'lib/tapioca/runtime/reflection.rb', line 47

def constantize(symbol, inherit: false, namespace: Object)
  namespace.const_get(symbol, inherit)
rescue NameError, LoadError, RuntimeError, ArgumentError, TypeError
  UNDEFINED_CONSTANT
end

#constants_of(constant) ⇒ Object

: (Module constant) -> Array



59
60
61
 
# File 'lib/tapioca/runtime/reflection.rb', line 59

def constants_of(constant)
  CONSTANTS_METHOD.bind_call(constant, false)
end

#descendants_of(klass) ⇒ Object

Returns an array with all classes that are < than the supplied class.

class C; end
descendants_of(C) # => []

class B < C; end
descendants_of(C) # => [B]

class A < B; end
descendants_of(C) # => [B, A]

class D < C; end
descendants_of(C) # => [B, A, D]

: [U] ((Class & U) klass) -> Array



170
171
172
173
174
175
176
 
# File 'lib/tapioca/runtime/reflection.rb', line 170

def descendants_of(klass)
  result = ObjectSpace.each_object(klass.singleton_class).reject do |k|
    k.singleton_class? || k == klass
  end

  T.unsafe(result)
end

#file_candidates_for(constant) ⇒ Object

: (Module constant) -> Set



221
222
223
224
225
 
# File 'lib/tapioca/runtime/reflection.rb', line 221

def file_candidates_for(constant)
  relevant_methods_for(constant).filter_map do |method|
    method.source_location&.first
  end.to_set
end

#final_module?(constant) ⇒ Boolean

: (Module constant) -> bool

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/tapioca/runtime/reflection.rb', line 234

def final_module?(constant)
  T::Private::Final.final_module?(constant)
end

#inherited_ancestors_of(constant) ⇒ Object

: (Module constant) -> Array



110
111
112
113
114
115
116
 
# File 'lib/tapioca/runtime/reflection.rb', line 110

def inherited_ancestors_of(constant)
  if Class === constant
    ancestors_of(superclass_of(constant) || Object)
  else
    Module.new.ancestors
  end
end

#method_of(constant, method) ⇒ Object

: (Module constant, Symbol method) -> Method



152
153
154
 
# File 'lib/tapioca/runtime/reflection.rb', line 152

def method_of(constant, method)
  METHOD_METHOD.bind_call(constant, method)
end

#name_of(constant) ⇒ Object

: (Module constant) -> String?



64
65
66
67
 
# File 'lib/tapioca/runtime/reflection.rb', line 64

def name_of(constant)
  name = NAME_METHOD.bind_call(constant)
  name&.start_with?("#<") ? nil : name
end

#name_of_type(type) ⇒ Object

: (T::Types::Base type) -> String



147
148
149
 
# File 'lib/tapioca/runtime/reflection.rb', line 147

def name_of_type(type)
  type.to_s
end

#object_id_of(object) ⇒ Object

: (BasicObject object) -> Integer



85
86
87
 
# File 'lib/tapioca/runtime/reflection.rb', line 85

def object_id_of(object)
  OBJECT_ID_METHOD.bind_call(object)
end

#private_instance_methods_of(constant) ⇒ Object

: (Module constant) -> Array



105
106
107
 
# File 'lib/tapioca/runtime/reflection.rb', line 105

def private_instance_methods_of(constant)
  PRIVATE_INSTANCE_METHODS_METHOD.bind_call(constant)
end

#protected_instance_methods_of(constant) ⇒ Object

: (Module constant) -> Array



100
101
102
 
# File 'lib/tapioca/runtime/reflection.rb', line 100

def protected_instance_methods_of(constant)
  PROTECTED_INSTANCE_METHODS_METHOD.bind_call(constant)
end

#public_instance_methods_of(constant) ⇒ Object

: (Module constant) -> Array



95
96
97
 
# File 'lib/tapioca/runtime/reflection.rb', line 95

def public_instance_methods_of(constant)
  PUBLIC_INSTANCE_METHODS_METHOD.bind_call(constant)
end

#qualified_name_of(constant) ⇒ Object

: (Module constant) -> String?



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/tapioca/runtime/reflection.rb', line 119

def qualified_name_of(constant)
  name = name_of(constant)
  return if name.nil?

  if name.start_with?("::")
    name
  else
    "::#{name}"
  end
end

#resolve_loc(locations) ⇒ Object

Examines the call stack to identify the closest location where a “require” is performed by searching for the label “<top (required)>” or “block in <class:…>” in the case of an ActiveSupport.on_load hook. If none is found, it returns the location labeled “<main>”, which is the original call site. : (Array? locations) -> SourceLocation?



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
 
# File 'lib/tapioca/runtime/reflection.rb', line 192

def resolve_loc(locations)
  return unless locations

  # Find the location of the closest file load, which should give us the location of the file that
  # triggered the definition.
  resolved_loc = locations.find do |loc|
    label = loc.label
    next unless label

    REQUIRED_FROM_LABELS.include?(label) || label.start_with?("block in <class:")
  end
  return unless resolved_loc

  resolved_loc_path = resolved_loc.absolute_path || resolved_loc.path

  # Find the location of the last frame in this file to get the most accurate line number.
  resolved_loc = locations.find { |loc| loc.absolute_path == resolved_loc_path }
  return unless resolved_loc

  # If the last operation was a `require`, and we have no more frames,
  # we are probably dealing with a C-method.
  return if locations.first&.label == "require"

  file = resolved_loc.absolute_path || resolved_loc.path || ""

  SourceLocation.from_loc([file, resolved_loc.lineno])
end

#sealed_module?(constant) ⇒ Boolean

: (Module constant) -> bool

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/tapioca/runtime/reflection.rb', line 239

def sealed_module?(constant)
  T::Private::Sealed.sealed_module?(constant)
end

#signature_of(method) ⇒ Object

: ((UnboundMethod | Method) method) -> untyped



140
141
142
143
144
 
# File 'lib/tapioca/runtime/reflection.rb', line 140

def signature_of(method)
  signature_of!(method)
rescue SignatureBlockError
  nil
end

#signature_of!(method) ⇒ Object

: ((UnboundMethod | Method) method) -> untyped



133
134
135
136
137
 
# File 'lib/tapioca/runtime/reflection.rb', line 133

def signature_of!(method)
  T::Utils.signature_for_method(method)
rescue LoadError, StandardError
  Kernel.raise SignatureBlockError
end

#singleton_class_of(constant) ⇒ Object

: (Module constant) -> Class



70
71
72
 
# File 'lib/tapioca/runtime/reflection.rb', line 70

def singleton_class_of(constant)
  SINGLETON_CLASS_METHOD.bind_call(constant)
end

#superclass_of(constant) ⇒ Object

: (Class constant) -> Class?



80
81
82
 
# File 'lib/tapioca/runtime/reflection.rb', line 80

def superclass_of(constant)
  SUPERCLASS_METHOD.bind_call(constant)
end