autodoc 0.8.1 → 0.9.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 (12) hide show
  1. checksums.yaml +4 -4
  2. data/.github/release.yml +23 -0
  3. data/.github/workflows/actions.lock +37 -0
  4. data/.github/workflows/bump-request.yml +26 -0
  5. data/.github/workflows/release.yml +11 -0
  6. data/.github/workflows/test.yml +6 -4
  7. data/Gemfile.lock +194 -139
  8. data/README.md +4 -5
  9. data/autodoc.gemspec +1 -0
  10. data/lib/autodoc/version.rb +1 -1
  11. metadata +8 -9
  12. data/CHANGELOG.md +0 -319
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9183278ddda7427ccdc155a3ad69f43f034b294464550527c07af123faa644db
4
- data.tar.gz: a7ef37d9c410a0ce89e3075db76113539593ea470cbef85177d258358222a9b8
3
+ metadata.gz: 2d103ef3e95ebc45479ee207be8bc938b808a39d215691503b458a2def2f8d42
4
+ data.tar.gz: a4440e56f1111874df07154a49fba894939619f971670808861dd88676330425
5
5
  SHA512:
6
- metadata.gz: 33ccf53ad9a5b809b1a7f48e5e59a31f6379f20575ee792c698211f3734f77ddef99788f542d093bb69c60d0e5f0b443998795110412d08b593df981ddf5c315
7
- data.tar.gz: 49a7f2cffb288e4d87f7bcaef467cdab1e3236080fac816907d9914d7d0105591395710a030b2f77c647ae93e947d79807ba1d88301c51204c0aceae22c48ca1
6
+ metadata.gz: 90df38749e88cc2519c724127e0f8a57da873647b41eb8b7eff53af06384db4f34f8a041c142f84e11e6500b5e8fd3d1f4778c1e27cd18f512e5272a6c8d6fc5
7
+ data.tar.gz: 51a5b8d0fb0f9dd523398be6368eee628f662f681f87dbcd2893a563ac0958f5436a1c226b506023cad5710d4a8e184dee813642bfe11ce24ed5f4019dca5395
data/.github/release.yml ADDED
@@ -0,0 +1,23 @@
1
+ changelog:
2
+ categories:
3
+ - title: Added
4
+ labels:
5
+ - add
6
+ - title: Changed
7
+ labels:
8
+ - change
9
+ - title: Deprecated
10
+ labels:
11
+ - deprecate
12
+ - title: Fixed
13
+ labels:
14
+ - fix
15
+ - title: Removed
16
+ labels:
17
+ - remove
18
+ - title: Security
19
+ labels:
20
+ - security
21
+ - title: Others
22
+ labels:
23
+ - "*"
data/.github/workflows/actions.lock ADDED
@@ -0,0 +1,37 @@
1
+ # This file is machine-generated by `gh actions-lock`.
2
+ # Do not edit by hand; run `gh actions-lock` to update.
3
+ # Docs: https://gh.io/actions-lockfile
4
+ version: 'v0.0.3'
5
+ workflows:
6
+ '.github/workflows/bump-request.yml':
7
+ - 'actions/checkout@v7.0.1'
8
+ - 'r7kamura/bump-request@v0.7.1'
9
+ - 'ruby/setup-ruby@v1.336.0'
10
+ '.github/workflows/release.yml': []
11
+ '.github/workflows/test.yml':
12
+ - 'actions/checkout@v7.0.1'
13
+ - 'ruby/setup-ruby@v1.336.0'
14
+ dependencies:
15
+ 'actions/checkout@v7.0.1':
16
+ ref: 'v7.0.1'
17
+ commit: 'sha1-3d3c42e5aac5ba805825da76410c181273ba90b1'
18
+ owner_id: 44036562
19
+ repo_id: 197814629
20
+ 'actions/setup-node@v7.1.0':
21
+ ref: 'v7.1.0'
22
+ commit: 'sha1-949feb2413d6458794dcd2491c4babbbce0c15c1'
23
+ owner_id: 44036562
24
+ repo_id: 189476904
25
+ 'r7kamura/bump-request@v0.7.1':
26
+ ref: 'v0.7.1'
27
+ commit: 'sha1-b27937188d404bc0c2fd442403e6de1d20f9b349'
28
+ owner_id: 111689
29
+ repo_id: 533135195
30
+ uses:
31
+ - 'actions/checkout@v7.0.1'
32
+ - 'actions/setup-node@v7.1.0'
33
+ 'ruby/setup-ruby@v1.336.0':
34
+ ref: 'v1.336.0'
35
+ commit: 'sha1-de492cf36cbab201753d720ce4f4e336cd688c94'
36
+ owner_id: 210414
37
+ repo_id: 231208785
data/.github/workflows/bump-request.yml ADDED
@@ -0,0 +1,26 @@
1
+ name: bump-request
2
+
3
+ on:
4
+ workflow_dispatch:
5
+ inputs:
6
+ version:
7
+ description: Version to change to.
8
+ required: true
9
+ type: string
10
+
11
+ jobs:
12
+ run:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v7.0.1
16
+ - name: Set up Ruby
17
+ uses: ruby/setup-ruby@v1.336.0
18
+ with:
19
+ ruby-version: 3.3
20
+ bundler-cache: true
21
+ - uses: r7kamura/bump-request@v0.7.1
22
+ with:
23
+ command: |
24
+ sed -i -r 's/([0-9]+\.[0-9]+\.[0-9]+)/${{ inputs.version }}/' lib/autodoc/version.rb
25
+ bundle install
26
+ version: ${{ inputs.version }}
data/.github/workflows/release.yml ADDED
@@ -0,0 +1,11 @@
1
+ name: release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - main
7
+
8
+ jobs:
9
+ release:
10
+ uses: r7kamura/workflows/.github/workflows/gem-release.yml@main
11
+ if: github.repository_owner == 'r7kamura'
data/.github/workflows/test.yml CHANGED
@@ -4,7 +4,7 @@ on:
4
4
  pull_request:
