yard-sorbet 0.2.0 → 0.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/yard-sorbet.rb +3 -6
- data/lib/yard-sorbet/handlers.rb +11 -0
- data/lib/yard-sorbet/handlers/abstract_dsl_handler.rb +26 -0
- data/lib/yard-sorbet/handlers/enums_handler.rb +28 -0
- data/lib/yard-sorbet/handlers/sig_handler.rb +102 -0
- data/lib/yard-sorbet/{struct_handler.rb → handlers/struct_handler.rb} +27 -19
- data/lib/yard-sorbet/handlers/struct_handler.rbi +5 -0
- data/lib/yard-sorbet/node_utils.rb +69 -0
- data/lib/yard-sorbet/sig_to_yard.rb +105 -81
- data/lib/yard-sorbet/version.rb +3 -1
- metadata +62 -26
- data/lib/yard-sorbet/sig_handler.rb +0 -184
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ca3c823cd78ea11784724185ff336604d2e7b131082945c3fc19200d1b3294cf
|
4
|
+
data.tar.gz: 43b2a6a38cb3161d2452eaa823ac336cbb5dcb0782fb40d0b5ddbf12afe33467
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aff435511b0e40b212c3ffcfd8194cec04a70d9e05ce82865dbbf074376cc6da7d9503a71f395aafde9615c99f524051977d9c6b9aaac971ee1c8f378ab4aa5f
|
7
|
+
data.tar.gz: 746934d64c6bfd728551b43b380cf6efd3da0ccbb9224cbb29bbabe065d17821530e640c3a8377e5935a05d1f9527d51f36da995c21dd0c5821903b86482017f
|
data/lib/yard-sorbet.rb
CHANGED
@@ -4,12 +4,9 @@
|
|
4
4
|
require 'sorbet-runtime'
|
5
5
|
require 'yard'
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
# top-level namespace
|
10
|
-
module YARDSorbet; end
|
7
|
+
require_relative 'yard-sorbet/version'
|
11
8
|
|
12
9
|
require_relative 'yard-sorbet/directives'
|
13
|
-
require_relative 'yard-sorbet/
|
10
|
+
require_relative 'yard-sorbet/handlers'
|
11
|
+
require_relative 'yard-sorbet/node_utils'
|
14
12
|
require_relative 'yard-sorbet/sig_to_yard'
|
15
|
-
require_relative 'yard-sorbet/struct_handler'
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# typed: strong
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# Custom YARD Handlers
|
5
|
+
# @see https://rubydoc.info/gems/yard/YARD/Handlers/Base YARD Base Handler documentation
|
6
|
+
module YARDSorbet::Handlers; end
|
7
|
+
|
8
|
+
require_relative 'handlers/abstract_dsl_handler'
|
9
|
+
require_relative 'handlers/enums_handler'
|
10
|
+
require_relative 'handlers/sig_handler'
|
11
|
+
require_relative 'handlers/struct_handler'
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# typed: strict
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
|
5
|
+
class YARDSorbet::Handlers::AbstractDSLHandler < YARD::Handlers::Ruby::Base
|
6
|
+
extend T::Sig
|
7
|
+
|
8
|
+
handles method_call(:abstract!), method_call(:interface!)
|
9
|
+
namespace_only
|
10
|
+
|
11
|
+
# The text accompanying the `@abstract` tag.
|
12
|
+
# @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb
|
13
|
+
# The `@abstract` tag template
|
14
|
+
TAG_TEXT = 'Subclasses must implement the `abstract` methods below.'
|
15
|
+
# Extra text for class namespaces
|
16
|
+
CLASS_TAG_TEXT = T.let("It cannont be directly instantiated. #{TAG_TEXT}", String)
|
17
|
+
|
18
|
+
sig { void }
|
19
|
+
def process
|
20
|
+
return if namespace.has_tag?(:abstract)
|
21
|
+
|
22
|
+
text = namespace.is_a?(YARD::CodeObjects::ClassObject) ? CLASS_TAG_TEXT : TAG_TEXT
|
23
|
+
tag = YARD::Tags::Tag.new(:abstract, text)
|
24
|
+
namespace.add_tag(tag)
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# typed: strict
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# Handle `enums` calls, registering enum values as constants
|
5
|
+
class YARDSorbet::Handlers::EnumsHandler < YARD::Handlers::Ruby::Base
|
6
|
+
extend T::Sig
|
7
|
+
|
8
|
+
handles method_call(:enums)
|
9
|
+
namespace_only
|
10
|
+
|
11
|
+
sig { void }
|
12
|
+
def process
|
13
|
+
statement.traverse do |node|
|
14
|
+
if const_assign_node?(node)
|
15
|
+
register YARD::CodeObjects::ConstantObject.new(namespace, node.first.source) do |obj|
|
16
|
+
obj.docstring = node.docstring
|
17
|
+
obj.source = node
|
18
|
+
obj.value = node.last.source
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
25
|
+
private def const_assign_node?(node)
|
26
|
+
node.type == :assign && node.children.first.children.first.type == :const
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,102 @@
|
|
1
|
+
# typed: strict
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# A YARD Handler for Sorbet type declarations
|
5
|
+
class YARDSorbet::Handlers::SigHandler < YARD::Handlers::Ruby::Base
|
6
|
+
extend T::Sig
|
7
|
+
|
8
|
+
handles method_call(:sig)
|
9
|
+
namespace_only
|
10
|
+
|
11
|
+
# A struct that holds the parsed contents of a Sorbet type signature
|
12
|
+
class ParsedSig < T::Struct
|
13
|
+
prop :abstract, T::Boolean, default: false
|
14
|
+
prop :params, T::Hash[String, T::Array[String]], default: {}
|
15
|
+
prop :return, T.nilable(T::Array[String])
|
16
|
+
end
|
17
|
+
|
18
|
+
# These node types attached to sigs represent attr_* declarations
|
19
|
+
ATTR_NODE_TYPES = T.let(%i[command fcall], T::Array[Symbol])
|
20
|
+
# Skip these node types when parsing `sig` params
|
21
|
+
PARAM_EXCLUDES = T.let(%i[array call hash].freeze, T::Array[Symbol])
|
22
|
+
# Skip these node types when parsing `sig`s
|
23
|
+
SIG_EXCLUDES = T.let(%i[array hash].freeze, T::Array[Symbol])
|
24
|
+
|
25
|
+
private_constant :ParsedSig, :ATTR_NODE_TYPES, :PARAM_EXCLUDES, :SIG_EXCLUDES
|
26
|
+
|
27
|
+
# Swap the method definition docstring and the sig docstring.
|
28
|
+
# Parse relevant parts of the `sig` and include them as well.
|
29
|
+
sig { void }
|
30
|
+
def process
|
31
|
+
method_node = YARDSorbet::NodeUtils.get_method_node(YARDSorbet::NodeUtils.sibling_node(statement))
|
32
|
+
docstring, directives = YARDSorbet::Directives.extract_directives(statement.docstring)
|
33
|
+
parsed_sig = parse_sig(statement)
|
34
|
+
enhance_tag(docstring, :abstract, parsed_sig)
|
35
|
+
enhance_tag(docstring, :return, parsed_sig)
|
36
|
+
unless ATTR_NODE_TYPES.include?(method_node.type)
|
37
|
+
parsed_sig.params.each do |name, types|
|
38
|
+
enhance_param(docstring, name, types)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
method_node.docstring = docstring.to_raw
|
42
|
+
YARDSorbet::Directives.add_directives(method_node.docstring, directives)
|
43
|
+
statement.docstring = nil
|
44
|
+
end
|
45
|
+
|
46
|
+
sig { params(docstring: YARD::Docstring, name: String, types: T::Array[String]).void }
|
47
|
+
private def enhance_param(docstring, name, types)
|
48
|
+
tag = docstring.tags.find { |t| t.tag_name == 'param' && t.name == name }
|
49
|
+
if tag
|
50
|
+
docstring.delete_tag_if { |t| t == tag }
|
51
|
+
tag.types = types
|
52
|
+
else
|
53
|
+
tag = YARD::Tags::Tag.new(:param, '', types, name)
|
54
|
+
end
|
55
|
+
docstring.add_tag(tag)
|
56
|
+
end
|
57
|
+
|
58
|
+
sig { params(docstring: YARD::Docstring, type: Symbol, parsed_sig: ParsedSig).void }
|
59
|
+
private def enhance_tag(docstring, type, parsed_sig)
|
60
|
+
type_value = parsed_sig.public_send(type)
|
61
|
+
return unless type_value
|
62
|
+
|
63
|
+
tag = docstring.tags.find { |t| t.tag_name == type.to_s }
|
64
|
+
if tag
|
65
|
+
docstring.delete_tags(type)
|
66
|
+
else
|
67
|
+
tag = YARD::Tags::Tag.new(type, '')
|
68
|
+
end
|
69
|
+
if type_value.is_a?(Array)
|
70
|
+
tag.types = type_value
|
71
|
+
end
|
72
|
+
docstring.add_tag(tag)
|
73
|
+
end
|
74
|
+
|
75
|
+
sig { params(sig_node: YARD::Parser::Ruby::MethodCallNode).returns(ParsedSig) }
|
76
|
+
private def parse_sig(sig_node)
|
77
|
+
parsed = ParsedSig.new
|
78
|
+
found_params = T.let(false, T::Boolean)
|
79
|
+
found_return = T.let(false, T::Boolean)
|
80
|
+
YARDSorbet::NodeUtils.bfs_traverse(sig_node, exclude: SIG_EXCLUDES) do |n|
|
81
|
+
if n.source == 'abstract'
|
82
|
+
parsed.abstract = true
|
83
|
+
elsif n.source == 'params' && !found_params
|
84
|
+
found_params = true
|
85
|
+
sibling = YARDSorbet::NodeUtils.sibling_node(n)
|
86
|
+
YARDSorbet::NodeUtils.bfs_traverse(sibling, exclude: PARAM_EXCLUDES) do |p|
|
87
|
+
if p.type == :assoc
|
88
|
+
param_name = p.children.first.source[0...-1]
|
89
|
+
types = YARDSorbet::SigToYARD.convert(p.children.last)
|
90
|
+
parsed.params[param_name] = types
|
91
|
+
end
|
92
|
+
end
|
93
|
+
elsif n.source == 'returns' && !found_return
|
94
|
+
found_return = true
|
95
|
+
parsed.return = YARDSorbet::SigToYARD.convert(YARDSorbet::NodeUtils.sibling_node(n))
|
96
|
+
elsif n.source == 'void'
|
97
|
+
parsed.return ||= ['void']
|
98
|
+
end
|
99
|
+
end
|
100
|
+
parsed
|
101
|
+
end
|
102
|
+
end
|
@@ -1,18 +1,23 @@
|
|
1
1
|
# typed: strict
|
2
2
|
# frozen_string_literal: true
|
3
3
|
|
4
|
-
#
|
4
|
+
# Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
|
5
5
|
# in creating a constructor
|
6
|
-
class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
|
6
|
+
class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
|
7
7
|
extend T::Sig
|
8
8
|
|
9
|
-
handles method_call(:const)
|
9
|
+
handles method_call(:const), method_call(:prop)
|
10
10
|
namespace_only
|
11
11
|
|
12
12
|
sig { void }
|
13
13
|
def process
|
14
14
|
# Store the property for use in the constructor definition
|
15
|
-
name = statement.parameters[0].jump(
|
15
|
+
name = statement.parameters[0].jump(
|
16
|
+
:ident, # handles most "normal" identifiers
|
17
|
+
:kw, # handles prop names using reserved words like `end` or `def`
|
18
|
+
:const # handles capitalized prop names like Foo
|
19
|
+
).source
|
20
|
+
|
16
21
|
doc = statement.docstring.to_s
|
17
22
|
source = statement.source
|
18
23
|
types = YARDSorbet::SigToYARD.convert(statement.parameters[1])
|
@@ -34,34 +39,39 @@ class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
|
|
34
39
|
object = MethodObject.new(namespace, name, scope)
|
35
40
|
object.source = source
|
36
41
|
|
37
|
-
|
42
|
+
# TODO: this should use `+` to delimit the attribute name when markdown is disabled
|
43
|
+
reader_docstring = doc.empty? ? "Returns the value of attribute `#{name}`." : doc
|
38
44
|
docstring = YARD::DocstringParser.new.parse(reader_docstring).to_docstring
|
39
45
|
docstring.add_tag(YARD::Tags::Tag.new(:return, '', types))
|
40
46
|
object.docstring = docstring.to_raw
|
41
47
|
|
42
|
-
# Register the object explicitly as an attribute
|
48
|
+
# Register the object explicitly as an attribute.
|
49
|
+
# While `const` attributes are immutable, `prop` attributes may be reassigned.
|
50
|
+
if statement.method_name.source == 'prop'
|
51
|
+
namespace.attributes[scope][name][:write] = object
|
52
|
+
end
|
43
53
|
namespace.attributes[scope][name][:read] = object
|
44
54
|
end
|
45
55
|
end
|
46
56
|
|
47
|
-
# Class-level handler that folds all `const` declarations into the constructor documentation
|
57
|
+
# Class-level handler that folds all `const` and `prop` declarations into the constructor documentation
|
48
58
|
# this needs to be injected as a module otherwise the default Class handler will overwrite documentation
|
49
|
-
|
59
|
+
#
|
60
|
+
# @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
|
61
|
+
module YARDSorbet::Handlers::StructClassHandler
|
50
62
|
extend T::Sig
|
51
63
|
|
52
64
|
sig { void }
|
53
65
|
def process
|
54
|
-
|
66
|
+
super
|
55
67
|
|
56
|
-
return
|
68
|
+
return if extra_state.prop_docs.nil?
|
57
69
|
|
58
70
|
# lookup the full YARD path for the current class
|
59
|
-
class_ns = YARD::CodeObjects::ClassObject.new(
|
60
|
-
|
61
|
-
)
|
62
|
-
props = T.unsafe(self).extra_state.prop_docs[class_ns]
|
71
|
+
class_ns = YARD::CodeObjects::ClassObject.new(namespace, statement[0].source.gsub(/\s/, ''))
|
72
|
+
props = extra_state.prop_docs[class_ns]
|
63
73
|
|
64
|
-
return
|
74
|
+
return if props.empty?
|
65
75
|
|
66
76
|
# Create a virtual `initialize` method with all the `prop`/`const` arguments
|
67
77
|
# having the name :initialize & the scope :instance marks this as the constructor.
|
@@ -88,14 +98,12 @@ module YARDSorbet::StructClassHandler
|
|
88
98
|
object.source ||= props.map { |p| p[:source] }.join("\n")
|
89
99
|
object.explicit ||= false # not strictly necessary
|
90
100
|
|
91
|
-
|
101
|
+
register(object)
|
92
102
|
|
93
103
|
object.docstring = docstring.to_raw
|
94
104
|
|
95
105
|
YARDSorbet::Directives.add_directives(object.docstring, directives)
|
96
|
-
|
97
|
-
ret
|
98
106
|
end
|
99
107
|
end
|
100
108
|
|
101
|
-
YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::StructClassHandler
|
109
|
+
YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::Handlers::StructClassHandler
|
@@ -0,0 +1,69 @@
|
|
1
|
+
# typed: strict
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
# Helper methods for working with YARD AST Nodes
|
5
|
+
module YARDSorbet::NodeUtils
|
6
|
+
extend T::Sig
|
7
|
+
|
8
|
+
# Command node types that can have type signatures
|
9
|
+
ATTRIBUTE_METHODS = T.let(%i[attr attr_accessor attr_reader attr_writer].freeze, T::Array[Symbol])
|
10
|
+
# Node types that can have type signatures
|
11
|
+
SIGABLE_NODE = T.type_alias do
|
12
|
+
T.any(YARD::Parser::Ruby::MethodDefinitionNode, YARD::Parser::Ruby::MethodCallNode)
|
13
|
+
end
|
14
|
+
|
15
|
+
private_constant :ATTRIBUTE_METHODS, :SIGABLE_NODE
|
16
|
+
|
17
|
+
# Traverese AST nodes in breadth-first order
|
18
|
+
# @yield [YARD::Parser::Ruby::AstNode]
|
19
|
+
sig do
|
20
|
+
params(
|
21
|
+
node: YARD::Parser::Ruby::AstNode,
|
22
|
+
exclude: T::Array[Symbol],
|
23
|
+
_blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void
|
24
|
+
).void
|
25
|
+
end
|
26
|
+
def self.bfs_traverse(node, exclude: [], &_blk)
|
27
|
+
queue = [node]
|
28
|
+
until queue.empty?
|
29
|
+
n = T.must(queue.shift)
|
30
|
+
yield n
|
31
|
+
n.children.each do |c|
|
32
|
+
unless exclude.include?(c.type)
|
33
|
+
queue.push(c)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Gets the node that a sorbet `sig` can be attached do, bypassing visisbility modifiers and the like
|
40
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(SIGABLE_NODE) }
|
41
|
+
def self.get_method_node(node)
|
42
|
+
case node
|
43
|
+
when YARD::Parser::Ruby::MethodDefinitionNode
|
44
|
+
return node
|
45
|
+
when YARD::Parser::Ruby::MethodCallNode
|
46
|
+
return node if ATTRIBUTE_METHODS.include?(node.method_name(true))
|
47
|
+
end
|
48
|
+
|
49
|
+
node.jump(:def, :defs)
|
50
|
+
end
|
51
|
+
|
52
|
+
# Find and return the adjacent node (ascending)
|
53
|
+
# @raise [IndexError] if the node does not have an adjacent sibling (ascending)
|
54
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(YARD::Parser::Ruby::AstNode) }
|
55
|
+
def self.sibling_node(node)
|
56
|
+
siblings = node.parent.children
|
57
|
+
siblings.each_with_index.find do |sibling, i|
|
58
|
+
if sibling.equal?(node)
|
59
|
+
return siblings.fetch(i + 1)
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
# Returns true if the given node represents a type signature.
|
65
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
66
|
+
def self.type_signature?(node)
|
67
|
+
node.is_a?(YARD::Parser::Ruby::MethodCallNode) && node.method_name(true) == :sig
|
68
|
+
end
|
69
|
+
end
|
@@ -1,11 +1,13 @@
|
|
1
1
|
# typed: strict
|
2
2
|
# frozen_string_literal: true
|
3
3
|
|
4
|
-
# Translate sig type syntax to YARD type syntax.
|
4
|
+
# Translate `sig` type syntax to `YARD` type syntax.
|
5
5
|
module YARDSorbet::SigToYARD
|
6
6
|
extend T::Sig
|
7
7
|
|
8
|
+
# Ruby 2.5 parsed call nodes slightly differently
|
8
9
|
IS_LEGACY_RUBY_VERSION = T.let(RUBY_VERSION.start_with?('2.5.'), T::Boolean)
|
10
|
+
private_constant :IS_LEGACY_RUBY_VERSION
|
9
11
|
|
10
12
|
# @see https://yardoc.org/types.html
|
11
13
|
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
@@ -16,81 +18,23 @@ module YARDSorbet::SigToYARD
|
|
16
18
|
end
|
17
19
|
|
18
20
|
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
19
|
-
def self.convert_type(node)
|
20
|
-
children = node.children
|
21
|
+
private_class_method def self.convert_type(node)
|
21
22
|
case node.type
|
22
|
-
when :aref
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
when :arg_paren
|
38
|
-
convert(children.first.children.first)
|
39
|
-
when :array
|
40
|
-
# https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
|
41
|
-
member_types = children.first.children.map { |n| convert(n) }.join(', ')
|
42
|
-
["Array(#{member_types})"]
|
43
|
-
when :call
|
44
|
-
if children[0].source == 'T'
|
45
|
-
t_method = IS_LEGACY_RUBY_VERSION ? children[1].source : children[2].source
|
46
|
-
case t_method
|
47
|
-
when 'all', 'attached_class', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
|
48
|
-
# YARD doesn't have equivalent notions, so we just use the raw source
|
49
|
-
[node.source]
|
50
|
-
when 'any'
|
51
|
-
children.last.children.first.children.map { |n| convert(n) }.flatten
|
52
|
-
when 'nilable'
|
53
|
-
# Order matters here, putting `nil` last results in a more concise
|
54
|
-
# return syntax in the UI (superscripted `?`)
|
55
|
-
convert(children.last) + ['nil']
|
56
|
-
else
|
57
|
-
log.warn("Unsupported T method #{node.source}")
|
58
|
-
[node.source]
|
59
|
-
end
|
60
|
-
else
|
61
|
-
[node.source]
|
62
|
-
end
|
63
|
-
when :const_path_ref, :const
|
64
|
-
case node.source
|
65
|
-
when 'T::Boolean'
|
66
|
-
['Boolean'] # YARD convention for booleans
|
67
|
-
else
|
68
|
-
[node.source]
|
69
|
-
end
|
70
|
-
when :hash, :list
|
71
|
-
# Fixed hashes as return values are unsupported:
|
72
|
-
# https://github.com/lsegal/yard/issues/425
|
73
|
-
#
|
74
|
-
# Hash key params can be individually documented with `@option`, but
|
75
|
-
# sig translation is unsupported.
|
76
|
-
['Hash']
|
77
|
-
when :var_ref
|
78
|
-
# YARD convention is use singleton objects when applicable:
|
79
|
-
# https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Literals
|
80
|
-
case node.source
|
81
|
-
when 'FalseClass'
|
82
|
-
['false']
|
83
|
-
when 'NilClass'
|
84
|
-
['nil']
|
85
|
-
when 'TrueClass'
|
86
|
-
['true']
|
87
|
-
else
|
88
|
-
[node.source]
|
89
|
-
end
|
90
|
-
when :top_const_ref
|
91
|
-
# A top-level constant reference, such as ::Klass
|
92
|
-
# It contains a child node of type :const
|
93
|
-
convert(children.first)
|
23
|
+
when :aref then handle_aref(node)
|
24
|
+
when :arg_paren then handle_arg_paren(node)
|
25
|
+
when :array then handle_array(node)
|
26
|
+
when :call then handle_call(node)
|
27
|
+
when :const_path_ref, :const then handle_const(node)
|
28
|
+
# Fixed hashes as return values are unsupported:
|
29
|
+
# https://github.com/lsegal/yard/issues/425
|
30
|
+
#
|
31
|
+
# Hash key params can be individually documented with `@option`, but
|
32
|
+
# sig translation is unsupported.
|
33
|
+
when :hash, :list then ['Hash']
|
34
|
+
when :var_ref then handle_var_ref(node)
|
35
|
+
# A top-level constant reference, such as ::Klass
|
36
|
+
# It contains a child node of type :const
|
37
|
+
when :top_const_ref then convert(node.children.first)
|
94
38
|
else
|
95
39
|
log.warn("Unsupported sig #{node.type} node #{node.source}")
|
96
40
|
[node.source]
|
@@ -98,14 +42,94 @@ module YARDSorbet::SigToYARD
|
|
98
42
|
end
|
99
43
|
|
100
44
|
sig { params(node: YARD::Parser::Ruby::AstNode).returns(String) }
|
101
|
-
def self.build_generic_type(node)
|
102
|
-
|
45
|
+
private_class_method def self.build_generic_type(node)
|
46
|
+
children = node.children
|
47
|
+
return node.source if children.empty? || node.type != :aref
|
103
48
|
|
104
|
-
collection_type =
|
105
|
-
member_type =
|
106
|
-
.map { |child| build_generic_type(child) }
|
107
|
-
.join(', ')
|
49
|
+
collection_type = children.first.source
|
50
|
+
member_type = children.last.children.map { |child| build_generic_type(child) }.join(', ')
|
108
51
|
|
109
52
|
"#{collection_type}[#{member_type}]"
|
110
53
|
end
|
54
|
+
|
55
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
56
|
+
private_class_method def self.handle_aref(node)
|
57
|
+
children = node.children
|
58
|
+
# https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Parametrized_Types
|
59
|
+
case children.first.source
|
60
|
+
when 'T::Array', 'T::Enumerable', 'T::Range', 'T::Set'
|
61
|
+
collection_type = children.first.source.split('::').last
|
62
|
+
member_type = convert(children.last.children.first).join(', ')
|
63
|
+
["#{collection_type}<#{member_type}>"]
|
64
|
+
when 'T::Hash'
|
65
|
+
kv = children.last.children
|
66
|
+
key_type = convert(kv.first).join(', ')
|
67
|
+
value_type = convert(kv.last).join(', ')
|
68
|
+
["Hash{#{key_type} => #{value_type}}"]
|
69
|
+
else
|
70
|
+
log.info("Unsupported sig aref node #{node.source}")
|
71
|
+
[build_generic_type(node)]
|
72
|
+
end
|
73
|
+
end
|
74
|
+
|
75
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
76
|
+
private_class_method def self.handle_arg_paren(node)
|
77
|
+
convert(node.children.first.children.first)
|
78
|
+
end
|
79
|
+
|
80
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
81
|
+
private_class_method def self.handle_array(node)
|
82
|
+
# https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
|
83
|
+
member_types = node.children.first.children.map { |n| convert(n) }.join(', ')
|
84
|
+
["Array(#{member_types})"]
|
85
|
+
end
|
86
|
+
|
87
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
88
|
+
private_class_method def self.handle_const(node)
|
89
|
+
source = node.source
|
90
|
+
case source
|
91
|
+
# YARD convention for booleans
|
92
|
+
when 'T::Boolean' then ['Boolean']
|
93
|
+
else [source]
|
94
|
+
end
|
95
|
+
end
|
96
|
+
|
97
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
98
|
+
private_class_method def self.handle_call(node)
|
99
|
+
children = node.children
|
100
|
+
if children[0].source == 'T'
|
101
|
+
t_method = IS_LEGACY_RUBY_VERSION ? children[1].source : children[2].source
|
102
|
+
handle_t_method(t_method, node)
|
103
|
+
else
|
104
|
+
[node.source]
|
105
|
+
end
|
106
|
+
end
|
107
|
+
|
108
|
+
sig { params(method_name: String, node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
109
|
+
private_class_method def self.handle_t_method(method_name, node)
|
110
|
+
case method_name
|
111
|
+
# YARD doesn't have equivalent notions, so we just use the raw source
|
112
|
+
when 'all', 'attached_class', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
|
113
|
+
[node.source]
|
114
|
+
when 'any' then node.children.last.children.first.children.map { |n| convert(n) }.flatten
|
115
|
+
# Order matters here, putting `nil` last results in a more concise
|
116
|
+
# return syntax in the UI (superscripted `?`)
|
117
|
+
when 'nilable' then convert(node.children.last) + ['nil']
|
118
|
+
else
|
119
|
+
log.warn("Unsupported T method #{node.source}")
|
120
|
+
[node.source]
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
|
125
|
+
private_class_method def self.handle_var_ref(node)
|
126
|
+
# YARD convention is use singleton objects when applicable:
|
127
|
+
# https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Literals
|
128
|
+
case node.source
|
129
|
+
when 'FalseClass' then ['false']
|
130
|
+
when 'NilClass' then ['nil']
|
131
|
+
when 'TrueClass' then ['true']
|
132
|
+
else [node.source]
|
133
|
+
end
|
134
|
+
end
|
111
135
|
end
|
data/lib/yard-sorbet/version.rb
CHANGED
metadata
CHANGED
@@ -1,29 +1,43 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard-sorbet
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Douglas Eichelberger
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-06-08 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler-audit
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
13
27
|
- !ruby/object:Gem::Dependency
|
14
28
|
name: codecov
|
15
29
|
requirement: !ruby/object:Gem::Requirement
|
16
30
|
requirements:
|
17
|
-
- - "
|
31
|
+
- - ">="
|
18
32
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0
|
33
|
+
version: '0'
|
20
34
|
type: :development
|
21
35
|
prerelease: false
|
22
36
|
version_requirements: !ruby/object:Gem::Requirement
|
23
37
|
requirements:
|
24
|
-
- - "
|
38
|
+
- - ">="
|
25
39
|
- !ruby/object:Gem::Version
|
26
|
-
version: 0
|
40
|
+
version: '0'
|
27
41
|
- !ruby/object:Gem::Dependency
|
28
42
|
name: rake
|
29
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -38,6 +52,20 @@ dependencies:
|
|
38
52
|
- - "~>"
|
39
53
|
- !ruby/object:Gem::Version
|
40
54
|
version: '13.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: redcarpet
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '3.5'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '3.5'
|
41
69
|
- !ruby/object:Gem::Dependency
|
42
70
|
name: rspec
|
43
71
|
requirement: !ruby/object:Gem::Requirement
|
@@ -58,28 +86,28 @@ dependencies:
|
|
58
86
|
requirements:
|
59
87
|
- - "~>"
|
60
88
|
- !ruby/object:Gem::Version
|
61
|
-
version: 1.
|
89
|
+
version: 1.16.0
|
62
90
|
type: :development
|
63
91
|
prerelease: false
|
64
92
|
version_requirements: !ruby/object:Gem::Requirement
|
65
93
|
requirements:
|
66
94
|
- - "~>"
|
67
95
|
- !ruby/object:Gem::Version
|
68
|
-
version: 1.
|
96
|
+
version: 1.16.0
|
69
97
|
- !ruby/object:Gem::Dependency
|
70
98
|
name: rubocop-performance
|
71
99
|
requirement: !ruby/object:Gem::Requirement
|
72
100
|
requirements:
|
73
101
|
- - "~>"
|
74
102
|
- !ruby/object:Gem::Version
|
75
|
-
version: 1.
|
103
|
+
version: 1.11.0
|
76
104
|
type: :development
|
77
105
|
prerelease: false
|
78
106
|
version_requirements: !ruby/object:Gem::Requirement
|
79
107
|
requirements:
|
80
108
|
- - "~>"
|
81
109
|
- !ruby/object:Gem::Version
|
82
|
-
version: 1.
|
110
|
+
version: 1.11.0
|
83
111
|
- !ruby/object:Gem::Dependency
|
84
112
|
name: rubocop-rake
|
85
113
|
requirement: !ruby/object:Gem::Requirement
|
@@ -100,56 +128,56 @@ dependencies:
|
|
100
128
|
requirements:
|
101
129
|
- - "~>"
|
102
130
|
- !ruby/object:Gem::Version
|
103
|
-
version: 2.
|
131
|
+
version: 2.3.0
|
104
132
|
type: :development
|
105
133
|
prerelease: false
|
106
134
|
version_requirements: !ruby/object:Gem::Requirement
|
107
135
|
requirements:
|
108
136
|
- - "~>"
|
109
137
|
- !ruby/object:Gem::Version
|
110
|
-
version: 2.
|
138
|
+
version: 2.3.0
|
111
139
|
- !ruby/object:Gem::Dependency
|
112
140
|
name: rubocop-sorbet
|
113
141
|
requirement: !ruby/object:Gem::Requirement
|
114
142
|
requirements:
|
115
143
|
- - "~>"
|
116
144
|
- !ruby/object:Gem::Version
|
117
|
-
version: 0.
|
145
|
+
version: 0.6.0
|
118
146
|
type: :development
|
119
147
|
prerelease: false
|
120
148
|
version_requirements: !ruby/object:Gem::Requirement
|
121
149
|
requirements:
|
122
150
|
- - "~>"
|
123
151
|
- !ruby/object:Gem::Version
|
124
|
-
version: 0.
|
152
|
+
version: 0.6.0
|
125
153
|
- !ruby/object:Gem::Dependency
|
126
154
|
name: simplecov
|
127
155
|
requirement: !ruby/object:Gem::Requirement
|
128
156
|
requirements:
|
129
|
-
- - "
|
157
|
+
- - ">="
|
130
158
|
- !ruby/object:Gem::Version
|
131
|
-
version: '0
|
159
|
+
version: '0'
|
132
160
|
type: :development
|
133
161
|
prerelease: false
|
134
162
|
version_requirements: !ruby/object:Gem::Requirement
|
135
163
|
requirements:
|
136
|
-
- - "
|
164
|
+
- - ">="
|
137
165
|
- !ruby/object:Gem::Version
|
138
|
-
version: '0
|
166
|
+
version: '0'
|
139
167
|
- !ruby/object:Gem::Dependency
|
140
168
|
name: sorbet
|
141
169
|
requirement: !ruby/object:Gem::Requirement
|
142
170
|
requirements:
|
143
171
|
- - "~>"
|
144
172
|
- !ruby/object:Gem::Version
|
145
|
-
version: 0.5.
|
173
|
+
version: 0.5.6289
|
146
174
|
type: :development
|
147
175
|
prerelease: false
|
148
176
|
version_requirements: !ruby/object:Gem::Requirement
|
149
177
|
requirements:
|
150
178
|
- - "~>"
|
151
179
|
- !ruby/object:Gem::Version
|
152
|
-
version: 0.5.
|
180
|
+
version: 0.5.6289
|
153
181
|
- !ruby/object:Gem::Dependency
|
154
182
|
name: sorbet-runtime
|
155
183
|
requirement: !ruby/object:Gem::Requirement
|
@@ -170,14 +198,14 @@ dependencies:
|
|
170
198
|
requirements:
|
171
199
|
- - ">="
|
172
200
|
- !ruby/object:Gem::Version
|
173
|
-
version: 0.9.
|
201
|
+
version: 0.9.21
|
174
202
|
type: :runtime
|
175
203
|
prerelease: false
|
176
204
|
version_requirements: !ruby/object:Gem::Requirement
|
177
205
|
requirements:
|
178
206
|
- - ">="
|
179
207
|
- !ruby/object:Gem::Version
|
180
|
-
version: 0.9.
|
208
|
+
version: 0.9.21
|
181
209
|
description: 'A YARD plugin that incorporates Sorbet type information
|
182
210
|
|
183
211
|
'
|
@@ -189,17 +217,25 @@ files:
|
|
189
217
|
- LICENSE
|
190
218
|
- lib/yard-sorbet.rb
|
191
219
|
- lib/yard-sorbet/directives.rb
|
192
|
-
- lib/yard-sorbet/
|
220
|
+
- lib/yard-sorbet/handlers.rb
|
221
|
+
- lib/yard-sorbet/handlers/abstract_dsl_handler.rb
|
222
|
+
- lib/yard-sorbet/handlers/enums_handler.rb
|
223
|
+
- lib/yard-sorbet/handlers/sig_handler.rb
|
224
|
+
- lib/yard-sorbet/handlers/struct_handler.rb
|
225
|
+
- lib/yard-sorbet/handlers/struct_handler.rbi
|
226
|
+
- lib/yard-sorbet/node_utils.rb
|
193
227
|
- lib/yard-sorbet/sig_to_yard.rb
|
194
|
-
- lib/yard-sorbet/struct_handler.rb
|
195
228
|
- lib/yard-sorbet/version.rb
|
196
229
|
homepage: https://github.com/dduugg/yard-sorbet
|
197
230
|
licenses:
|
198
231
|
- Apache-2.0
|
199
232
|
metadata:
|
233
|
+
bug_tracker_uri: https://github.com/dduugg/yard-sorbet/issues
|
234
|
+
changelog_uri: https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md
|
235
|
+
documentation_uri: https://dduugg.github.io/yard-sorbet/
|
200
236
|
homepage_uri: https://github.com/dduugg/yard-sorbet
|
201
237
|
source_code_uri: https://github.com/dduugg/yard-sorbet
|
202
|
-
|
238
|
+
wiki_uri: https://github.com/dduugg/yard-sorbet/wiki
|
203
239
|
post_install_message:
|
204
240
|
rdoc_options: []
|
205
241
|
require_paths:
|
@@ -215,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
215
251
|
- !ruby/object:Gem::Version
|
216
252
|
version: '0'
|
217
253
|
requirements: []
|
218
|
-
rubygems_version: 3.
|
254
|
+
rubygems_version: 3.1.4
|
219
255
|
signing_key:
|
220
256
|
specification_version: 4
|
221
257
|
summary: Create YARD docs from Sorbet type signatures
|
@@ -1,184 +0,0 @@
|
|
1
|
-
# typed: strict
|
2
|
-
# frozen_string_literal: true
|
3
|
-
|
4
|
-
# A YARD Handler for Sorbet type declarations
|
5
|
-
class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
|
6
|
-
extend T::Sig
|
7
|
-
handles :class, :module, :singleton_class?
|
8
|
-
|
9
|
-
PARAM_EXCLUDES = T.let(%i[array call hash].freeze, T::Array[Symbol])
|
10
|
-
PROCESSABLE_NODES = T.let(%i[def defs command].freeze, T::Array[Symbol])
|
11
|
-
SIG_EXCLUDES = T.let(%i[array hash].freeze, T::Array[Symbol])
|
12
|
-
SIG_NODE_TYPES = T.let(%i[call fcall vcall].freeze, T::Array[Symbol])
|
13
|
-
private_constant :PARAM_EXCLUDES, :PROCESSABLE_NODES, :SIG_EXCLUDES, :SIG_NODE_TYPES
|
14
|
-
|
15
|
-
sig { void }
|
16
|
-
def process
|
17
|
-
# Find the list of declarations inside the class
|
18
|
-
class_def = statement.children.find { |c| c.type == :list }
|
19
|
-
class_contents = class_def.children
|
20
|
-
|
21
|
-
process_class_contents(class_contents)
|
22
|
-
end
|
23
|
-
|
24
|
-
sig { params(class_contents: T::Array[YARD::Parser::Ruby::MethodCallNode]).void }
|
25
|
-
private def process_class_contents(class_contents)
|
26
|
-
class_contents.each_with_index do |child, i|
|
27
|
-
if child.type == :sclass && child.children.size == 2 && child.children[1].type == :list
|
28
|
-
singleton_class_contents = child.children[1]
|
29
|
-
process_class_contents(singleton_class_contents)
|
30
|
-
end
|
31
|
-
next unless type_signature?(child)
|
32
|
-
|
33
|
-
next_statement = class_contents[i + 1]
|
34
|
-
next unless processable_method?(next_statement)
|
35
|
-
|
36
|
-
process_method_definition(T.must(next_statement), child)
|
37
|
-
end
|
38
|
-
end
|
39
|
-
|
40
|
-
sig { params(next_statement: T.nilable(YARD::Parser::Ruby::AstNode)).returns(T::Boolean) }
|
41
|
-
private def processable_method?(next_statement)
|
42
|
-
PROCESSABLE_NODES.include?(next_statement&.type)
|
43
|
-
end
|
44
|
-
|
45
|
-
sig do
|
46
|
-
params(
|
47
|
-
method_node: YARD::Parser::Ruby::AstNode,
|
48
|
-
sig_node: YARD::Parser::Ruby::MethodCallNode
|
49
|
-
).void
|
50
|
-
end
|
51
|
-
private def process_method_definition(method_node, sig_node)
|
52
|
-
# Swap the method definition docstring and the sig docstring.
|
53
|
-
# Parse relevant parts of the `sig` and include them as well.
|
54
|
-
docstring, directives = YARDSorbet::Directives.extract_directives(sig_node.docstring)
|
55
|
-
parsed_sig = parse_sig(sig_node)
|
56
|
-
enhance_tag(docstring, :abstract, parsed_sig)
|
57
|
-
enhance_tag(docstring, :return, parsed_sig)
|
58
|
-
if method_node.type != :command
|
59
|
-
parsed_sig[:params]&.each do |name, types|
|
60
|
-
enhance_param(docstring, name, types)
|
61
|
-
end
|
62
|
-
end
|
63
|
-
method_node.docstring = docstring.to_raw
|
64
|
-
YARDSorbet::Directives.add_directives(method_node.docstring, directives)
|
65
|
-
sig_node.docstring = nil
|
66
|
-
end
|
67
|
-
|
68
|
-
sig { params(docstring: YARD::Docstring, name: String, types: T::Array[String]).void }
|
69
|
-
private def enhance_param(docstring, name, types)
|
70
|
-
tag = docstring.tags.find { |t| t.tag_name == 'param' && t.name == name }
|
71
|
-
if tag
|
72
|
-
docstring.delete_tag_if { |t| t == tag }
|
73
|
-
tag.types = types
|
74
|
-
else
|
75
|
-
tag = YARD::Tags::Tag.new(:param, '', types, name)
|
76
|
-
end
|
77
|
-
docstring.add_tag(tag)
|
78
|
-
end
|
79
|
-
|
80
|
-
sig { params(docstring: YARD::Docstring, type: Symbol, parsed_sig: T::Hash[Symbol, Object]).void }
|
81
|
-
private def enhance_tag(docstring, type, parsed_sig)
|
82
|
-
return if !parsed_sig[type]
|
83
|
-
|
84
|
-
tag = docstring.tags.find { |t| t.tag_name == type.to_s }
|
85
|
-
if tag
|
86
|
-
docstring.delete_tags(type)
|
87
|
-
else
|
88
|
-
tag = YARD::Tags::Tag.new(type, '')
|
89
|
-
end
|
90
|
-
if parsed_sig[type].is_a?(Array)
|
91
|
-
tag.types = parsed_sig[type]
|
92
|
-
end
|
93
|
-
docstring.add_tag(tag)
|
94
|
-
end
|
95
|
-
|
96
|
-
sig do
|
97
|
-
params(sig_node: YARD::Parser::Ruby::MethodCallNode)
|
98
|
-
.returns(
|
99
|
-
{
|
100
|
-
abstract: T::Boolean,
|
101
|
-
params: T::Hash[String, T::Array[String]],
|
102
|
-
return: T.nilable(T::Array[String])
|
103
|
-
}
|
104
|
-
)
|
105
|
-
end
|
106
|
-
private def parse_sig(sig_node)
|
107
|
-
parsed = {
|
108
|
-
abstract: false,
|
109
|
-
params: {},
|
110
|
-
return: nil
|
111
|
-
}
|
112
|
-
found_params = T.let(false, T::Boolean)
|
113
|
-
found_return = T.let(false, T::Boolean)
|
114
|
-
bfs_traverse(sig_node, exclude: SIG_EXCLUDES) do |n|
|
115
|
-
if n.source == 'abstract'
|
116
|
-
parsed[:abstract] = true
|
117
|
-
elsif n.source == 'params' && !found_params
|
118
|
-
found_params = true
|
119
|
-
sibling = T.must(sibling_node(n))
|
120
|
-
bfs_traverse(sibling, exclude: PARAM_EXCLUDES) do |p|
|
121
|
-
if p.type == :assoc
|
122
|
-
param_name = p.children.first.source[0...-1]
|
123
|
-
types = YARDSorbet::SigToYARD.convert(p.children.last)
|
124
|
-
parsed[:params][param_name] = types
|
125
|
-
end
|
126
|
-
end
|
127
|
-
elsif n.source == 'returns' && !found_return
|
128
|
-
found_return = true
|
129
|
-
parsed[:return] = YARDSorbet::SigToYARD.convert(T.must(sibling_node(n)))
|
130
|
-
elsif n.source == 'void'
|
131
|
-
parsed[:return] ||= ['void']
|
132
|
-
end
|
133
|
-
end
|
134
|
-
parsed
|
135
|
-
end
|
136
|
-
|
137
|
-
# Returns true if the given node is part of a type signature.
|
138
|
-
sig { params(node: T.nilable(YARD::Parser::Ruby::AstNode)).returns(T::Boolean) }
|
139
|
-
private def type_signature?(node)
|
140
|
-
loop do
|
141
|
-
return false if node.nil?
|
142
|
-
return false unless SIG_NODE_TYPES.include?(node.type)
|
143
|
-
return true if T.unsafe(node).method_name(true) == :sig
|
144
|
-
|
145
|
-
node = T.let(node.children.first, T.nilable(YARD::Parser::Ruby::AstNode))
|
146
|
-
end
|
147
|
-
end
|
148
|
-
|
149
|
-
sig { params(node: YARD::Parser::Ruby::AstNode).returns(T.nilable(YARD::Parser::Ruby::AstNode)) }
|
150
|
-
private def sibling_node(node)
|
151
|
-
found_sibling = T.let(false, T::Boolean)
|
152
|
-
node.parent.children.each do |n|
|
153
|
-
if found_sibling
|
154
|
-
return n
|
155
|
-
end
|
156
|
-
|
157
|
-
if n == node
|
158
|
-
found_sibling = true
|
159
|
-
end
|
160
|
-
end
|
161
|
-
nil
|
162
|
-
end
|
163
|
-
|
164
|
-
# @yield [YARD::Parser::Ruby::AstNode]
|
165
|
-
sig do
|
166
|
-
params(
|
167
|
-
node: YARD::Parser::Ruby::AstNode,
|
168
|
-
exclude: T::Array[Symbol],
|
169
|
-
_blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void
|
170
|
-
).void
|
171
|
-
end
|
172
|
-
private def bfs_traverse(node, exclude: [], &_blk)
|
173
|
-
queue = [node]
|
174
|
-
while !queue.empty?
|
175
|
-
n = T.must(queue.shift)
|
176
|
-
yield n
|
177
|
-
n.children.each do |c|
|
178
|
-
if !exclude.include?(c.type)
|
179
|
-
queue.push(c)
|
180
|
-
end
|
181
|
-
end
|
182
|
-
end
|
183
|
-
end
|
184
|
-
end
|