Class: RBS::DefinitionBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/rbs/definition_builder.rb,
lib/rbs/definition_builder/method_builder.rb,
lib/rbs/definition_builder/ancestor_builder.rb

Defined Under Namespace

Classes: AncestorBuilder, MethodBuilder

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env:, ancestor_builder: nil, method_builder: nil) ⇒ DefinitionBuilder

Returns a new instance of DefinitionBuilder.



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rbs/definition_builder.rb', line 13

def initialize(env:, ancestor_builder: nil, method_builder: nil)
  @env = env
  @type_name_resolver = TypeNameResolver.from_env(env)
  @ancestor_builder = ancestor_builder || AncestorBuilder.new(env: env)
  @method_builder = method_builder || MethodBuilder.new(env: env)

  @instance_cache = {}
  @singleton_cache = {}
  @singleton0_cache = {}
  @interface_cache = {}
end

Instance Attribute Details

#ancestor_builder ⇒ Object (readonly)

Returns the value of attribute ancestor_builder.



5
6
7
 
# File 'lib/rbs/definition_builder.rb', line 5

def ancestor_builder
  @ancestor_builder
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



3
4
5
 
# File 'lib/rbs/definition_builder.rb', line 3

def env
  @env
end

#instance_cache ⇒ Object (readonly)

Returns the value of attribute instance_cache.



8
9
10
 
# File 'lib/rbs/definition_builder.rb', line 8

def instance_cache
  @instance_cache
end

#interface_cache ⇒ Object (readonly)

Returns the value of attribute interface_cache.



11
12
13
 
# File 'lib/rbs/definition_builder.rb', line 11

def interface_cache
  @interface_cache
end

#method_builder ⇒ Object (readonly)

Returns the value of attribute method_builder.



6
7
8
 
# File 'lib/rbs/definition_builder.rb', line 6

def method_builder
  @method_builder
end

#singleton0_cache ⇒ Object (readonly)

Returns the value of attribute singleton0_cache.



10
11
12
 
# File 'lib/rbs/definition_builder.rb', line 10

def singleton0_cache
  @singleton0_cache
end

#singleton_cache ⇒ Object (readonly)

Returns the value of attribute singleton_cache.



9
10
11
 
# File 'lib/rbs/definition_builder.rb', line 9

def singleton_cache
  @singleton_cache
end

#type_name_resolver ⇒ Object (readonly)

Returns the value of attribute type_name_resolver.



4
5
6
 
# File 'lib/rbs/definition_builder.rb', line 4

def type_name_resolver
  @type_name_resolver
end

Instance Method Details

#build_instance(type_name, no_self_types: false) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/rbs/definition_builder.rb', line 135

