rdoc-markdown 0.6.0 → 0.7.0

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 (20) hide show
  1. checksums.yaml +4 -4
  2. data/.erb_lint.yml +40 -0
  3. data/.erb_linters/no_embedded_assets.rb +29 -0
  4. data/.erb_linters/non_raw_html.rb +29 -0
  5. data/.standard.yml +3 -0
  6. data/.yard-lint.yml +283 -0
  7. data/AGENTS.md +48 -0
  8. data/CHANGELOG.md +14 -0
  9. data/Gemfile +9 -0
  10. data/Gemfile.lock +164 -34
  11. data/README.md +7 -0
  12. data/Rakefile +12 -8
  13. data/example/Bird.md +1 -1
  14. data/gemfiles/rdoc_head.gemfile +5 -0
  15. data/lib/markdown.rb +1 -0
  16. data/lib/rdoc/generator/markdown.rb +409 -239
  17. data/lib/rdoc/markdown/version.rb +4 -1
  18. data/mutant.yml +15 -0
  19. data/rdoc-markdown.gemspec +27 -25
  20. metadata +41 -4
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- rdoc-markdown (0.6.0)
4
+ rdoc-markdown (0.7.0)
5
5
  csv
6
6
  erb
7
7
  rdoc
@@ -10,64 +10,194 @@ PATH
10
10
  GEM
11
11
  remote: https://rubygems.org/
12
12
  specs:
13
- commonmarker (2.6.3-aarch64-linux)
14
- commonmarker (2.6.3-arm-linux)
15
- commonmarker (2.6.3-arm64-darwin)
16
- commonmarker (2.6.3-x86_64-darwin)
17
- commonmarker (2.6.3-x86_64-linux)
18
- commonmarker (2.6.3-x86_64-linux-musl)
13
+ actionview (8.1.3)
14
+ activesupport (= 8.1.3)
15
+ builder (~> 3.1)
16
+ erubi (~> 1.11)
17
+ rails-dom-testing (~> 2.2)
18
+ rails-html-sanitizer (~> 1.6)
19
+ activesupport (8.1.3)
20
+ base64
21
+ bigdecimal
22
+ concurrent-ruby (~> 1.0, >= 1.3.1)
23
+ connection_pool (>= 2.2.5)
24
+ drb
25
+ i18n (>= 1.6, < 2)
26
+ json
27
+ logger (>= 1.4.2)
28
+ minitest (>= 5.1)
29
+ securerandom (>= 0.3)
30
+ tzinfo (~> 2.0, >= 2.0.5)
31
+ uri (>= 0.13.1)
32
+ ast (2.4.3)
33
+ base64 (0.3.0)
34
+ better_html (2.2.0)
35
+ actionview (>= 7.0)
36
+ activesupport (>= 7.0)
37
+ ast (~> 2.0)
38
+ erubi (~> 1.4)
39
+ parser (>= 2.4)
40
+ smart_properties
41
+ bigdecimal (4.1.2)
42
+ builder (3.3.0)
43
+ commonmarker (2.8.1-x86_64-linux)
44
+ concurrent-ruby (1.3.6)
45
+ connection_pool (3.0.2)
46
+ crass (1.0.6)
19
47
  csv (3.3.5)
20
48
  date (3.5.1)
21
- erb (6.0.1)
49
+ diff-lcs (2.0.0)
50
+ docile (1.4.1)
51
+ drb (2.2.3)
52
+ erb (6.0.4)
53
+ erb_lint (0.9.0)
54
+ activesupport
55
+ better_html (>= 2.0.1)
56
+ parser (>= 2.7.1.4)
57
+ rainbow
58
+ rubocop (>= 1)
59
+ smart_properties
60
+ erubi (1.13.1)
61
+ i18n (1.14.8)
62
+ concurrent-ruby (~> 1.0)
63
+ io-console (0.8.2)
64
+ irb (1.18.0)
65
+ pp (>= 0.6.0)
66
+ prism (>= 1.3.0)
67
+ rdoc (>= 4.0.0)
68
+ reline (>= 0.4.2)
69
+ json (2.19.4)
70
+ language_server-protocol (3.17.0.5)
71
+ lint_roller (1.1.0)
72
+ logger (1.7.0)
73
+ loofah (2.25.1)
74
+ crass (~> 1.0.2)
75
+ nokogiri (>= 1.12.0)
22
76
  minitest (5.27.0)
