Class: Steep::Interface::Params

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

Defined Under Namespace

Classes: OptionalPositional, RequiredPositional, RestPositional

Constant Summary collapse

NONE = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(required:, optional:, rest:, required_keywords:, optional_keywords:, rest_keywords:) ⇒ Params

Returns a new instance of Params.



11
12
13
14
15
16
17
18
 
# File 'lib/steep/interface/method_type.rb', line 11

def initialize(required:, optional:, rest:, required_keywords:, optional_keywords:, rest_keywords:)
  @required = required
  @optional = optional
  @rest = rest
  @required_keywords = required_keywords
  @optional_keywords = optional_keywords
  @rest_keywords = rest_keywords
end

Instance Attribute Details

#optional ⇒ Object (readonly)

Returns the value of attribute optional.



5
6
7
 
# File 'lib/steep/interface/method_type.rb', line 5

def optional
  @optional
end

#optional_keywords ⇒ Object (readonly)

Returns the value of attribute optional_keywords.



8
9
10
 
# File 'lib/steep/interface/method_type.rb', line 8

def optional_keywords
  @optional_keywords
end

#required ⇒ Object (readonly)

Returns the value of attribute required.



4
5
6
 
# File 'lib/steep/interface/method_type.rb', line 4

def required
  @required
end

#required_keywords ⇒ Object (readonly)

Returns the value of attribute required_keywords.



7
8
9
 
# File 'lib/steep/interface/method_type.rb', line 7

def required_keywords
  @required_keywords
end

#rest ⇒ Object (readonly)

Returns the value of attribute rest.



6
7
8
 
# File 'lib/steep/interface/method_type.rb', line 6

def rest
  @rest
end

#rest_keywords ⇒ Object (readonly)

Returns the value of attribute rest_keywords.



9
10
11
 
# File 'lib/steep/interface/method_type.rb', line 9

def rest_keywords
  @rest_keywords
end

Class Method Details

.empty ⇒ Object 



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/steep/interface/method_type.rb', line 66

def self.empty
  self.new(
    required: [],
    optional: [],
    rest: nil,
    required_keywords: {},
    optional_keywords: {},
    rest_keywords: nil
  )
end

Instance Method Details

#&(other) ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
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
523
524
525
526
527
528
 
# File 'lib/steep/interface/method_type.rb', line 398

def &(other)
  a = first_param
  b = other.first_param

  case
  when a.is_a?(RequiredPositional) && b.is_a?(RequiredPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other.drop_first).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.is_a?(OptionalPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other.drop_first).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.is_a?(RestPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.nil?
    (self.drop_first & other).with_first_param(RequiredPositional.new(AST::Types::Bot.new))
  when a.is_a?(OptionalPositional) && b.is_a?(RequiredPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other.drop_first).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.is_a?(OptionalPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.is_a?(RestPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.nil?
    self.drop_first & other
  when a.is_a?(RestPositional) && b.is_a?(RequiredPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self & other.drop_first).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.is_a?(OptionalPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self & other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.is_a?(RestPositional)
    AST::Types::Intersection.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first & other.drop_first).with_first_param(RestPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.nil?
    self.drop_first & other
  when a.nil? && b.is_a?(RequiredPositional)
    (self & other.drop_first).with_first_param(RequiredPositional.new(AST::Types::Bot.new))
  when a.nil? && b.is_a?(OptionalPositional)
    self & other.drop_first
  when a.nil? && b.is_a?(RestPositional)
    self & other.drop_first
  when a.nil? && b.nil?
    optional_keywords = {}

    (Set.new(self.optional_keywords.keys) & Set.new(other.optional_keywords.keys)).each do |keyword|
      self.optional_keywords[keyword] = AST::Types::Intersection.build(
        types: [
          self.optional_keywords[keyword],
          other.optional_keywords[keyword]
        ]
      )
    end

    required_keywords = {}
    self.optional_keywords.each do |keyword, t|
      unless optional_keywords.key?(keyword)
        case
        when other.required_keywords.key?(keyword)
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, other.required_keywords[keyword]])
        when other.rest_keywords
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, other.rest_keywords])
        else
          required_keywords[keyword] = t
        end
      end
    end
    other.optional_keywords.each do |keyword, t|
      unless optional_keywords.key?(keyword)
        case
        when self.required_keywords.key?(keyword)
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, self.required_keywords[keyword]])
        when self.rest_keywords
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, self.rest_keywords])
        else
          required_keywords[keyword] = t
        end
      end
    end
    self.required_keywords.each do |keyword, t|
      unless required_keywords.key?(keyword)
        case
        when other.required_keywords.key?(keyword)
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, other.required_keywords[keyword]])
        when other.rest_keywords
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, other.rest_keywords])
        else
          required_keywords[keyword] = t
        end
      end
    end
    other.required_keywords.each do |keyword, t|
      unless required_keywords.key?(keyword)
        case
        when self.required_keywords.key?(keyword)
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, self.required_keywords[keyword]])
        when self.rest_keywords
          required_keywords[keyword] = AST::Types::Intersection.build(types: [t, self.rest_keywords])
        else
          required_keywords[keyword] = t
        end
      end
    end

    rest = case
           when self.rest_keywords && other.rest_keywords
             AST::Types::Intersection.build(types: [self.rest_keywords, other.rest_keywords])
           else
             self.rest_keywords || other.rest_keywords
           end

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

