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.



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

def initialize(env:, ancestor_builder: nil, method_builder: nil)
  @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.



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

def ancestor_builder
  @ancestor_builder
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



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

def env
  @env
end

#instance_cache ⇒ Object (readonly)

Returns the value of attribute instance_cache.



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

def instance_cache
  @instance_cache
end

#interface_cache ⇒ Object (readonly)

Returns the value of attribute interface_cache.



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

def interface_cache
  @interface_cache
end

#method_builder ⇒ Object (readonly)

Returns the value of attribute method_builder.



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

def method_builder
  @method_builder
end

#singleton0_cache ⇒ Object (readonly)

Returns the value of attribute singleton0_cache.



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

def singleton0_cache
  @singleton0_cache
end

#singleton_cache ⇒ Object (readonly)

Returns the value of attribute singleton_cache.



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

def singleton_cache
  @singleton_cache
end

Instance Method Details

#build_instance(type_name) ⇒ Object 



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

def build_instance(type_name)
  type_name = env.normalize_module_name(type_name)

  try_cache(type_name, cache: instance_cache) 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)

    ancestors = ancestor_builder.instance_ancestors(type_name)
    args = entry.type_params.map {|param| Types::Variable.new(name: param.name, location: param.location) }
    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 entry.is_a?(Environment::ClassEntry)
        if super_class = one_ancestors.super_class
          super_class.is_a?(Definition::Ancestor::Instance) or raise

          build_instance(super_class.name).tap do |defn|
            unless super_class.args.empty?
              super_class.args.each do |arg|
                validate_type_presence(arg)
              end

              subst = tapp_subst(super_class.name, super_class.args)
              defn = defn.sub(subst)
            end

            definition.methods.merge!(defn.methods)
            definition.instance_variables.merge!(defn.instance_variables)
            definition.class_variables.merge!(defn.class_variables)
          end
        end
      end

      if entry.is_a?(Environment::ModuleEntry)
        if self_types = one_ancestors.self_types
          self_types.each do |ans|
            ans.args.each do |arg|
              validate_type_presence(arg)
            end

            subst = tapp_subst(ans.name, ans.args)
            if ans.name.interface?
              define_interface(definition, ans.name, subst)
            else
              define_instance(definition, ans.name, subst)
            end
          end
        end
      end

      define_instance(definition, type_name, Substitution.new)
    end
  end
end

#build_interface(type_name) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rbs/definition_builder.rb', line 43

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)

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

    subst = Substitution.build(type_params, type_args)

    ancestors = ancestor_builder.interface_ancestors(type_name)
    Definition.new(type_name: type_name, entry: entry, self_type: self_type, ancestors: ancestors).tap do |definition|
      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)

      define_interface(definition, type_name, subst)
    end
  end
end

#build_singleton(type_name) ⇒ Object 



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/rbs/definition_builder.rb', line 288

