packwerk 3.2.0 → 3.2.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/packwerk/association_inspector.rb +17 -4
- data/lib/packwerk/checker.rb +3 -3
- data/lib/packwerk/configuration.rb +4 -0
- data/lib/packwerk/const_node_inspector.rb +2 -2
- data/lib/packwerk/constant_name_inspector.rb +2 -2
- data/lib/packwerk/offenses_formatter.rb +3 -3
- data/lib/packwerk/package.rb +1 -1
- data/lib/packwerk/package_todo.rb +1 -4
- data/lib/packwerk/parsers/factory.rb +3 -3
- data/lib/packwerk/parsers/ruby.rb +7 -0
- data/lib/packwerk/reference_extractor.rb +29 -1
- data/lib/packwerk/reference_offense.rb +1 -1
- data/lib/packwerk/run_context.rb +15 -4
- data/lib/packwerk/validator.rb +3 -3
- data/lib/packwerk/version.rb +1 -1
- data/lib/packwerk.rb +1 -0
- data/sorbet/config +1 -0
- data/sorbet/rbi/gems/actionpack@7.0.3.1.rbi +3280 -3450
- data/sorbet/rbi/gems/actionview@7.0.3.1.rbi +2322 -1782
- data/sorbet/rbi/gems/activesupport@7.0.3.1.rbi +2654 -3268
- data/sorbet/rbi/gems/ast@2.4.2.rbi +535 -6
- data/sorbet/rbi/gems/better_html@2.0.1.rbi +529 -0
- data/sorbet/rbi/gems/builder@3.2.4.rbi +4 -4
- data/sorbet/rbi/gems/byebug@11.1.3.rbi +32 -4
- data/sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi +1750 -1840
- data/sorbet/rbi/gems/constant_resolver@0.2.0.rbi +15 -15
- data/sorbet/rbi/gems/crass@1.0.6.rbi +489 -5
- data/sorbet/rbi/gems/erubi@1.11.0.rbi +24 -21
- data/sorbet/rbi/gems/i18n@1.12.0.rbi +395 -395
- data/sorbet/rbi/gems/json@2.6.2.rbi +70 -77
- data/sorbet/rbi/gems/language_server-protocol@3.16.0.3.rbi +1 -1
- data/sorbet/rbi/gems/loofah@2.18.0.rbi +134 -134
- data/sorbet/rbi/gems/m@1.6.0.rbi +60 -60
- data/sorbet/rbi/gems/method_source@1.1.0.rbi +303 -0
- data/sorbet/rbi/gems/minitest-focus@1.3.1.rbi +22 -28
- data/sorbet/rbi/gems/minitest@5.16.2.rbi +384 -396
- data/sorbet/rbi/gems/mocha@1.14.0.rbi +589 -589
- data/sorbet/rbi/gems/netrc@0.11.0.rbi +37 -32
- data/sorbet/rbi/gems/nokogiri@1.15.3.rbi +962 -946
- data/sorbet/rbi/gems/{parallel@1.22.1.rbi → parallel@1.24.0.rbi} +85 -82
- data/sorbet/rbi/gems/{parser@3.2.2.0.rbi → parser@3.3.1.0.rbi} +1679 -1609
- data/sorbet/rbi/gems/prettier_print@0.1.0.rbi +1 -1
- data/sorbet/rbi/gems/{prism@0.24.0.rbi → prism@0.27.0.rbi} +13473 -6472
- data/sorbet/rbi/gems/{racc@1.6.0.rbi → racc@1.7.1.rbi} +42 -33
- data/sorbet/rbi/gems/rack-test@2.0.2.rbi +148 -338
- data/sorbet/rbi/gems/rack@2.2.4.rbi +1079 -1130
- data/sorbet/rbi/gems/rails-dom-testing@2.0.3.rbi +354 -22
- data/sorbet/rbi/gems/rails-html-sanitizer@1.4.3.rbi +113 -259
- data/sorbet/rbi/gems/railties@7.0.3.1.rbi +642 -638
- data/sorbet/rbi/gems/rainbow@3.1.1.rbi +109 -99
- data/sorbet/rbi/gems/rake@13.0.6.rbi +714 -599
- data/sorbet/rbi/gems/{rbi@0.0.15.rbi → rbi@0.1.12.rbi} +865 -801
- data/sorbet/rbi/gems/regexp_parser@2.5.0.rbi +853 -870
- data/sorbet/rbi/gems/rexml@3.2.5.rbi +480 -477
- data/sorbet/rbi/gems/rubocop-ast@1.21.0.rbi +1621 -1622
- data/sorbet/rbi/gems/rubocop-performance@1.14.3.rbi +507 -526
- data/sorbet/rbi/gems/rubocop-shopify@2.9.0.rbi +1 -1
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +186 -203
- data/sorbet/rbi/gems/rubocop@1.34.1.rbi +8126 -8367
- data/sorbet/rbi/gems/{ruby-lsp@0.2.1.rbi → ruby-lsp@0.2.3.rbi} +2 -2
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +1235 -4
- data/sorbet/rbi/gems/smart_properties@1.17.0.rbi +90 -90
- data/sorbet/rbi/gems/spoom@1.3.2.rbi +4420 -0
- data/sorbet/rbi/gems/spring@4.0.0.rbi +104 -104
- data/sorbet/rbi/gems/syntax_tree@3.3.0.rbi +1 -1
- data/sorbet/rbi/gems/{tapioca@0.9.2.rbi → tapioca@0.13.3.rbi} +1596 -1253
- data/sorbet/rbi/gems/{thor@1.2.1.rbi → thor@1.3.1.rbi} +1047 -652
- data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +531 -513
- data/sorbet/rbi/gems/unicode-display_width@2.2.0.rbi +13 -13
- data/sorbet/rbi/gems/{yard-sorbet@0.6.1.rbi → yard-sorbet@0.8.1.rbi} +132 -92
- data/sorbet/rbi/gems/{yard@0.9.28.rbi → yard@0.9.36.rbi} +3158 -3067
- data/sorbet/rbi/gems/zeitwerk@2.6.4.rbi +149 -145
- metadata +22 -94
- data/.github/ISSUE_TEMPLATE/bug_report.md +0 -27
- data/.github/pull_request_template.md +0 -28
- data/.github/workflows/ci.yml +0 -93
- data/.github/workflows/cla.yml +0 -22
- data/.gitignore +0 -13
- data/.rubocop.yml +0 -75
- data/.ruby-version +0 -1
- data/CODEOWNERS +0 -1
- data/CODE_OF_CONDUCT.md +0 -76
- data/CONTRIBUTING.md +0 -17
- data/Gemfile +0 -27
- data/Gemfile.lock +0 -206
- data/RESOLVING_VIOLATIONS.md +0 -76
- data/Rakefile +0 -22
- data/TROUBLESHOOT.md +0 -44
- data/UPGRADING.md +0 -66
- data/USAGE.md +0 -364
- data/bin/console +0 -15
- data/bin/m +0 -29
- data/bin/rake +0 -29
- data/bin/rubocop +0 -29
- data/bin/setup +0 -8
- data/bin/srb +0 -29
- data/bin/tapioca +0 -29
- data/dev.yml +0 -32
- data/docs/cohesion.png +0 -0
- data/gemfiles/Gemfile-rails-6-0 +0 -22
- data/gemfiles/Gemfile-rails-6-1 +0 -22
- data/packwerk.gemspec +0 -59
- data/shipit.rubygems.yml +0 -5
- data/sorbet/rbi/gems/actioncable@7.0.3.1.rbi +0 -2754
- data/sorbet/rbi/gems/actionmailbox@7.0.3.1.rbi +0 -1496
- data/sorbet/rbi/gems/actionmailer@7.0.3.1.rbi +0 -2362
- data/sorbet/rbi/gems/actiontext@7.0.3.1.rbi +0 -1569
- data/sorbet/rbi/gems/activejob@7.0.3.1.rbi +0 -2553
- data/sorbet/rbi/gems/activemodel@7.0.3.1.rbi +0 -5999
- data/sorbet/rbi/gems/activerecord@7.0.3.1.rbi +0 -37832
- data/sorbet/rbi/gems/activestorage@7.0.3.1.rbi +0 -2321
- data/sorbet/rbi/gems/better_html@1.0.16.rbi +0 -317
- data/sorbet/rbi/gems/coderay@1.1.3.rbi +0 -8
- data/sorbet/rbi/gems/diff-lcs@1.5.0.rbi +0 -1079
- data/sorbet/rbi/gems/digest@3.1.0.rbi +0 -189
- data/sorbet/rbi/gems/globalid@1.0.0.rbi +0 -572
- data/sorbet/rbi/gems/mail@2.7.1.rbi +0 -2490
- data/sorbet/rbi/gems/marcel@1.0.2.rbi +0 -220
- data/sorbet/rbi/gems/method_source@1.0.0.rbi +0 -76
- data/sorbet/rbi/gems/mini_mime@1.1.2.rbi +0 -170
- data/sorbet/rbi/gems/net-imap@0.2.3.rbi +0 -2147
- data/sorbet/rbi/gems/net-pop@0.1.1.rbi +0 -926
- data/sorbet/rbi/gems/net-protocol@0.1.3.rbi +0 -11
- data/sorbet/rbi/gems/net-smtp@0.3.1.rbi +0 -1108
- data/sorbet/rbi/gems/nio4r@2.5.8.rbi +0 -292
- data/sorbet/rbi/gems/pry@0.14.1.rbi +0 -8
- data/sorbet/rbi/gems/rails@7.0.3.1.rbi +0 -8
- data/sorbet/rbi/gems/spoom@1.1.11.rbi +0 -2181
- data/sorbet/rbi/gems/strscan@3.0.4.rbi +0 -8
- data/sorbet/rbi/gems/timeout@0.3.0.rbi +0 -142
- data/sorbet/rbi/gems/unparser@0.6.5.rbi +0 -4529
- data/sorbet/rbi/gems/webrick@1.7.0.rbi +0 -2582
- data/sorbet/rbi/gems/websocket-driver@0.7.5.rbi +0 -993
- data/sorbet/rbi/gems/websocket-extensions@0.1.5.rbi +0 -71
@@ -4,45 +4,45 @@
|
|
4
4
|
# This is an autogenerated file for types exported from the `unicode-display_width` gem.
|
5
5
|
# Please instead update this file by running `bin/tapioca gem unicode-display_width`.
|
6
6
|
|
7
|
-
# source://unicode-display_width
|
7
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#3
|
8
8
|
module Unicode; end
|
9
9
|
|
10
|
-
# source://unicode-display_width
|
10
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#4
|
11
11
|
class Unicode::DisplayWidth
|
12
12
|
# @return [DisplayWidth] a new instance of DisplayWidth
|
13
13
|
#
|
14
|
-
# source://unicode-display_width
|
14
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#46
|
15
15
|
def initialize(ambiguous: T.unsafe(nil), overwrite: T.unsafe(nil), emoji: T.unsafe(nil)); end
|
16
16
|
|
17
|
-
# source://unicode-display_width
|
17
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#52
|
18
18
|
def get_config(**kwargs); end
|
19
19
|
|
20
|
-
# source://unicode-display_width
|
20
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#60
|
21
21
|
def of(string, **kwargs); end
|
22
22
|
|
23
23
|
class << self
|
24
|
-
# source://unicode-display_width
|
24
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#28
|
25
25
|
def emoji_extra_width_of(string, ambiguous = T.unsafe(nil), overwrite = T.unsafe(nil), _ = T.unsafe(nil)); end
|
26
26
|
|
27
|
-
# source://unicode-display_width
|
27
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#10
|
28
28
|
def of(string, ambiguous = T.unsafe(nil), overwrite = T.unsafe(nil), options = T.unsafe(nil)); end
|
29
29
|
end
|
30
30
|
end
|
31
31
|
|
32
|
-
# source://unicode-display_width
|
32
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#7
|
33
33
|
Unicode::DisplayWidth::DATA_DIRECTORY = T.let(T.unsafe(nil), String)
|
34
34
|
|
35
|
-
# source://unicode-display_width
|
35
|
+
# source://unicode-display_width//lib/unicode/display_width.rb#8
|
36
36
|
Unicode::DisplayWidth::DEPTHS = T.let(T.unsafe(nil), Array)
|
37
37
|
|
38
|
-
# source://unicode-display_width
|
38
|
+
# source://unicode-display_width//lib/unicode/display_width/index.rb#11
|
39
39
|
Unicode::DisplayWidth::INDEX = T.let(T.unsafe(nil), Array)
|
40
40
|
|
41
|
-
# source://unicode-display_width
|
41
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#8
|
42
42
|
Unicode::DisplayWidth::INDEX_FILENAME = T.let(T.unsafe(nil), String)
|
43
43
|
|
44
|
-
# source://unicode-display_width
|
44
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#6
|
45
45
|
Unicode::DisplayWidth::UNICODE_VERSION = T.let(T.unsafe(nil), String)
|
46
46
|
|
47
|
-
# source://unicode-display_width
|
47
|
+
# source://unicode-display_width//lib/unicode/display_width/constants.rb#5
|
48
48
|
Unicode::DisplayWidth::VERSION = T.let(T.unsafe(nil), String)
|
@@ -10,19 +10,19 @@ end
|
|
10
10
|
|
11
11
|
# Types are documentation
|
12
12
|
#
|
13
|
-
# source://yard-sorbet
|
13
|
+
# source://yard-sorbet//lib/yard-sorbet/version.rb#5
|
14
14
|
module YARDSorbet; end
|
15
15
|
|
16
16
|
# Extract & re-add directives to a docstring
|
17
17
|
#
|
18
|
-
# source://yard-sorbet
|
18
|
+
# source://yard-sorbet//lib/yard-sorbet/directives.rb#6
|
19
19
|
module YARDSorbet::Directives
|
20
20
|
class << self
|
21
|
-
# source://yard-sorbet
|
21
|
+
# source://yard-sorbet//lib/yard-sorbet/directives.rb#21
|
22
22
|
sig { params(docstring: ::String, directives: T::Array[::String]).void }
|
23
23
|
def add_directives(docstring, directives); end
|
24
24
|
|
25
|
-
# source://yard-sorbet
|
25
|
+
# source://yard-sorbet//lib/yard-sorbet/directives.rb#10
|
26
26
|
sig { params(docstring: T.nilable(::String)).returns([::YARD::Docstring, T::Array[::String]]) }
|
27
27
|
def extract_directives(docstring); end
|
28
28
|
end
|
@@ -32,41 +32,41 @@ end
|
|
32
32
|
#
|
33
33
|
# @see https://rubydoc.info/gems/yard/YARD/Handlers/Base YARD Base Handler documentation
|
34
34
|
#
|
35
|
-
# source://yard-sorbet
|
35
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers.rb#7
|
36
36
|
module YARDSorbet::Handlers; end
|
37
37
|
|
38
38
|
# Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
|
39
39
|
#
|
40
|
-
# source://yard-sorbet
|
40
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#7
|
41
41
|
class YARDSorbet::Handlers::AbstractDSLHandler < ::YARD::Handlers::Ruby::Base
|
42
|
-
# source://yard-sorbet
|
42
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#21
|
43
43
|
sig { void }
|
44
44
|
def process; end
|
45
45
|
end
|
46
46
|
|
47
47
|
# Extra text for class namespaces
|
48
48
|
#
|
49
|
-
# source://yard-sorbet
|
49
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#18
|
50
50
|
YARDSorbet::Handlers::AbstractDSLHandler::CLASS_TAG_TEXT = T.let(T.unsafe(nil), String)
|
51
51
|
|
52
52
|
# The text accompanying the `@abstract` tag.
|
53
53
|
#
|
54
54
|
# @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb The `@abstract` tag template
|
55
55
|
#
|
56
|
-
# source://yard-sorbet
|
56
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/abstract_dsl_handler.rb#16
|
57
57
|
YARDSorbet::Handlers::AbstractDSLHandler::TAG_TEXT = T.let(T.unsafe(nil), String)
|
58
58
|
|
59
59
|
# Handle `enums` calls, registering enum values as constants
|
60
60
|
#
|
61
|
-
# source://yard-sorbet
|
61
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#7
|
62
62
|
class YARDSorbet::Handlers::EnumsHandler < ::YARD::Handlers::Ruby::Base
|
63
|
-
# source://yard-sorbet
|
63
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#14
|
64
64
|
sig { void }
|
65
65
|
def process; end
|
66
66
|
|
67
67
|
private
|
68
68
|
|
69
|
-
# source://yard-sorbet
|
69
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/enums_handler.rb#29
|
70
70
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
71
71
|
def const_assign_node?(node); end
|
72
72
|
end
|
@@ -75,15 +75,15 @@ end
|
|
75
75
|
#
|
76
76
|
# @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
|
77
77
|
#
|
78
|
-
# source://yard-sorbet
|
78
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#9
|
79
79
|
class YARDSorbet::Handlers::IncludeHandler < ::YARD::Handlers::Ruby::Base
|
80
|
-
# source://yard-sorbet
|
80
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#16
|
81
81
|
sig { void }
|
82
82
|
def process; end
|
83
83
|
|
84
84
|
private
|
85
85
|
|
86
|
-
# source://yard-sorbet
|
86
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/include_handler.rb#28
|
87
87
|
sig { returns(::YARD::CodeObjects::NamespaceObject) }
|
88
88
|
def included_in; end
|
89
89
|
end
|
@@ -92,70 +92,94 @@ end
|
|
92
92
|
#
|
93
93
|
# @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
|
94
94
|
#
|
95
|
-
# source://yard-sorbet
|
95
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#9
|
96
96
|
class YARDSorbet::Handlers::MixesInClassMethodsHandler < ::YARD::Handlers::Ruby::Base
|
97
|
-
# source://yard-sorbet
|
97
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#23
|
98
98
|
sig { void }
|
99
99
|
def process; end
|
100
100
|
|
101
101
|
class << self
|
102
|
-
# source://yard-sorbet
|
103
|
-
sig { params(code_obj: ::String).returns(T.nilable(::String)) }
|
102
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb#18
|
103
|
+
sig { params(code_obj: ::String).returns(T.nilable(T::Array[::String])) }
|
104
104
|
def mixed_in_class_methods(code_obj); end
|
105
105
|
end
|
106
106
|
end
|
107
107
|
|
108
108
|
# A YARD Handler for Sorbet type declarations
|
109
109
|
#
|
110
|
-
# source://yard-sorbet
|
110
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#7
|
111
111
|
class YARDSorbet::Handlers::SigHandler < ::YARD::Handlers::Ruby::Base
|
112
112
|
# Swap the method definition docstring and the sig docstring.
|
113
113
|
# Parse relevant parts of the `sig` and include them as well.
|
114
114
|
#
|
115
|
-
# source://yard-sorbet
|
115
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#24
|
116
116
|
sig { void }
|
117
117
|
def process; end
|
118
118
|
|
119
119
|
private
|
120
120
|
|
121
|
-
# source://yard-sorbet
|
121
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#73
|
122
|
+
sig { params(method_objects: T::Array[::YARD::CodeObjects::MethodObject]).void }
|
123
|
+
def document_attr_methods(method_objects); end
|
124
|
+
|
125
|
+
# An attr* sig can be merged into a previous attr* docstring if it is the only parameter passed to the attr*
|
126
|
+
# declaration. This is to avoid needing to rewrite the source code to separate merged and unmerged attr*
|
127
|
+
# declarations.
|
128
|
+
#
|
129
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#60
|
130
|
+
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Boolean) }
|
131
|
+
def merged_into_attr?(attr_node); end
|
132
|
+
|
133
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#78
|
122
134
|
sig do
|
123
135
|
params(
|
124
|
-
|
125
|
-
|
126
|
-
|
136
|
+
attach_to: T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode),
|
137
|
+
docstring: T.nilable(::String),
|
138
|
+
include_params: T::Boolean
|
127
139
|
).void
|
128
140
|
end
|
129
|
-
def
|
141
|
+
def parse_node(attach_to, docstring, include_params: T.unsafe(nil)); end
|
142
|
+
|
143
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#99
|
144
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
|
145
|
+
def parse_params(node, docstring); end
|
130
146
|
|
131
|
-
# source://yard-sorbet
|
147
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#109
|
132
148
|
sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
|
133
149
|
def parse_return(node, docstring); end
|
134
150
|
|
135
|
-
# source://yard-sorbet
|
136
|
-
sig { params(
|
137
|
-
def parse_sig(
|
151
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#87
|
152
|
+
sig { params(docstring: ::YARD::Docstring, include_params: T::Boolean).void }
|
153
|
+
def parse_sig(docstring, include_params: T.unsafe(nil)); end
|
154
|
+
|
155
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#50
|
156
|
+
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).void }
|
157
|
+
def process_attr(attr_node); end
|
158
|
+
|
159
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#36
|
160
|
+
sig { params(def_node: ::YARD::Parser::Ruby::MethodDefinitionNode).void }
|
161
|
+
def process_def(def_node); end
|
138
162
|
end
|
139
163
|
|
140
|
-
#
|
164
|
+
# YARD types that can have docstrings attached to them
|
141
165
|
#
|
142
|
-
# source://yard-sorbet
|
143
|
-
YARDSorbet::Handlers::SigHandler::
|
166
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/sig_handler.rb#14
|
167
|
+
YARDSorbet::Handlers::SigHandler::Documentable = T.type_alias { T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
|
144
168
|
|
145
169
|
# Class-level handler that folds all `const` and `prop` declarations into the constructor documentation
|
146
170
|
# this needs to be injected as a module otherwise the default Class handler will overwrite documentation
|
147
171
|
#
|
148
172
|
# @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
|
149
173
|
#
|
150
|
-
# source://yard-sorbet
|
174
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#10
|
151
175
|
module YARDSorbet::Handlers::StructClassHandler
|
152
|
-
# source://yard-sorbet
|
176
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#14
|
153
177
|
sig { void }
|
154
178
|
def process; end
|
155
179
|
|
156
180
|
private
|
157
181
|
|
158
|
-
# source://yard-sorbet
|
182
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#50
|
159
183
|
sig do
|
160
184
|
params(
|
161
185
|
object: ::YARD::CodeObjects::MethodObject,
|
@@ -168,11 +192,11 @@ module YARDSorbet::Handlers::StructClassHandler
|
|
168
192
|
|
169
193
|
# Create a virtual `initialize` method with all the `prop`/`const` arguments
|
170
194
|
#
|
171
|
-
# source://yard-sorbet
|
195
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#30
|
172
196
|
sig { params(props: T::Array[::YARDSorbet::TStructProp], class_ns: ::YARD::CodeObjects::ClassObject).void }
|
173
197
|
def process_t_struct_props(props, class_ns); end
|
174
198
|
|
175
|
-
# source://yard-sorbet
|
199
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_class_handler.rb#60
|
176
200
|
sig { params(props: T::Array[::YARDSorbet::TStructProp]).returns(T::Array[[::String, T.nilable(::String)]]) }
|
177
201
|
def to_object_parameters(props); end
|
178
202
|
end
|
@@ -180,9 +204,9 @@ end
|
|
180
204
|
# Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
|
181
205
|
# in creating a constructor
|
182
206
|
#
|
183
|
-
# source://yard-sorbet
|
207
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#8
|
184
208
|
class YARDSorbet::Handlers::StructPropHandler < ::YARD::Handlers::Ruby::Base
|
185
|
-
# source://yard-sorbet
|
209
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#15
|
186
210
|
sig { void }
|
187
211
|
def process; end
|
188
212
|
|
@@ -190,45 +214,50 @@ class YARDSorbet::Handlers::StructPropHandler < ::YARD::Handlers::Ruby::Base
|
|
190
214
|
|
191
215
|
# Add the source and docstring to the method object
|
192
216
|
#
|
193
|
-
# source://yard-sorbet
|
217
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#28
|
194
218
|
sig { params(object: ::YARD::CodeObjects::MethodObject, prop: ::YARDSorbet::TStructProp).void }
|
195
219
|
def decorate_object(object, prop); end
|
196
220
|
|
197
|
-
#
|
198
|
-
|
199
|
-
|
200
|
-
sig { returns(T.nilable(::String)) }
|
201
|
-
def default_value; end
|
221
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#38
|
222
|
+
sig { returns(T::Boolean) }
|
223
|
+
def immutable?; end
|
202
224
|
|
203
|
-
# source://yard-sorbet
|
225
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#44
|
226
|
+
sig { params(kwd: ::String).returns(T.nilable(::String)) }
|
227
|
+
def kw_arg(kwd); end
|
228
|
+
|
229
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#49
|
204
230
|
sig { params(name: ::String).returns(::YARDSorbet::TStructProp) }
|
205
231
|
def make_prop(name); end
|
206
232
|
|
233
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#60
|
234
|
+
sig { returns(T::Array[::YARD::Parser::Ruby::AstNode]) }
|
235
|
+
def params; end
|
236
|
+
|
207
237
|
# Register the field explicitly as an attribute.
|
208
|
-
# While `const` attributes are immutable, `prop` attributes may be reassigned.
|
209
238
|
#
|
210
|
-
# source://yard-sorbet
|
239
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#66
|
211
240
|
sig { params(object: ::YARD::CodeObjects::MethodObject, name: ::String).void }
|
212
241
|
def register_attrs(object, name); end
|
213
242
|
|
214
243
|
# Store the prop for use in the constructor definition
|
215
244
|
#
|
216
|
-
# source://yard-sorbet
|
245
|
+
# source://yard-sorbet//lib/yard-sorbet/handlers/struct_prop_handler.rb#74
|
217
246
|
sig { params(prop: ::YARDSorbet::TStructProp).void }
|
218
247
|
def update_state(prop); end
|
219
248
|
end
|
220
249
|
|
221
250
|
# Helper methods for working with `YARD` AST Nodes
|
222
251
|
#
|
223
|
-
# source://yard-sorbet
|
252
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#6
|
224
253
|
module YARDSorbet::NodeUtils
|
225
254
|
class << self
|
226
|
-
#
|
255
|
+
# Traverse AST nodes in breadth-first order
|
227
256
|
#
|
228
257
|
# @note This will skip over some node types.
|
229
258
|
# @yield [YARD::Parser::Ruby::AstNode]
|
230
259
|
#
|
231
|
-
# source://yard-sorbet
|
260
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#21
|
232
261
|
sig do
|
233
262
|
params(
|
234
263
|
node: ::YARD::Parser::Ruby::AstNode,
|
@@ -237,9 +266,13 @@ module YARDSorbet::NodeUtils
|
|
237
266
|
end
|
238
267
|
def bfs_traverse(node, &_blk); end
|
239
268
|
|
269
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#32
|
270
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).void }
|
271
|
+
def delete_node(node); end
|
272
|
+
|
240
273
|
# Gets the node that a sorbet `sig` can be attached do, bypassing visisbility modifiers and the like
|
241
274
|
#
|
242
|
-
# source://yard-sorbet
|
275
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#38
|
243
276
|
sig do
|
244
277
|
params(
|
245
278
|
node: ::YARD::Parser::Ruby::AstNode
|
@@ -251,93 +284,95 @@ module YARDSorbet::NodeUtils
|
|
251
284
|
#
|
252
285
|
# @raise [IndexError] if the node does not have an adjacent sibling (ascending)
|
253
286
|
#
|
254
|
-
# source://yard-sorbet
|
287
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#45
|
255
288
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::YARD::Parser::Ruby::AstNode) }
|
256
289
|
def sibling_node(node); end
|
290
|
+
|
291
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#52
|
292
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
|
293
|
+
def sigable_node?(node); end
|
294
|
+
|
295
|
+
# @see https://github.com/lsegal/yard/blob/main/lib/yard/handlers/ruby/attribute_handler.rb YARD::Handlers::Ruby::AttributeHandler.validated_attribute_names
|
296
|
+
#
|
297
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#63
|
298
|
+
sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
|
299
|
+
def validated_attribute_names(attr_node); end
|
257
300
|
end
|
258
301
|
end
|
259
302
|
|
260
303
|
# Command node types that can have type signatures
|
261
304
|
#
|
262
|
-
# source://yard-sorbet
|
305
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#10
|
263
306
|
YARDSorbet::NodeUtils::ATTRIBUTE_METHODS = T.let(T.unsafe(nil), Array)
|
264
307
|
|
265
|
-
# Node types that can have type signatures
|
266
|
-
#
|
267
|
-
# source://yard-sorbet-0.6.1/lib/yard-sorbet/node_utils.rb:12
|
268
|
-
YARDSorbet::NodeUtils::SIGABLE_NODE = T.type_alias { T.any(::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
|
269
|
-
|
270
308
|
# Skip these method contents during BFS node traversal, they can have their own nested types via `T.Proc`
|
271
309
|
#
|
272
|
-
# source://yard-sorbet
|
310
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#12
|
273
311
|
YARDSorbet::NodeUtils::SKIP_METHOD_CONTENTS = T.let(T.unsafe(nil), Array)
|
274
312
|
|
313
|
+
# Node types that can have type signatures
|
314
|
+
#
|
315
|
+
# source://yard-sorbet//lib/yard-sorbet/node_utils.rb#14
|
316
|
+
YARDSorbet::NodeUtils::SigableNode = T.type_alias { T.any(::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
|
317
|
+
|
275
318
|
# Translate `sig` type syntax to `YARD` type syntax.
|
276
319
|
#
|
277
|
-
# source://yard-sorbet
|
320
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#6
|
278
321
|
module YARDSorbet::SigToYARD
|
279
322
|
class << self
|
280
323
|
# @see https://yardoc.org/types.html
|
281
324
|
#
|
282
|
-
# source://yard-sorbet
|
325
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#23
|
283
326
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
284
327
|
def convert(node); end
|
285
328
|
|
286
329
|
private
|
287
330
|
|
288
|
-
# source://yard-sorbet
|
331
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#61
|
289
332
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::String) }
|
290
333
|
def build_generic_type(node); end
|
291
334
|
|
292
|
-
# source://yard-sorbet
|
335
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#70
|
293
336
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
294
337
|
def convert_aref(node); end
|
295
338
|
|
296
|
-
# source://yard-sorbet
|
297
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(
|
339
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#82
|
340
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
298
341
|
def convert_array(node); end
|
299
342
|
|
300
|
-
# source://yard-sorbet
|
301
|
-
sig { params(node: ::YARD::Parser::Ruby::
|
302
|
-
def convert_call(node); end
|
303
|
-
|
304
|
-
# source://yard-sorbet-0.6.1/lib/yard-sorbet/sig_to_yard.rb:79
|
305
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
343
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#90
|
344
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
306
345
|
def convert_collection(node); end
|
307
346
|
|
308
|
-
# source://yard-sorbet
|
309
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(
|
347
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#97
|
348
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
310
349
|
def convert_hash(node); end
|
311
350
|
|
312
|
-
# source://yard-sorbet
|
351
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#105
|
313
352
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
314
353
|
def convert_list(node); end
|
315
354
|
|
316
|
-
# source://yard-sorbet
|
355
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#31
|
317
356
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
318
357
|
def convert_node(node); end
|
319
358
|
|
320
|
-
# source://yard-sorbet
|
359
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#43
|
321
360
|
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
322
361
|
def convert_node_type(node); end
|
323
362
|
|
324
|
-
# source://yard-sorbet
|
325
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
|
326
|
-
def convert_ref(node); end
|
327
|
-
|
328
|
-
# source://yard-sorbet-0.6.1/lib/yard-sorbet/sig_to_yard.rb:113
|
363
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#110
|
329
364
|
sig { params(node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
|
330
365
|
def convert_t_method(node); end
|
331
366
|
|
332
|
-
# source://yard-sorbet
|
333
|
-
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(
|
367
|
+
# source://yard-sorbet//lib/yard-sorbet/sig_to_yard.rb#121
|
368
|
+
sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
|
334
369
|
def convert_unknown(node); end
|
335
370
|
end
|
336
371
|
end
|
337
372
|
|
338
373
|
# Used to store the details of a `T::Struct` `prop` definition
|
339
374
|
#
|
340
|
-
# source://yard-sorbet
|
375
|
+
# source://yard-sorbet//lib/yard-sorbet/t_struct_prop.rb#6
|
341
376
|
class YARDSorbet::TStructProp < ::T::Struct
|
342
377
|
const :default, T.nilable(::String)
|
343
378
|
const :doc, ::String
|
@@ -346,17 +381,17 @@ class YARDSorbet::TStructProp < ::T::Struct
|
|
346
381
|
const :types, T::Array[::String]
|
347
382
|
|
348
383
|
class << self
|
349
|
-
# source://sorbet-runtime
|
384
|
+
# source://sorbet-runtime/0.5.11367/lib/types/struct.rb#13
|
350
385
|
def inherited(s); end
|
351
386
|
end
|
352
387
|
end
|
353
388
|
|
354
389
|
# Helper methods for working with `YARD` tags
|
355
390
|
#
|
356
|
-
# source://yard-sorbet
|
391
|
+
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#6
|
357
392
|
module YARDSorbet::TagUtils
|
358
393
|
class << self
|
359
|
-
# source://yard-sorbet
|
394
|
+
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#16
|
360
395
|
sig do
|
361
396
|
params(
|
362
397
|
docstring: ::YARD::Docstring,
|
@@ -368,7 +403,7 @@ module YARDSorbet::TagUtils
|
|
368
403
|
|
369
404
|
# Create or update a `YARD` tag with type information
|
370
405
|
#
|
371
|
-
# source://yard-sorbet
|
406
|
+
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#30
|
372
407
|
sig do
|
373
408
|
params(
|
374
409
|
docstring: ::YARD::Docstring,
|
@@ -382,7 +417,12 @@ module YARDSorbet::TagUtils
|
|
382
417
|
end
|
383
418
|
end
|
384
419
|
|
420
|
+
# The `void` return type, as a constant to reduce array allocations
|
421
|
+
#
|
422
|
+
# source://yard-sorbet//lib/yard-sorbet/tag_utils.rb#10
|
423
|
+
YARDSorbet::TagUtils::VOID_RETURN_TYPE = T.let(T.unsafe(nil), Array)
|
424
|
+
|
385
425
|
# {https://rubygems.org/gems/yard-sorbet Version history}
|
386
426
|
#
|
387
|
-
# source://yard-sorbet
|
427
|
+
# source://yard-sorbet//lib/yard-sorbet/version.rb#7
|
388
428
|
YARDSorbet::VERSION = T.let(T.unsafe(nil), String)
|