23
- nokogiri (1.19.0-aarch64-linux-gnu)
24
- racc (~> 1.4)
25
- nokogiri (1.19.0-aarch64-linux-musl)
26
- racc (~> 1.4)
27
- nokogiri (1.19.0-arm-linux-gnu)
28
- racc (~> 1.4)
29
- nokogiri (1.19.0-arm-linux-musl)
30
- racc (~> 1.4)
31
- nokogiri (1.19.0-arm64-darwin)
32
- racc (~> 1.4)
33
- nokogiri (1.19.0-x86_64-darwin)
34
- racc (~> 1.4)
35
- nokogiri (1.19.0-x86_64-linux-gnu)
36
- racc (~> 1.4)
37
- nokogiri (1.19.0-x86_64-linux-musl)
77
+ minitest-strict (1.0.0)
78
+ minitest (>= 5.21, < 7)
79
+ mutant (0.16.2)
80
+ diff-lcs (>= 1.6, < 3)
81
+ irb (~> 1.15)
82
+ parser (~> 3.3.10)
83
+ regexp_parser (~> 2.10)
84
+ securerandom (>= 0.3)
85
+ sorbet-runtime (~> 0.6.0)
86
+ unparser (>= 0.8.2, < 0.10)
87
+ mutant-minitest (0.16.2)
88
+ minitest (>= 5.11, < 7)
89
+ mutant (= 0.16.2)
90
+ mutex_m (~> 0.2)
91
+ mutex_m (0.3.0)
92
+ nokogiri (1.19.2-x86_64-linux-gnu)
38
93
  racc (~> 1.4)
94
+ parallel (1.28.0)
95
+ parser (3.3.11.1)
96
+ ast (~> 2.4.1)
97
+ racc
98
+ pp (0.6.3)
99
+ prettyprint
100
+ prettyprint (0.2.0)
101
+ prism (1.9.0)
39
102
  psych (5.3.1)
40
103
  date
41
104
  stringio
42
105
  racc (1.8.1)
43
- rake (13.3.1)
44
- rdiscount (2.2.7.3)
106
+ rails-dom-testing (2.3.0)
107
+ activesupport (>= 5.0.0)
108
+ minitest
109
+ nokogiri (>= 1.6)
110
+ rails-html-sanitizer (1.7.0)
111
+ loofah (~> 2.25)
112
+ nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
113
+ rainbow (3.1.1)
114
+ rake (13.4.2)
115
+ rdiscount (2.2.7.4)
45
116
  rdoc (7.2.0)
46
117
  erb
47
118
  psych (>= 4.0.0)
48
119
  tsort
120
+ regexp_parser (2.12.0)
121
+ reline (0.6.3)
122
+ io-console (~> 0.5)
49
123
  reverse_markdown (3.0.2)
50
124
  nokogiri
125
+ rubocop (1.84.2)
126
+ json (~> 2.3)
127
+ language_server-protocol (~> 3.17.0.2)
128
+ lint_roller (~> 1.1.0)
129
+ parallel (~> 1.10)
130
+ parser (>= 3.3.0.2)
131
+ rainbow (>= 2.2.2, < 4.0)
132
+ regexp_parser (>= 2.9.3, < 3.0)
133
+ rubocop-ast (>= 1.49.0, < 2.0)
134
+ ruby-progressbar (~> 1.7)
135
+ unicode-display_width (>= 2.4.0, < 4.0)
136
+ rubocop-ast (1.49.1)
137
+ parser (>= 3.3.7.2)
138
+ prism (~> 1.7)
139
+ rubocop-performance (1.26.1)
140
+ lint_roller (~> 1.1)
141
+ rubocop (>= 1.75.0, < 2.0)
142
+ rubocop-ast (>= 1.47.1, < 2.0)
143
+ ruby-progressbar (1.13.0)
144
+ securerandom (0.4.1)
145
+ simplecov (0.22.0)
146
+ docile (~> 1.1)
147
+ simplecov-html (~> 0.11)
148
+ simplecov_json_formatter (~> 0.1)
149
+ simplecov-html (0.13.2)
150
+ simplecov_json_formatter (0.1.4)
151
+ smart_properties (1.17.0)
152
+ sorbet-runtime (0.6.13163)
153
+ standard (1.54.0)
154
+ language_server-protocol (~> 3.17.0.2)
155
+ lint_roller (~> 1.0)
156
+ rubocop (~> 1.84.0)
157
+ standard-custom (~> 1.0.0)
158
+ standard-performance (~> 1.8)
159
+ standard-custom (1.0.2)
160
+ lint_roller (~> 1.0)
161
+ rubocop (~> 1.50)
162
+ standard-performance (1.9.0)
163
+ lint_roller (~> 1.1)
164
+ rubocop-performance (~> 1.26.0)
51
165
  stringio (3.2.0)
52
166
  tsort (0.2.0)
167
+ tzinfo (2.0.6)
168
+ concurrent-ruby (~> 1.0)
169
+ unicode-display_width (3.2.0)
170
+ unicode-emoji (~> 4.1)
171
+ unicode-emoji (4.2.0)
172
+ unparser (0.9.0)
173
+ diff-lcs (>= 1.6, < 3)
174
+ parser (>= 3.3.0)
175
+ prism (>= 1.5.1)
176
+ uri (1.1.1)
177
+ yard (0.9.43)
178
+ yard-lint (1.5.1)
179
+ yard (~> 0.9)
180
+ zeitwerk (~> 2.6)
181
+ zeitwerk (2.7.5)
53
182
 
54
183
  PLATFORMS
