m2m_keygen 0.4.9 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (174) hide show
  1. checksums.yaml +4 -4
  2. data/.overcommit.yml +4 -7
  3. data/.rubocop.yml +19 -16
  4. data/.ruby-version +1 -1
  5. data/.streerc +1 -0
  6. data/.tool-versions +1 -1
  7. data/CHANGELOG.md +70 -1
  8. data/Gemfile +2 -2
  9. data/Gemfile.lock +135 -158
  10. data/README.md +64 -78
  11. data/docs/MIGRATING.md +69 -0
  12. data/docs/SPEC.md +245 -0
  13. data/examples/nonce_store/postgres.rb +40 -0
  14. data/examples/nonce_store/redis.rb +23 -0
  15. data/gemfiles/rack_2.gemfile +5 -0
  16. data/gemfiles/rack_3.gemfile +5 -0
  17. data/lib/m2m_keygen/canonicalizer.rb +57 -0
  18. data/lib/m2m_keygen/nonce_store/disabled.rb +19 -0
  19. data/lib/m2m_keygen/nonce_store/memory.rb +64 -0
  20. data/lib/m2m_keygen/nonce_store.rb +18 -0
  21. data/lib/m2m_keygen/rack_validator.rb +86 -19
  22. data/lib/m2m_keygen/request_signer/signed_request.rb +10 -0
  23. data/lib/m2m_keygen/request_signer.rb +118 -0
  24. data/lib/m2m_keygen/signature.rb +41 -39
  25. data/lib/m2m_keygen/types/params_type.rb +6 -17
  26. data/lib/m2m_keygen/version.rb +1 -1
  27. data/lib/m2m_keygen.rb +6 -0
  28. data/m2m_keygen.gemspec +12 -14
  29. data/sorbet/config +1 -0
  30. data/sorbet/rbi/gems/.gitattributes +1 -0
  31. data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi} +45 -79
  32. data/sorbet/rbi/gems/{benchmark@0.2.0.rbi → benchmark@0.5.0.rbi} +91 -58
  33. data/sorbet/rbi/gems/bundler-audit@0.9.3.rbi +397 -0
  34. data/sorbet/rbi/gems/byebug@13.0.0.rbi +3651 -0
  35. data/sorbet/rbi/gems/childprocess@5.1.0.rbi +336 -0
  36. data/sorbet/rbi/gems/concurrent-ruby@1.3.7.rbi +384 -0
  37. data/sorbet/rbi/gems/{diff-lcs@1.5.0.rbi → diff-lcs@1.6.2.rbi} +189 -199
  38. data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +147 -147
  39. data/sorbet/rbi/gems/dotenv@3.2.0.rbi +267 -0
  40. data/sorbet/rbi/gems/erubi@1.13.1.rbi +155 -0
  41. data/sorbet/rbi/gems/{faker@2.22.0.rbi → faker@3.8.0.rbi} +8468 -3829
  42. data/sorbet/rbi/gems/{ffi@1.15.5.rbi → ffi@1.17.4.rbi} +1 -0
  43. data/sorbet/rbi/gems/{formatador@1.1.0.rbi → formatador@1.2.3.rbi} +1 -0
  44. data/sorbet/rbi/gems/{guard@2.18.0.rbi → guard@2.20.1.rbi} +1 -0
  45. data/sorbet/rbi/gems/{i18n@1.12.0.rbi → i18n@1.15.2.rbi} +687 -827
  46. data/sorbet/rbi/gems/io-console@0.8.2.rbi +9 -0
  47. data/sorbet/rbi/gems/{json@2.6.2.rbi → json@2.20.0.rbi} +994 -252
  48. data/sorbet/rbi/gems/language_server-protocol@3.17.0.5.rbi +9 -0
  49. data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +189 -0
  50. data/sorbet/rbi/gems/listen@3.10.0.rbi +9 -0
  51. data/sorbet/rbi/gems/logger@1.7.0.rbi +896 -0
  52. data/sorbet/rbi/gems/{lumberjack@1.2.8.rbi → lumberjack@1.4.2.rbi} +1 -0
  53. data/sorbet/rbi/gems/{method_source@1.0.0.rbi → method_source@1.1.0.rbi} +111 -90
  54. data/sorbet/rbi/gems/{overcommit@0.59.1.rbi → overcommit@0.71.0.rbi} +503 -647
  55. data/sorbet/rbi/gems/parallel@2.1.0.rbi +321 -0
  56. data/sorbet/rbi/gems/parser@3.3.11.1.rbi +5229 -0
  57. data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +878 -0
  58. data/sorbet/rbi/gems/prism@1.9.0.rbi +42224 -0
  59. data/sorbet/rbi/gems/pry-byebug@3.12.0.rbi +481 -0
  60. data/sorbet/rbi/gems/{pry@0.14.1.rbi → pry@0.16.0.rbi} +2567 -3550
  61. data/sorbet/rbi/gems/{racc@1.6.0.rbi → racc@1.8.1.rbi} +54 -40
  62. data/sorbet/rbi/gems/rack@3.2.6.rbi +4653 -0
  63. data/sorbet/rbi/gems/{rake@13.0.6.rbi → rake@13.4.2.rbi} +963 -732
  64. data/sorbet/rbi/gems/{rb-inotify@0.10.1.rbi → rb-inotify@0.11.1.rbi} +1 -0
  65. data/sorbet/rbi/gems/rbi@0.3.14.rbi +5519 -0
  66. data/sorbet/rbi/gems/rbs@4.0.3.rbi +6908 -0
  67. data/sorbet/rbi/gems/regexp_parser@2.12.0.rbi +3398 -0
  68. data/sorbet/rbi/gems/reline@0.6.3.rbi +2446 -0
  69. data/sorbet/rbi/gems/require-hooks@0.4.0.rbi +152 -0
  70. data/sorbet/rbi/gems/{rexml@3.2.5.rbi → rexml@3.4.4.rbi} +1085 -894
  71. data/sorbet/rbi/gems/rspec-core@3.13.6.rbi +9475 -0
  72. data/sorbet/rbi/gems/rspec-expectations@3.13.5.rbi +6108 -0
  73. data/sorbet/rbi/gems/rspec-mocks@3.13.8.rbi +4787 -0
  74. data/sorbet/rbi/gems/rspec-support@3.13.7.rbi +1274 -0
  75. data/sorbet/rbi/gems/rspec@3.13.2.rbi +15 -0
  76. data/sorbet/rbi/gems/rspec_in_context@1.2.2.rbi +294 -0
  77. data/sorbet/rbi/gems/rubocop-ast@1.49.1.rbi +7140 -0
  78. data/sorbet/rbi/gems/rubocop-faker@1.3.0.rbi +88 -0
  79. data/sorbet/rbi/gems/rubocop-performance@1.26.1.rbi +3403 -0
  80. data/sorbet/rbi/gems/rubocop-sorbet@0.12.0.rbi +2448 -0
  81. data/sorbet/rbi/gems/rubocop@1.88.1.rbi +63103 -0
  82. data/sorbet/rbi/gems/ruby-lsp@0.26.9.rbi +28 -0
  83. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +988 -0
  84. data/sorbet/rbi/gems/rubydex@0.2.7.rbi +836 -0
  85. data/sorbet/rbi/gems/simplecov-html@0.13.2.rbi +90 -0
  86. data/sorbet/rbi/gems/{simplecov@0.21.2.rbi → simplecov@0.22.0.rbi} +438 -578
  87. data/sorbet/rbi/gems/spoom@1.8.2.rbi +6691 -0
  88. data/sorbet/rbi/gems/syntax_tree@6.3.0.rbi +22090 -0
  89. data/sorbet/rbi/gems/tapioca@0.19.2.rbi +3597 -0
  90. data/sorbet/rbi/gems/{thor@1.2.1.rbi → thor@1.5.0.rbi} +1085 -1171
  91. data/sorbet/rbi/gems/tsort@0.2.0.rbi +389 -0
  92. data/sorbet/rbi/gems/unicode-display_width@3.2.0.rbi +130 -0
  93. data/sorbet/rbi/gems/unicode-emoji@4.2.0.rbi +332 -0
  94. data/sorbet/rbi/gems/{yard-sorbet@0.7.0.rbi → yard-sorbet@0.9.0.rbi} +142 -99
  95. data/sorbet/rbi/gems/{yard@0.9.28.rbi → yard@0.9.44.rbi} +5350 -6316
  96. data/sorbet/rbi/gems/zeitwerk@2.8.2.rbi +1178 -0
  97. metadata +105 -111
  98. data/.prettierrc.js +0 -4
  99. data/docs/M2mKeygen/Error.html +0 -135
  100. data/docs/M2mKeygen/ParamsEncoder.html +0 -321
  101. data/docs/M2mKeygen/RackValidator.html +0 -533
  102. data/docs/M2mKeygen/Signature.html +0 -680
  103. data/docs/M2mKeygen/Types.html +0 -147
  104. data/docs/M2mKeygen.html +0 -157
  105. data/docs/_index.html +0 -182
  106. data/docs/class_list.html +0 -51
  107. data/docs/css/common.css +0 -1
  108. data/docs/css/full_list.css +0 -58
  109. data/docs/css/style.css +0 -497
  110. data/docs/file.README.html +0 -230
  111. data/docs/file_list.html +0 -56
  112. data/docs/frames.html +0 -17
  113. data/docs/index.html +0 -230
  114. data/docs/js/app.js +0 -314
  115. data/docs/js/full_list.js +0 -216
  116. data/docs/js/jquery.js +0 -4
  117. data/docs/method_list.html +0 -139
  118. data/docs/top-level-namespace.html +0 -110
  119. data/lib/m2m_keygen/params_encoder.rb +0 -56
  120. data/package.json +0 -12
  121. data/sig/m2m_keygen.rbs +0 -4
  122. data/sorbet/rbi/gems/activesupport@7.0.3.1.rbi +0 -18608
  123. data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -522
  124. data/sorbet/rbi/gems/bundler-audit@0.9.1.rbi +0 -308
  125. data/sorbet/rbi/gems/byebug@11.1.3.rbi +0 -3603
  126. data/sorbet/rbi/gems/childprocess@4.1.0.rbi +0 -401
  127. data/sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi +0 -11581
  128. data/sorbet/rbi/gems/dotenv@2.8.1.rbi +0 -234
  129. data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -8
  130. data/sorbet/rbi/gems/haml@5.2.2.rbi +0 -3190
  131. data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +0 -19
  132. data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -133
  133. data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3261
  134. data/sorbet/rbi/gems/listen@3.7.1.rbi +0 -1181
  135. data/sorbet/rbi/gems/minitest@5.16.3.rbi +0 -1459
  136. data/sorbet/rbi/gems/nokogiri@1.13.8.rbi +0 -6514
  137. data/sorbet/rbi/gems/parallel@1.22.1.rbi +0 -277
  138. data/sorbet/rbi/gems/parser@3.1.2.1.rbi +0 -6826
  139. data/sorbet/rbi/gems/prettier@3.2.0.rbi +0 -22
  140. data/sorbet/rbi/gems/prettier_print@0.1.0.rbi +0 -8
  141. data/sorbet/rbi/gems/pry-byebug@3.10.1.rbi +0 -1222
  142. data/sorbet/rbi/gems/rack@2.2.4.rbi +0 -5630
  143. data/sorbet/rbi/gems/rbi@0.0.15.rbi +0 -3007
  144. data/sorbet/rbi/gems/rbs@2.6.0.rbi +0 -8
  145. data/sorbet/rbi/gems/regexp_parser@2.5.0.rbi +0 -3366
  146. data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -389
  147. data/sorbet/rbi/gems/rspec-core@3.11.0.rbi +0 -10786
  148. data/sorbet/rbi/gems/rspec-expectations@3.11.0.rbi +0 -8170
  149. data/sorbet/rbi/gems/rspec-mocks@3.11.1.rbi +0 -5385
  150. data/sorbet/rbi/gems/rspec-support@3.11.0.rbi +0 -1746
  151. data/sorbet/rbi/gems/rspec@3.11.0.rbi +0 -187
  152. data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +0 -1113
  153. data/sorbet/rbi/gems/rubocop-ast@1.21.0.rbi +0 -7044
  154. data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +0 -106
  155. data/sorbet/rbi/gems/rubocop-performance@1.14.3.rbi +0 -2982
  156. data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +0 -990
  157. data/sorbet/rbi/gems/rubocop@1.35.1.rbi +0 -52002
  158. data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +0 -1239
  159. data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -219
  160. data/sorbet/rbi/gems/solargraph@0.46.0.rbi +0 -9075
  161. data/sorbet/rbi/gems/spoom@1.1.12.rbi +0 -2369
  162. data/sorbet/rbi/gems/syntax_tree-haml@1.3.1.rbi +0 -8
  163. data/sorbet/rbi/gems/syntax_tree-rbs@0.5.0.rbi +0 -8
  164. data/sorbet/rbi/gems/syntax_tree@3.5.0.rbi +0 -8
  165. data/sorbet/rbi/gems/tapioca@0.9.4.rbi +0 -2946
  166. data/sorbet/rbi/gems/temple@0.8.2.rbi +0 -1712
  167. data/sorbet/rbi/gems/tilt@2.0.11.rbi +0 -742
  168. data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +0 -5914
  169. data/sorbet/rbi/gems/unicode-display_width@2.2.0.rbi +0 -48
  170. data/sorbet/rbi/gems/unparser@0.6.5.rbi +0 -4529
  171. data/sorbet/rbi/gems/webrick@1.7.0.rbi +0 -2553
  172. data/sorbet/rbi/gems/zeitwerk@2.6.0.rbi +0 -867
  173. data/sorbet/rbi/manual.rbi +0 -7
  174. data/yarn.lock +0 -20