#==(other) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/steep/interface/method_type.rb', line 77

def ==(other)
  other.is_a?(self.class) &&
    other.required == required &&
    other.optional == optional &&
    other.rest == rest &&
    other.required_keywords == required_keywords &&
    other.optional_keywords == optional_keywords &&
    other.rest_keywords == rest_keywords
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


222
223
224
 
# File 'lib/steep/interface/method_type.rb', line 222

def closed?
  required.all?(&:closed?) && optional.all?(&:closed?) && (!rest || rest.closed?) && required_keywords.values.all?(&:closed?) && optional_keywords.values.all?(&:closed?) && (!rest_keywords || rest_keywords.closed?)
end

#drop_first ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/steep/interface/method_type.rb', line 110

def drop_first
  case
  when required.any? || optional.any? || rest
    self.class.new(
      required: required.any? ? required.drop(1) : [],
      optional: required.empty? && optional.any? ? optional.drop(1) : optional,
      rest: required.empty? && optional.empty? ? nil : rest,
      required_keywords: required_keywords,
      optional_keywords: optional_keywords,
      rest_keywords: rest_keywords
    )
  when has_keywords?
    without_keywords
  else
    raise "Cannot drop from empty params"
  end
end

#each_extra_argument(args) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/steep/interface/method_type.rb', line 136

def each_extra_argument(args)
  return if rest

  if has_keywords?
    args = args.take(args.count - 1) if args.count > 0
  end

  args.size.times do |index|
    if index >= required.count + optional.count
      yield index
    end
  end
end

#each_extra_keyword(args) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/steep/interface/method_type.rb', line 162

def each_extra_keyword(args)
  return unless has_keywords?
  return if rest_keywords

  keywords, rest = extract_keywords(args)

  return unless rest.empty?

  all_keywords = flat_keywords
  keywords.each do |keyword, _|
    yield keyword unless all_keywords.key?(keyword)
  end
end

#each_missing_argument(args) ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/steep/interface/method_type.rb', line 128

def each_missing_argument(args)
  required.size.times do |index|
    if index >= args.size
      yield index
    end
  end
end

#each_missing_keyword(args) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/steep/interface/method_type.rb', line 150

def each_missing_keyword(args)
  return unless has_keywords?

  keywords, rest = extract_keywords(args)

  return unless rest.empty?

  required_keywords.each do |keyword, _|
    yield keyword unless keywords.key?(keyword)
  end
end

#each_type ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/steep/interface/method_type.rb', line 199

def each_type()
  if block_given?
    flat_unnamed_params.each do |(_, type)|
      yield type
    end
    flat_keywords.each do |_, type|
      yield type
    end
    rest and yield rest
    rest_keywords and yield rest_keywords
  else
    enum_for :each_type
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
 
# File 'lib/steep/interface/method_type.rb', line 262

def empty?
  !has_positional? && !has_keywords?
end

#extract_keywords(args) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/steep/interface/method_type.rb', line 176