def build_instance(type_name, no_self_types: false)
  try_cache(type_name, cache: instance_cache, key: [type_name, no_self_types]) do
    entry = env.class_decls[type_name] or raise "Unknown name for build_instance: #{type_name}"
    ensure_namespace!(type_name.namespace, location: entry.decls[0].decl.location)

    case entry
    when Environment::ClassEntry, Environment::ModuleEntry
      ancestors = ancestor_builder.instance_ancestors(type_name)
      args = Types::Variable.build(entry.type_params.each.map(&:name))
      self_type = Types::ClassInstance.new(name: type_name, args: args, location: nil)

      Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
        one_ancestors = ancestor_builder.one_instance_ancestors(type_name)
        methods = method_builder.build_instance(type_name)

        validate_type_params definition, methods: methods, ancestors: one_ancestors

        if super_class = one_ancestors.super_class
          case super_class
          when Definition::Ancestor::Instance
            build_instance(super_class.name).yield_self do |defn|
              merge_definition(src: defn,
                              dest: definition,
                              subst: Substitution.build(defn.type_params, super_class.args),
                              keep_super: true)
            end
          else
            raise
          end
        end

        if self_types = one_ancestors.self_types
          unless no_self_types
            self_types.each do |ans|
              defn = if ans.name.interface?
                       build_interface(ans.name)
                     else
                       build_instance(ans.name)
                     end

              # Successor interface method overwrites.
              merge_definition(src: defn,
                               dest: definition,
                               subst: Substitution.build(defn.type_params, ans.args),
                               keep_super: true)
            end
          end
        end

        one_ancestors.each_included_module do |mod|
          defn = build_instance(mod.name, no_self_types: true)
          merge_definition(src: defn,
                           dest: definition,
                           subst: Substitution.build(defn.type_params, mod.args))
        end

        interface_methods = {}

        one_ancestors.each_included_interface do |mod|
          defn = build_interface(mod.name)
          subst = Substitution.build(defn.type_params, mod.args)

          defn.methods.each do |name, method|
            if interface_methods.key?(name)
              include_member = mod.source

              raise unless include_member.is_a?(AST::Members::Include)

              raise DuplicatedInterfaceMethodDefinitionError.new(
                type: self_type,
                method_name: name,
                member: include_member
              )
            end

            merge_method(type_name, interface_methods, name, method, subst, implemented_in: type_name)
          end
        end

        define_methods(definition,
                       interface_methods: interface_methods,
                       methods: methods,
                       super_interface_method: entry.is_a?(Environment::ModuleEntry))

        entry.decls.each do |d|
          subst = Substitution.build(d.decl.type_params.each.map(&:name), args)

          d.decl.members.each do |member|
            case member
            when AST::Members::AttrReader, AST::Members::AttrAccessor, AST::Members::AttrWriter
              if member.kind == :instance
                ivar_name = case member.ivar_name
                            when false
                              nil
                            else
                              member.ivar_name || :"@#{member.name}"
                            end

                if ivar_name
                  insert_variable(type_name,
                                  definition.instance_variables,
                                  name: ivar_name,
                                  type: member.type.sub(subst))
                end
              end

            when AST::Members::InstanceVariable
              insert_variable(type_name,
                              definition.instance_variables,
                              name: member.name,
                              type: member.type.sub(subst))

            when AST::Members::ClassVariable
              insert_variable(type_name, definition.class_variables, name: member.name, type: member.type)
            end
          end
        end

        one_ancestors.each_prepended_module do |mod|
          defn = build_instance(mod.name)
          merge_definition(src: defn,
                           dest: definition,
                           subst: Substitution.build(defn.type_params, mod.args))
        end
      end
    end
  end
end

#build_interface(type_name) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/rbs/definition_builder.rb', line 33

def build_interface(type_name)
  try_cache(type_name, cache: interface_cache) do
    entry = env.interface_decls[type_name] or raise "Unknown name for build_interface: #{type_name}"
    declaration = entry.decl
    ensure_namespace!(type_name.namespace, location: declaration.location)

    self_type = Types::Interface.new(
      name: type_name,
      args: Types::Variable.build(declaration.type_params.each.map(&:name)),
      location: nil
    )

    ancestors = ancestor_builder.interface_ancestors(type_name)
    Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
      included_interfaces = ancestor_builder.one_interface_ancestors(type_name).included_interfaces or raise
      included_interfaces.each do |mod|
        defn = build_interface(mod.name)
        subst = Substitution.build(defn.type_params, mod.args)

        defn.methods.each do |name, method|
          definition.methods[name] = method.sub(subst)
        end
      end

      methods = method_builder.build_interface(type_name)
      one_ancestors = ancestor_builder.one_interface_ancestors(type_name)

      validate_type_params(definition, methods: methods, ancestors: one_ancestors)

      methods.each do |defn|
        method = case original = defn.original
                 when AST::Members::MethodDefinition
                   defs = original.types.map do |method_type|
                     Definition::Method::TypeDef.new(
                       type: method_type,
                       member: original,
                       defined_in: type_name,
                       implemented_in: nil
                     )
                   end

                   Definition::Method.new(
                     super_method: nil,
                     defs: defs,
                     accessibility: :public,
                     alias_of: nil
                   )
                 when AST::Members::Alias
                   unless definition.methods.key?(original.old_name)
                     raise UnknownMethodAliasError.new(
                       type_name: type_name,
                       original_name: original.old_name,
                       aliased_name: original.new_name,
                       location: original.location
                     )
                   end

                   original_method = definition.methods[original.old_name]
                   Definition::Method.new(
                     super_method: nil,
                     defs: original_method.defs.map do |defn|
                       defn.update(implemented_in: nil, defined_in: type_name)
                     end,
                     accessibility: :public,
                     alias_of: original_method
                   )
                 when nil
                   unless definition.methods.key?(defn.name)
                     raise InvalidOverloadMethodError.new(
                       type_name: type_name,
                       method_name: defn.name,
                       kind: :instance,
                       members: defn.overloads
                     )
                   end

                   definition.methods[defn.name]

                 when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
                   raise

                 end

        defn.overloads.each do |overload|
          overload_defs = overload.types.map do |method_type|
            Definition::Method::TypeDef.new(
              type: method_type,
              member: overload,
              defined_in: type_name,
              implemented_in: nil
            )
          end

          method.defs.unshift(*overload_defs)
        end

        definition.methods[defn.name] = method
      end
    end
  end