@@ -4,158 +4,184 @@
4
4
  # This is an autogenerated file for types exported from the `yard-sorbet` gem.
5
5
  # Please instead update this file by running `bin/tapioca gem yard-sorbet`.
6
6
 
7
+
7
8
  class YARD::Handlers::Ruby::ClassHandler < ::YARD::Handlers::Ruby::Base
8
9
  include ::YARDSorbet::Handlers::StructClassHandler
9
10
  end
10
11
 
11
12
  # Types are documentation
12
13
  #
13
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/version.rb:5
14
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/version.rb:5
14
15
  module YARDSorbet; end
15
16
 
16
17
  # Extract & re-add directives to a docstring
17
18
  #
18
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/directives.rb:6
19
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/directives.rb:6
19
20
  module YARDSorbet::Directives
20
21
  class << self
21
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/directives.rb:21
22
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/directives.rb:21
22
23
  sig { params(docstring: ::String, directives: T::Array[::String]).void }
23
24
  def add_directives(docstring, directives); end
24
25
 
25
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/directives.rb:10
26
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/directives.rb:10
26
27
  sig { params(docstring: T.nilable(::String)).returns([::YARD::Docstring, T::Array[::String]]) }
27
28
  def extract_directives(docstring); end
28
29
  end
29
30
  end
