Class: Steep::Interface::Builder

Inherits:
Object
  • Object
show all
Defined in:
lib/steep/interface/builder.rb

Defined Under Namespace

Classes: RecursiveDefinitionError

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(signatures:) ⇒ Builder 



20
21
22
23
 
# File 'lib/steep/interface/builder.rb', line 20

def initialize(signatures:)
  @cache = {}
  @signatures = signatures
end

Instance Attribute Details

#cache ⇒ Object (readonly)

Returns the value of attribute cache.



18
19
20
 
# File 'lib/steep/interface/builder.rb', line 18

def cache
  @cache
end

#signatures ⇒ Object (readonly)

Returns the value of attribute signatures.



17
18
19
 
# File 'lib/steep/interface/builder.rb', line 17

def signatures
  @signatures
end

Instance Method Details

#absolute_type(type, current:) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/steep/interface/builder.rb', line 53

def absolute_type(type, current:)
  case type
  when AST::Types::Name
    AST::Types::Name.new(
      name: absolute_type_name(type.name, current: current),
      args: type.args.map {|ty| absolute_type(ty, current: current) },
      location: type.location
    )
  when AST::Types::Union
    AST::Types::Union.build(
      types: type.types.map {|ty| absolute_type(ty, current: current) },
      location: type.location
    )
  when AST::Types::Intersection
    AST::Types::Intersection.build(
      types: type.types.map {|ty| absolute_type(ty, current: current) },
      location: type.location
    )
  else
    type
  end
end

#absolute_type_name(type_name, current:) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/steep/interface/builder.rb', line 25

def absolute_type_name(type_name, current:)
  if current
    begin
      case type_name
      when TypeName::Instance
        type_name.map_module_name {|name|
          signatures.find_class_or_module(name, current_module: current).name
        }
      when TypeName::Module
        type_name.map_module_name {|name|
          signatures.find_module(name, current_module: current).name
        }
      when TypeName::Class
        type_name.map_module_name {|name|
          signatures.find_class(name, current_module: current).name
        }
      else
        type_name
      end
    rescue => exn
      STDERR.puts "Cannot find absolute type name: #{exn.inspect}"
      type_name
    end
  else
    type_name.map_module_name(&:absolute!)
  end
end

#add_method(type_name, method, methods:) ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/steep/interface/builder.rb', line 135

def add_method(type_name, method, methods:)
  super_method = methods[method.name]
  new_method = Method.new(
    type_name: type_name,
    name: method.name,
    types: method.types.map do |method_type|
      method_type_to_method_type(method_type, current: type_name.name)
    end,
    super_method: super_method,
    attributes: method.attributes
  )

  methods[method.name] = if super_method&.include_in_chain?(new_method)
                           super_method
                         else
                           new_method
                         end
end

#build(type_name, current: nil, with_initialize: false) ⇒ Object 



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
 
# File 'lib/steep/interface/builder.rb', line 76

def build(type_name, current: nil, with_initialize: false)
  type_name = absolute_type_name(type_name, current: current)
  cache_key = [type_name, with_initialize]
  cached = cache[cache_key]

  case cached
  when nil
    begin
      cache[cache_key] = type_name

      interface = case type_name
                  when TypeName::Instance
                    instance_to_interface(signatures.find_class_or_module(type_name.name), with_initialize: with_initialize)
                  when TypeName::Module
                    module_to_interface(signatures.find_module(type_name.name))
                  when TypeName::Class
                    class_to_interface(signatures.find_class_or_module(type_name.name),
                                       constructor: type_name.constructor)
                  when TypeName::Interface
                    interface_to_interface(type_name.name,
                                           signatures.find_interface(type_name.name))
                  else
                    raise "Unexpected type_name: #{type_name.inspect}"
                  end

      cache[cache_key]= interface
    rescue RecursiveDefinitionError => exn
      exn.chain.unshift(type_name)
      raise
    end
  when TypeName::Base
    raise RecursiveDefinitionError, type_name
  else
    cached
  end
end

#class_to_interface(sig, constructor:) ⇒ Object 



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
 
# File 'lib/steep/interface/builder.rb', line 154