end

#build_singleton(type_name) ⇒ Object 



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
 
# File 'lib/rbs/definition_builder.rb', line 363

def build_singleton(type_name)
  try_cache type_name, cache: singleton_cache do
    entry = env.class_decls[type_name] or raise "Unknown name for build_singleton: #{type_name}"
    ensure_namespace!(type_name.namespace, location: entry.decls[0].decl.location)

    case entry
    when Environment::ClassEntry, Environment::ModuleEntry
      ancestors = ancestor_builder.singleton_ancestors(type_name)
      self_type = Types::ClassSingleton.new(name: type_name, location: nil)

      Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
        def0 = build_singleton0(type_name)
        subst = Substitution.new

        merge_definition(src: def0, dest: definition, subst: subst, keep_super: true)

        if entry.is_a?(Environment::ClassEntry)
          new_method = definition.methods[:new]
          if new_method.defs.all? {|d| d.defined_in == BuiltinNames::Class.name }
            # The method is _untyped new_.

            instance = build_instance(type_name)
            initialize = instance.methods[:initialize]

            if initialize
              class_params = entry.type_params.each.map(&:name)

              # Inject a virtual _typed new_.
              initialize_defs = initialize.defs
              definition.methods[:new] = Definition::Method.new(
                super_method: new_method,
                defs: initialize_defs.map do |initialize_def|
                  method_type = initialize_def.type

                  class_type_param_vars = Set.new(class_params)
                  method_type_param_vars = Set.new(method_type.type_params)

                  if class_type_param_vars.intersect?(method_type_param_vars)
                    renamed_method_params = method_type.type_params.map do |name|
                      if class_type_param_vars.include?(name)
                        Types::Variable.fresh(name).name
                      else
                        name
                      end
                    end
                    method_params = class_params + renamed_method_params

                    sub = Substitution.build(method_type.type_params, Types::Variable.build(renamed_method_params))
                  else
                    method_params = class_params + method_type.type_params
                    sub = Substitution.build([], [])
                  end

                  method_type = method_type.map_type {|ty| ty.sub(sub) }
                  method_type = method_type.update(
                    type_params: method_params,
                    type: method_type.type.with_return_type(
                      Types::ClassInstance.new(
                        name: type_name,
                        args: Types::Variable.build(entry.type_params.each.map(&:name)),
                        location: nil
                      )
                    )
                  )

                  Definition::Method::TypeDef.new(
                    type: method_type,
                    member: initialize_def.member,
                    defined_in: initialize_def.defined_in,
                    implemented_in: initialize_def.implemented_in
                  )
                end,
                accessibility: :public,
                annotations: [],
                alias_of: nil
              )
            end
          end
        end
      end
    end
  end
end

#build_singleton0(type_name) ⇒ Object

Builds a definition for singleton without .new method.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/rbs/definition_builder.rb', line 266

