Class: Solargraph::ComplexType::UniqueType

Inherits:
Object
  • Object
show all
Includes:
TypeMethods, Equality, Logging
Defined in:
lib/solargraph/complex_type/unique_type.rb

Overview

An individual type signature. A complex type can consist of multiple unique types.

Constant Summary collapse

UNDEFINED = 
UniqueType.new('undefined', rooted: false)
BOOLEAN = 
UniqueType.new('Boolean', rooted: true)
TRUE = 
UniqueType.new('true', rooted: true)
FALSE = 
UniqueType.new('false', rooted: true)
NIL = 
UniqueType.new('nil', rooted: true)
SINGLE_SUBTYPE = 
{
  '::TrueClass' => UniqueType::TRUE,
  '::FalseClass' => UniqueType::FALSE,
  '::NilClass' => UniqueType::NIL
}.freeze

Constants included from Logging

Logging::DEFAULT_LOG_LEVEL, Logging::LOG_LEVELS

Constants included from TypeMethods

TypeMethods::PARAMETERS_TYPE_BY_STARTING_TAG

Instance Attribute Summary collapse

Attributes included from TypeMethods

#name, #parameters_type

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Logging

logger

Methods included from Equality

#freeze

Methods included from TypeMethods

#defined?, #duck_type?, #each_unique_type, #erase_generics, #fixed_parameters?, #generate_substring_from, #hash_parameters?, #list_parameters?, #namespace, #namespace_type, #nil_type?, #rooted_name, #rooted_namespace, #rooted_substring, #rooted_tag, #scope, #substring, #tag, #tuple?, #undefined?, #value_types, #void?

Constructor Details

#initialize(name, key_types = [], subtypes = [], rooted:, parameters_type: nil) ⇒ UniqueType

Returns a new instance of UniqueType.

Parameters:

  • name (String)
  • key_types (Array<ComplexType>) (defaults to: [])
  • subtypes (Array<ComplexType>) (defaults to: [])
  • rooted (Boolean)
  • parameters_type (Symbol, nil) (defaults to: nil) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 77

def initialize(name, key_types = [], subtypes = [], rooted:, parameters_type: nil)
  if parameters_type.nil?
    raise "You must supply parameters_type if you provide parameters" unless key_types.empty? && subtypes.empty?
  end
  raise "Please remove leading :: and set rooted instead - #{name.inspect}" if name.start_with?('::')
  @name = name
  @parameters_type = parameters_type
  if implicit_union?
    @key_types = key_types.uniq
    @subtypes = subtypes.uniq
  else
    @key_types = key_types
    @subtypes = subtypes
  end
  @rooted = rooted
  @all_params = []
  @all_params.concat @key_types
  @all_params.concat @subtypes
end

Instance Attribute Details

#all_params ⇒ Object (readonly)

Returns the value of attribute all_params.



12
13
14
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 12

def all_params
  @all_params
end

#key_types ⇒ Object (readonly)

Returns the value of attribute key_types.



12
13
14
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 12

def key_types
  @key_types
end

#subtypes ⇒ Object (readonly)

Returns the value of attribute subtypes.



12
13
14
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 12

def subtypes
  @subtypes
end

Class Method Details

.can_root_name?(name) ⇒ Boolean

Parameters:

  • name (String)

Returns:

  • (Boolean) 


454
455
456
457
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 454

def self.can_root_name?(name)
  # name is not lowercase

  !name.empty? && name != name.downcase
end

.parse(name, substring = '', make_rooted: nil) ⇒ UniqueType

