yard 0.9.28 → 0.9.43

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 (138) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +139 -1
  3. data/LEGAL +29 -1
  4. data/README.md +29 -25
  5. data/docs/GettingStarted.md +41 -15
  6. data/docs/Parser.md +17 -42
  7. data/docs/Tags.md +6 -6
  8. data/docs/Templates.md +5 -4
  9. data/docs/WhatsNew.md +61 -9
  10. data/docs/templates/default/yard_tags/html/setup.rb +1 -1
  11. data/lib/yard/autoload.rb +20 -1
  12. data/lib/yard/cli/command.rb +1 -1
  13. data/lib/yard/cli/diff.rb +7 -2
  14. data/lib/yard/cli/yardoc.rb +1 -1
  15. data/lib/yard/code_objects/base.rb +6 -2
  16. data/lib/yard/code_objects/extra_file_object.rb +1 -0
  17. data/lib/yard/code_objects/macro_object.rb +0 -1
  18. data/lib/yard/code_objects/proxy.rb +1 -1
  19. data/lib/yard/docstring_parser.rb +1 -2
  20. data/lib/yard/handlers/base.rb +23 -1
  21. data/lib/yard/handlers/processor.rb +1 -1
  22. data/lib/yard/handlers/rbs/attribute_handler.rb +79 -0
  23. data/lib/yard/handlers/rbs/base.rb +38 -0
  24. data/lib/yard/handlers/rbs/constant_handler.rb +18 -0
  25. data/lib/yard/handlers/rbs/method_handler.rb +327 -0
  26. data/lib/yard/handlers/rbs/mixin_handler.rb +20 -0
  27. data/lib/yard/handlers/rbs/namespace_handler.rb +26 -0
  28. data/lib/yard/handlers/ruby/attribute_handler.rb +7 -4
  29. data/lib/yard/handlers/ruby/constant_handler.rb +24 -6
  30. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +1 -1
  31. data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +2 -1
  32. data/lib/yard/handlers/ruby/mixin_handler.rb +13 -6
  33. data/lib/yard/handlers/ruby/visibility_handler.rb +14 -1
  34. data/lib/yard/i18n/locale.rb +2 -2
  35. data/lib/yard/i18n/message.rb +2 -2
  36. data/lib/yard/i18n/messages.rb +1 -1
  37. data/lib/yard/i18n/pot_generator.rb +2 -2
  38. data/lib/yard/logging.rb +116 -61
  39. data/lib/yard/open_struct.rb +67 -0
  40. data/lib/yard/options.rb +1 -1
  41. data/lib/yard/parser/rbs/rbs_parser.rb +325 -0
  42. data/lib/yard/parser/rbs/statement.rb +75 -0
  43. data/lib/yard/parser/ruby/ast_node.rb +5 -4
  44. data/lib/yard/parser/ruby/legacy/irb/slex.rb +19 -1
  45. data/lib/yard/parser/ruby/legacy/ruby_lex.rb +20 -5
  46. data/lib/yard/parser/ruby/ruby_parser.rb +117 -26
  47. data/lib/yard/parser/source_parser.rb +7 -7
  48. data/lib/yard/registry_resolver.rb +9 -1
  49. data/lib/yard/rubygems/specification.rb +1 -1
  50. data/lib/yard/server/commands/base.rb +2 -2
  51. data/lib/yard/server/commands/library_command.rb +8 -8
  52. data/lib/yard/server/commands/static_file_helpers.rb +1 -2
  53. data/lib/yard/server/http_utils.rb +512 -0
  54. data/lib/yard/server/library_version.rb +1 -1
  55. data/lib/yard/server/rack_adapter.rb +13 -5
  56. data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +168 -88
  57. data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +203 -12
  58. data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +1 -17
  59. data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -2
  60. data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +3 -3
  61. data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +2 -3
  62. data/lib/yard/server/templates/doc_server/processing/html/processing.erb +22 -16
  63. data/lib/yard/tags/default_factory.rb +1 -0
  64. data/lib/yard/tags/directives.rb +7 -1
  65. data/lib/yard/tags/library.rb +3 -3
  66. data/lib/yard/tags/overload_tag.rb +2 -1
  67. data/lib/yard/tags/tag.rb +4 -3
  68. data/lib/yard/tags/types_explainer.rb +6 -5
  69. data/lib/yard/templates/engine.rb +0 -1
  70. data/lib/yard/templates/helpers/base_helper.rb +1 -1
  71. data/lib/yard/templates/helpers/html_helper.rb +21 -6
  72. data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +6 -1
  73. data/lib/yard/templates/helpers/markup/hybrid_markdown.rb +2147 -0
  74. data/lib/yard/templates/helpers/markup/rdoc_markup.rb +2 -0
  75. data/lib/yard/templates/helpers/markup_helper.rb +4 -2
  76. data/lib/yard/templates/template_options.rb +0 -1
  77. data/lib/yard/version.rb +1 -1
  78. data/po/ja.po +101 -101
  79. data/templates/default/fulldoc/html/css/common.css +1 -1
  80. data/templates/default/fulldoc/html/css/full_list.css +201 -53
  81. data/templates/default/fulldoc/html/css/style.css +991 -399
  82. data/templates/default/fulldoc/html/frames.erb +9 -4
  83. data/templates/default/fulldoc/html/full_list.erb +8 -5
  84. data/templates/default/fulldoc/html/js/app.js +799 -312
  85. data/templates/default/fulldoc/html/js/full_list.js +332 -214
  86. data/templates/default/fulldoc/html/setup.rb +10 -2
  87. data/templates/default/layout/html/headers.erb +1 -1
  88. data/templates/default/layout/html/layout.erb +3 -1
  89. data/templates/default/method/html/header.erb +3 -3
  90. data/templates/default/module/html/defines.erb +3 -3
  91. data/templates/default/module/html/inherited_methods.erb +1 -0
  92. data/templates/default/module/html/method_summary.erb +8 -0
  93. data/templates/default/module/setup.rb +20 -0
  94. data/templates/default/onefile/html/headers.erb +2 -0
  95. data/templates/default/onefile/html/layout.erb +3 -4
  96. data/templates/default/tags/html/example.erb +2 -2
  97. data/templates/default/tags/html/option.erb +1 -1
  98. data/templates/guide/fulldoc/html/css/style.css +347 -97
  99. data/templates/guide/fulldoc/html/js/app.js +61 -33
  100. data/templates/guide/layout/html/layout.erb +69 -72
  101. metadata +21 -60
  102. data/.dockerignore +0 -2
  103. data/.gitattributes +0 -4
  104. data/.github/FUNDING.yml +0 -3
  105. data/.github/ISSUE_TEMPLATE.md +0 -33
  106. data/.github/PULL_REQUEST_TEMPLATE.md +0 -12
  107. data/.github/workflows/ci.yml +0 -30
  108. data/.github/workflows/gem.yml +0 -19
  109. data/.gitignore +0 -14
  110. data/.rspec +0 -2
  111. data/.rubocop.yml +0 -112
  112. data/CODE_OF_CONDUCT.md +0 -15
  113. data/CONTRIBUTING.md +0 -140
  114. data/Dockerfile.samus +0 -28
  115. data/Gemfile +0 -34
  116. data/Rakefile +0 -36
  117. data/SECURITY.md +0 -26
  118. data/benchmarks/builtins_vs_eval.rb +0 -24
  119. data/benchmarks/concat_vs_join.rb +0 -13
  120. data/benchmarks/erb_vs_erubis.rb +0 -54
  121. data/benchmarks/format_args.rb +0 -47
  122. data/benchmarks/generation.rb +0 -38
  123. data/benchmarks/marshal_vs_dbm.rb +0 -64
  124. data/benchmarks/parsing.rb +0 -46
  125. data/benchmarks/pathname_vs_string.rb +0 -51
  126. data/benchmarks/rdoc_vs_yardoc.rb +0 -11
  127. data/benchmarks/registry_store_types.rb +0 -49
  128. data/benchmarks/ri_vs_yri.rb +0 -19
  129. data/benchmarks/ripper_parser.rb +0 -13
  130. data/benchmarks/splat_vs_flatten.rb +0 -13
  131. data/benchmarks/template_erb.rb +0 -23
  132. data/benchmarks/template_format.rb +0 -7
  133. data/benchmarks/template_profile.rb +0 -18
  134. data/benchmarks/yri_cache.rb +0 -20
  135. data/samus.json +0 -49
  136. data/tasks/prepare_tag.rake +0 -45
  137. data/tasks/update_error_map.rake +0 -53
  138. data/yard.gemspec +0 -25