def build_singleton0(type_name)
  try_cache type_name, cache: singleton0_cache do
    entry = env.class_decls[type_name] or raise "Unknown name for build_singleton0: #{type_name}"
    ensure_namespace!(type_name.namespace, location: entry.decls[0].decl.location)

    case entry
    when Environment::ClassEntry, Environment::ModuleEntry
      ancestors = ancestor_builder.singleton_ancestors(type_name)
      self_type = Types::ClassSingleton.new(name: type_name, location: nil)

      Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
        one_ancestors = ancestor_builder.one_singleton_ancestors(type_name)

        if super_class = one_ancestors.super_class
          case super_class
          when Definition::Ancestor::Instance
            defn = build_instance(super_class.name)
            merge_definition(src: defn,
                             dest: definition,
                             subst: Substitution.build(defn.type_params, super_class.args),
                             keep_super: true)
          when Definition::Ancestor::Singleton
            defn = build_singleton0(super_class.name)
            merge_definition(src: defn, dest: definition, subst: Substitution.new, keep_super: true)
          end
        end

        one_ancestors.each_extended_module do |mod|
          mod.args.each do |arg|
            validate_type_presence(arg)
          end

          mod_defn = build_instance(mod.name, no_self_types: true)
          merge_definition(src: mod_defn,
                           dest: definition,
                           subst: Substitution.build(mod_defn.type_params, mod.args))
        end

        interface_methods = {}
        one_ancestors.each_extended_interface do |mod|
          mod.args.each do |arg|
            validate_type_presence(arg)
          end

          mod_defn = build_interface(mod.name)
          subst = Substitution.build(mod_defn.type_params, mod.args)

          mod_defn.methods.each do |name, method|
            if interface_methods.key?(name)
              src_member = mod.source

              raise unless src_member.is_a?(AST::Members::Extend)

              raise DuplicatedInterfaceMethodDefinitionError.new(
                type: self_type,
                method_name: name,
                member: src_member
              )
            end

            merge_method(type_name, interface_methods, name, method, subst, implemented_in: type_name)
          end
        end

        methods = method_builder.build_singleton(type_name)
        define_methods(definition, interface_methods: interface_methods, methods: methods, super_interface_method: false)

        entry.decls.each do |d|
          d.decl.members.each do |member|
            case member
            when AST::Members::AttrReader, AST::Members::AttrAccessor, AST::Members::AttrWriter
              if member.kind == :singleton
                ivar_name = case member.ivar_name
                            when false
                              nil
                            else
                              member.ivar_name || :"@#{member.name}"
                            end

                if ivar_name
                  insert_variable(type_name, definition.instance_variables, name: ivar_name, type: member.type)
                end
              end

            when AST::Members::ClassInstanceVariable
              insert_variable(type_name, definition.instance_variables, name: member.name, type: member.type)

            when AST::Members::ClassVariable
              insert_variable(type_name, definition.class_variables, name: member.name, type: member.type)
            end
          end
        end
      end
    end
  end
end

#define_methods(definition, interface_methods:, methods:, super_interface_method:) ⇒ Object 



557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/rbs/definition_builder.rb', line 557