5
5
  push:
6
6
  branches:
7
- - master
7
+ - main
8
8
 
9
9
  jobs:
10
10
  build:
@@ -12,11 +12,13 @@ jobs:
12
12
  strategy:
13
13
  matrix:
14
14
  ruby:
15
- - 2.7.2
15
+ - '3.3'
16
+ - '3.4'
17
+ - '4.0'
16
18
  steps:
17
- - uses: actions/checkout@v2
19
+ - uses: actions/checkout@v7.0.1
18
20
  - name: Set up Ruby
19
- uses: ruby/setup-ruby@v1
21
+ uses: ruby/setup-ruby@v1.336.0
20
22
  with:
21
23
  ruby-version: ${{ matrix.ruby }}
22
24
  bundler-cache: true
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- autodoc (0.8.1)
4
+ autodoc (0.9.0)
5
5
  actionpack
6
6
  activesupport (>= 3.0.0)
7
7
  rspec
@@ -9,181 +9,236 @@ PATH
9
9
  GEM
10
10
  remote: https://rubygems.org/
11
11
  specs:
12
- actioncable (7.0.4.1)
13
- actionpack (= 7.0.4.1)
14
- activesupport (= 7.0.4.1)
12
+ action_text-trix (2.1.19)
13
+ railties
14
+ actioncable (8.1.4)
15
+ actionpack (= 8.1.4)
16
+ activesupport (= 8.1.4)
15
17
  nio4r (~> 2.0)
16
18
  websocket-driver (>= 0.6.1)
17
- actionmailbox (7.0.4.1)
18
- actionpack (= 7.0.4.1)
19
- activejob (= 7.0.4.1)
20
- activerecord (= 7.0.4.1)
21
- activestorage (= 7.0.4.1)
22
- activesupport (= 7.0.4.1)
23
- mail (>= 2.7.1)
24
- net-imap
25
- net-pop
26
- net-smtp
27
- actionmailer (7.0.4.1)
28
- actionpack (= 7.0.4.1)
29
- actionview (= 7.0.4.1)
30
- activejob (= 7.0.4.1)
31
- activesupport (= 7.0.4.1)
32
- mail (~> 2.5, >= 2.5.4)
33
- net-imap
34
- net-pop
35
- net-smtp
36
- rails-dom-testing (~> 2.0)
37
- actionpack (7.0.4.1)
38
- actionview (= 7.0.4.1)
39
- activesupport (= 7.0.4.1)
40
- rack (~> 2.0, >= 2.2.0)
19
+ zeitwerk (~> 2.6)
20
+ actionmailbox (8.1.4)
21
+ actionpack (= 8.1.4)
22
+ activejob (= 8.1.4)
23
+ activerecord (= 8.1.4)
24
+ activestorage (= 8.1.4)
25
+ activesupport (= 8.1.4)
26
+ mail (>= 2.8.0)
27
+ actionmailer (8.1.4)
28
+ actionpack (= 8.1.4)
29
+ actionview (= 8.1.4)
30
+ activejob (= 8.1.4)
31
+ activesupport (= 8.1.4)
32
+ mail (>= 2.8.0)
33
+ rails-dom-testing (~> 2.2)
34
+ actionpack (8.1.4)
35
+ actionview (= 8.1.4)
36
+ activesupport (= 8.1.4)
37
+ nokogiri (>= 1.8.5)
38
+ rack (>= 2.2.4)
39
+ rack-session (>= 1.0.1)
41
40
  rack-test (>= 0.6.3)