def class_to_interface(sig, constructor:)
  type_name = TypeName::Class.new(name: sig.name, constructor: constructor)

  supers = []
  methods = {
    new: Method.new(
      type_name: TypeName::Class.new(name: "Builtin", constructor: true),
      name: :new,
      types: [
        MethodType.new(type_params: [],
                       params: Params.empty,
                       block: nil,
                       return_type: AST::Types::Instance.new,
                       location: nil
        )
      ],
      super_method: nil,
      attributes: []
    )
  }

  klass = build(TypeName::Instance.new(name: ModuleName.parse("::Class")))
  instantiated = klass.instantiate(
    type: AST::Types::Self.new,
    args: [AST::Types::Instance.new],
    instance_type: AST::Types::Instance.new,
    module_type: AST::Types::Class.new
  )
  methods.merge!(instantiated.methods)

  unless sig.name == ModuleName.parse("::BasicObject")
    super_class_name = sig.super_class&.name&.absolute! || ModuleName.parse("::Object")
    merge_mixin(TypeName::Class.new(name: super_class_name, constructor: constructor),
                [],
                methods: methods,
                ivars: {},
                supers: supers,
                current: sig.name)
  end

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Include
      merge_mixin(TypeName::Module.new(name: member.name),
                  [],
                  methods: methods,
                  supers: supers,
                  ivars: {},
                  current: sig.name)
    when AST::Signature::Members::Extend
      merge_mixin(TypeName::Instance.new(name: member.name),
                  member.args.map {|type| absolute_type(type, current: sig.name) },
                  methods: methods,
                  ivars: {},
                  supers: supers,
                  current: sig.name)
    end
  end

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Method
      case
      when member.module_method?
        add_method(type_name, member, methods: methods)
      when member.instance_method? && member.name == :initialize
        if constructor
          methods[:new] = Method.new(
            type_name: type_name,
            name: :new,
            types: member.types.map do |method_type_sig|
              method_type = method_type_to_method_type(method_type_sig, current: sig.name).with(return_type: AST::Types::Instance.new)
              args = (sig.params&.variables || []) + method_type.type_params

              method_type.with(
                type_params: args,
                return_type: AST::Types::Instance.new
              )
            end,
            super_method: nil,
            attributes: []
          )
        end
      end
    end
  end

  unless constructor
    methods.delete(:new)
  end

  Abstract.new(
    name: type_name,
    params: [],
    methods: methods,
    supers: supers,
    ivar_chains: {}
  )
end

#instance_to_interface(sig, with_initialize:) ⇒ Object 



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
 
# File 'lib/steep/interface/builder.rb', line 306

def instance_to_interface(sig, with_initialize:)
  type_name = TypeName::Instance.new(name: sig.name)

  params = sig.params&.variables || []
  supers = []
  methods = {}
  ivar_chains = {}

  if sig.is_a?(AST::Signature::Class)
    unless sig.name == ModuleName.parse("::BasicObject")
      super_class_name = sig.super_class&.name || ModuleName.parse("::Object")
      super_class_interface = build(TypeName::Instance.new(name: super_class_name), current: nil)

      supers.push(*super_class_interface.supers)
      instantiated = super_class_interface.instantiate(
        type: AST::Types::Self.new,
        args: (sig.super_class&.args || []).map {|type| absolute_type(type, current: nil) },
        instance_type: AST::Types::Instance.new,
        module_type: AST::Types::Class.new
      )

      methods.merge!(instantiated.methods)
      merge_ivars(ivar_chains, instantiated.ivars)
    end
  end

  if sig.is_a?(AST::Signature::Module)
    if sig.self_type
      supers << sig.self_type
    end
  end

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Include
      merge_mixin(TypeName::Instance.new(name: member.name),
                  member.args.map {|type| absolute_type(type, current: sig.name) },
                  methods: methods,
                  ivars: ivar_chains,
                  supers: supers,
                  current: sig.name)
    end
  end

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Method
      if member.instance_method?
        if with_initialize || member.name != :initialize
          add_method(type_name, member, methods: methods)
        end
      end
    when AST::Signature::Members::Ivar
      merge_ivars(ivar_chains,
                  { member.name => absolute_type(member.type, current: sig.name) })
    when AST::Signature::Members::Attr
      if member.ivar != false
        ivar_name = member.ivar || "@#{member.name}".to_sym
        merge_ivars(ivar_chains,
                    { ivar_name => absolute_type(member.type, current: sig.name) })
      end

      reader_method = AST::Signature::Members::Method.new(
        location: member.location,
        name: member.name,
        kind: :instance,
        types: [
          AST::MethodType.new(location: member.type.location,
                              type_params: nil,
                              params: nil,
                              block: nil,
                              return_type: member.type)
        ],
        attributes: []
      )
      add_method(type_name, reader_method, methods: methods)

      if member.accessor?
        writer_method = AST::Signature::Members::Method.new(
          location: member.location,
          name: "#{member.name}=".to_sym,
          kind: :instance,
          types: [
            AST::MethodType.new(location: member.type.location,
                                type_params: nil,
                                params: AST::MethodType::Params::Required.new(location: member.type.location,
                                                                              type: member.type),
                                block: nil,
                                return_type: member.type)
          ],
          attributes: []
        )
        add_method(type_name, writer_method, methods: methods)
      end
    end
  end

  signatures.find_extensions(sig.name).each do |ext|
    ext.members.each do |member|
      case member
      when AST::Signature::Members::Method
        if member.instance_method?
          add_method(type_name, member, methods: methods)
        end
      end
    end
  end

  Abstract.new(
    name: type_name,
    params: params,
    methods: methods,
    supers: supers,
    ivar_chains: ivar_chains
  )
end