def define_methods(definition, interface_methods:, methods:, super_interface_method:)
  methods.each do |method_def|
    method_name = method_def.name
    original = method_def.original

    if original.is_a?(AST::Members::Alias)
      existing_method = interface_methods[method_name] || definition.methods[method_name]
      original_method = interface_methods[original.old_name] || definition.methods[original.old_name]

      unless original_method
        raise UnknownMethodAliasError.new(
          type_name: definition.type_name,
          original_name: original.old_name,
          aliased_name: original.new_name,
          location: original.location
        )
      end

      method = Definition::Method.new(
        super_method: existing_method,
        defs: original_method.defs.map do |defn|
          defn.update(defined_in: definition.type_name, implemented_in: definition.type_name)
        end,
        accessibility: method_def.accessibility,
        alias_of: original_method
      )
    else
      if interface_methods.key?(method_name)
        interface_method = interface_methods[method_name]

        if original = method_def.original
          raise DuplicatedMethodDefinitionError.new(
            type: definition.self_type,
            method_name: method_name,
            members: [original]
          )
        end

        definition.methods[method_name] = interface_method
      end

      existing_method = definition.methods[method_name]

      case original
      when AST::Members::MethodDefinition
        defs = original.types.map do |method_type|
          Definition::Method::TypeDef.new(
            type: method_type,
            member: original,
            defined_in: definition.type_name,
            implemented_in: definition.type_name
          )
        end

        # @type var accessibility: RBS::Definition::accessibility
        accessibility = if method_name == :initialize
                          :private
                        else
                          method_def.accessibility
                        end

        method = Definition::Method.new(
          super_method: existing_method,
          defs: defs,
          accessibility: accessibility,
          alias_of: nil
        )

      when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
        method_type = if method_name.to_s.end_with?("=")
                        # setter
                        MethodType.new(
                          type_params: [],
                          type: Types::Function.empty(original.type).update(
                            required_positionals: [
                              Types::Function::Param.new(type: original.type, name: original.name)
                            ]
                          ),
                          block: nil,
                          location: nil
                        )
                      else
                        # getter
                        MethodType.new(
                          type_params: [],
                          type: Types::Function.empty(original.type),
                          block: nil,
                          location: nil
                        )
                      end
        defs = [
          Definition::Method::TypeDef.new(
            type: method_type,
            member: original,
            defined_in: definition.type_name,
            implemented_in: definition.type_name
          )
        ]

        method = Definition::Method.new(
          super_method: existing_method,
          defs: defs,
          accessibility: method_def.accessibility,
          alias_of: nil
        )

      when nil
        unless definition.methods.key?(method_name)
          raise InvalidOverloadMethodError.new(
            type_name: definition.type_name,
            method_name: method_name,
            kind: :instance,
            members: method_def.overloads
          )
        end

        if !super_interface_method && existing_method.defs.any? {|defn| defn.defined_in.interface? }
          super_method = existing_method.super_method
        else
          super_method = existing_method
        end

        method = Definition::Method.new(
          super_method: super_method,
          defs: existing_method.defs.map do |defn|
            defn.update(implemented_in: definition.type_name)
          end,
          accessibility: existing_method.accessibility,
          alias_of: existing_method.alias_of
        )
      end
    end

    method_def.overloads.each do |overload|
      type_defs = overload.types.map do |method_type|
        Definition::Method::TypeDef.new(
          type: method_type,
          member: overload,
          defined_in: definition.type_name,
          implemented_in: definition.type_name
        )
      end

      method.defs.unshift(*type_defs)
    end

    definition.methods[method_name] = method
  end

  interface_methods.each do |name, method|
    unless methods.methods.key?(name)
      merge_method(definition.type_name, definition.methods, name, method, Substitution.new)
    end
  end
end

#ensure_namespace!(namespace, location:) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/rbs/definition_builder.rb', line 25

def ensure_namespace!(namespace, location:)
  namespace.ascend do |ns|
    unless ns.empty?
      NoTypeFoundError.check!(ns.to_type_name, env: env, location: location)
    end
  end
end

#expand_alias(type_name) ⇒ Object 



791
792
793
 
# File 'lib/rbs/definition_builder.rb', line 791

def expand_alias(type_name)
  expand_alias2(type_name, [])
end

#expand_alias1(type_name) ⇒ Object 



795
796
797
798
799
 
# File 'lib/rbs/definition_builder.rb', line 795

def expand_alias1(type_name)
  entry = env.alias_decls[type_name] or raise "Unknown alias name: #{type_name}"
  as = entry.decl.type_params.each.map { Types::Bases::Any.new(location: nil) }
  expand_alias2(type_name, as)
end

#expand_alias2(type_name, args) ⇒ Object 



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
 
# File 'lib/rbs/definition_builder.rb', line 801

