discorb 0.18.0 → 0.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/build_version.yml +2 -2
- data/.rubocop.yml +12 -75
- data/Changelog.md +25 -0
- data/Gemfile +4 -4
- data/README.md +2 -1
- data/Rakefile +482 -459
- data/Steepfile +8 -6
- data/docs/application_command.md +1 -0
- data/docs/events.md +2 -2
- data/docs/voice_events.md +6 -6
- data/lib/discorb/allowed_mentions.rb +68 -72
- data/lib/discorb/app_command/command.rb +466 -394
- data/lib/discorb/app_command/common.rb +65 -25
- data/lib/discorb/app_command/handler.rb +304 -265
- data/lib/discorb/app_command.rb +5 -5
- data/lib/discorb/application.rb +198 -197
- data/lib/discorb/asset.rb +101 -101
- data/lib/discorb/attachment.rb +134 -119
- data/lib/discorb/audit_logs.rb +412 -385
- data/lib/discorb/automod.rb +279 -269
- data/lib/discorb/channel/base.rb +107 -108
- data/lib/discorb/channel/category.rb +32 -32
- data/lib/discorb/channel/container.rb +44 -44
- data/lib/discorb/channel/dm.rb +26 -28
- data/lib/discorb/channel/guild.rb +311 -246
- data/lib/discorb/channel/stage.rb +156 -140
- data/lib/discorb/channel/text.rb +430 -336
- data/lib/discorb/channel/thread.rb +374 -325
- data/lib/discorb/channel/voice.rb +85 -79
- data/lib/discorb/channel.rb +5 -5
- data/lib/discorb/client.rb +635 -623
- data/lib/discorb/color.rb +178 -182
- data/lib/discorb/common.rb +168 -164
- data/lib/discorb/components/button.rb +107 -106
- data/lib/discorb/components/select_menu.rb +157 -145
- data/lib/discorb/components/text_input.rb +103 -106
- data/lib/discorb/components.rb +68 -66
- data/lib/discorb/dictionary.rb +135 -135
- data/lib/discorb/embed.rb +404 -398
- data/lib/discorb/emoji.rb +309 -302
- data/lib/discorb/emoji_table.rb +16099 -8857
- data/lib/discorb/error.rb +131 -131
- data/lib/discorb/event.rb +360 -314
- data/lib/discorb/event_handler.rb +39 -39
- data/lib/discorb/exe/about.rb +17 -17
- data/lib/discorb/exe/irb.rb +72 -67
- data/lib/discorb/exe/new.rb +323 -315
- data/lib/discorb/exe/run.rb +69 -68
- data/lib/discorb/exe/setup.rb +57 -55
- data/lib/discorb/exe/show.rb +12 -12
- data/lib/discorb/extend.rb +25 -45
- data/lib/discorb/extension.rb +89 -83
- data/lib/discorb/flag.rb +126 -128
- data/lib/discorb/gateway.rb +984 -794
- data/lib/discorb/gateway_events.rb +670 -638
- data/lib/discorb/gateway_requests.rb +45 -48
- data/lib/discorb/guild.rb +2115 -1626
- data/lib/discorb/guild_template.rb +280 -241
- data/lib/discorb/http.rb +247 -232
- data/lib/discorb/image.rb +42 -42
- data/lib/discorb/integration.rb +169 -161
- data/lib/discorb/intents.rb +161 -163
- data/lib/discorb/interaction/autocomplete.rb +76 -62
- data/lib/discorb/interaction/command.rb +279 -224
- data/lib/discorb/interaction/components.rb +114 -104
- data/lib/discorb/interaction/modal.rb +36 -32
- data/lib/discorb/interaction/response.rb +379 -330
- data/lib/discorb/interaction/root.rb +271 -118
- data/lib/discorb/interaction.rb +5 -5
- data/lib/discorb/invite.rb +154 -153
- data/lib/discorb/member.rb +344 -311
- data/lib/discorb/message.rb +615 -544
- data/lib/discorb/message_meta.rb +197 -186
- data/lib/discorb/modules.rb +371 -290
- data/lib/discorb/permission.rb +305 -289
- data/lib/discorb/presence.rb +352 -346
- data/lib/discorb/rate_limit.rb +81 -76
- data/lib/discorb/reaction.rb +55 -54
- data/lib/discorb/role.rb +272 -240
- data/lib/discorb/shard.rb +76 -74
- data/lib/discorb/sticker.rb +193 -171
- data/lib/discorb/user.rb +205 -188
- data/lib/discorb/utils/colored_puts.rb +16 -16
- data/lib/discorb/utils.rb +12 -16
- data/lib/discorb/voice_state.rb +305 -281
- data/lib/discorb/webhook.rb +537 -507
- data/lib/discorb.rb +62 -56
- data/sig/discorb/activity.rbs +1 -0
- data/sig/discorb/allowed_mentions.rbs +1 -0
- data/sig/discorb/app_command/base.rbs +7 -1
- data/sig/discorb/application.rbs +6 -0
- data/sig/discorb/asset.rbs +2 -0
- data/sig/discorb/attachment.rbs +8 -0
- data/sig/discorb/audit_log.rbs +7 -0
- data/sig/discorb/automod.rbs +32 -6
- data/sig/discorb/avatar.rbs +1 -0
- data/sig/discorb/channel/base.rbs +8 -1
- data/sig/discorb/channel/category.rbs +1 -0
- data/sig/discorb/channel/container.rbs +4 -0
- data/sig/discorb/channel/stage.rbs +4 -0
- data/sig/discorb/channel/text.rbs +2 -2
- data/sig/discorb/channel/thread.rbs +11 -0
- data/sig/discorb/channel/voice.rbs +2 -0
- data/sig/discorb/client.rbs +21 -20
- data/sig/discorb/color.rbs +6 -0
- data/sig/discorb/component/base.rbs +1 -0
- data/sig/discorb/component/button.rbs +2 -0
- data/sig/discorb/component/select_menu.rbs +4 -0
- data/sig/discorb/component/text_input.rbs +1 -0
- data/sig/discorb/custom_emoji.rbs +5 -1
- data/sig/discorb/dictionary.rbs +2 -0
- data/sig/discorb/discord_model.rbs +2 -0
- data/sig/discorb/embed.rbs +7 -0
- data/sig/discorb/emoji.rbs +1 -0
- data/sig/discorb/event_handler.rbs +2 -1
- data/sig/discorb/extension.rbs +13 -12
- data/sig/discorb/flag.rbs +2 -0
- data/sig/discorb/gateway.rbs +5 -0
- data/sig/discorb/guild.rbs +8 -4
- data/sig/discorb/guild_template.rbs +1 -1
- data/sig/discorb/http.rbs +4 -1
- data/sig/discorb/image.rbs +2 -0
- data/sig/discorb/integration.rbs +1 -1
- data/sig/discorb/intents.rbs +4 -3
- data/sig/discorb/interaction/base.rbs +36 -0
- data/sig/discorb/interaction/message_component.rbs +1 -2
- data/sig/discorb/interaction/modal.rbs +1 -2
- data/sig/discorb/interaction/responder.rbs +49 -49
- data/sig/discorb/invite.rbs +1 -1
- data/sig/discorb/member.rbs +2 -0
- data/sig/discorb/message.rbs +8 -1
- data/sig/discorb/messageable.rbs +1 -4
- data/sig/discorb/partial_emoji.rbs +3 -0
- data/sig/discorb/permissions.rbs +7 -0
- data/sig/discorb/presence.rbs +2 -0
- data/sig/discorb/reaction.rbs +5 -1
- data/sig/discorb/role.rbs +7 -1
- data/sig/discorb/scheduled_event.rbs +2 -1
- data/sig/discorb/shard.rbs +2 -1
- data/sig/discorb/snowflake.rbs +2 -0
- data/sig/discorb/stage_instance.rbs +9 -3
- data/sig/discorb/sticker.rbs +1 -1
- data/sig/discorb/unicode_emoji.rbs +4 -0
- data/sig/discorb/user.rbs +24 -20
- data/sig/discorb/webhook.rbs +17 -6
- data/sig/discorb/welcome_screen.rbs +1 -0
- data/sig/override.rbs +2 -0
- metadata +3 -3
data/Rakefile
CHANGED
@@ -1,459 +1,482 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require "bundler/gem_tasks"
|
4
|
-
require_relative "lib/discorb/utils/colored_puts"
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
tag
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
end
|
18
|
-
|
19
|
-
desc "
|
20
|
-
task :
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
end
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
require_relative "template-replace/scripts/
|
94
|
-
require_relative "template-replace/scripts/
|
95
|
-
require_relative "template-replace/scripts/
|
96
|
-
require_relative "template-replace/scripts/
|
97
|
-
require_relative "template-replace/scripts/
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
content.
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
next unless
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
task
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
Rake::Task["document:
|
166
|
-
Rake::Task["document:replace:
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
tags.each do |tag|
|
172
|
-
sh "git checkout #{tag} -f"
|
173
|
-
iputs "Building #{tag}"
|
174
|
-
FileUtils.cp_r("./tmp-template-replace/.", "./template-replace")
|
175
|
-
version = tag.delete_prefix("v")
|
176
|
-
Rake::Task["document:yard"].execute
|
177
|
-
Rake::Task["document:replace:html"].execute
|
178
|
-
Rake::Task["document:replace:css"].execute
|
179
|
-
Rake::Task["document:replace:eol"].execute
|
180
|
-
Rake::Task["document:replace:locale"].execute
|
181
|
-
FileUtils.cp_r("./doc/.", "./tmp-doc")
|
182
|
-
FileUtils.rm_rf("doc")
|
183
|
-
end
|
184
|
-
sh "git switch main -f"
|
185
|
-
FileUtils.cp_r("./tmp-doc/.", "./doc")
|
186
|
-
FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
|
187
|
-
sputs "Successfully built all versions"
|
188
|
-
rescue StandardError => e
|
189
|
-
sh "git switch main -f"
|
190
|
-
raise e
|
191
|
-
end
|
192
|
-
|
193
|
-
desc "Push to discorb-lib/discorb-lib.github.io"
|
194
|
-
task :push do
|
195
|
-
iputs "Pushing documents"
|
196
|
-
Dir.chdir("doc") do
|
197
|
-
sh "git init"
|
198
|
-
sh "git remote add origin git@github.com:discorb-lib/discorb-lib.github.io"
|
199
|
-
sh "git add ."
|
200
|
-
sh "git commit -m \"Update: Update document\""
|
201
|
-
sh "git push -f"
|
202
|
-
end
|
203
|
-
sputs "Successfully pushed documents"
|
204
|
-
end
|
205
|
-
|
206
|
-
namespace :locale do
|
207
|
-
desc "Generate Japanese document"
|
208
|
-
task :ja do
|
209
|
-
require "crowdin-api"
|
210
|
-
require "zip"
|
211
|
-
crowdin =
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
crowdin.
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
Rake::Task["document:
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
client_rbs = File.read("sig/discorb/client.rbs")
|
240
|
-
extension_rbs = File.read("sig/discorb/extension.rbs")
|
241
|
-
event_document = File.read("./docs/events.md")
|
242
|
-
voice_event_document = File.read("./docs/voice_events.md")
|
243
|
-
event_reference = event_document.split("## Event reference")[1]
|
244
|
-
event_reference += voice_event_document.split("# Voice Events")[1]
|
245
|
-
event_reference.gsub!(/^### (.*)$/, "")
|
246
|
-
events = []
|
247
|
-
event_reference.split("#### `")[1..].each do |event|
|
248
|
-
header, content = event.split("`\n", 2)
|
249
|
-
name = header.split("(")[0]
|
250
|
-
description = content.split("| Parameter", 2)[0].strip
|
251
|
-
parameters =
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
|
272
|
-
|
273
|
-
parameter[:type]
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
|
286
|
-
|
287
|
-
|
288
|
-
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
| (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } ->
|
297
|
-
RBS
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
304
|
-
|
305
|
-
|
306
|
-
|
307
|
-
|
308
|
-
|
309
|
-
|
310
|
-
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
raise "Failed to generate Client#
|
319
|
-
|
320
|
-
res =
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
326
|
-
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
|
342
|
-
|
343
|
-
|
344
|
-
|
345
|
-
"
|
346
|
-
|
347
|
-
|
348
|
-
|
349
|
-
|
350
|
-
|
351
|
-
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
|
371
|
-
|
372
|
-
|
373
|
-
|
374
|
-
|
375
|
-
|
376
|
-
|
377
|
-
|
378
|
-
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
|
385
|
-
#
|
386
|
-
#
|
387
|
-
|
388
|
-
|
389
|
-
#
|
390
|
-
#
|
391
|
-
|
392
|
-
|
393
|
-
#
|
394
|
-
#
|
395
|
-
#
|
396
|
-
# @
|
397
|
-
#
|
398
|
-
#
|
399
|
-
#
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
#
|
404
|
-
#
|
405
|
-
#
|
406
|
-
|
407
|
-
|
408
|
-
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
|
413
|
-
|
414
|
-
#
|
415
|
-
|
416
|
-
|
417
|
-
#
|
418
|
-
#
|
419
|
-
|
420
|
-
|
421
|
-
|
422
|
-
|
423
|
-
|
424
|
-
|
425
|
-
#
|
426
|
-
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
end
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "bundler/gem_tasks"
|
4
|
+
require_relative "lib/discorb/utils/colored_puts"
|
5
|
+
task default: %i[]
|
6
|
+
|
7
|
+
# @private
|
8
|
+
def current_version
|
9
|
+
require_relative "lib/discorb/common"
|
10
|
+
tag = `git tag --points-at HEAD`.force_encoding("utf-8").strip
|
11
|
+
tag.empty? ? "main" : Discorb::VERSION
|
12
|
+
end
|
13
|
+
|
14
|
+
desc "Run spec with parallel_rspec"
|
15
|
+
task :spec do
|
16
|
+
sh "parallel_rspec spec/*.spec.rb spec/**/*.spec.rb"
|
17
|
+
end
|
18
|
+
|
19
|
+
desc "Build emoji_table.rb"
|
20
|
+
task :emoji_table do
|
21
|
+
require_relative "lib/discorb"
|
22
|
+
|
23
|
+
iputs "Building emoji_table.rb"
|
24
|
+
res = {}
|
25
|
+
Discorb::EmojiTable::DISCORD_TO_UNICODE.each do |discord, unicode|
|
26
|
+
res[unicode] ||= []
|
27
|
+
res[unicode] << discord
|
28
|
+
end
|
29
|
+
|
30
|
+
res_text = +""
|
31
|
+
res.each do |unicode, discord|
|
32
|
+
res_text << %(#{unicode.unpack("C*").pack("C*").inspect} => %w[#{discord.join(" ")}],\n)
|
33
|
+
end
|
34
|
+
|
35
|
+
table_script = File.read("lib/discorb/emoji_table.rb")
|
36
|
+
|
37
|
+
table_script.gsub!(
|
38
|
+
/(?<=UNICODE_TO_DISCORD = {\n)[\s\S]+(?=}\.freeze)/,
|
39
|
+
res_text
|
40
|
+
)
|
41
|
+
|
42
|
+
File.open("lib/discorb/emoji_table.rb", "w") { |f| f.print(table_script) }
|
43
|
+
`rufo lib/discorb/emoji_table.rb`
|
44
|
+
sputs "Successfully made emoji_table.rb"
|
45
|
+
end
|
46
|
+
|
47
|
+
desc "Format files"
|
48
|
+
task :format do
|
49
|
+
Dir
|
50
|
+
.glob("**/*.rb")
|
51
|
+
.each do |file|
|
52
|
+
next if file.start_with?("vendor")
|
53
|
+
|
54
|
+
iputs "Formatting #{file}"
|
55
|
+
`rufo ./#{file}`
|
56
|
+
content = ""
|
57
|
+
File.open(file, "rb") { |f| content = f.read }
|
58
|
+
content.gsub!("\r\n", "\n")
|
59
|
+
File.open(file, "wb") { |f| f.print(content) }
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
desc "Generate document and replace"
|
64
|
+
namespace :document do
|
65
|
+
version = current_version
|
66
|
+
desc "Just generate document"
|
67
|
+
task :yard do
|
68
|
+
sh "yard -o doc/#{version} --locale #{ENV.fetch("rake_locale", nil) or "en"}"
|
69
|
+
end
|
70
|
+
|
71
|
+
desc "Replace files"
|
72
|
+
namespace :replace do
|
73
|
+
require "fileutils"
|
74
|
+
|
75
|
+
desc "Replace CSS"
|
76
|
+
task :css do
|
77
|
+
iputs "Replacing css"
|
78
|
+
Dir
|
79
|
+
.glob("template-replace/files/**/*.*")
|
80
|
+
.map { |f| f.delete_prefix("template-replace/files") }
|
81
|
+
.each do |file|
|
82
|
+
FileUtils.cp(
|
83
|
+
"template-replace/files#{file}",
|
84
|
+
"doc/#{version}/#{file}"
|
85
|
+
)
|
86
|
+
end
|
87
|
+
sputs "Successfully replaced css"
|
88
|
+
end
|
89
|
+
|
90
|
+
desc "Replace HTML"
|
91
|
+
task :html do
|
92
|
+
require_relative "template-replace/scripts/sidebar"
|
93
|
+
require_relative "template-replace/scripts/version"
|
94
|
+
require_relative "template-replace/scripts/index"
|
95
|
+
require_relative "template-replace/scripts/yard_replace"
|
96
|
+
require_relative "template-replace/scripts/favicon"
|
97
|
+
require_relative "template-replace/scripts/arrow"
|
98
|
+
iputs "Resetting changes"
|
99
|
+
Dir.glob("doc/#{version}/**/*.html") do |f|
|
100
|
+
if (m = f.match(/[0-9]+\.[0-9]+\.[0-9]+(-[a-z]+)?/)) && m[0] != version
|
101
|
+
next
|
102
|
+
end
|
103
|
+
|
104
|
+
content = File.read(f)
|
105
|
+
content.gsub!(/<!--od-->[\s\S]*<!--eod-->/, "")
|
106
|
+
File.write(f, content)
|
107
|
+
end
|
108
|
+
iputs "Adding version tab"
|
109
|
+
%w[file_list class_list method_list].each do |f|
|
110
|
+
replace_sidebar("doc/#{version}/#{f}.html")
|
111
|
+
end
|
112
|
+
|
113
|
+
iputs "Building version tab"
|
114
|
+
build_version_sidebar("doc/#{version}", version)
|
115
|
+
iputs "Replacing _index.html"
|
116
|
+
replace_index("doc/#{version}", version)
|
117
|
+
iputs "Replacing YARD credits"
|
118
|
+
yard_replace("doc/#{version}", version)
|
119
|
+
iputs "Adding favicon"
|
120
|
+
add_favicon("doc/#{version}")
|
121
|
+
iputs "Replacing arrow"
|
122
|
+
replace_arrow("doc/#{version}")
|
123
|
+
iputs "Successfully replaced htmls"
|
124
|
+
end
|
125
|
+
|
126
|
+
desc "Replace EOL"
|
127
|
+
task :eol do
|
128
|
+
iputs "Replacing CRLF with LF"
|
129
|
+
Dir.glob("doc/**/*.*") do |file|
|
130
|
+
next unless File.file?(file)
|
131
|
+
next unless %w[html css js].include? file.split(".").last
|
132
|
+
|
133
|
+
content = ""
|
134
|
+
File.open(file, "rb") { |f| content = f.read }
|
135
|
+
content.gsub!("\r\n", "\n")
|
136
|
+
File.open(file, "wb") { |f| f.print(content) }
|
137
|
+
end
|
138
|
+
sputs "Successfully replaced CRLF with LF"
|
139
|
+
end
|
140
|
+
|
141
|
+
desc "change locale of current document"
|
142
|
+
task :locale do
|
143
|
+
next if ENV["rake_locale"].nil?
|
144
|
+
|
145
|
+
require_relative "template-replace/scripts/locale_#{ENV.fetch("rake_locale", nil)}.rb"
|
146
|
+
replace_locale("doc/main")
|
147
|
+
end
|
148
|
+
end
|
149
|
+
task replace: %i[replace:css replace:html replace:eol]
|
150
|
+
|
151
|
+
desc "Build all versions"
|
152
|
+
task :build_all do
|
153
|
+
require "fileutils"
|
154
|
+
|
155
|
+
iputs "Building all versions"
|
156
|
+
begin
|
157
|
+
FileUtils.rm_rf("doc")
|
158
|
+
rescue StandardError
|
159
|
+
nil
|
160
|
+
end
|
161
|
+
FileUtils.cp_r("./template-replace/.", "./tmp-template-replace")
|
162
|
+
Rake::Task["document:yard"].execute
|
163
|
+
Rake::Task["document:replace:html"].execute
|
164
|
+
Rake::Task["document:replace:css"].execute
|
165
|
+
Rake::Task["document:replace:eol"].execute
|
166
|
+
Rake::Task["document:replace:locale"].execute
|
167
|
+
tags =
|
168
|
+
`git tag`.force_encoding("utf-8")
|
169
|
+
.split("\n")
|
170
|
+
.sort_by { |t| t[1..].split(".").map(&:to_i) }
|
171
|
+
tags.each do |tag|
|
172
|
+
sh "git checkout #{tag} -f"
|
173
|
+
iputs "Building #{tag}"
|
174
|
+
FileUtils.cp_r("./tmp-template-replace/.", "./template-replace")
|
175
|
+
version = tag.delete_prefix("v")
|
176
|
+
Rake::Task["document:yard"].execute
|
177
|
+
Rake::Task["document:replace:html"].execute
|
178
|
+
Rake::Task["document:replace:css"].execute
|
179
|
+
Rake::Task["document:replace:eol"].execute
|
180
|
+
Rake::Task["document:replace:locale"].execute
|
181
|
+
FileUtils.cp_r("./doc/.", "./tmp-doc")
|
182
|
+
FileUtils.rm_rf("doc")
|
183
|
+
end
|
184
|
+
sh "git switch main -f"
|
185
|
+
FileUtils.cp_r("./tmp-doc/.", "./doc")
|
186
|
+
FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
|
187
|
+
sputs "Successfully built all versions"
|
188
|
+
rescue StandardError => e
|
189
|
+
sh "git switch main -f"
|
190
|
+
raise e
|
191
|
+
end
|
192
|
+
|
193
|
+
desc "Push to discorb-lib/discorb-lib.github.io"
|
194
|
+
task :push do
|
195
|
+
iputs "Pushing documents"
|
196
|
+
Dir.chdir("doc") do
|
197
|
+
sh "git init"
|
198
|
+
sh "git remote add origin git@github.com:discorb-lib/discorb-lib.github.io"
|
199
|
+
sh "git add ."
|
200
|
+
sh "git commit -m \"Update: Update document\""
|
201
|
+
sh "git push -f"
|
202
|
+
end
|
203
|
+
sputs "Successfully pushed documents"
|
204
|
+
end
|
205
|
+
|
206
|
+
namespace :locale do
|
207
|
+
desc "Generate Japanese document"
|
208
|
+
task :ja do
|
209
|
+
require "crowdin-api"
|
210
|
+
require "zip"
|
211
|
+
crowdin =
|
212
|
+
Crowdin::Client.new do |config|
|
213
|
+
config.api_token = ENV.fetch("CROWDIN_PERSONAL_TOKEN", nil)
|
214
|
+
config.project_id = ENV["CROWDIN_PROJECT_ID"].to_i
|
215
|
+
end
|
216
|
+
build = crowdin.build_project_translation["data"]["id"]
|
217
|
+
crowdin.download_project_translations("./tmp.zip", build)
|
218
|
+
|
219
|
+
Zip::File.open("tmp.zip") do |zip|
|
220
|
+
zip.each { |entry| zip.extract(entry, entry.name) { true } }
|
221
|
+
end
|
222
|
+
ENV["rake_locale"] = "ja"
|
223
|
+
Rake::Task["document:yard"].execute
|
224
|
+
Rake::Task["document:replace"].execute
|
225
|
+
end
|
226
|
+
|
227
|
+
desc "Generate English document"
|
228
|
+
task :en do
|
229
|
+
Rake::Task["document"].execute("locale:en")
|
230
|
+
end
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
desc "Generate rbs file"
|
235
|
+
namespace :rbs do
|
236
|
+
desc "Generate event signature"
|
237
|
+
task :event do
|
238
|
+
require "syntax_tree/rbs"
|
239
|
+
client_rbs = File.read("sig/discorb/client.rbs")
|
240
|
+
extension_rbs = File.read("sig/discorb/extension.rbs")
|
241
|
+
event_document = File.read("./docs/events.md")
|
242
|
+
voice_event_document = File.read("./docs/voice_events.md")
|
243
|
+
event_reference = event_document.split("## Event reference")[1]
|
244
|
+
event_reference += voice_event_document.split("# Voice Events")[1]
|
245
|
+
event_reference.gsub!(/^### (.*)$/, "")
|
246
|
+
events = []
|
247
|
+
event_reference.split("#### `")[1..].each do |event|
|
248
|
+
header, content = event.split("`\n", 2)
|
249
|
+
name = header.split("(")[0]
|
250
|
+
description = content.split("| Parameter", 2)[0].strip
|
251
|
+
parameters =
|
252
|
+
if content.include?("| Parameter")
|
253
|
+
content.scan(/\| `(.*?)` +\| (.*?) +\| (.*?) +\|/)
|
254
|
+
else
|
255
|
+
[]
|
256
|
+
end
|
257
|
+
events << {
|
258
|
+
name: name,
|
259
|
+
description: description,
|
260
|
+
parameters:
|
261
|
+
parameters.map { |p| { name: p[0], type: p[1], description: p[2] } }
|
262
|
+
}
|
263
|
+
end
|
264
|
+
event_sig = +""
|
265
|
+
event_lock_sig = +""
|
266
|
+
extension_sig = +""
|
267
|
+
events.each do |event|
|
268
|
+
args = []
|
269
|
+
event[:parameters].each do |parameter|
|
270
|
+
args << {
|
271
|
+
name: parameter[:name],
|
272
|
+
type:
|
273
|
+
if parameter[:type].start_with?("?")
|
274
|
+
parameter[:type][1..]
|
275
|
+
else
|
276
|
+
parameter[:type]
|
277
|
+
end.tr("{}`", "")
|
278
|
+
.tr("<>", "[]")
|
279
|
+
.gsub(", ", " | ")
|
280
|
+
.then do |t|
|
281
|
+
if event[:name] == "event_receive"
|
282
|
+
case t
|
283
|
+
when "Hash"
|
284
|
+
next "Discorb::json"
|
285
|
+
end
|
286
|
+
end
|
287
|
+
t
|
288
|
+
end
|
289
|
+
}
|
290
|
+
end
|
291
|
+
sig = args.map { |a| "#{a[:type]} #{a[:name]}" }.join(", ")
|
292
|
+
tuple_sig = args.map { |a| a[:type] }.join(", ")
|
293
|
+
tuple_sig = "[#{tuple_sig}]" if args.length > 1
|
294
|
+
tuple_sig = "void" if args.length.zero?
|
295
|
+
event_sig << <<~RBS
|
296
|
+
| (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> Discorb::EventHandler
|
297
|
+
RBS
|
298
|
+
event_lock_sig << <<~RBS
|
299
|
+
| (:#{event[:name]} event, ?Integer? timeout) { (#{sig}) -> boolish } -> Async::Task[#{tuple_sig}]
|
300
|
+
RBS
|
301
|
+
extension_sig << <<~RBS
|
302
|
+
| (:#{event[:name]} event_name, ?id: Symbol?, **untyped metadata) { (#{sig}) -> void } -> void
|
303
|
+
RBS
|
304
|
+
end
|
305
|
+
event_sig << <<~RBS
|
306
|
+
| (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> Discorb::EventHandler
|
307
|
+
RBS
|
308
|
+
event_lock_sig << <<~RBS
|
309
|
+
| (Symbol event, ?Integer? timeout) { (*untyped) -> boolish } -> Async::Task[untyped]
|
310
|
+
RBS
|
311
|
+
extension_sig << <<~RBS
|
312
|
+
| (Symbol event_name, ?id: Symbol?, **untyped metadata) { (*untyped) -> void } -> void
|
313
|
+
RBS
|
314
|
+
event_sig.sub!("| ", " ").rstrip!
|
315
|
+
event_lock_sig.sub!("| ", " ").rstrip!
|
316
|
+
extension_sig.sub!("| ", " ").rstrip!
|
317
|
+
res = client_rbs.gsub!(/(?<=def on:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
|
318
|
+
raise "Failed to generate Client#on" unless res
|
319
|
+
|
320
|
+
res = client_rbs.gsub!(/(?<=def once:\n)(?:[\s\S]*?)(?=\n\n)/, event_sig)
|
321
|
+
raise "Failed to generate Client#once" unless res
|
322
|
+
|
323
|
+
res =
|
324
|
+
client_rbs.gsub!(
|
325
|
+
/(?<=def event_lock:\n)(?:[\s\S]*?)(?=\n\n)/,
|
326
|
+
event_lock_sig
|
327
|
+
)
|
328
|
+
raise "Failed to generate Client#event_lock" unless res
|
329
|
+
|
330
|
+
res =
|
331
|
+
extension_rbs.gsub!(
|
332
|
+
/(?<=def event:\n)(?:[\s\S]*?)(?=\n\n)/,
|
333
|
+
extension_sig
|
334
|
+
)
|
335
|
+
raise "Failed to generate Extension.event" unless res
|
336
|
+
|
337
|
+
res =
|
338
|
+
extension_rbs.gsub!(
|
339
|
+
/(?<=def once_event:\n)(?:[\s\S]*?)(?=\n\n)/,
|
340
|
+
extension_sig
|
341
|
+
)
|
342
|
+
raise "Failed to generate Extension.once_event" unless res
|
343
|
+
|
344
|
+
File.write(
|
345
|
+
"sig/discorb/client.rbs",
|
346
|
+
SyntaxTree::RBS.format(client_rbs),
|
347
|
+
mode: "wb"
|
348
|
+
)
|
349
|
+
File.write(
|
350
|
+
"sig/discorb/extension.rbs",
|
351
|
+
SyntaxTree::RBS.format(extension_rbs),
|
352
|
+
mode: "wb"
|
353
|
+
)
|
354
|
+
end
|
355
|
+
|
356
|
+
desc "Generate rbs file using sord"
|
357
|
+
task :sord do
|
358
|
+
require "open3"
|
359
|
+
type_errors = {
|
360
|
+
"SORD_ERROR_SymbolSymbolSymbolInteger" =>
|
361
|
+
"{ r: Integer, g: Integer, b: Integer}",
|
362
|
+
"SORD_ERROR_DiscorbRoleDiscorbMemberDiscorbPermissionOverwrite" =>
|
363
|
+
"Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
|
364
|
+
"SORD_ERROR_DiscorbRoleDiscorbMemberPermissionOverwrite" =>
|
365
|
+
"Hash[Discorb::Role | Discorb::Member, Discorb::PermissionOverwrite]",
|
366
|
+
"SORD_ERROR_f | SORD_ERROR_F | SORD_ERROR_d | SORD_ERROR_D | SORD_ERROR_t | SORD_ERROR_T | SORD_ERROR_R" =>
|
367
|
+
'"f" | "F" | "d" | "D" | "t" | "T" | "R"',
|
368
|
+
"SORD_ERROR_dark | SORD_ERROR_light" => '"dark" | "light"',
|
369
|
+
"SORD_ERROR_SymbolStringSymbolboolSymbolObject" =>
|
370
|
+
"String | Integer | Float"
|
371
|
+
}
|
372
|
+
regenerate = ARGV.include?("--regenerate") || ARGV.include?("-r")
|
373
|
+
|
374
|
+
sh(
|
375
|
+
"sord gen sig/discorb.rbs --keep-original-comments " \
|
376
|
+
"--no-sord-comments#{regenerate ? " --regenerate" : " --no-regenerate"}"
|
377
|
+
)
|
378
|
+
base = File.read("sig/discorb.rbs")
|
379
|
+
base.gsub!(/\n +def _set_data: \(.+\) -> untyped\n\n/, "\n")
|
380
|
+
# base.gsub!(/( )?( *)# @private.+?(?:\n\n(?=\1\2#)|(?=\n\2end))/sm, "")
|
381
|
+
base.gsub!(/untyped ([a-z_]*id)/, "_ToS \\1")
|
382
|
+
# #region rbs dictionary
|
383
|
+
base.gsub!(/ class Dictionary.+?end\n/ms, <<-RBS)
|
384
|
+
class Dictionary[K, V]
|
385
|
+
#
|
386
|
+
# Initialize a new Dictionary.
|
387
|
+
#
|
388
|
+
# @param [Hash] hash A hash of items to add to the dictionary.
|
389
|
+
# @param [Integer] limit The maximum number of items in the dictionary.
|
390
|
+
# @param [false, Proc] sort Whether to sort the items in the dictionary.
|
391
|
+
def initialize: (?::Hash[untyped, untyped] hash, ?limit: Integer?, ?sort: (bool | Proc)) -> void
|
392
|
+
|
393
|
+
#
|
394
|
+
# Registers a new item in the dictionary.
|
395
|
+
#
|
396
|
+
# @param [#to_s] id The ID of the item.
|
397
|
+
# @param [Object] body The item to register.
|
398
|
+
#
|
399
|
+
# @return [self] The dictionary.
|
400
|
+
def register: (_ToS id, Object body) -> self
|
401
|
+
|
402
|
+
#
|
403
|
+
# Merges another dictionary into this one.
|
404
|
+
#
|
405
|
+
# @param [Discorb::Dictionary] other The dictionary to merge.
|
406
|
+
def merge: (Discorb::Dictionary other) -> untyped
|
407
|
+
|
408
|
+
#
|
409
|
+
# Removes an item from the dictionary.
|
410
|
+
#
|
411
|
+
# @param [#to_s] id The ID of the item to remove.
|
412
|
+
def remove: (_ToS id) -> untyped
|
413
|
+
|
414
|
+
#
|
415
|
+
# Get an item from the dictionary.
|
416
|
+
#
|
417
|
+
# @param [#to_s] id The ID of the item.
|
418
|
+
# @return [Object] The item.
|
419
|
+
# @return [nil] if the item was not found.
|
420
|
+
#
|
421
|
+
# @overload get(index)
|
422
|
+
# @param [Integer] index The index of the item.
|
423
|
+
#
|
424
|
+
# @return [Object] The item.
|
425
|
+
# @return [nil] if the item is not found.
|
426
|
+
def get: (K id) -> V?
|
427
|
+
|
428
|
+
#
|
429
|
+
# Returns the values of the dictionary.
|
430
|
+
#
|
431
|
+
# @return [Array] The values of the dictionary.
|
432
|
+
def values: () -> ::Array[V]
|
433
|
+
|
434
|
+
#
|
435
|
+
# Checks if the dictionary has an ID.
|
436
|
+
#
|
437
|
+
# @param [#to_s] id The ID to check.
|
438
|
+
#
|
439
|
+
# @return [Boolean] `true` if the dictionary has the ID, `false` otherwise.
|
440
|
+
def has?: (_ToS id) -> bool
|
441
|
+
|
442
|
+
#
|
443
|
+
# Send a message to the array of values.
|
444
|
+
def method_missing: (untyped name) -> untyped
|
445
|
+
|
446
|
+
def respond_to_missing?: (untyped name, untyped args, untyped kwargs) -> bool
|
447
|
+
|
448
|
+
def inspect: () -> String
|
449
|
+
|
450
|
+
# @return [Integer] The maximum number of items in the dictionary.
|
451
|
+
attr_accessor limit: Integer
|
452
|
+
end
|
453
|
+
RBS
|
454
|
+
# #endregion
|
455
|
+
type_errors.each { |error, type| base.gsub!(error, type) }
|
456
|
+
base.gsub!("end\n\n\nend", "end\n")
|
457
|
+
base.gsub!(/ +$/m, "")
|
458
|
+
File.write("sig/discorb.rbs", base)
|
459
|
+
end
|
460
|
+
|
461
|
+
desc "Lint rbs with stree"
|
462
|
+
task :lint do
|
463
|
+
sh "stree check --plugins=rbs sig/**/*.rbs"
|
464
|
+
end
|
465
|
+
|
466
|
+
desc "Autofix rbs with stree"
|
467
|
+
task "lint:fix" do
|
468
|
+
sh "stree write --plugins=rbs sig/**/*.rbs"
|
469
|
+
end
|
470
|
+
end
|
471
|
+
|
472
|
+
task document: %i[document:yard document:replace]
|
473
|
+
|
474
|
+
desc "Lint code with rubocop"
|
475
|
+
task :lint do
|
476
|
+
sh "rubocop lib spec Rakefile"
|
477
|
+
end
|
478
|
+
|
479
|
+
desc "Autofix code with rubocop"
|
480
|
+
task "lint:fix" do
|
481
|
+
sh "rubocop lib spec Rakefile -A"
|
482
|
+
end
|