30
31
 
31
32
  # Custom YARD Handlers
32
- #
33
33
  # @see https://rubydoc.info/gems/yard/YARD/Handlers/Base YARD Base Handler documentation
34
34
  #
35
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers.rb:7
35
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers.rb:7
36
36
  module YARDSorbet::Handlers; end
37
37
 
38
- # Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
38
+ # Applies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
39
39
  #
40
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/abstract_dsl_handler.rb:7
40
+ # pkg:gem/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-0.7.0/lib/yard-sorbet/handlers/abstract_dsl_handler.rb:21
42
+ # pkg:gem/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-0.7.0/lib/yard-sorbet/handlers/abstract_dsl_handler.rb:18
49
+ # pkg:gem/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
+ # @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb
54
+ # The `@abstract` tag template
53
55
  #
54
- # @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb The `@abstract` tag template
55
- #
56
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/abstract_dsl_handler.rb:16
56
+ # pkg:gem/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-0.7.0/lib/yard-sorbet/handlers/enums_handler.rb:7
61
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/enums_handler.rb:7
62
62
  class YARDSorbet::Handlers::EnumsHandler < ::YARD::Handlers::Ruby::Base
63
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/enums_handler.rb:14
63
+ # pkg:gem/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-0.7.0/lib/yard-sorbet/handlers/enums_handler.rb:29
69
+ # pkg:gem/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
73
73
 