def build_singleton(type_name)
  type_name = env.normalize_module_name(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)

    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|
      definition0 = build_singleton0(type_name)
      definition.methods.merge!(definition0.methods)
      definition.instance_variables.merge!(definition0.instance_variables)
      definition.class_variables.merge!(definition0.class_variables)

      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_.

          alias_methods = definition.methods.each.with_object([]) do |entry, array|
            # @type var method: Definition::Method?
            name, method = entry
            while method
              if method.alias_of == new_method
                array << name
                break
              end
              method = method.alias_of
            end
          end

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

          if initialize
            class_params = entry.type_params

            # Inject a virtual _typed new_.
            initialize_defs = initialize.defs
            typed_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.map(&:name))
                method_type_param_vars = Set.new(method_type.type_params.map(&:name))

                if class_type_param_vars.intersect?(method_type_param_vars)
                  new_method_param_names = method_type.type_params.map do |method_param|
                    if class_type_param_vars.include?(method_param.name)
                      Types::Variable.fresh(method_param.name).name
                    else
                      method_param.name
                    end
                  end

                  sub = Substitution.build(
                    method_type.type_params.map(&:name),
                    Types::Variable.build(new_method_param_names)
                  )

                  method_params = class_params + AST::TypeParam.rename(method_type.type_params, new_names: new_method_param_names)
                  method_type = method_type
                    .update(type_params: [])
                    .sub(sub)
                    .update(type_params: method_params)
                else
                  method_type = method_type
                    .update(type_params: class_params + method_type.type_params)
                end

                method_type = method_type.update(
                  type: method_type.type.with_return_type(
                    Types::ClassInstance.new(
                      name: type_name,
                      args: entry.type_params.map {|param| Types::Variable.new(name: param.name, location: param.location) },
                      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,
              alias_of: nil
            )

            definition.methods[:new] = typed_new

            alias_methods.each do |alias_name|
              definition.methods[alias_name] = definition.methods[alias_name].update(
                alias_of: typed_new,
                defs: typed_new.defs
              )
            end
          end
        end
      end
    end
  end
end

#build_singleton0(type_name) ⇒ Object

Builds a definition for singleton without .new method.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/rbs/definition_builder.rb', line 217

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)

    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)
      methods = method_builder.build_singleton(type_name)

      if super_class = one_ancestors.super_class
        case super_class
        when Definition::Ancestor::Instance
          defn = build_instance(super_class.name)
        when Definition::Ancestor::Singleton
          defn = build_singleton0(super_class.name)
        end

        definition.methods.merge!(defn.methods)
        definition.instance_variables.merge!(defn.instance_variables)
        definition.class_variables.merge!(defn.class_variables)
      end

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

        subst = tapp_subst(mod.name, mod.args)
        define_instance(definition, mod.name, subst)
      end

      all_interfaces = one_ancestors.each_extended_interface.flat_map do |interface|
        other_interfaces = ancestor_builder.interface_ancestors(interface.name).ancestors #: Array[Definition::Ancestor::Instance]
        other_interfaces = other_interfaces.select {|ancestor| ancestor.source }
        [interface, *other_interfaces]
      end
      interface_methods = interface_methods(all_interfaces)
      import_methods(definition, type_name, methods, interface_methods, Substitution.new)

      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

#define_instance(definition, type_name, subst) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/rbs/definition_builder.rb', line 85

def define_instance(definition, type_name, subst)
  one_ancestors = ancestor_builder.one_instance_ancestors(type_name)
  methods = method_builder.build_instance(type_name)

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

    define_instance(definition, mod.name, subst + tapp_subst(mod.name, mod.args))
  end

  all_interfaces = one_ancestors.each_included_interface.flat_map do |interface|
    other_interfaces = ancestor_builder.interface_ancestors(interface.name).ancestors #: Array[Definition::Ancestor::Instance]
    other_interfaces = other_interfaces.select {|ancestor| ancestor.source }
    [interface, *other_interfaces]
  end
  interface_methods = interface_methods(all_interfaces)
  import_methods(definition, type_name, methods, interface_methods, subst)

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

    define_instance(definition, mod.name, subst + tapp_subst(mod.name, mod.args))
  end

  entry = env.class_decls[type_name] or raise "Unknown name for build_instance: #{type_name}"
  args = entry.type_params.map {|param| Types::Variable.new(name: param.name, location: param.location) }

  entry.decls.each do |d|
    subst_ = 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
end

#define_interface(definition, type_name, subst) ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/rbs/definition_builder.rb', line 33

def define_interface(definition, type_name, subst)
  included_interfaces = ancestor_builder.interface_ancestors(type_name).ancestors #: Array[Definition::Ancestor::Instance]
  included_interfaces = included_interfaces.reject {|ancestor| ancestor.source == nil }

  interface_methods = interface_methods(included_interfaces)
  methods = method_builder.build_interface(type_name)

  import_methods(definition, type_name, methods, interface_methods, subst)
end

#define_method(methods, definition, method, subst, defined_in:, implemented_in: defined_in) ⇒ Object 



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/rbs/definition_builder.rb', line 590