def extract_keywords(args)
  last_arg = args.last

  keywords = {}
  rest = []

  if last_arg&.type == :hash
    last_arg.children.each do |element|
      case element.type
      when :pair
        if element.children[0].type == :sym
          name = element.children[0].children[0]
          keywords[name] = element.children[1]
        end
      when :kwsplat
        rest << element.children[0]
      end
    end
  end

  [keywords, rest]
end

#first_param ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/steep/interface/method_type.rb', line 36

def first_param
  case
  when !required.empty?
    RequiredPositional.new(required[0])
  when !optional.empty?
    OptionalPositional.new(optional[0])
  when rest
    RestPositional.new(rest)
  else
    nil
  end
end

#flat_keywords ⇒ Object 



91
92
93
 
# File 'lib/steep/interface/method_type.rb', line 91

def flat_keywords
  required_keywords.merge optional_keywords
end

#flat_unnamed_params ⇒ Object 



87
88
89
 
# File 'lib/steep/interface/method_type.rb', line 87

def flat_unnamed_params
  required.map {|p| [:required, p] } + optional.map {|p| [:optional, p] }
end

#free_variables ⇒ Object 



214
215
216
217
218
219
220
 
# File 'lib/steep/interface/method_type.rb', line 214

def free_variables
  Set.new.tap do |fvs|
    each_type do |type|
      fvs.merge type.free_variables
    end
  end
end

#has_keywords? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/steep/interface/method_type.rb', line 95

def has_keywords?
  !required_keywords.empty? || !optional_keywords.empty? || rest_keywords
end

#has_positional? ⇒ Boolean

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/steep/interface/method_type.rb', line 62

def has_positional?
  first_param
end

#map_type(&block) ⇒ Object 



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/steep/interface/method_type.rb', line 251

def map_type(&block)
  self.class.new(
    required: required.map(&block),
    optional: optional.map(&block),
    rest: rest && yield(rest),
    required_keywords: required_keywords.transform_values(&block),
    optional_keywords: optional_keywords.transform_values(&block),
    rest_keywords: rest_keywords && yield(rest_keywords)
  )
end

#size ⇒ Object 



237
238
239
 
# File 'lib/steep/interface/method_type.rb', line 237

def size
  required.size + optional.size + (rest ? 1 : 0) + required_keywords.size + optional_keywords.size + (rest_keywords ? 1 : 0)
end

#subst(s) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/steep/interface/method_type.rb', line 226

def subst(s)
  self.class.new(
    required: required.map {|t| t.subst(s) },
    optional: optional.map {|t| t.subst(s) },
    rest: rest&.subst(s),
    required_keywords: required_keywords.transform_values {|t| t.subst(s) },
    optional_keywords: optional_keywords.transform_values {|t| t.subst(s) },
    rest_keywords: rest_keywords&.subst(s)
  )
end

#to_s ⇒ Object 



241
242
243
244
245
246
247
248
249
 
# File 'lib/steep/interface/method_type.rb', line 241

def to_s
  required = self.required.map {|ty| ty.to_s }
  optional = self.optional.map {|ty| "?#{ty}" }
  rest = self.rest ? ["*#{self.rest}"] : []
  required_keywords = self.required_keywords.map {|name, type| "#{name}: #{type}" }
  optional_keywords = self.optional_keywords.map {|name, type| "?#{name}: #{type}"}
  rest_keywords = self.rest_keywords ? ["**#{self.rest_keywords}"] : []
  "(#{(required + optional + rest + required_keywords + optional_keywords + rest_keywords).join(", ")})"
end

#update(required: NONE, optional: NONE, rest: NONE, required_keywords: NONE, optional_keywords: NONE, rest_keywords: NONE) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/steep/interface/method_type.rb', line 21

def update(required: NONE, optional: NONE, rest: NONE, required_keywords: NONE, optional_keywords: NONE, rest_keywords: NONE)
  self.class.new(
    required: required.equal?(NONE) ? self.required : required,
    optional: optional.equal?(NONE) ? self.optional : optional,
    rest: rest.equal?(NONE) ? self.rest : rest,
    required_keywords: required_keywords.equal?(NONE) ? self.required_keywords : required_keywords,
    optional_keywords: optional_keywords.equal?(NONE) ? self.optional_keywords : optional_keywords,
    rest_keywords: rest_keywords.equal?(NONE) ? self.rest_keywords : rest_keywords
  )