42
- rails-dom-testing (~> 2.0)
43
- rails-html-sanitizer (~> 1.0, >= 1.2.0)
44
- actiontext (7.0.4.1)
45
- actionpack (= 7.0.4.1)
46
- activerecord (= 7.0.4.1)
47
- activestorage (= 7.0.4.1)
48
- activesupport (= 7.0.4.1)
41
+ rails-dom-testing (~> 2.2)
42
+ rails-html-sanitizer (~> 1.6)
43
+ useragent (~> 0.16)
44
+ actiontext (8.1.4)
45
+ action_text-trix (~> 2.1.15)
46
+ actionpack (= 8.1.4)
47
+ activerecord (= 8.1.4)
48
+ activestorage (= 8.1.4)
49
+ activesupport (= 8.1.4)
49
50
  globalid (>= 0.6.0)
50
51
  nokogiri (>= 1.8.5)
51
- actionview (7.0.4.1)
52
- activesupport (= 7.0.4.1)
52
+ actionview (8.1.4)
53
+ activesupport (= 8.1.4)
53
54
  builder (~> 3.1)
54
- erubi (~> 1.4)
55
- rails-dom-testing (~> 2.0)
56
- rails-html-sanitizer (~> 1.1, >= 1.2.0)
57
- activejob (7.0.4.1)
58
- activesupport (= 7.0.4.1)
55
+ erubi (~> 1.11)
56
+ rails-dom-testing (~> 2.2)
57
+ rails-html-sanitizer (~> 1.6)
58
+ activejob (8.1.4)
59
+ activesupport (= 8.1.4)
59
60
  globalid (>= 0.3.6)
60
- activemodel (7.0.4.1)
61
- activesupport (= 7.0.4.1)
62
- activerecord (7.0.4.1)
63
- activemodel (= 7.0.4.1)
64
- activesupport (= 7.0.4.1)
65
- activestorage (7.0.4.1)
66
- actionpack (= 7.0.4.1)
67
- activejob (= 7.0.4.1)
68
- activerecord (= 7.0.4.1)
69
- activesupport (= 7.0.4.1)
61
+ activemodel (8.1.4)
62
+ activesupport (= 8.1.4)
63
+ activerecord (8.1.4)
64
+ activemodel (= 8.1.4)
65
+ activesupport (= 8.1.4)
66
+ timeout (>= 0.4.0)
67
+ activestorage (8.1.4)
68
+ actionpack (= 8.1.4)
69
+ activejob (= 8.1.4)
70
+ activerecord (= 8.1.4)
71
+ activesupport (= 8.1.4)
70
72
  marcel (~> 1.0)
71
- mini_mime (>= 1.1.0)
72
- activesupport (7.0.4.1)
73
- concurrent-ruby (~> 1.0, >= 1.0.2)
73
+ activesupport (8.1.4)
74
+ base64
75
+ bigdecimal
76
+ concurrent-ruby (~> 1.0, >= 1.3.1)
77
+ connection_pool (>= 2.2.5)
78
+ drb
74
79
  i18n (>= 1.6, < 2)
80
+ json
81
+ logger (>= 1.4.2)
75
82
  minitest (>= 5.1)
76
- tzinfo (~> 2.0)
77
- builder (3.2.4)
83
+ securerandom (>= 0.3)
84
+ tzinfo (~> 2.0, >= 2.0.5)
85
+ uri (>= 0.13.1)
86
+ base64 (0.3.0)
87
+ bigdecimal (4.1.3)
88
+ builder (3.3.0)
78
89
  coderay (1.1.3)
79
- concurrent-ruby (1.1.10)
80
- crass (1.0.6)
81
- date (3.4.1)
82
- diff-lcs (1.5.0)
83
- erubi (1.12.0)
84
- globalid (1.0.1)
85
- activesupport (>= 5.0)
86
- i18n (1.12.0)
90
+ concurrent-ruby (1.3.8)
91
+ connection_pool (3.0.2)
92
+ crass (1.0.8)
93
+ date (3.6.0)
94
+ diff-lcs (1.6.2)
95
+ drb (2.2.3)
96
+ erb (6.0.7)
97
+ erubi (1.13.1)
98
+ globalid (1.4.0)
99
+ activesupport (>= 6.1)
100
+ i18n (1.15.2)
87
101
  concurrent-ruby (~> 1.0)