data/templates/guide/layout/html/layout.erb CHANGED
@@ -1,81 +1,78 @@
1
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
1
+ <!DOCTYPE html>
2
+ <html lang="en">
4
3
  <head>
5
4
  <%= erb(:headers) %>
6
- <script type="text/javascript">
7
- $(function() {
8
- $('.object_link').each(function() {
9
- $(this).html($(this).find('a').html())
10
- });
11
- });
12
- $(function() {
13
- generateTOC();
14
- if ($('#toc li').size() == 0) {
15
- $('#sidebar h2.toc').hide();
16
- }
17
- })
18
- </script>
5
+ <script type="text/javascript">
6
+ document.addEventListener("DOMContentLoaded", function() {
7
+ Array.prototype.forEach.call(document.querySelectorAll('.object_link'), function(node) {
8
+ var link = node.querySelector('a');
9
+ if (link) node.innerHTML = link.innerHTML;
10
+ });
11
+ generateTOC();
12
+ if (document.querySelectorAll('#toc li').length === 0) {
13
+ document.querySelector('#sidebar h2.toc').style.display = 'none';
14
+ }
15
+ });
16
+ </script>
19
17
  </head>
20
18
  <body>
21
- <div id="top_nav">
22
- <div id="inner_nav">
23
- <% if options.readme != options.file && options.title %>
24
- <span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
25
- <small class="links">
26
- <% links = [@prevfile ? link_file(@prevfile, '&larr;') : nil,
19
+ <div id="top_nav">
20
+ <div id="inner_nav">
21
+ <% if options.readme != options.file && options.title %>
22
+ <span class="title"><strong><%= options.title %></strong>: <%= @page_title %></span>
23
+ <small class="links">
24
+ <% links = [@prevfile ? link_file(@prevfile, '&larr;') : nil,
27
25
  link_file('index.html', '&uarr;'),
28
26
  @nextfile ? link_file(@nextfile, '&rarr;') : nil].compact %>
29
- <%= links.join(" ") %>
30
- </small>
31
- <% end %>
32
- </div>
33
- </div>
34
- <div id="page">
35
- <div id="sidebar">
36
- <h2 class="toc">Table Of Contents</h2>
37
- <div id="toc"></div>
38
-
39
- <% if options.readme != options.file %>
40
- <h2>Related Topics</h2>
41
- <div id="links">
42
- <ol class="top">
43
- <% if options.readme %>
44
- <li><%= link_file("index.html", "Documentation Overview") %></li>
45
- <% end %>
46
- <ol>
47
- <% if @prevfile %>
48
- <li>
49
- <strong>Previous:</strong>
50
- <%= link_file(@prevfile) %>
51
- </li>
52
- <% end %>
53
- <% if @nextfile %>
54
- <li>
55
- <strong>Next:</strong>
56
- <%= link_file(@nextfile) %>
57
- </li>
58
- <% end %>
59
- </ol>
60
- </ol>
61
- </div>
62
- <% else %>
63
- <h2>List of Topics</h2>
64
- <div id="links">
65
- <ol class="top">
66
- <li><a href="#">Documentation Overview</a></li>
67
- <ol>
68
- <% options.files.each do |file| %>
69
- <li><%= link_file(file.filename, file.title) %></li>
70
- <% end %>
71
- </ol>
72
- </ol>
73
- </div>
74
- <% end %>
75
- </div>
76
- <div id="content"><%= yieldall %></div>
77
- </div>
78
- <div style="clear:both"></div>
27
+ <%= links.join(" ") %>
28
+ </small>
29
+ <% end %>
30
+ </div>
31
+ </div>
32
+ <div id="page">
33
+ <div id="sidebar">
34
+ <h2 class="toc">Table Of Contents</h2>
35
+ <div id="toc"></div>
36
+ <% if options.readme != options.file %>
37
+ <h2>Related Topics</h2>
38
+ <div id="links">
39
+ <ol class="top">
40
+ <% if options.readme %>
41
+ <li><%= link_file("index.html", "Documentation Overview") %></li>
42
+ <% end %>
43
+ <ol>
44
+ <% if @prevfile %>
45
+ <li>
46
+ <strong>Previous:</strong>
47
+ <%= link_file(@prevfile) %>
48
+ </li>
49
+ <% end %>
50
+ <% if @nextfile %>
51
+ <li>
52
+ <strong>Next:</strong>
53
+ <%= link_file(@nextfile) %>
54
+ </li>
55
+ <% end %>
56
+ </ol>
57
+ </ol>
58
+ </div>
59
+ <% else %>
60
+ <h2>List of Topics</h2>
61
+ <div id="links">
62
+ <ol class="top">
63
+ <li><a href="#">Documentation Overview</a></li>
64
+ <ol>
65
+ <% options.files.each do |file| %>
66
+ <li><%= link_file(file.filename, file.title) %></li>
67
+ <% end %>
68
+ </ol>
69
+ </ol>
70
+ </div>
71
+ <% end %>
72
+ </div>
73
+ <div id="content"><%= yieldall %></div>
74
+ </div>
75
+ <div style="clear:both"></div>
79
76
  <%= erb(:footer) %>
80
77
  </body>
81
78
  </html>
metadata CHANGED
@@ -1,29 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yard
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.28
4
+ version: 0.9.43
5
5
  platform: ruby
6
6
  authors:
7
7
  - Loren Segal
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-06-01 00:00:00.000000000 Z
12
- dependencies:
13
- - !ruby/object:Gem::Dependency
14
- name: webrick
15
- requirement: !ruby/object:Gem::Requirement
16
- requirements:
17
- - - "~>"
18
- - !ruby/object:Gem::Version
19
- version: 1.7.0
20
- type: :runtime
21
- prerelease: false
22
- version_requirements: !ruby/object:Gem::Requirement
23
- requirements:
24
- - - "~>"
25
- - !ruby/object:Gem::Version
26
- version: 1.7.0
11
+ date: 2026-04-18 00:00:00.000000000 Z
12
+ dependencies: []
27
13
  description: |2
28
14
  YARD is a documentation generation tool for the Ruby programming language.
29
15
  It enables the user to generate consistent, usable documentation that can be
@@ -37,46 +23,13 @@ executables:
37
23
  extensions: []
38
24
  extra_rdoc_files: []
39
25
  files:
40
- - ".dockerignore"
41
- - ".gitattributes"
42
- - ".github/FUNDING.yml"
43
- - ".github/ISSUE_TEMPLATE.md"
44
- - ".github/PULL_REQUEST_TEMPLATE.md"
45
- - ".github/workflows/ci.yml"
46
- - ".github/workflows/gem.yml"
47
- - ".gitignore"
48
- - ".rspec"
49
- - ".rubocop.yml"
50
26
  - ".yardopts"
51
27
  - ".yardopts_guide"
52
28
  - ".yardopts_i18n"
53
29
  - CHANGELOG.md
54
- - CODE_OF_CONDUCT.md
55
- - CONTRIBUTING.md
56
- - Dockerfile.samus
57
- - Gemfile
58
30
  - LEGAL
59
31
  - LICENSE
60
32
  - README.md
61
- - Rakefile
62
- - SECURITY.md
63
- - benchmarks/builtins_vs_eval.rb
64
- - benchmarks/concat_vs_join.rb
65
- - benchmarks/erb_vs_erubis.rb
66
- - benchmarks/format_args.rb
67
- - benchmarks/generation.rb
68
- - benchmarks/marshal_vs_dbm.rb
69
- - benchmarks/parsing.rb
70
- - benchmarks/pathname_vs_string.rb
71
- - benchmarks/rdoc_vs_yardoc.rb
72
- - benchmarks/registry_store_types.rb
73
- - benchmarks/ri_vs_yri.rb
74
- - benchmarks/ripper_parser.rb
75
- - benchmarks/splat_vs_flatten.rb
76
- - benchmarks/template_erb.rb
77
- - benchmarks/template_format.rb
78
- - benchmarks/template_profile.rb
79
- - benchmarks/yri_cache.rb
80
33
  - bin/yard
81
34
  - bin/yardoc
82
35
  - bin/yri
@@ -162,6 +115,12 @@ files:
162
115
  - lib/yard/handlers/c/symbol_handler.rb
163
116
  - lib/yard/handlers/common/method_handler.rb
164
117
  - lib/yard/handlers/processor.rb
118
+ - lib/yard/handlers/rbs/attribute_handler.rb
119
+ - lib/yard/handlers/rbs/base.rb
120
+ - lib/yard/handlers/rbs/constant_handler.rb
121
+ - lib/yard/handlers/rbs/method_handler.rb
122
+ - lib/yard/handlers/rbs/mixin_handler.rb
123
+ - lib/yard/handlers/rbs/namespace_handler.rb
165
124
  - lib/yard/handlers/ruby/alias_handler.rb
166
125
  - lib/yard/handlers/ruby/attribute_handler.rb
167
126
  - lib/yard/handlers/ruby/base.rb
@@ -212,11 +171,14 @@ files:
212
171
  - lib/yard/i18n/pot_generator.rb
213
172
  - lib/yard/i18n/text.rb
214
173
  - lib/yard/logging.rb
174
+ - lib/yard/open_struct.rb
215
175
  - lib/yard/options.rb
216
176
  - lib/yard/parser/base.rb
217
177
  - lib/yard/parser/c/c_parser.rb
218
178
  - lib/yard/parser/c/comment_parser.rb
219
179
  - lib/yard/parser/c/statement.rb
180
+ - lib/yard/parser/rbs/rbs_parser.rb
181
+ - lib/yard/parser/rbs/statement.rb
220
182
  - lib/yard/parser/ruby/ast_node.rb
221
183
  - lib/yard/parser/ruby/legacy/irb/slex.rb
222
184
  - lib/yard/parser/ruby/legacy/ruby_lex.rb
@@ -259,6 +221,7 @@ files:
259
221
  - lib/yard/server/commands/static_file_helpers.rb
260
222
  - lib/yard/server/doc_server_helper.rb
261
223
  - lib/yard/server/doc_server_serializer.rb
224
+ - lib/yard/server/http_utils.rb
262
225
  - lib/yard/server/library_version.rb
263
226
  - lib/yard/server/rack_adapter.rb
264
227
  - lib/yard/server/router.rb
@@ -298,6 +261,7 @@ files:
298
261
  - lib/yard/templates/helpers/filter_helper.rb
299
262
  - lib/yard/templates/helpers/html_helper.rb
300
263
  - lib/yard/templates/helpers/html_syntax_highlight_helper.rb
264
+ - lib/yard/templates/helpers/markup/hybrid_markdown.rb
301
265
  - lib/yard/templates/helpers/markup/rdoc_markdown.rb
302
266
  - lib/yard/templates/helpers/markup/rdoc_markup.rb
303
267
  - lib/yard/templates/helpers/markup_helper.rb
@@ -311,9 +275,6 @@ files:
311
275
  - lib/yard/verifier.rb
312
276
  - lib/yard/version.rb
313
277
  - po/ja.po
314
- - samus.json
315
- - tasks/prepare_tag.rake
316
- - tasks/update_error_map.rake
317
278
  - templates/default/class/dot/setup.rb
318
279
  - templates/default/class/dot/superklass.erb
319
280
  - templates/default/class/html/constructor_details.erb
@@ -441,13 +402,13 @@ files:
441
402
  - templates/guide/onefile/html/setup.rb
442
403
  - templates/guide/onefile/html/toc.erb
443
404
  - templates/guide/tags/html/setup.rb
444
- - yard.gemspec
445
- homepage: http://yardoc.org
405
+ homepage: https://yardoc.org
446
406
  licenses:
447
407
  - MIT
448
408
  metadata:
449
409
  yard.run: yri
450
- post_install_message:
410
+ changelog_uri: https://rubydoc.info/gems/yard/file/CHANGELOG.md
411
+ post_install_message:
451
412
  rdoc_options: []
452
413
  require_paths:
453
414
  - lib
@@ -455,15 +416,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
455
416
  requirements:
456
417
  - - ">="
457
418
  - !ruby/object:Gem::Version
458
- version: '0'
419
+ version: 1.8.7
459
420
  required_rubygems_version: !ruby/object:Gem::Requirement
460
421
  requirements:
461
422
  - - ">="
462
423
  - !ruby/object:Gem::Version
463
424
  version: '0'
464
425
  requirements: []
465
- rubygems_version: 3.1.2
466
- signing_key:
426
+ rubygems_version: 3.4.20
427
+ signing_key:
467
428
  specification_version: 4
468
429
  summary: Documentation tool for consistent and usable documentation in Ruby.
469
430
  test_files: []
data/.dockerignore DELETED
@@ -1,2 +0,0 @@
1
- doc
2
- .yardoc
data/.gitattributes DELETED
@@ -1,4 +0,0 @@
1
- # Auto detect text files and perform LF normalization
2
- * text eol=lf
3
-
4
- *.png binary
data/.github/FUNDING.yml DELETED
@@ -1,3 +0,0 @@
1
- # These are supported funding model platforms
2
-
3
- github: lsegal
data/.github/ISSUE_TEMPLATE.md DELETED
@@ -1,33 +0,0 @@
1
- [Describe your issue here. Try to be as specific as possible so we can find
2
- the root cause more quickly!]
3
-
4
- ## Steps to reproduce
5
-
6
- This is the minimal reproduction for the issue. I've done my best to remove
7
- all extraneous code and unique environment state on my machine before providing
8
- these steps:
9
-
10
- 1. Run the following command: `yard doc --no-private`
11
- 2. Open browser to (URL)...
12
- 3. Click on Method List link.
13
-
14
- ## Actual Output
15
-
16
- [Provide the full output (**please run yard with `--debug`**) or screenshots for
17
- visual issues.]
18
-
19
- ## Expected Output
20
-
21
- [Describe what you *expected* to happen.]
22
-
23
- ## Environment details:
24
-
25
- - OS: [Enter operating system / version here]
26
- - Ruby version (`ruby -v`): [Enter output of `ruby -v`]
27
- - YARD version (`yard -v`): [Enter output of `yard -v`]
28
- - Relevant software dependency/versions:
29
- - [Any 3rd party libs required to reproduce, omit if none]
30
-
31
- I have read the [Contributing Guide][contrib].
32
-
33
- [contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md
data/.github/PULL_REQUEST_TEMPLATE.md DELETED
@@ -1,12 +0,0 @@
1
- # Description
2
-
3
- Describe your pull request and problem statement here.
4
-
5
- # Completed Tasks
6
-
7
- - [ ] I have read the [Contributing Guide][contrib].
8
- - [ ] The pull request is complete (implemented / written).
9
- - [ ] Git commits have been cleaned up (squash WIP / revert commits).
10
- - [ ] I wrote tests and ran `bundle exec rake` locally (if code is attached to PR).
11
-
12
- [contrib]: https://github.com/lsegal/yard/blob/main/CONTRIBUTING.md
data/.github/workflows/ci.yml DELETED
@@ -1,30 +0,0 @@
1
- name: Unit Tests
2
-
3
- on: [push, pull_request, workflow_dispatch]
4
- jobs:
5
- build:
6
- name: "Ruby: ${{ matrix.ruby }} OS: ${{ matrix.os }}"
7
- runs-on: ${{ matrix.os }}
8
- strategy:
9
- fail-fast: false
10
- matrix:
11
- os: [ubuntu-20.04, macos-10.15, windows-2019]
12
- # 3.0 is interpreted as 3. also disable 2.5 due to bundler crashes
13
- ruby: [2.2, 2.3, 2.4, 2.6, 2.7, "3.0", 3.1]
14
- exclude:
15
- - { os: windows-2019, ruby: 2.2 }
16
- - { os: windows-2019, ruby: 2.3 }
17
- steps:
18
- - name: Checkout
19
- uses: actions/checkout@v2
20
- - name: Install Ruby & 'bundle install'
21
- uses: ruby/setup-ruby@v1
22
- with:
23
- ruby-version: ${{ matrix.ruby }}
24
- bundler-cache: true
25
- - name: Run Test
26
- run: |
27
- ruby -v
28
- bundle exec rake
29
- env:
30
- CI: true
data/.github/workflows/gem.yml DELETED
@@ -1,19 +0,0 @@
1
- name: Release Version
2
-
3
- on:
4
- push:
5
- tags:
6
- - "v*"
7
-
8
- jobs:
9
- release_version:
10
- runs-on: ubuntu-latest
11
- steps:
12
- - uses: actions/checkout@v2
13
- - uses: lsegal/github-release-from-changelog-action@latest
14
- env:
15
- GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16
- - name: Publish RubyGem
17
- uses: dawidd6/action-publish-gem@v1
18
- with:
19
- api_key: ${{secrets.RUBYGEMS_API_KEY}}
data/.gitignore DELETED
@@ -1,14 +0,0 @@
1
- _Yardoc
2
- .DS_Store
3
- *.rbc
4
- *.pdf
5
- .yardoc
6
- *.gem
7
- Gemfile.lock
8
- /pkg
9
- /doc
10
- /doc_guide
11
- /coverage
12
- /.bundle
13
- /vendor
14
- spec/examples.txt
data/.rspec DELETED
@@ -1,2 +0,0 @@
1
- --color
2
- --require spec_helper
data/.rubocop.yml DELETED
@@ -1,112 +0,0 @@
1
- #inherit_from:
2
- # - .rubocop_todo.yml
3
-
4
- Metrics:
5
- Enabled: false
6
- Layout/LineLength:
7
- AutoCorrect: true
8
- Max: 100
9
- Style/Semicolon:
10
- AllowAsExpressionSeparator: true
11
- Style/Documentation:
12
- Enabled: false
13
- Style/ClassVars:
14
- Enabled: false
15
- Style/HashSyntax:
16
- EnforcedStyle: hash_rockets
17
- Layout/SpaceInsideHashLiteralBraces:
18
- EnforcedStyle: no_space
19
- Layout/SpaceInsideBlockBraces:
20
- SpaceBeforeBlockParameters: false
21
- Style/NumericPredicate: # ruby 1.8/1.9 do not have positive?/negative?
22
- EnforcedStyle: comparison
23
- Layout/MultilineMethodCallIndentation:
24
- EnforcedStyle: indented
25
- Layout/DotPosition:
26
- EnforcedStyle: trailing
27
- Style/FormatString:
28
- EnforcedStyle: percent
29
- Layout/FirstArrayElementIndentation:
30
- EnforcedStyle: consistent
31
- Layout/FirstHashElementIndentation:
32
- EnforcedStyle: consistent
33
-
34
- # Disable these until we know what to do with them
35
- Style/SafeNavigation:
36
- Enabled: false # not supported in 1.8...2.1
37
- Style/GuardClause: # does not provide much value
38
- Enabled: false
39
- Naming/VariableNumber:
40
- Enabled: false
41
- Naming/AccessorMethodName: # this creates breaking changes in the API
42
- Enabled: false
43
- Naming/PredicateName: # this creates breaking changes in the API
44
- Enabled: false
45
- Style/MethodMissingSuper: # this doesn't exist in 1.8/1.9
46
- Enabled: false
47
- Style/MissingRespondToMissing: # this doesn't exist in 1.8/1.9
48
- Enabled: false
49
- Style/Lambda: # not supported in 1.8
50
- Enabled: false
51
- Style/EachWithObject: # not supported in 1.8
52
- Enabled: false
53
- Layout/ParameterAlignment: # does not work correctly with subsequent block
54
- Enabled: false
55
- Layout/ArrayAlignment: # does not support indentation
56
- Enabled: false
57
- Layout/HashAlignment: # does not support indentation
58
- Enabled: false
59
- Style/MultilineTernaryOperator:
60
- Enabled: false
61
- Style/ClassAndModuleChildren:
62
- Enabled: false
63
- Layout/EmptyLineBetweenDefs:
64
- AllowAdjacentOneLineDefs: true
65
- Style/SingleLineMethods:
66
- Enabled: false
67
- Style/SingleLineBlockParams:
68
- Enabled: false
69
- Style/NestedTernaryOperator:
70
- Enabled: false
71
- Style/MutableConstant:
72
- Enabled: false
73
- Style/WhenThen:
74
- Enabled: false
75
- Style/StringLiterals:
76
- Enabled: false
77
- Style/StringLiteralsInInterpolation:
78
- Enabled: false
79
- Style/PerlBackrefs:
80
- Enabled: false
81
- Style/BlockComments:
82
- Exclude:
83
- - benchmarks/*.rb
84
- Style/CaseEquality:
85
- Enabled: false
86
- Style/WordArray:
87
- Enabled: false
88
- Style/GlobalVars:
89
- Exclude:
90
- - benchmarks/**/*.rb
91
- - spec/**/*.rb
92
- Lint/RedundantSplatExpansion:
93
- Enabled: false
94
- Security/Eval:
95
- Exclude:
96
- - benchmarks/**/*.rb
97
- - spec/**/*.rb
98
-
99
- Layout/SpaceAroundMethodCallOperator:
100
- Enabled: false
101
- Lint/RaiseException:
102
- Enabled: false
103
- Lint/StructNewOverride:
104
- Enabled: false
105
- Style/ExponentialNotation:
106
- Enabled: false
107
- Style/HashEachMethods:
108
- Enabled: false
109
- Style/HashTransformKeys:
110
- Enabled: false
111
- Style/HashTransformValues:
112
- Enabled: false
data/CODE_OF_CONDUCT.md DELETED
@@ -1,15 +0,0 @@
1
- This document provides community guidelines for a safe, respectful, productive,
2
- and collaborative place for any person who is willing to contribute to the YARD
3
- project. It applies to all “collaborative space”, which is defined as community
4
- communications channels (such as mailing lists, submitted patches, commit
5
- comments, etc.).
6
-
7
- * Participants will be tolerant of opposing views.
8
-
9
- * Participants must ensure that their language and actions are free of personal
10
- attacks and disparaging personal remarks.
11
-
12
- * When interpreting the words and actions of others, participants should always
13
- assume good intentions.
14
-
15
- * Behaviour which can be reasonably considered harassment will not be tolerated.