def expand_alias2(type_name, args)
  entry = env.alias_decls[type_name] or raise "Unknown alias name: #{type_name}"

  ensure_namespace!(type_name.namespace, location: entry.decl.location)
  params = entry.decl.type_params.each.map(&:name)

  unless params.size == args.size
    as = "[#{args.join(", ")}]" unless args.empty?
    ps = "[#{params.join(", ")}]" unless params.empty?

    raise "Invalid type application: type = #{type_name}#{as}, decl = #{type_name}#{ps}"
  end

  type = entry.decl.type

  unless params.empty?
    subst = Substitution.build(params, args)
    type = type.sub(subst)
  end

  type
end

#insert_variable(type_name, variables, name:, type:) ⇒ Object 



549
550
551
552
553
554
555
 
# File 'lib/rbs/definition_builder.rb', line 549

def insert_variable(type_name, variables, name:, type:)
  variables[name] = Definition::Variable.new(
    parent_variable: variables[name],
    type: type,
    declared_in: type_name
  )
end

#merge_definition(src:, dest:, subst:, implemented_in: :keep, keep_super: false) ⇒ Object 



713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/rbs/definition_builder.rb', line 713

def merge_definition(src:, dest:, subst:, implemented_in: :keep, keep_super: false)
  src.methods.each do |name, method|
    merge_method(dest.type_name, dest.methods, name, method, subst, implemented_in: implemented_in, keep_super: keep_super)
  end

  src.instance_variables.each do |name, variable|
    merge_variable(dest.instance_variables, name, variable, subst, keep_super: keep_super)
  end

  src.class_variables.each do |name, variable|
    merge_variable(dest.class_variables, name, variable, subst, keep_super: keep_super)
  end
end

#merge_method(type_name, methods, name, method, sub, implemented_in: :keep, keep_super: false) ⇒ Object 



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
 
# File 'lib/rbs/definition_builder.rb', line 737

def merge_method(type_name, methods, name, method, sub, implemented_in: :keep, keep_super: false)
  if sub.empty? && implemented_in == :keep && keep_super
    methods[name] = method
  else
    if sub.empty? && implemented_in == :keep
      defs = method.defs
    else
      defs = method.defs.map do |defn|
        defn.update(
          type: sub.empty? ? defn.type : defn.type.sub(sub),
          implemented_in: case implemented_in
                          when :keep
                            defn.implemented_in
                          when nil
                            nil
                          else
                            implemented_in
                          end
        )
      end

      defs = method.defs.map do |defn|
        defn.update(
          type: sub.empty? ? defn.type : defn.type.sub(sub),
          implemented_in: case implemented_in
                          when :keep
                            defn.implemented_in
                          when nil
                            nil
                          else
                            implemented_in
                          end
        )
      end
    end

    super_method = methods[name]

    methods[name] = Definition::Method.new(
      super_method: keep_super ? method.super_method : super_method,
      accessibility: method.accessibility,
      defs: defs,
      alias_of: method.alias_of
    )
  end
end

#merge_variable(variables, name, variable, sub, keep_super: false) ⇒ Object 



727
728
729
730
731
732
733
734
735
 
# File 'lib/rbs/definition_builder.rb', line 727

def merge_variable(variables, name, variable, sub, keep_super: false)
  super_variable = variables[name]

  variables[name] = Definition::Variable.new(
    parent_variable: keep_super ? variable.parent_variable : super_variable,
    type: sub.empty? ? variable.type : variable.type.sub(sub),
    declared_in: variable.declared_in
  )
end

#source_location(source, decl) ⇒ Object 



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/rbs/definition_builder.rb', line 457

def source_location(source, decl)
  case source
  when nil
    decl.location
  when :super
    case decl
    when AST::Declarations::Class
      decl.super_class&.location
    end
  else
    source.location
  end
end

#try_cache(type_name, cache:, key: type_name) ⇒ Object 



784
785
786
787
788
789
 
# File 'lib/rbs/definition_builder.rb', line 784

def try_cache(type_name, cache:, key: type_name)
  # @type var cc: Hash[untyped, Definition | nil]
  cc = _ = cache

  cc[key] ||= yield
end

#update(env:, except:, ancestor_builder:) ⇒ Object 



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/rbs/definition_builder.rb', line 824