88
- loofah (2.19.1)
102
+ io-console (0.9.5)
103
+ irb (1.18.0)
104
+ pp (>= 0.6.0)
105
+ prism (>= 1.3.0)
106
+ rdoc (>= 4.0.0)
107
+ reline (>= 0.4.2)
108
+ json (3.1.0)
109
+ logger (1.7.0)
110
+ loofah (2.25.2)
89
111
  crass (~> 1.0.2)
90
- nokogiri (>= 1.5.9)
91
- mail (2.8.0.1)
112
+ nokogiri (>= 1.12.0)
113
+ mail (2.9.1)
114
+ logger
92
115
  mini_mime (>= 0.1.1)
93
116
  net-imap
94
117
  net-pop
95
118
  net-smtp
96
- marcel (1.0.2)
97
- method_source (1.0.0)
98
- mini_mime (1.1.2)
99
- mini_portile2 (2.8.1)
100
- minitest (5.17.0)
101
- net-imap (0.3.9)
119
+ marcel (1.2.1)
120
+ method_source (1.1.0)
121
+ mini_mime (1.1.5)
122
+ mini_portile2 (2.8.9)
123
+ minitest (6.0.6)
124
+ drb (~> 2.0)
125
+ prism (~> 1.5)
126
+ net-imap (0.6.8)
102
127
  date
103
128
  net-protocol
104
129
  net-pop (0.1.2)
105
130
  net-protocol
106
- net-protocol (0.2.2)
131
+ net-protocol (0.4.0)
107
132
  timeout
108
- net-smtp (0.3.3)
133
+ net-smtp (0.5.2)
109
134
  net-protocol
110
- nio4r (2.5.8)
111
- nokogiri (1.14.3)
112
- mini_portile2 (~> 2.8.0)
135
+ nio4r (2.7.5)
136
+ nokogiri (1.19.4)
137
+ mini_portile2 (~> 2.8.2)
113
138
  racc (~> 1.4)
114
- pry (0.14.2)
139
+ pp (0.6.4)
140
+ prettyprint
141
+ prettyprint (0.2.1)
142
+ prism (1.9.0)
143
+ pry (0.16.1)
115
144
  coderay (~> 1.1)
116
145
  method_source (~> 1.0)
117
- pry-rails (0.3.9)
118
- pry (>= 0.10.4)
119
- racc (1.6.2)
120
- rack (2.2.14)
121
- rack-test (2.0.2)
146
+ reline (>= 0.6.0)
147
+ pry-rails (0.3.11)
148
+ pry (>= 0.13.0)
149
+ racc (1.8.1)
150
+ rack (3.2.8)
151
+ rack-session (2.1.2)
152
+ base64 (>= 0.1.0)
153
+ rack (>= 3.0.0)
154
+ rack-test (2.3.0)
122
155
  rack (>= 1.3)
123
- rails (7.0.4.1)
124
- actioncable (= 7.0.4.1)
125
- actionmailbox (= 7.0.4.1)
126
- actionmailer (= 7.0.4.1)
127
- actionpack (= 7.0.4.1)
128
- actiontext (= 7.0.4.1)
129
- actionview (= 7.0.4.1)
130
- activejob (= 7.0.4.1)
131
- activemodel (= 7.0.4.1)
132
- activerecord (= 7.0.4.1)
133
- activestorage (= 7.0.4.1)
134
- activesupport (= 7.0.4.1)
156
+ rackup (2.3.1)
157
+ rack (>= 3)
158
+ rails (8.1.4)
159
+ actioncable (= 8.1.4)
160
+ actionmailbox (= 8.1.4)
161
+ actionmailer (= 8.1.4)
162
+ actionpack (= 8.1.4)
163
+ actiontext (= 8.1.4)
164
+ actionview (= 8.1.4)
165
+ activejob (= 8.1.4)
166
+ activemodel (= 8.1.4)
167
+ activerecord (= 8.1.4)
168
+ activestorage (= 8.1.4)
169
+ activesupport (= 8.1.4)
135
170
  bundler (>= 1.15.0)
136
- railties (= 7.0.4.1)
137
- rails-dom-testing (2.0.3)
138
- activesupport (>= 4.2.0)
171
+ railties (= 8.1.4)
172
+ rails-dom-testing (2.3.0)
173
+ activesupport (>= 5.0.0)
174
+ minitest
139
175
  nokogiri (>= 1.6)