Create a UniqueType with the specified name and an optional substring. The substring is the parameter section of a parametrized type, e.g., for the type ‘Array<String>`, the name is `Array` and the substring is `<String>`.

Parameters:

  • name (String) —

    The name of the type

  • substring (String) (defaults to: '') —

    The substring of the type

  • make_rooted (Boolean, nil) (defaults to: nil)

Returns:



28
29
30
31
32
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
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 28

def self.parse name, substring = '', make_rooted: nil
  if name.start_with?(':::')
    raise ComplexTypeError, "Illegal prefix: #{name}"
  end
  if name.start_with?('::')
    name = name[2..-1]
    rooted = true
  elsif !can_root_name?(name)
    rooted = true
  else
    rooted = false
  end
  rooted = make_rooted unless make_rooted.nil?

  # @type [Array<ComplexType>]

  key_types = []
  # @type [Array<ComplexType>]

  subtypes = []
  parameters_type = nil
  unless substring.empty?
    subs = ComplexType.parse(substring[1..-2], partial: true)
    parameters_type = PARAMETERS_TYPE_BY_STARTING_TAG.fetch(substring[0])
    if parameters_type == :hash
      raise ComplexTypeError, "Bad hash type: name=#{name}, substring=#{substring}" unless !subs.is_a?(ComplexType) and subs.length == 2 and !subs[0].is_a?(UniqueType) and !subs[1].is_a?(UniqueType)
      # @todo should be able to resolve map; both types have it

      #   with same return type

      # @sg-ignore

      key_types.concat(subs[0].map { |u| ComplexType.new([u]) })
      # @sg-ignore

      subtypes.concat(subs[1].map { |u| ComplexType.new([u]) })
    elsif parameters_type == :list && name == 'Hash'
      # Treat Hash<A, B> as Hash{A => B}

      if subs.length != 2
        raise ComplexTypeError, "Bad hash type: name=#{name}, substring=#{substring} - must have exactly two parameters"
      end
      key_types.concat(subs[0].map { |u| ComplexType.new([u]) })
      subtypes.concat(subs[1].map { |u| ComplexType.new([u]) })
    else
      subtypes.concat subs
    end
  end
  new(name, key_types, subtypes, rooted: rooted, parameters_type: parameters_type)
end

Instance Method Details

#==(other) ⇒ Object 



150
151
152
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 150

def ==(other)
  eql?(other)
end

#all_rooted? ⇒ Boolean

Returns:

  • (Boolean) 


440
441
442
443
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 440

def all_rooted?
  return true if name == GENERIC_TAG_NAME
  rooted? && all_params.all?(&:rooted?)
end

#can_assign?(api_map, atype) ⇒ Boolean

Parameters:

  • api_map (ApiMap) —

    The ApiMap that performs qualification

  • atype (ComplexType) —

    type which may be assigned to this type

Returns:

  • (Boolean) 


241
242
243
244
245
246
247
248
249
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 241

def can_assign?(api_map, atype)
  logger.debug { "UniqueType#can_assign?(self=#{rooted_tags.inspect}, atype=#{atype.rooted_tags.inspect})" }
  downcasted_atype = atype.downcast_to_literal_if_possible
  out = downcasted_atype.all? do |autype|
    autype.name == name || api_map.super_and_sub?(name, autype.name)
  end
  logger.debug { "UniqueType#can_assign?(self=#{rooted_tags.inspect}, atype=#{atype.rooted_tags.inspect}) => #{out}" }
  out
end

#can_root_name?(name_to_check = name) ⇒ Boolean

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 449

def can_root_name?(name_to_check = name)
  self.class.can_root_name?(name_to_check)
end

#desc ⇒ Object 



174
175
176
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 174

def desc
  rooted_tags
end

#determine_non_literal_name ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 123

def determine_non_literal_name
  # https://github.com/ruby/rbs/blob/master/docs/syntax.md

  #

  # _literal_ ::= _string-literal_

  #    | _symbol-literal_

  #    | _integer-literal_

  #    | `true`

  #    | `false`

  return name if name.empty?
  return 'NilClass' if name == 'nil'
  return 'Boolean' if ['true', 'false'].include?(name)
  return 'Symbol' if name[0] == ':'
  return 'String' if ['"', "'"].include?(name[0])
  return 'Integer' if name.match?(/^-?\d+$/)
  name
end

#downcast_to_literal_if_possible ⇒ UniqueType

Returns:



252
253
254
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 252

def downcast_to_literal_if_possible
  SINGLE_SUBTYPE.fetch(rooted_tag, self)
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
143
144
145
146
147
148
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 140

def eql?(other)
  self.class == other.class &&
    @name == other.name &&
    @key_types == other.key_types &&
    @subtypes == other.subtypes &&
    @rooted == other.rooted? &&
    @all_params == other.all_params &&
    @parameters_type == other.parameters_type
end

#force_rooted ⇒ self

Returns:

  • (self) 


381
382
383
384
385
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 381

def force_rooted
  transform do |t|
    t.recreate(make_rooted: true)
  end
end

#generic? ⇒ Boolean

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 235

def generic?
  name == GENERIC_TAG_NAME || all_params.any?(&:generic?)
end

#hash ⇒ Object 



154
155
156
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 154

def hash
  [self.class, @name, @key_types, @sub_types, @rooted, @all_params, @parameters_type].hash
end

#implicit_union? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
102
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 97

def implicit_union?
  # @todo use api_map to establish number of generics in type;

  #   if only one is allowed but multiple are passed in, treat

  #   those as implicit unions

  ['Hash', 'Array', 'Set', '_ToAry', 'Enumerable', '_Each'].include?(name) && parameters_type != :fixed
end

#items ⇒ Array<UniqueType>

Returns:



159
160
161
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 159

def items
  [self]
end

#literal? ⇒ Boolean

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 115

def literal?
  non_literal_name != name
end

#map {|t| ... } ⇒ Array<self>

Yield Parameters:

  • t (self)

Yield Returns:

  • (self)

Returns:

  • (Array<self>) 


345
346
347
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 345

def map &block
  [block.yield(self)]
end

#non_literal_name ⇒ Object 



119
120
121
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 119

def non_literal_name
  @non_literal_name ||= determine_non_literal_name
end

#parameters? ⇒ Boolean

Returns:

  • (Boolean) 


209
210
211
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 209

def parameters?
  !all_params.empty?
end

#parameters_as_rbs ⇒ String

Returns:

  • (String) 


224
225
226
227
228
229
230
231
232
233
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 224

def parameters_as_rbs
  return '' unless parameters?

  return "[#{all_params.map(&:to_rbs).join(', ')}]" if key_types.empty?

  # handle, e.g., Hash[K, V] case

  key_types_str = rbs_union(key_types)
  subtypes_str = rbs_union(subtypes)
  "[#{key_types_str}, #{subtypes_str}]"
end

#qualify(api_map, context = '') ⇒ self, ...

Generate a ComplexType that fully qualifies this type’s namespaces.

Parameters:

  • api_map (ApiMap) —

    The ApiMap that performs qualification

  • context (String) (defaults to: '') —

    The namespace from which to resolve names

Returns:



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 412

def qualify api_map, context = ''
  transform do |t|
    next t if t.name == GENERIC_TAG_NAME
    next t if t.duck_type? || t.void? || t.undefined?
    recon = (t.rooted? ? '' : context)
    fqns = api_map.qualify(t.name, recon)
    if fqns.nil?
      next UniqueType::BOOLEAN if t.tag == 'Boolean'
      next UniqueType::UNDEFINED
    end
    t.recreate(new_name: fqns, make_rooted: true)
  end
end

#rbs_name ⇒ String

Returns:

  • (String) 


164
165
166
167
168
169
170
171
172
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 164

def rbs_name
  if name == 'undefined'
    'untyped'
  elsif literal?
    name
  else
    rooted_name
  end
end

#rbs_union(types) ⇒ String

Parameters:

Returns:

  • (String) 


215
216
217
218
219
220
221
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 215

def rbs_union(types)
  if types.length == 1
    types.first.to_rbs
  else
    "(#{types.map(&:to_rbs).join(' | ')})"
  end
end

#recreate(new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil) ⇒ self

Parameters:

  • new_name (String, nil) (defaults to: nil)
  • make_rooted (Boolean, nil) (defaults to: nil)
  • new_key_types (Array<UniqueType>, nil) (defaults to: nil)
  • rooted (Boolean, nil)
  • new_subtypes (Array<UniqueType>, nil) (defaults to: nil)

Returns:

  • (self) 


360
361
362
363
364
365
366
367
368
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 360

def recreate(new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil)
  raise "Please remove leading :: and set rooted instead - #{new_name}" if new_name&.start_with?('::')

  new_name ||= name
  new_key_types ||= @key_types
  new_subtypes ||= @subtypes
  make_rooted = @rooted if make_rooted.nil?
  UniqueType.new(new_name, new_key_types, new_subtypes, rooted: make_rooted, parameters_type: parameters_type)
end

#resolve_generics(definitions, context_type) ⇒ UniqueType, ComplexType

Probe the concrete type for each of the generic type parameters used in this type, and return a new type if possible.

Parameters:

Returns:



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
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 311

def resolve_generics definitions, context_type
  return self if definitions.nil? || definitions.generics.empty?

  transform(name) do |t|
    if t.name == GENERIC_TAG_NAME
      generic_name = t.subtypes.first&.name
      idx = definitions.generics.index(generic_name)
      next t if idx.nil?
      if context_type.parameters_type == :hash
        if idx == 0
          next ComplexType.new(context_type.key_types)
        elsif idx == 1
          next ComplexType.new(context_type.subtypes)
        else
          next ComplexType::UNDEFINED
        end
      elsif context_type.all?(&:implicit_union?)
        if idx == 0 && !context_type.all_params.empty?
          ComplexType.new(context_type.all_params)
        else
          ComplexType::UNDEFINED
        end
      else
        context_type.all_params[idx] || definitions.generic_defaults[generic_name] || ComplexType::UNDEFINED
      end
    else
      t
    end
  end
end

#resolve_generics_from_context(generics_to_resolve, context_type, resolved_generic_values: {}) ⇒ UniqueType, ComplexType

Parameters:

  • generics_to_resolve (Enumerable<String>)
  • context_type (UniqueType, nil)
  • resolved_generic_values (Hash{String => ComplexType}) (defaults to: {}) —

    Added to as types are encountered or resolved

Returns:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 260

def resolve_generics_from_context generics_to_resolve, context_type, resolved_generic_values: {}
  if name == ComplexType::GENERIC_TAG_NAME
    type_param = subtypes.first&.name
    return self unless generics_to_resolve.include? type_param
    unless context_type.nil? || !resolved_generic_values[type_param].nil?
      new_binding = true
      resolved_generic_values[type_param] = context_type
    end
    if new_binding
      resolved_generic_values.transform_values! do |complex_type|
        complex_type.resolve_generics_from_context(generics_to_resolve, nil, resolved_generic_values: resolved_generic_values)
      end
    end
    return resolved_generic_values[type_param] || self
  end

  # @todo typechecking should complain when the method being called has no @yieldparam tag

  new_key_types = resolve_param_generics_from_context(generics_to_resolve, context_type, resolved_generic_values, &:key_types)
  new_subtypes = resolve_param_generics_from_context(generics_to_resolve, context_type, resolved_generic_values, &:subtypes)
  recreate(new_key_types: new_key_types, new_subtypes: new_subtypes)
end

#resolve_param_generics_from_context(generics_to_resolve, context_type, resolved_generic_values) ⇒ Array<ComplexType>

Parameters:

  • generics_to_resolve (Enumerable<String>)
  • context_type (UniqueType)
  • resolved_generic_values (Hash{String => ComplexType})

Yield Returns:

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 287

def resolve_param_generics_from_context(generics_to_resolve, context_type, resolved_generic_values)
  types = yield self
  types.each_with_index.flat_map do |ct, i|
    ct.items.flat_map do |ut|
      context_params = yield context_type if context_type
      if context_params && context_params[i]
        type_arg = context_params[i]
        type_arg.map do |new_unique_context_type|
          ut.resolve_generics_from_context generics_to_resolve, new_unique_context_type, resolved_generic_values: resolved_generic_values
        end
      else
        ut.resolve_generics_from_context generics_to_resolve, nil, resolved_generic_values: resolved_generic_values
      end
    end
  end
end

#rooted? ⇒ Boolean

Returns:

  • (Boolean) 


445
446
447
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 445

def rooted?
  !can_root_name? || @rooted
end

#rooted_tags ⇒ String

Returns:

  • (String) 


371
372
373
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 371

def rooted_tags
  rooted_tag
end

#self_to_type(dst) ⇒ self

Parameters:

Returns:

  • (self) 


432
433
434
435
436
437
438
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 432

def self_to_type dst
  object_type_dst = dst.reduce_class_type
  transform do |t|
    next t if t.name != 'self'
    object_type_dst
  end
end

#selfy? ⇒ Boolean

Returns:

  • (Boolean) 


426
427
428
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 426

def selfy?
  @name == 'self' || @key_types.any?(&:selfy?) || @subtypes.any?(&:selfy?)
end

#simplify_literals ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 108

def simplify_literals
  transform do |t|
    next t unless t.literal?
    t.recreate(new_name: t.non_literal_name)
  end
end

#tags ⇒ String

Returns:

  • (String) 


376
377
378
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 376

def tags
  tag
end

#to_a ⇒ Array<UniqueType>

Returns:



350
351
352
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 350

def to_a
  [self]
end

#to_rbs ⇒ String

Returns:

  • (String) 


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
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 179

def to_rbs
  if duck_type?
    'untyped'
  elsif name == 'Boolean'
    'bool'
  elsif name.downcase == 'nil'
    'nil'
  elsif name == GENERIC_TAG_NAME
    all_params.first.name
  elsif ['Class', 'Module'].include?(name)
    rbs_name
  elsif ['Tuple', 'Array'].include?(name) && fixed_parameters?
    # tuples don't have a name; they're just [foo, bar, baz].

    if substring == '()'
      # but there are no zero element tuples, so we go with an array

      if rooted?
        '::Array[]'
      else
        'Array[]'
      end
    else
      # already generated surrounded by []

      parameters_as_rbs
    end
  else
    "#{rbs_name}#{parameters_as_rbs}"
  end
end

#to_s ⇒ Object 



104
105
106
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 104

def to_s
  tag
end

#transform(new_name = nil) {|t| ... } ⇒ self

Apply the given transformation to each subtype and then finally to this type

Parameters:

  • new_name (String, nil) (defaults to: nil)

Yield Parameters:

Yield Returns:

  • (self)

Returns:

  • (self) 


393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/solargraph/complex_type/unique_type.rb', line 393

def transform(new_name = nil, &transform_type)
  raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}" if new_name&.start_with?('::')
  if name == ComplexType::GENERIC_TAG_NAME
    # doesn't make sense to manipulate the name of the generic

    new_key_types = @key_types
    new_subtypes = @subtypes
  else
    new_key_types = @key_types.flat_map { |ct| ct.items.map { |ut| ut.transform(&transform_type) } }
    new_subtypes = @subtypes.flat_map { |ct| ct.items.map { |ut| ut.transform(&transform_type) } }
  end
  new_type = recreate(new_name: new_name || name, new_key_types: new_key_types, new_subtypes: new_subtypes, make_rooted: @rooted)
  yield new_type
end