74
74
  # Extends any modules included via `mixes_in_class_methods`
75
+ # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook
76
+ # Sorbet `mixes_in_class_methods` documentation
75
77
  #
76
- # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
77
- #
78
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/include_handler.rb:9
78
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/include_handler.rb:9
79
79
  class YARDSorbet::Handlers::IncludeHandler < ::YARD::Handlers::Ruby::Base
80
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/include_handler.rb:16
80
+ # pkg:gem/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-0.7.0/lib/yard-sorbet/handlers/include_handler.rb:30
86
+ # @return the namespace object that is including the module
87
+ #
88
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/include_handler.rb:28
87
89
  sig { returns(::YARD::CodeObjects::NamespaceObject) }
88
90
  def included_in; end
89
91
  end
90
92
 
91
93
  # Tracks modules that invoke `mixes_in_class_methods` for use in {IncludeHandler}
94
+ # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook
95
+ # Sorbet `mixes_in_class_methods` documentation
92
96
  #
93
- # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook Sorbet `mixes_in_class_methods` documentation
94
- #
95
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:9
97
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:9
96
98
  class YARDSorbet::Handlers::MixesInClassMethodsHandler < ::YARD::Handlers::Ruby::Base
97
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:23
99
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:21
98
100
  sig { void }