140
- rails-html-sanitizer (1.4.4)
141
- loofah (~> 2.19, >= 2.19.1)
142
- railties (7.0.4.1)
143
- actionpack (= 7.0.4.1)
144
- activesupport (= 7.0.4.1)
145
- method_source
176
+ rails-html-sanitizer (1.7.1)
177
+ loofah (~> 2.25, >= 2.25.2)
178
+ 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)
179
+ railties (8.1.4)
180
+ actionpack (= 8.1.4)
181
+ activesupport (= 8.1.4)
182
+ irb (~> 1.13)
183
+ rackup (>= 1.0.0)
146
184
  rake (>= 12.2)
147
- thor (~> 1.0)
148
- zeitwerk (~> 2.5)
149
- rake (13.0.6)
150
- redcarpet (3.5.1)
151
- responders (3.0.1)
152
- actionpack (>= 5.0)
153
- railties (>= 5.0)
154
- rspec (3.12.0)
155
- rspec-core (~> 3.12.0)
156
- rspec-expectations (~> 3.12.0)
157
- rspec-mocks (~> 3.12.0)
158
- rspec-core (3.12.0)
159
- rspec-support (~> 3.12.0)
160
- rspec-expectations (3.12.2)
185
+ thor (~> 1.0, >= 1.2.2)
186
+ tsort (>= 0.2)
187
+ zeitwerk (~> 2.6)
188
+ rake (13.4.2)
189
+ rbs (4.2.0)
190
+ logger
191
+ prism (>= 1.6.0)
192
+ tsort
193
+ rdoc (8.1.0)
194
+ erb
195
+ prism (>= 1.6.0)
196
+ rbs (>= 4.0.0)
197
+ tsort
198
+ redcarpet (3.6.1)
199
+ reline (0.7.0)
200
+ io-console (~> 0.5)
201
+ responders (3.2.1)
202
+ actionpack (>= 7.0)
203
+ railties (>= 7.0)
204
+ rspec (3.13.2)
205
+ rspec-core (~> 3.13.0)
206
+ rspec-expectations (~> 3.13.0)
207
+ rspec-mocks (~> 3.13.0)
208
+ rspec-core (3.13.6)
209
+ rspec-support (~> 3.13.0)
210
+ rspec-expectations (3.13.5)
161
211
  diff-lcs (>= 1.2.0, < 2.0)
162
- rspec-support (~> 3.12.0)
163
- rspec-mocks (3.12.3)
212
+ rspec-support (~> 3.13.0)
213
+ rspec-mocks (3.13.8)
164
214
  diff-lcs (>= 1.2.0, < 2.0)
165
- rspec-support (~> 3.12.0)
166
- rspec-rails (6.0.1)
167
- actionpack (>= 6.1)
168
- activesupport (>= 6.1)
169
- railties (>= 6.1)
170
- rspec-core (~> 3.11)
171
- rspec-expectations (~> 3.11)
172
- rspec-mocks (~> 3.11)
173
- rspec-support (~> 3.11)
174
- rspec-support (3.12.0)
175
- sqlite3 (1.6.0)
215
+ rspec-support (~> 3.13.0)
216
+ rspec-rails (8.0.4)
217
+ actionpack (>= 7.2)
218
+ activesupport (>= 7.2)
219
+ railties (>= 7.2)
220
+ rspec-core (>= 3.13.0, < 5.0.0)
221
+ rspec-expectations (>= 3.13.0, < 5.0.0)
222
+ rspec-mocks (>= 3.13.0, < 5.0.0)
223
+ rspec-support (>= 3.13.0, < 5.0.0)
224
+ rspec-support (3.13.7)
225
+ securerandom (0.4.1)
226
+ sqlite3 (2.10.2)
176
227
  mini_portile2 (~> 2.8.0)
177
- thor (1.2.1)
178
- timeout (0.4.3)
179
- tzinfo (2.0.5)
228
+ thor (1.5.0)
229
+ timeout (0.6.1)
230
+ tsort (0.2.0)
231
+ tzinfo (2.0.6)
180
232
  concurrent-ruby (~> 1.0)
233
+ uri (1.1.2)
234
+ useragent (0.16.11)
181
235
  weak_parameters (0.5.0)
182
236
  rails (>= 4.0.0)
183
- websocket-driver (0.7.5)
237
+ websocket-driver (0.8.2)
238
+ base64
184
239
  websocket-extensions (>= 0.1.0)
185
240
  websocket-extensions (0.1.5)
186
- zeitwerk (2.6.6)
241
+ zeitwerk (2.8.3)
187
242
 
188
243
  PLATFORMS
189
244
  ruby
@@ -202,4 +257,4 @@ DEPENDENCIES
202
257
  weak_parameters