#interface_to_interface(_, sig) ⇒ Object 



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/steep/interface/builder.rb', line 429

def interface_to_interface(_, sig)
  type_name = TypeName::Interface.new(name: sig.name)

  variables = sig.params&.variables || []
  methods = sig.methods.each.with_object({}) do |method, methods|
    methods[method.name] = Method.new(
      type_name: type_name,
      name: method.name,
      types: method.types.map do |method_type|
        method_type_to_method_type(method_type, current: nil)
      end,
      super_method: nil,
      attributes: []
    )
  end

  Abstract.new(
    name: type_name,
    params: variables,
    methods: methods,
    supers: [],
    ivar_chains: {}
  )
end

#merge_ivars(dest, new_vars) ⇒ Object 



423
424
425
426
427
 
# File 'lib/steep/interface/builder.rb', line 423

def merge_ivars(dest, new_vars)
  new_vars.each do |name, new_type|
    dest[name] = IvarChain.new(type: new_type, parent: dest[name])
  end
end

#merge_mixin(type_name, args, methods:, ivars:, supers:, current:) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/steep/interface/builder.rb', line 113

def merge_mixin(type_name, args, methods:, ivars:, supers:, current:)
  mixed = block_given? ? yield : build(type_name, current: current)

  supers.push(*mixed.supers)
  instantiated = mixed.instantiate(
    type: AST::Types::Self.new,
    args: args,
    instance_type: AST::Types::Instance.new,
    module_type: AST::Types::Class.new
  )

  methods.merge!(instantiated.methods) do |_, super_method, new_method|
    if super_method.include_in_chain?(new_method)
      super_method
    else
      new_method.with_super(super_method)
    end
  end

  merge_ivars ivars, instantiated.ivars
end

#method_type_to_method_type(method_type, current:) ⇒ Object 



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/steep/interface/builder.rb', line 454

def method_type_to_method_type(method_type, current:)
  type_params = method_type.type_params&.variables || []
  params = params_to_params(method_type.params, current: current)
  block = method_type.block && Block.new(
    params: params_to_params(method_type.block.params, current: current),
    return_type: absolute_type(method_type.block.return_type, current: current)
  )

  MethodType.new(
    type_params: type_params,
    return_type: absolute_type(method_type.return_type, current: current),
    block: block,
    params: params,
    location: method_type.location
  )
end

#module_to_interface(sig) ⇒ Object 



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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/steep/interface/builder.rb', line 254

def module_to_interface(sig)
  type_name = TypeName::Module.new(name: sig.name)

  supers = [sig.self_type].compact.map {|type| absolute_type(type, current: nil) }
  methods = {}

  module_instance = build(TypeName::Instance.new(name: ModuleName.parse("::Module")))
  instantiated = module_instance.instantiate(
    type: AST::Types::Self.new,
    args: [],
    instance_type: AST::Types::Instance.new,
    module_type: AST::Types::Class.new
  )
  methods.merge!(instantiated.methods)

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Include
      merge_mixin(TypeName::Module.new(name: member.name),
                  member.args.map {|type| absolute_type(type, current: sig.name) },
                  methods: methods,
                  ivars: {},
                  supers: supers,
                  current: sig.name)
    when AST::Signature::Members::Extend
      merge_mixin(TypeName::Instance.new(name: member.name),
                  member.args.map {|type| absolute_type(type, current: sig.name) },
                  methods: methods,
                  ivars: {},
                  supers: supers,
                  current: sig.name)
    end
  end

  sig.members.each do |member|
    case member
    when AST::Signature::Members::Method
      if member.module_method?
        add_method(type_name, member, methods: methods)
      end
    end
  end

  Abstract.new(
    name: type_name,
    params: [],
    methods: methods,
    supers: supers,
    ivar_chains: {}
  )
end

#params_to_params(params, current:) ⇒ 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
 
# File 'lib/steep/interface/builder.rb', line 471

def params_to_params(params, current:)
  required = []
  optional = []
  rest = nil
  required_keywords = {}
  optional_keywords = {}
  rest_keywords = nil

  while params
    case params
    when AST::MethodType::Params::Required
      required << absolute_type(params.type, current: current)
    when AST::MethodType::Params::Optional
      optional << absolute_type(params.type, current: current)
    when AST::MethodType::Params::Rest
      rest = absolute_type(params.type, current: current)
    when AST::MethodType::Params::RequiredKeyword
      required_keywords[params.name] = absolute_type(params.type, current: current)
    when AST::MethodType::Params::OptionalKeyword
      optional_keywords[params.name] = absolute_type(params.type, current: current)
    when AST::MethodType::Params::RestKeyword
      rest_keywords = absolute_type(params.type, current: current)
      break
    end
    params = params.next_params
  end

  Params.new(
    required: required,
    optional: optional,
    rest: rest,
    required_keywords: required_keywords,
    optional_keywords: optional_keywords,
    rest_keywords: rest_keywords
  )
end