99
101
  def process; end
100
102
 
101
103
  class << self
102
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:18
103
- sig { params(code_obj: ::String).returns(T.nilable(::String)) }
104
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/mixes_in_class_methods_handler.rb:18
105
+ sig { params(code_obj: ::String).returns(T.nilable(T::Array[::String])) }
104
106
  def mixed_in_class_methods(code_obj); end
105
107
  end
106
108
  end
107
109
 
108
110
  # A YARD Handler for Sorbet type declarations
109
111
  #
110
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:7
112
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:7
111
113
  class YARDSorbet::Handlers::SigHandler < ::YARD::Handlers::Ruby::Base
112
114
  # Swap the method definition docstring and the sig docstring.
113
115
  # Parse relevant parts of the `sig` and include them as well.
114
116
  #
115
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:20
117
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:24
116
118
  sig { void }
117
119
  def process; end
118
120
 
119
121
  private
120
122
 
121
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:52
123
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:73
124
+ sig { params(method_objects: T::Array[::YARD::CodeObjects::MethodObject]).void }
125
+ def document_attrs(method_objects); end
126
+
127
+ # An attr* sig can be merged into a previous attr* docstring if it is the only parameter passed to the attr*
128
+ # declaration. This is to avoid needing to rewrite the source code to separate merged and unmerged attr*
129
+ # declarations.
130
+ #
131
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:60
132
+ sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Boolean) }
133
+ def merged_into_attr?(attr_node); end
134
+
135
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:76
122
136
  sig do
123
137
  params(
124
- method_node: ::YARD::Parser::Ruby::AstNode,
125
- node: ::YARD::Parser::Ruby::AstNode,
126
- docstring: ::YARD::Docstring
138
+ attach_to: T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode),
139
+ docstring: T.nilable(::String),
140
+ include_params: T::Boolean
127
141
  ).void
128
142
  end
129
- def parse_params(method_node, node, docstring); end
143
+ def parse_node(attach_to, docstring, include_params: T.unsafe(nil)); end
130
144
 