203
258
 
204
259
  BUNDLED WITH
205
- 2.4.4
260
+ 2.5.22
data/README.md CHANGED
@@ -1,7 +1,6 @@
1
1
  # Autodoc
2
2
 
3
3
  [![test](https://github.com/r7kamura/autodoc/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/autodoc/actions/workflows/test.yml)
4
- [![Gem Version](https://badge.fury.io/rb/autodoc.svg)](https://rubygems.org/gems/autodoc)
5
4
 
6
5
  Generate documentation from your rack application & request-spec.
7
6
 
@@ -18,7 +17,7 @@ gem "redcarpet", group: :test
18
17
 
19
18
  ## Usage
20
19
  Run rspec with AUTODOC=1 to generate documents for your request-specs tagged with `:autodoc`.
21
- example: Autodoc generates [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/recipes.md) and [doc/toc.md](https://github.com/r7kamura/autodoc/blob/master/spec/dummy/doc/toc.md) from [spec/requests/recipes_spec.rb](https://github.com/r7kamura/autodoc/blob/master/spec/requests/recipes_spec.rb).
20
+ example: Autodoc generates [doc/recipes.md](https://github.com/r7kamura/autodoc/blob/main/spec/dummy/doc/recipes.md) and [doc/toc.md](https://github.com/r7kamura/autodoc/blob/main/spec/dummy/doc/toc.md) from [spec/requests/recipes_spec.rb](https://github.com/r7kamura/autodoc/blob/main/spec/requests/recipes_spec.rb).
22
21
 
23
22
  ```sh
24
23
  # shell-command
@@ -82,10 +81,10 @@ You can configure `Autodoc.configuration` to change its behavior:
82
81
  * path - [String] location to put files (default: ./doc)
83
82
  * suppressed_request_header - [Strings] filtered request header keys
84
83
  * suppressed_response_header - [Strings] filtered response header keys
85
- * template - [String] ERB template for each document (default: [document.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/document.md.erb))
86
- * toc_template - [String] ERB template for ToC (default: [toc.md.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/toc.md.erb))
84
+ * template - [String] ERB template for each document (default: [document.md.erb](https://github.com/r7kamura/autodoc/blob/main/lib/autodoc/templates/document.md.erb))
85
+ * toc_template - [String] ERB template for ToC (default: [toc.md.erb](https://github.com/r7kamura/autodoc/blob/main/lib/autodoc/templates/toc.md.erb))
87
86
  * toc - [Boolean] whether to generate toc.md (default: false)
88
- * toc_html_template - [String] ERB template for html ToC (default: [toc.html.erb](https://github.com/r7kamura/autodoc/blob/master/lib/autodoc/templates/toc.html.erb))
87
+ * toc_html_template - [String] ERB template for html ToC (default: [toc.html.erb](https://github.com/r7kamura/autodoc/blob/main/lib/autodoc/templates/toc.html.erb))
89
88
  * toc_html - [Boolean] whether to generate toc.html - a single page documentation with a toc (default: false)
90
89
  * document_path_from_example - [Proc] specify a Proc to change the naming rule of document file paths
91
90
 
data/autodoc.gemspec CHANGED
@@ -6,6 +6,7 @@ require "autodoc/version"
6
6
  Gem::Specification.new do |spec|
7
7
  spec.name = "autodoc"
8
8
  spec.version = Autodoc::VERSION
9
+ spec.required_ruby_version = ">= 3.3"
9
10
  spec.authors = ["Ryo Nakamura"]
10
11
  spec.email = ["r7kamura@gmail.com"]
11
12
  spec.summary = "Auto-generate JSON API documents from your request-specs."
data/lib/autodoc/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Autodoc
2
- VERSION = "0.8.1"
2
+ VERSION = '0.9.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: autodoc
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.8.1
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ryo Nakamura
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2025-05-14 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: activesupport
@@ -52,16 +51,18 @@ dependencies:
52
51
  - - ">="
53
52
  - !ruby/object:Gem::Version
54
53
  version: '0'
55
- description:
56
54
  email:
57
55
  - r7kamura@gmail.com
58
56
  executables: []
59
57
  extensions: []
60
58
  extra_rdoc_files: []
61
59
  files:
60
+ - ".github/release.yml"
61
+ - ".github/workflows/actions.lock"
62
+ - ".github/workflows/bump-request.yml"
63
+ - ".github/workflows/release.yml"
62
64
  - ".github/workflows/test.yml"
63
65
  - ".gitignore"
64
- - CHANGELOG.md
65
66
  - Gemfile
66
67
  - Gemfile.lock
67
68
  - LICENSE.txt
@@ -130,7 +131,6 @@ homepage: https://github.com/r7kamura/autodoc
130
131
  licenses:
131
132
  - MIT
132
133
  metadata: {}
133
- post_install_message:
134
134
  rdoc_options: []
135
135
  require_paths:
136
136
  - lib
@@ -138,15 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
138
138
  requirements:
139
139
  - - ">="
140
140
  - !ruby/object:Gem::Version
141
- version: '0'
141
+ version: '3.3'
142
142
  required_rubygems_version: !ruby/object:Gem::Requirement
143
143
  requirements:
144
144
  - - ">="
145
145
  - !ruby/object:Gem::Version
146
146
  version: '0'
147
147
  requirements: []
148
- rubygems_version: 3.1.6
149
- signing_key:
148
+ rubygems_version: 4.0.20
150
149
  specification_version: 4
151
150
  summary: Auto-generate JSON API documents from your request-specs.
152
151
  test_files:
data/CHANGELOG.md DELETED
@@ -1,319 +0,0 @@
1
- # Changelog
2
-
3
- All notable changes to this project will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
-
8
- ## Unreleased
9
-
10
- ## 0.8.1 - 2025-05-14
11
-
12
- ### Fixed
13
-
14
- - Silence string literal freeze warnings on Ruby 3.4.
15
-
16
- ## 0.8.0 - 2022-12-23
17
-
18
- ### Fixed
19
-
20
- - Change the order of documents to match the order of tests.
21
-
22
- ## 0.7.7 - 2022-05-17
23
-
24
- ### Fixed
25
-
26
- - Prefer `#media_type` to `#content_type` (for Rails 7's change).
27
- - Fix `ERB.new` arguments style.
28
-
29
- ## 0.7.6 - 2021-04-22
30
-
31
- ### Fixed
32
-
33
- - Replace `URI.unescape` with `URI.decode_www_form_component` for Ruby 3 support.
34
-
35
- ## 0.7.5 - 2021-02-16
36
-
37
- ### Fixed
38
-
39
- - Convert header key to string.
40
-
41
- ## 0.7.4 - 2020-04-14
42
-
43
- ### Fixed
44
-
45
- - Improve error message on no request case.
46
-
47
- ## 0.7.3 - 2019-06-18
48
-
49
- ### Fixed
50
-
51
- - Fix indent in toc template.
52
-
53
- ## 0.7.2 - 2019-01-09
54
-
55
- ### Fixed
56
-
57
- - Fixed broken symlink on spec/dummy/spec.
58
-
59
- ## 0.7.1 - 2018-12-18
60
-
61
- ## 0.7.0 - 2018-08-30
62
-
63
- ### Changed
64
-
65
- - Shell-escape given path.
66
- - Use `#to_hash` to response headers if it can respond it.
67
-
68
- ## 0.6.2 - 2017-08-22
69
-
70
- ### Fixed
71
-
72
- - Support multibyte query parameters.
73
-
74
- ## 0.6.1 - 2017-05-30
75
-
76
- ### Fixed
77
-
78
- - Fix Ruby-level warnings.
79
-
80
- ## 0.6.0 - 2016-03-03
81
-
82
- ### Changed
83
-
84
- - Change the message capitalization rule.
85
-
86
- ## 0.5.3 - 2016-02-19
87
-
88
- ### Fixed
89
-
90
- - Fix bugs on pending examples.
91
-
92
- ## 0.5.2 - 2015-09-18
93
-
94
- ### Fixed
95
-
96
- - Fix version detector.
97
-
98
- ## 0.5.1 - 2015-06-28
99
-
100
- ### Fixed
101
-
102
- - Fix lambda syntax.
103
-
104
- ## 0.5.0 - 2015-04-22
105
-
106
- ### Added
107
-
108
- - Add `Autodoc.configuration.document_path_from_example`.
109
-
110
- ## 0.4.5 - 2015-04-10
111
-
112
- ### Added
113
-
114
- - Support other specs directory than spec/requests.
115
-
116
- ## 0.4.4 - 2015-03-31
117
-
118
- ### Added
119
-
120
- - Support image response.
121
-
122
- ## 0.4.3 - 2015-02-28
123
-
124
- ### Added
125
-
126
- - Support nested parameters on weak_parameters.
127
-
128
- ## 0.4.2 - 2015-02-13
129
-
130
- ### Added
131
-
132
- - Add HTML Documentation support.
133
-
134
- ## 0.4.1 - 2015-01-13
135
-
136
- ### Added
137
-
138
- - Support RSpec 2.99.
139
-
140
- ## 0.4.0 - 2014-10-29
141
-
142
- ### Added
143
-
144
- - Support RSpec 3.
145
-
146
- ## 0.3.6 - 2014-05-19
147
-
148
- ### Added
149
-
150
- - Show dummy message if Content-Type might be BINARY.
151
-
152
- ## 0.3.5 - 2014-02-15
153
-
154
- ### Added
155
-
156
- - Support PATCH method.
157
-
158
- ## 0.3.4 - 2014-01-24
159
-
160
- ### Added
161
-
162
- - Some improvements on the document template file.
163
-
164
- ## 0.3.3 - 2013-12-30
165
-
166
- ### Fixed
167
-
168
- - Fix ToC template for specs in sub-directory.
169
-
170
- ## 0.3.2 - 2013-12-18
171
-
172
- ### Fixed
173
-
174
- - Fix template & document bug.
175
-
176
- ## 0.3.1 - 2013-12-17
177
-
178
- ### Added
179
-
180
- - Filter request & response header by Autodoc.configuration.suppress_{request,response}_header.
181
-
182
- ### Changed
183
-
184
- - Prettify JSON request body.
185
-
186
- ## 0.3.0 - 2013-12-17
187
-
188
- ### Changed
189
-
190
- - Change Autodoc::Document interface & template to mimic HTTP text.
191
-
192
- ## 0.2.8 - 2013-12-17
193
-
194
- ### Changed
195
-
196
- - Include query string into document template.
197
-
198
- ## 0.2.7 - 2013-12-05
199
-
200
- ### Changed
201
-
202
- - Sort list in ToC.
203
-
204
- ## 0.2.6 - 2013-12-02
205
-
206
- ### Fixed
207
-
208
- - Fix ToC generator.
209
-
210
- ## 0.2.5 - 2013-11-30
211
-
212
- ### Added
213
-
214
- - Add ToC generator.
215
- - Use Autodoc.configuration.path to change documents path.
216
-
217
- ## 0.2.4 - 2013-11-30
218
-
219
- ### Added
220
-
221
- - Add Documents class.
222
-
223
- ## 0.2.3 - 2013-11-30
224
-
225
- ### Changed
226
-
227
- - Clean up dependencies & implementation.
228
-
229
- ## 0.2.2 - 2013-11-29
230
-
231
- ### Fixed
232
-
233
- - Fix default documented headers.
234
-
235
- ## 0.2.1 - 2013-11-29
236
-
237
- ### Fixed
238
-
239
- - Fix load dependency on rspec.
240
-
241
- ## 0.2.0 - 2013-11-29
242
-
243
- ### Changed
244
-
245
- - Remove dependency on awesome_print.
246
-
247
- ## 0.1.9 - 2013-11-01
248
-
249
- ### Fixed
250
-
251
- - Fix encoding error at ruby 1.9 or earlier versions.
252
-
253
- ## 0.1.8 - 2013-10-23
254
-
255
- ### Added
256
-
257
- - Support rack-test.
258
-
259
- ## 0.1.7 - 2013-10-08
260
-
261
- ### Changed
262
-
263
- - Change response format from Ruby hash table to JSON object.
264
-
265
- ## 0.1.6 - 2013-09-04
266
-
267
- ### Added
268
-
269
- - Support WeakParameter's :description option.
270
-
271
- ## 0.1.5 - 2013-08-22
272
-
273
- ## 0.1.4 - 2013-08-20
274
-
275
- ## 0.1.3 - 2013-08-20
276
-
277
- ## 0.1.2 - 2013-07-29
278
-
279
- ## 0.1.1 - 2013-07-29
280
-
281
- ### Added
282
-
283
- - Custom template.
284
-
285
- ## 0.1.0 - 2013-07-12
286
-
287
- ### Added
288
-
289
- - AUTODOC environment variable.
290
-
291
- ## 0.0.9 - 2013-07-08
292
-
293
- ## 0.0.8 - 2013-07-08
294
-
295
- ### Changed
296
-
297
- - Show request body.
298
-
299
- ## 0.0.7 - 2013-06-18
300
-
301
- ## 0.0.6 - 2013-06-14
302
-
303
- ## 0.0.5 - 2013-06-11
304
-
305
- ## 0.0.4 - 2013-06-11
306
-
307
- ## 0.0.3 - 2013-06-11
308
-
309
- ### Added
310
-
311
- - Configurable response header.
312
-
313
- ## 0.0.2 - 2013-06-10
314
-
315
- ## 0.0.1 - 2013-06-07
316
-
317
- ### Added
318
-
319
- - 1st release on 2013-06-07.