end

#with_first_param(param) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/steep/interface/method_type.rb', line 49

def with_first_param(param)
  case param
  when RequiredPositional
    update(required: [param.type] + required)
  when OptionalPositional
    update(optional: [param.type] + required)
  when RestPositional
    update(rest: param.type)
  else
    self
  end
end

#without_keywords ⇒ Object 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/steep/interface/method_type.rb', line 99

def without_keywords
  self.class.new(
    required: required,
    optional: optional,
    rest: rest,
    required_keywords: {},
    optional_keywords: {},
    rest_keywords: nil
  )
end

#|(other) ⇒ Object 



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
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/steep/interface/method_type.rb', line 266

def |(other)
  a = first_param
  b = other.first_param

  case
  when a.is_a?(RequiredPositional) && b.is_a?(RequiredPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other.drop_first).with_first_param(RequiredPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.is_a?(OptionalPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.is_a?(RestPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(RequiredPositional) && b.nil?
    (self.drop_first | other).with_first_param(OptionalPositional.new(a.type))
  when a.is_a?(OptionalPositional) && b.is_a?(RequiredPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.is_a?(OptionalPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.is_a?(RestPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(OptionalPositional) && b.nil?
    (self.drop_first | other).with_first_param(OptionalPositional.new(a.type))
  when a.is_a?(RestPositional) && b.is_a?(RequiredPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self | other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.is_a?(OptionalPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self | other.drop_first).with_first_param(OptionalPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.is_a?(RestPositional)
    AST::Types::Union.build(types: [a.type, b.type]).yield_self do |type|
      (self.drop_first | other.drop_first).with_first_param(RestPositional.new(type))
    end
  when a.is_a?(RestPositional) && b.nil?
    (self.drop_first | other).with_first_param(RestPositional.new(a.type))
  when a.nil? && b.is_a?(RequiredPositional)
    (self | other.drop_first).with_first_param(OptionalPositional.new(b.type))
  when a.nil? && b.is_a?(OptionalPositional)
    (self | other.drop_first).with_first_param(OptionalPositional.new(b.type))
  when a.nil? && b.is_a?(RestPositional)
    (self | other.drop_first).with_first_param(RestPositional.new(b.type))
  when a.nil? && b.nil?
    required_keywords = {}

    (Set.new(self.required_keywords.keys) & Set.new(other.required_keywords.keys)).each do |keyword|
      required_keywords[keyword] = AST::Types::Union.build(
        types: [
          self.required_keywords[keyword],
          other.required_keywords[keyword]
        ]
      )
    end

    optional_keywords = {}
    self.required_keywords.each do |keyword, t|
      unless required_keywords.key?(keyword)
        case
        when other.optional_keywords.key?(keyword)
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, other.optional_keywords[keyword]])
        when other.rest_keywords
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, other.rest_keywords])
        else
          optional_keywords[keyword] = t
        end
      end
    end
    other.required_keywords.each do |keyword, t|
      unless required_keywords.key?(keyword)
        case
        when self.optional_keywords.key?(keyword)
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, self.optional_keywords[keyword]])
        when self.rest_keywords
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, self.rest_keywords])
        else
          optional_keywords[keyword] = t
        end
      end
    end
    self.optional_keywords.each do |keyword, t|
      unless optional_keywords.key?(keyword)
        case
        when other.optional_keywords.key?(keyword)
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, other.optional_keywords[keyword]])
        when other.rest_keywords
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, other.rest_keywords])
        else
          optional_keywords[keyword] = t
        end
      end
    end
    other.optional_keywords.each do |keyword, t|
      unless optional_keywords.key?(keyword)
        case
        when self.optional_keywords.key?(keyword)
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, self.optional_keywords[keyword]])
        when self.rest_keywords
          optional_keywords[keyword] = AST::Types::Union.build(types: [t, self.rest_keywords])
        else
          optional_keywords[keyword] = t
        end
      end
    end

    rest = case
           when self.rest_keywords && other.rest_keywords
             AST::Types::Union.build(types: [self.rest_keywords, other.rest_keywords])
           else
             self.rest_keywords || other.rest_keywords
           end

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