def update(env:, except:, ancestor_builder:)
  method_builder = self.method_builder.update(env: env, except: except)

  DefinitionBuilder.new(env: env, ancestor_builder: ancestor_builder, method_builder: method_builder).tap do |builder|
    builder.instance_cache.merge!(instance_cache)
    builder.singleton_cache.merge!(singleton_cache)
    builder.singleton0_cache.merge!(singleton0_cache)
    builder.interface_cache.merge!(interface_cache)

    except.each do |name|
      builder.instance_cache.delete([name, true])
      builder.instance_cache.delete([name, false])
      builder.singleton_cache.delete(name)
      builder.singleton0_cache.delete(name)
      builder.interface_cache.delete(name)
    end
  end
end

#validate_params_with(type_params, result:) ⇒ Object 



447
448
449
450
451
452
453
454
455
 
# File 'lib/rbs/definition_builder.rb', line 447

def validate_params_with(type_params, result:)
  type_params.each do |param|
    unless param.skip_validation
      unless result.compatible?(param.name, with_annotation: param.variance)
        yield param
      end
    end
  end
end

#validate_type_name(name, location) ⇒ Object

Raises:



854
855
856
857
858
859
860
861
862
 
# File 'lib/rbs/definition_builder.rb', line 854

def validate_type_name(name, location)
  name = name.absolute!

  return if name.class? && env.class_decls.key?(name)
  return if name.interface? && env.interface_decls.key?(name)
  return if name.alias? && env.alias_decls.key?(name)

  raise NoTypeFoundError.new(type_name: name, location: location)
end

#validate_type_params(definition, ancestors:, methods:) ⇒ Object 



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/rbs/definition_builder.rb', line 471

def validate_type_params(definition, ancestors:, methods:)
  type_params = definition.type_params_decl

  calculator = VarianceCalculator.new(builder: self)
  param_names = type_params.each.map(&:name)

  ancestors.each_ancestor do |ancestor|
    case ancestor
    when Definition::Ancestor::Instance
      result = calculator.in_inherit(name: ancestor.name, args: ancestor.args, variables: param_names)
      validate_params_with(type_params, result: result) do |param|
        decl = case entry = definition.entry
               when Environment::ModuleEntry, Environment::ClassEntry
                 entry.primary.decl
               when Environment::SingleEntry
                 entry.decl
               end

        raise InvalidVarianceAnnotationError.new(
          type_name: definition.type_name,
          param: param,
          location: source_location(ancestor.source, decl)
        )
      end
    end
  end

  methods.each do |defn|
    next if defn.name == :initialize

    method_types = case original = defn.original
                   when AST::Members::MethodDefinition
                     original.types
                   when AST::Members::AttrWriter, AST::Members::AttrReader, AST::Members::AttrAccessor
                     if defn.name.to_s.end_with?("=")
                       [
                         MethodType.new(
                           type_params: [],
                           type: Types::Function.empty(original.type).update(
                             required_positionals: [
                               Types::Function::Param.new(type: original.type, name: original.name)
                             ]
                           ),
                           block: nil,
                           location: original.location
                         )
                       ]
                     else
                       [
                         MethodType.new(
                           type_params: [],
                           type: Types::Function.empty(original.type),
                           block: nil,
                           location: original.location
                         )
                       ]
                     end
                   when AST::Members::Alias
                     nil
                   when nil
                     nil
                   end

    if method_types
      method_types.each do |method_type|
        result = calculator.in_method_type(method_type: method_type, variables: param_names)
        validate_params_with(type_params, result: result) do |param|
          raise InvalidVarianceAnnotationError.new(
            type_name: definition.type_name,
            param: param,
            location: method_type.location
          )
        end
      end
    end
  end
end

#validate_type_presence(type) ⇒ Object 



843
844
845
846
847
848
849
850
851
852
 
# File 'lib/rbs/definition_builder.rb', line 843

def validate_type_presence(type)
  case type
  when Types::ClassInstance, Types::ClassSingleton, Types::Interface, Types::Alias
    validate_type_name(type.name, type.location)
  end

  type.each_type do |type|
    validate_type_presence(type)
  end
end