131
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:64
145
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:97
146
+ sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
147
+ def parse_params(node, docstring); end
148
+
149
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:107
132
150
  sig { params(node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
133
151
  def parse_return(node, docstring); end
134
152
 
135
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:32
136
- sig { params(method_node: ::YARD::Parser::Ruby::AstNode, docstring: ::YARD::Docstring).void }
137
- def parse_sig(method_node, docstring); end
153
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:85
154
+ sig { params(docstring: ::YARD::Docstring, include_params: T::Boolean).void }
155
+ def parse_sig(docstring, include_params: T.unsafe(nil)); end
156
+
157
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:50
158
+ sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).void }
159
+ def process_attr(attr_node); end
160
+
161
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:36
162
+ sig { params(def_node: ::YARD::Parser::Ruby::MethodDefinitionNode).void }
163
+ def process_def(def_node); end
138
164
  end
139
165
 
140
- # These node types attached to sigs represent attr_* declarations
166
+ # YARD types that can have docstrings attached to them
141
167
  #
142
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/sig_handler.rb:14
143
- YARDSorbet::Handlers::SigHandler::ATTR_NODE_TYPES = T.let(T.unsafe(nil), Array)
168
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/sig_handler.rb:14
169
+ YARDSorbet::Handlers::SigHandler::Documentable = T.type_alias { T.any(::YARD::CodeObjects::MethodObject, ::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
144
170
 
145
171
  # Class-level handler that folds all `const` and `prop` declarations into the constructor documentation
146
172
  # this needs to be injected as a module otherwise the default Class handler will overwrite documentation
147
173
  #
148
174
  # @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
149
175
  #
150
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_class_handler.rb:10
176
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_class_handler.rb:10
151
177
  module YARDSorbet::Handlers::StructClassHandler
152
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_class_handler.rb:14
178
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_class_handler.rb:14
153
179
  sig { void }
154
180
  def process; end
155
181
 
156
182
  private
157
183
 
158
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_class_handler.rb:50
184
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_class_handler.rb:50
159
185
  sig do
160
186
  params(
161
187
  object: ::YARD::CodeObjects::MethodObject,
@@ -168,11 +194,11 @@ module YARDSorbet::Handlers::StructClassHandler
168
194
 
169
195
  # Create a virtual `initialize` method with all the `prop`/`const` arguments
170
196
  #
171
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_class_handler.rb:30
197
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_class_handler.rb:30
172
198
  sig { params(props: T::Array[::YARDSorbet::TStructProp], class_ns: ::YARD::CodeObjects::ClassObject).void }
173
199
  def process_t_struct_props(props, class_ns); end
174
200
 
175
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_class_handler.rb:60
201
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_class_handler.rb:60
176
202
  sig { params(props: T::Array[::YARDSorbet::TStructProp]).returns(T::Array[[::String, T.nilable(::String)]]) }
177
203
  def to_object_parameters(props); end
178
204
  end
@@ -180,9 +206,9 @@ end
180
206
  # Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
181
207
  # in creating a constructor
182
208
  #
183
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:8
209
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:8
184
210
  class YARDSorbet::Handlers::StructPropHandler < ::YARD::Handlers::Ruby::Base
185
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:15
211
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:15
186
212
  sig { void }
187
213
  def process; end
188
214
 
@@ -190,45 +216,51 @@ class YARDSorbet::Handlers::StructPropHandler < ::YARD::Handlers::Ruby::Base
190
216
 
191
217
  # Add the source and docstring to the method object
192
218
  #
193
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:28
219
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:28
194
220
  sig { params(object: ::YARD::CodeObjects::MethodObject, prop: ::YARDSorbet::TStructProp).void }
195
221
  def decorate_object(object, prop); end
196
222
 
197
- # Get the default prop value
223
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:38
224
+ sig { returns(T::Boolean) }
225
+ def immutable?; end
226
+
227
+ # @return the value passed to the keyword argument, or nil
198
228
  #
199
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:39
200
- sig { returns(T.nilable(::String)) }
201
- def default_value; end
229
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:42
230
+ sig { params(kwd: ::String).returns(T.nilable(::String)) }
231
+ def kw_arg(kwd); end
202
232
 
203
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:44
233
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:45
204
234
  sig { params(name: ::String).returns(::YARDSorbet::TStructProp) }
205
235
  def make_prop(name); end
206
236
 
237
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:56
238
+ sig { returns(T::Array[::YARD::Parser::Ruby::AstNode]) }
239
+ def params; end
240
+
207
241
  # Register the field explicitly as an attribute.
208
- # While `const` attributes are immutable, `prop` attributes may be reassigned.
209
242
  #
210
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:57
243
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:60
211
244
  sig { params(object: ::YARD::CodeObjects::MethodObject, name: ::String).void }
212
245
  def register_attrs(object, name); end
213
246
 
214
247
  # Store the prop for use in the constructor definition
215
248
  #
216
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/handlers/struct_prop_handler.rb:65
249
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/handlers/struct_prop_handler.rb:68
217
250
  sig { params(prop: ::YARDSorbet::TStructProp).void }
218
251
  def update_state(prop); end
219
252
  end
220
253
 
221
254
  # Helper methods for working with `YARD` AST Nodes
222
255
  #
223
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:6
256
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:6
224
257
  module YARDSorbet::NodeUtils
225
258
  class << self
226
259
  # Traverse AST nodes in breadth-first order
227
- #
228
260
  # @note This will skip over some node types.
229
261
  # @yield [YARD::Parser::Ruby::AstNode]
230
262
  #
231
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:22
263
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:21
232
264
  sig do
233
265
  params(
234
266
  node: ::YARD::Parser::Ruby::AstNode,
@@ -237,9 +269,19 @@ module YARDSorbet::NodeUtils
237
269
  end
238
270
  def bfs_traverse(node, &_blk); end
239
271
 
272
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:31
273
+ sig { params(node: ::YARD::Parser::Ruby::AstNode).void }
274
+ def delete_node(node); end
275
+
276
+ # Enqueue the eligible children of a node in the BFS queue
277
+ #
278
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:35
279
+ sig { params(queue: ::Thread::Queue, node: ::YARD::Parser::Ruby::AstNode).void }
280
+ def enqueue_children(queue, node); end
281
+
240
282
  # Gets the node that a sorbet `sig` can be attached do, bypassing visisbility modifiers and the like
241
283
  #
242
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:34
284
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:48
243
285
  sig do
244
286
  params(
245
287
  node: ::YARD::Parser::Ruby::AstNode
@@ -248,118 +290,114 @@ module YARDSorbet::NodeUtils
248
290
  def get_method_node(node); end
249
291
 
250
292
  # Find and return the adjacent node (ascending)
251
- #
252
293
  # @raise [IndexError] if the node does not have an adjacent sibling (ascending)
253
294
  #
254
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:48
295
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:53
255
296
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::YARD::Parser::Ruby::AstNode) }
256
297
  def sibling_node(node); end
298
+
299
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:60
300
+ sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
301
+ def sigable_node?(node); end
302
+
303
+ # @see https://github.com/lsegal/yard/blob/main/lib/yard/handlers/ruby/attribute_handler.rb
304
+ # YARD::Handlers::Ruby::AttributeHandler.validated_attribute_names
305
+ #
306
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:71
307
+ sig { params(attr_node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
308
+ def validated_attribute_names(attr_node); end
257
309
  end
258
310
  end
259
311
 
260
312
  # Command node types that can have type signatures
261
313
  #
262
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:10
314
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:10
263
315
  YARDSorbet::NodeUtils::ATTRIBUTE_METHODS = T.let(T.unsafe(nil), Array)
264
316
 
265
317
  # Skip these method contents during BFS node traversal, they can have their own nested types via `T.Proc`
266
318
  #
267
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:12
319
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:12
268
320
  YARDSorbet::NodeUtils::SKIP_METHOD_CONTENTS = T.let(T.unsafe(nil), Array)
269
321
 
270
322
  # Node types that can have type signatures
271
323
  #
272
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/node_utils.rb:14
324
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/node_utils.rb:14
273
325
  YARDSorbet::NodeUtils::SigableNode = T.type_alias { T.any(::YARD::Parser::Ruby::MethodCallNode, ::YARD::Parser::Ruby::MethodDefinitionNode) }
274
326
 
275
327
  # Translate `sig` type syntax to `YARD` type syntax.
276
328
  #
277
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:6
329
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:6
278
330
  module YARDSorbet::SigToYARD
279
331
  class << self
280
332
  # @see https://yardoc.org/types.html
281
333
  #
282
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:21
334
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:23
283
335
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
284
336
  def convert(node); end
285
337
 
286
338
  private
287
339
 
288
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:54
340
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:58
289
341
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(::String) }
290
342
  def build_generic_type(node); end
291
343
 
292
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:63
344
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:67
293
345
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
294
346
  def convert_aref(node); end
295
347
 
296
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:75
348
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:79
297
349
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
298
350
  def convert_array(node); end
299
351
 
300
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:83
301
- sig { params(node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
302
- def convert_call(node); end
303
-
304
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:88
352
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:87
305
353
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
306
354
  def convert_collection(node); end
307
355
 
308
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:95
356
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:94
309
357
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
310
358
  def convert_hash(node); end
311
359
 
312
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:103
360
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:102
313
361
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
314
362
  def convert_list(node); end
315
363
 
316
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:27
364
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:28
317
365
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
318
366
  def convert_node(node); end
319
367
 
320
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:36
368
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:40
321
369
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns(T::Array[::String]) }
322
370
  def convert_node_type(node); end
323
371
 
324
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:108
325
- sig { params(node_source: ::String).returns([::String]) }
326
- def convert_ref(node_source); end
327
-
328
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:113
372
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:107
329
373
  sig { params(node: ::YARD::Parser::Ruby::MethodCallNode).returns(T::Array[::String]) }
330
374
  def convert_t_method(node); end
331
375
 
332
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:125
376
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/sig_to_yard.rb:118
333
377
  sig { params(node: ::YARD::Parser::Ruby::AstNode).returns([::String]) }
334
378
  def convert_unknown(node); end
335
379
  end
336
380
  end
337
381
 
338
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/sig_to_yard.rb:9
339
- YARDSorbet::SigToYARD::REF_TYPES = T.let(T.unsafe(nil), Hash)
340
-
341
382
  # Used to store the details of a `T::Struct` `prop` definition
342
383
  #
343
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/t_struct_prop.rb:6
384
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/t_struct_prop.rb:6
344
385
  class YARDSorbet::TStructProp < ::T::Struct
345
386
  const :default, T.nilable(::String)
346
387
  const :doc, ::String
347
388
  const :prop_name, ::String
348
389
  const :source, ::String
349
390
  const :types, T::Array[::String]
350
-
351
- class << self
352
- # source://sorbet-runtime-0.5.10346/lib/types/struct.rb:13
353
- def inherited(s); end
354
- end
355
391
  end
356
392
 
357
393
  # Helper methods for working with `YARD` tags
358
394
  #
359
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/tag_utils.rb:6
395
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/tag_utils.rb:6
360
396
  module YARDSorbet::TagUtils
361
397
  class << self
362
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/tag_utils.rb:13
398
+ # @return the tag with the matching `tag_name` and `name`, or `nil`
399
+ #
400
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/tag_utils.rb:16
363
401
  sig do
364
402
  params(
365
403
  docstring: ::YARD::Docstring,
@@ -371,7 +409,7 @@ module YARDSorbet::TagUtils
371
409
 
372
410
  # Create or update a `YARD` tag with type information
373
411
  #
374
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/tag_utils.rb:27
412
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/tag_utils.rb:28
375
413
  sig do
376
414
  params(
377
415
  docstring: ::YARD::Docstring,
@@ -385,7 +423,12 @@ module YARDSorbet::TagUtils
385
423
  end
386
424
  end
387
425
 
426
+ # The `void` return type, as a constant to reduce array allocations
427
+ #
428
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/tag_utils.rb:10
429
+ YARDSorbet::TagUtils::VOID_RETURN_TYPE = T.let(T.unsafe(nil), Array)
430
+
388
431
  # {https://rubygems.org/gems/yard-sorbet Version history}
389
432
  #
390
- # source://yard-sorbet-0.7.0/lib/yard-sorbet/version.rb:7
433
+ # pkg:gem/yard-sorbet#lib/yard-sorbet/version.rb:7
391
434
  YARDSorbet::VERSION = T.let(T.unsafe(nil), String)