55
- aarch64-linux-gnu
56
- aarch64-linux-musl
57
- arm-linux-gnu
58
- arm-linux-musl
59
- arm64-darwin
60
- x86_64-darwin
61
184
  x86_64-linux-gnu
62
- x86_64-linux-musl
63
185
 
64
186
  DEPENDENCIES
65
- bundler (~> 2.0)
187
+ bundler (>= 2.0)
66
188
  commonmarker
189
+ erb_lint
67
190
  minitest (~> 5.0)
191
+ minitest-strict (~> 1.0)
192
+ mutant
193
+ mutant-minitest
194
+ mutex_m
68
195
  rake (~> 13.0)
69
196
  rdiscount (~> 2.0)
70
197
  rdoc-markdown!
198
+ simplecov (~> 0.22)
199
+ standard
200
+ yard-lint
71
201
 
72
202
  BUNDLED WITH
73
- 2.6.1
203
+ 4.0.10
data/README.md CHANGED
@@ -57,6 +57,7 @@ Following command should run entire testsuit:
57
57
  ```
58
58
  rake test
59
59
  ```
60
+ The test suite loads `minitest-strict`, so boolean and nil assertions only pass on exact `true`, `false`, and `nil` values.
60
61
  Testing is not excessive, just verifies that basic functionality is operational.
61
62
 
62
63
  To validate generated markdown against GitHub Flavored Markdown and check local links/anchors:
@@ -81,6 +82,12 @@ MARKDOWN_VALIDATE_STRICT_VENDOR=1 rake markdown:validate
81
82
 
82
83
  This task is also executed in CI.
83
84
 
85
+ To lint markdown ERB templates:
86
+
87
+ ```
88
+ bundle exec rake erb:lint
89
+ ```
90
+
84
91
  ### Integration harness: minitest
85
92
  To run the integration harness against minitest (aligned with docs.seattlerb.org/minitest):
86
93
 
data/Rakefile CHANGED
@@ -13,6 +13,13 @@ end
13
13
 
14
14
  task default: [:test]
15
15
 
16
+ namespace :erb do
17
+ desc "Lint markdown ERB templates"
18
+ task :lint do
19
+ sh "bundle exec erb_lint --lint-all"
20
+ end
21
+ end
22
+
16
23
  namespace :markdown do
17
24
  desc "Validate generated markdown as GitHub Flavored Markdown"
18
25
  task :validate do
@@ -104,9 +111,6 @@ def minitest_docs_files(root)
104
111
  files = Dir[File.join(root, "lib/**/*.rb")]
105
112
  files.concat(Dir[File.join(root, "*.rdoc")])
106
113
 
107
- manifest = File.join(root, "Manifest.txt")
108
- files << manifest if File.file?(manifest)
109
-
110
114
  files.uniq
111
115
  end
112
116
 
@@ -131,18 +135,18 @@ end
131
135
 
132
136
  namespace :vendor do
133
137
  namespace :setup do
134
- MINITEST_REF = "v6.0.1"
135
- RAILS_REF = ENV.fetch("RAILS_REF", "main")
138
+ minitest_ref = "v6.0.1"
139
+ rails_ref = ENV.fetch("RAILS_REF", "main")
136
140
 
137
141
  desc "Clone/update vendor/minitest and checkout docs-aligned tag"
138
142
  task :minitest do
139
- ensure_git_checkout(path: "vendor/minitest", url: "https://github.com/minitest/minitest.git", ref: MINITEST_REF)
140
- Dir.chdir("vendor/minitest") { sh "git checkout #{MINITEST_REF}" }
143
+ ensure_git_checkout(path: "vendor/minitest", url: "https://github.com/minitest/minitest.git", ref: minitest_ref)
144
+ Dir.chdir("vendor/minitest") { sh "git checkout #{minitest_ref}" }
141
145
  end
142
146
 
143
147
  desc "Clone/update vendor/rails"
144
148
  task :rails do
145
- ensure_git_checkout(path: "vendor/rails", url: "https://github.com/rails/rails.git", ref: RAILS_REF)
149
+ ensure_git_checkout(path: "vendor/rails", url: "https://github.com/rails/rails.git", ref: rails_ref)
146
150
  end
147
151
  end
148
152
 
data/example/Bird.md CHANGED
@@ -5,7 +5,7 @@ The base class for all birds.
5
5
 
6
6
  ### Public Instance Methods
7
7
 
8
- #### `fly(string, number) -> bool`
8
+ #### `fly(direction: string, velocity: number) -> bool`
9
9
  <a id="method-i-fly"></a>
10
10
 
11
11
  Fly somewhere.
data/gemfiles/rdoc_head.gemfile ADDED
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ eval_gemfile "../Gemfile"
4
+
5
+ gem "rdoc", git: "https://github.com/ruby/rdoc.git", branch: "master"
data/lib/markdown.rb CHANGED
@@ -2,5 +2,6 @@
2
2
 
3
3
  require "rdoc/generator/markdown"
4
4
 
5
+ # Compatibility namespace loaded by RDoc's generator discovery.
5
6
  class RDoc::Markdown
6
7
  end