def define_method(methods, definition, method, subst, defined_in:, implemented_in: defined_in)
  existing_method = methods[method.name] || definition.methods[method.name]

  case original = method.original
  when AST::Members::Alias
    original_method = 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 = Definition::Method.new(
      super_method: existing_method,
      defs: original_method.defs.map do |defn|
        defn.update(defined_in: defined_in, implemented_in: implemented_in)
      end,
      accessibility: original_method.accessibility,
      alias_of: original_method
    )
  when AST::Members::MethodDefinition
    if duplicated_method = methods[method.name]
      raise DuplicatedMethodDefinitionError.new(
        type: definition.self_type,
        method_name: method.name,
        members: [original, *duplicated_method.members]
      )
    end

    defs = original.overloads.map do |overload|
      Definition::Method::TypeDef.new(
        type: subst.empty? ? overload.method_type : overload.method_type.sub(subst),
        member: original,
        defined_in: defined_in,
        implemented_in: implemented_in
      )
    end

    # @type var accessibility: RBS::Definition::accessibility
    accessibility =
      if original.instance? && [:initialize, :initialize_copy, :initialize_clone, :initialize_dup, :respond_to_missing?].include?(method.name)
        :private
      else
        method.accessibility
      end
    # Skip setting up `super_method` if `implemented_in` is `nil`, that means the type doesn't have implementation.
    # This typically happens if the type is an interface.
    if implemented_in
      super_method = existing_method
    end

    method_definition = Definition::Method.new(
      super_method: super_method,
      defs: defs,
      accessibility: accessibility,
      alias_of: nil
    )
  when AST::Members::AttrReader, AST::Members::AttrWriter, AST::Members::AttrAccessor
    if duplicated_method = methods[method.name]
      raise DuplicatedMethodDefinitionError.new(
        type: definition.self_type,
        method_name: method.name,
        members: [*duplicated_method.members, original]
      )
    end

    attr_type = original.type.sub(subst)
    method_type =
      if method.name.to_s.end_with?("=")
        # setter
        MethodType.new(
          type_params: [],
          type: Types::Function.empty(attr_type).update(
            required_positionals: [
              Types::Function::Param.new(type: attr_type, name: original.name)
            ]
          ),
          block: nil,
          location: original.location
        )
      else
        # getter
        MethodType.new(
          type_params: [],
          type: Types::Function.empty(attr_type),
          block: nil,
          location: original.location
        )
      end

    if implemented_in
      super_method = existing_method
    end

    method_definition = Definition::Method.new(
      super_method: super_method,
      defs: [
        Definition::Method::TypeDef.new(
          type: method_type,
          member: original,
          defined_in: defined_in,
          implemented_in: implemented_in
        )
      ],
      accessibility: method.accessibility,
      alias_of: nil
    )
  when nil
    # Overloading method definition only

    case
    when methods.key?(method.name)
      # The method is defined in an interface
      super_method = methods[method.name].super_method
    when definition.methods.key?(method.name)
      # The method is defined in the super class
      super_method = existing_method
    else
      # Cannot find any non-overloading method
      raise InvalidOverloadMethodError.new(
        type_name: definition.type_name,
        method_name: method.name,
        kind: :instance,
        members: method.overloads
      )
    end

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

  method.overloads.each do |overloading_def|
    overloading_def.overloads.reverse_each do |overload|
      type_def = Definition::Method::TypeDef.new(
        type: subst.empty? ? overload.method_type : overload.method_type.sub(subst),
        member: overloading_def,
        defined_in: defined_in,
        implemented_in: implemented_in
      )

      method_definition.defs.unshift(type_def)
    end
  end

  methods[method.name] = method_definition
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 



751
752
753
 
# File 'lib/rbs/definition_builder.rb', line 751

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

#expand_alias1(type_name) ⇒ Object 



755
756
757
758
759
760
 
# File 'lib/rbs/definition_builder.rb', line 755

def expand_alias1(type_name)
  type_name = env.normalize_type_name(type_name)
  entry = env.type_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 



762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
 
# File 'lib/rbs/definition_builder.rb', line 762

def expand_alias2(type_name, args)
  type_name = env.normalize_type_name(type_name)
  entry = env.type_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

#import_methods(definition, module_name, module_methods, interfaces_methods, subst) ⇒ Object 



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/rbs/definition_builder.rb', line 532

def import_methods(definition, module_name, module_methods, interfaces_methods, subst)
  new_methods = {} #: Hash[Symbol, Definition::Method]
  interface_method_duplicates = Set[] #: Set[Symbol]

  interfaces_methods.each do |interface, (methods, member)|
    unless interface.args.empty?
      methods.type.is_a?(Types::Interface) or raise
      params = methods.type.args.map do |arg|
        arg.is_a?(Types::Variable) or raise
        arg.name
      end

      interface.args.each do |arg|
        validate_type_presence(arg)
      end

      subst_ = subst + Substitution.build(params, interface.args)
    else
      subst_ = subst
    end

    methods.each do |method|
      if interface_method_duplicates.include?(method.name)
        member.is_a?(AST::Members::Include) || member.is_a?(AST::Members::Extend) or raise

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

      interface_method_duplicates << method.name
      define_method(
        new_methods,
        definition,
        method,
        subst_,
        defined_in: interface.name,
        implemented_in: module_name
      )
    end
  end

  module_methods.each do |method|
    define_method(
      new_methods,
      definition,
      method,
      subst,
      defined_in: module_name,
      implemented_in: module_name.interface? ? nil : module_name
    )
  end

  definition.methods.merge!(new_methods)
end

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



524
525
526
527
528
529
530
 
# File 'lib/rbs/definition_builder.rb', line 524

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

#interface_methods(interface_ancestors) ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/rbs/definition_builder.rb', line 398

def interface_methods(interface_ancestors)
  interface_methods = {} #: interface_methods

  interface_ancestors.each do |mod|
    source =
      case mod.source
      when AST::Members::Include, AST::Members::Extend
        mod.source
      else
        raise "Interface mixin must be include/extend: #{mod.source.inspect}"
      end

    methods = method_builder.build_interface(mod.name)

    interface_methods[mod] = [methods, source]
  end

  interface_methods
end

#source_location(source, decl) ⇒ Object 



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/rbs/definition_builder.rb', line 428

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

#tapp_subst(name, args) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/rbs/definition_builder.rb', line 66

def tapp_subst(name, args)
  params =
    case
    when name.interface?
      entry = env.interface_decls[name] or raise "Unknown interface name: #{name}"
      entry.decl.type_params
    when name.alias?
      entry = env.type_alias_decls[name] or raise "Unknown alias name: #{name}"
      entry.decl.type_params
    when name.class?
      entry = env.class_decls[name] or raise "Unknown module name: #{name}"
      entry.type_params
    else
      raise
    end

  Substitution.build(params.map(&:name), args)
end

#try_cache(type_name, cache:) ⇒ Object 



747
748
749
 
# File 'lib/rbs/definition_builder.rb', line 747

def try_cache(type_name, cache:)
  cache[type_name] ||= yield
end

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



786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
 
# File 'lib/rbs/definition_builder.rb', line 786

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)
      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 



418
419
420
421
422
423
424
425
426
 
# File 'lib/rbs/definition_builder.rb', line 418

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

#validate_type_name(name, location) ⇒ Object

Raises:



815
816
817
818
819
820
 
# File 'lib/rbs/definition_builder.rb', line 815

def validate_type_name(name, location)
  name = name.absolute! unless name.absolute?
  return if env.type_name?(env.normalize_type_name(name))

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

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



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'lib/rbs/definition_builder.rb', line 442

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.overloads.map(&:method_type)
                   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|
        merged_params = type_params
          .reject {|param| method_type.type_param_names.include?(param.name) }
          .concat(method_type.type_params)

        result = calculator.in_method_type(method_type: method_type, variables: param_names)
        validate_params_with(merged_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 



804
805
806
807
808
809
810
811
812
813
 
# File 'lib/rbs/definition_builder.rb', line 804

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