m2m_keygen 0.4.9 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.overcommit.yml +4 -7
- data/.rubocop.yml +19 -16
- data/.ruby-version +1 -1
- data/.streerc +1 -0
- data/.tool-versions +1 -1
- data/CHANGELOG.md +70 -1
- data/Gemfile +2 -2
- data/Gemfile.lock +135 -158
- data/README.md +64 -78
- data/docs/MIGRATING.md +69 -0
- data/docs/SPEC.md +245 -0
- data/examples/nonce_store/postgres.rb +40 -0
- data/examples/nonce_store/redis.rb +23 -0
- data/gemfiles/rack_2.gemfile +5 -0
- data/gemfiles/rack_3.gemfile +5 -0
- data/lib/m2m_keygen/canonicalizer.rb +57 -0
- data/lib/m2m_keygen/nonce_store/disabled.rb +19 -0
- data/lib/m2m_keygen/nonce_store/memory.rb +64 -0
- data/lib/m2m_keygen/nonce_store.rb +18 -0
- data/lib/m2m_keygen/rack_validator.rb +86 -19
- data/lib/m2m_keygen/request_signer/signed_request.rb +10 -0
- data/lib/m2m_keygen/request_signer.rb +118 -0
- data/lib/m2m_keygen/signature.rb +41 -39
- data/lib/m2m_keygen/types/params_type.rb +6 -17
- data/lib/m2m_keygen/version.rb +1 -1
- data/lib/m2m_keygen.rb +6 -0
- data/m2m_keygen.gemspec +12 -14
- data/sorbet/config +1 -0
- data/sorbet/rbi/gems/.gitattributes +1 -0
- data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi} +45 -79
- data/sorbet/rbi/gems/{benchmark@0.2.0.rbi → benchmark@0.5.0.rbi} +91 -58
- data/sorbet/rbi/gems/bundler-audit@0.9.3.rbi +397 -0
- data/sorbet/rbi/gems/byebug@13.0.0.rbi +3651 -0
- data/sorbet/rbi/gems/childprocess@5.1.0.rbi +336 -0
- data/sorbet/rbi/gems/concurrent-ruby@1.3.7.rbi +384 -0
- data/sorbet/rbi/gems/{diff-lcs@1.5.0.rbi → diff-lcs@1.6.2.rbi} +189 -199
- data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +147 -147
- data/sorbet/rbi/gems/dotenv@3.2.0.rbi +267 -0
- data/sorbet/rbi/gems/erubi@1.13.1.rbi +155 -0
- data/sorbet/rbi/gems/{faker@2.22.0.rbi → faker@3.8.0.rbi} +8468 -3829
- data/sorbet/rbi/gems/{ffi@1.15.5.rbi → ffi@1.17.4.rbi} +1 -0
- data/sorbet/rbi/gems/{formatador@1.1.0.rbi → formatador@1.2.3.rbi} +1 -0
- data/sorbet/rbi/gems/{guard@2.18.0.rbi → guard@2.20.1.rbi} +1 -0
- data/sorbet/rbi/gems/{i18n@1.12.0.rbi → i18n@1.15.2.rbi} +687 -827
- data/sorbet/rbi/gems/io-console@0.8.2.rbi +9 -0
- data/sorbet/rbi/gems/{json@2.6.2.rbi → json@2.20.0.rbi} +994 -252
- data/sorbet/rbi/gems/language_server-protocol@3.17.0.5.rbi +9 -0
- data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +189 -0
- data/sorbet/rbi/gems/listen@3.10.0.rbi +9 -0
- data/sorbet/rbi/gems/logger@1.7.0.rbi +896 -0
- data/sorbet/rbi/gems/{lumberjack@1.2.8.rbi → lumberjack@1.4.2.rbi} +1 -0
- data/sorbet/rbi/gems/{method_source@1.0.0.rbi → method_source@1.1.0.rbi} +111 -90
- data/sorbet/rbi/gems/{overcommit@0.59.1.rbi → overcommit@0.71.0.rbi} +503 -647
- data/sorbet/rbi/gems/parallel@2.1.0.rbi +321 -0
- data/sorbet/rbi/gems/parser@3.3.11.1.rbi +5229 -0
- data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +878 -0
- data/sorbet/rbi/gems/prism@1.9.0.rbi +42224 -0
- data/sorbet/rbi/gems/pry-byebug@3.12.0.rbi +481 -0
- data/sorbet/rbi/gems/{pry@0.14.1.rbi → pry@0.16.0.rbi} +2567 -3550
- data/sorbet/rbi/gems/{racc@1.6.0.rbi → racc@1.8.1.rbi} +54 -40
- data/sorbet/rbi/gems/rack@3.2.6.rbi +4653 -0
- data/sorbet/rbi/gems/{rake@13.0.6.rbi → rake@13.4.2.rbi} +963 -732
- data/sorbet/rbi/gems/{rb-inotify@0.10.1.rbi → rb-inotify@0.11.1.rbi} +1 -0
- data/sorbet/rbi/gems/rbi@0.3.14.rbi +5519 -0
- data/sorbet/rbi/gems/rbs@4.0.3.rbi +6908 -0
- data/sorbet/rbi/gems/regexp_parser@2.12.0.rbi +3398 -0
- data/sorbet/rbi/gems/reline@0.6.3.rbi +2446 -0
- data/sorbet/rbi/gems/require-hooks@0.4.0.rbi +152 -0
- data/sorbet/rbi/gems/{rexml@3.2.5.rbi → rexml@3.4.4.rbi} +1085 -894
- data/sorbet/rbi/gems/rspec-core@3.13.6.rbi +9475 -0
- data/sorbet/rbi/gems/rspec-expectations@3.13.5.rbi +6108 -0
- data/sorbet/rbi/gems/rspec-mocks@3.13.8.rbi +4787 -0
- data/sorbet/rbi/gems/rspec-support@3.13.7.rbi +1274 -0
- data/sorbet/rbi/gems/rspec@3.13.2.rbi +15 -0
- data/sorbet/rbi/gems/rspec_in_context@1.2.2.rbi +294 -0
- data/sorbet/rbi/gems/rubocop-ast@1.49.1.rbi +7140 -0
- data/sorbet/rbi/gems/rubocop-faker@1.3.0.rbi +88 -0
- data/sorbet/rbi/gems/rubocop-performance@1.26.1.rbi +3403 -0
- data/sorbet/rbi/gems/rubocop-sorbet@0.12.0.rbi +2448 -0
- data/sorbet/rbi/gems/rubocop@1.88.1.rbi +63103 -0
- data/sorbet/rbi/gems/ruby-lsp@0.26.9.rbi +28 -0
- data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +988 -0
- data/sorbet/rbi/gems/rubydex@0.2.7.rbi +836 -0
- data/sorbet/rbi/gems/simplecov-html@0.13.2.rbi +90 -0
- data/sorbet/rbi/gems/{simplecov@0.21.2.rbi → simplecov@0.22.0.rbi} +438 -578
- data/sorbet/rbi/gems/spoom@1.8.2.rbi +6691 -0
- data/sorbet/rbi/gems/syntax_tree@6.3.0.rbi +22090 -0
- data/sorbet/rbi/gems/tapioca@0.19.2.rbi +3597 -0
- data/sorbet/rbi/gems/{thor@1.2.1.rbi → thor@1.5.0.rbi} +1085 -1171
- data/sorbet/rbi/gems/tsort@0.2.0.rbi +389 -0
- data/sorbet/rbi/gems/unicode-display_width@3.2.0.rbi +130 -0
- data/sorbet/rbi/gems/unicode-emoji@4.2.0.rbi +332 -0
- data/sorbet/rbi/gems/{yard-sorbet@0.7.0.rbi → yard-sorbet@0.9.0.rbi} +142 -99
- data/sorbet/rbi/gems/{yard@0.9.28.rbi → yard@0.9.44.rbi} +5350 -6316
- data/sorbet/rbi/gems/zeitwerk@2.8.2.rbi +1178 -0
- metadata +105 -111
- data/.prettierrc.js +0 -4
- data/docs/M2mKeygen/Error.html +0 -135
- data/docs/M2mKeygen/ParamsEncoder.html +0 -321
- data/docs/M2mKeygen/RackValidator.html +0 -533
- data/docs/M2mKeygen/Signature.html +0 -680
- data/docs/M2mKeygen/Types.html +0 -147
- data/docs/M2mKeygen.html +0 -157
- data/docs/_index.html +0 -182
- data/docs/class_list.html +0 -51
- data/docs/css/common.css +0 -1
- data/docs/css/full_list.css +0 -58
- data/docs/css/style.css +0 -497
- data/docs/file.README.html +0 -230
- data/docs/file_list.html +0 -56
- data/docs/frames.html +0 -17
- data/docs/index.html +0 -230
- data/docs/js/app.js +0 -314
- data/docs/js/full_list.js +0 -216
- data/docs/js/jquery.js +0 -4
- data/docs/method_list.html +0 -139
- data/docs/top-level-namespace.html +0 -110
- data/lib/m2m_keygen/params_encoder.rb +0 -56
- data/package.json +0 -12
- data/sig/m2m_keygen.rbs +0 -4
- data/sorbet/rbi/gems/activesupport@7.0.3.1.rbi +0 -18608
- data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -522
- data/sorbet/rbi/gems/bundler-audit@0.9.1.rbi +0 -308
- data/sorbet/rbi/gems/byebug@11.1.3.rbi +0 -3603
- data/sorbet/rbi/gems/childprocess@4.1.0.rbi +0 -401
- data/sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi +0 -11581
- data/sorbet/rbi/gems/dotenv@2.8.1.rbi +0 -234
- data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -8
- data/sorbet/rbi/gems/haml@5.2.2.rbi +0 -3190
- data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +0 -19
- data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -133
- data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3261
- data/sorbet/rbi/gems/listen@3.7.1.rbi +0 -1181
- data/sorbet/rbi/gems/minitest@5.16.3.rbi +0 -1459
- data/sorbet/rbi/gems/nokogiri@1.13.8.rbi +0 -6514
- data/sorbet/rbi/gems/parallel@1.22.1.rbi +0 -277
- data/sorbet/rbi/gems/parser@3.1.2.1.rbi +0 -6826
- data/sorbet/rbi/gems/prettier@3.2.0.rbi +0 -22
- data/sorbet/rbi/gems/prettier_print@0.1.0.rbi +0 -8
- data/sorbet/rbi/gems/pry-byebug@3.10.1.rbi +0 -1222
- data/sorbet/rbi/gems/rack@2.2.4.rbi +0 -5630
- data/sorbet/rbi/gems/rbi@0.0.15.rbi +0 -3007
- data/sorbet/rbi/gems/rbs@2.6.0.rbi +0 -8
- data/sorbet/rbi/gems/regexp_parser@2.5.0.rbi +0 -3366
- data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -389
- data/sorbet/rbi/gems/rspec-core@3.11.0.rbi +0 -10786
- data/sorbet/rbi/gems/rspec-expectations@3.11.0.rbi +0 -8170
- data/sorbet/rbi/gems/rspec-mocks@3.11.1.rbi +0 -5385
- data/sorbet/rbi/gems/rspec-support@3.11.0.rbi +0 -1746
- data/sorbet/rbi/gems/rspec@3.11.0.rbi +0 -187
- data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +0 -1113
- data/sorbet/rbi/gems/rubocop-ast@1.21.0.rbi +0 -7044
- data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +0 -106
- data/sorbet/rbi/gems/rubocop-performance@1.14.3.rbi +0 -2982
- data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +0 -990
- data/sorbet/rbi/gems/rubocop@1.35.1.rbi +0 -52002
- data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +0 -1239
- data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -219
- data/sorbet/rbi/gems/solargraph@0.46.0.rbi +0 -9075
- data/sorbet/rbi/gems/spoom@1.1.12.rbi +0 -2369
- data/sorbet/rbi/gems/syntax_tree-haml@1.3.1.rbi +0 -8
- data/sorbet/rbi/gems/syntax_tree-rbs@0.5.0.rbi +0 -8
- data/sorbet/rbi/gems/syntax_tree@3.5.0.rbi +0 -8
- data/sorbet/rbi/gems/tapioca@0.9.4.rbi +0 -2946
- data/sorbet/rbi/gems/temple@0.8.2.rbi +0 -1712
- data/sorbet/rbi/gems/tilt@2.0.11.rbi +0 -742
- data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +0 -5914
- data/sorbet/rbi/gems/unicode-display_width@2.2.0.rbi +0 -48
- data/sorbet/rbi/gems/unparser@0.6.5.rbi +0 -4529
- data/sorbet/rbi/gems/webrick@1.7.0.rbi +0 -2553
- data/sorbet/rbi/gems/zeitwerk@2.6.0.rbi +0 -867
- data/sorbet/rbi/manual.rbi +0 -7
- data/yarn.lock +0 -20
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
# This is an autogenerated file for types exported from the `benchmark` gem.
|
|
5
5
|
# Please instead update this file by running `bin/tapioca gem benchmark`.
|
|
6
6
|
|
|
7
|
+
|
|
7
8
|
# The Benchmark module provides methods to measure and report the time
|
|
8
9
|
# used to execute Ruby code.
|
|
9
10
|
#
|
|
@@ -18,8 +19,9 @@
|
|
|
18
19
|
#
|
|
19
20
|
# 0.350000 0.400000 0.750000 ( 0.835234)
|
|
20
21
|
#
|
|
21
|
-
# This report shows the user CPU time, system CPU time, the
|
|
22
|
-
#
|
|
22
|
+
# This report shows the user CPU time, system CPU time, the total time
|
|
23
|
+
# (sum of user CPU time, system CPU time, children's user CPU time,
|
|
24
|
+
# and children's system CPU time), and the elapsed real time. The unit
|
|
23
25
|
# of time is seconds.
|
|
24
26
|
#
|
|
25
27
|
# * Do some experiments sequentially using the #bm method:
|
|
@@ -106,6 +108,8 @@
|
|
|
106
108
|
# upto: 0.950000 0.000000 0.950000 ( 0.946787)
|
|
107
109
|
# >total: 2.880000 0.000000 2.880000 ( 2.883764)
|
|
108
110
|
# >avg: 0.960000 0.000000 0.960000 ( 0.961255)
|
|
111
|
+
#
|
|
112
|
+
# pkg:gem/benchmark#lib/benchmark.rb:123
|
|
109
113
|
module Benchmark
|
|
110
114
|
private
|
|
111
115
|
|
|
@@ -150,7 +154,7 @@ module Benchmark
|
|
|
150
154
|
# >total: 2.930000 0.000000 2.930000 ( 2.932889)
|
|
151
155
|
# >avg: 0.976667 0.000000 0.976667 ( 0.977630)
|
|
152
156
|
#
|
|
153
|
-
#
|
|
157
|
+
# pkg:gem/benchmark#lib/benchmark.rb:171
|
|
154
158
|
def benchmark(caption = T.unsafe(nil), label_width = T.unsafe(nil), format = T.unsafe(nil), *labels); end
|
|
155
159
|
|
|
156
160
|
# A simple interface to the #benchmark method, #bm generates sequential
|
|
@@ -173,7 +177,7 @@ module Benchmark
|
|
|
173
177
|
# times: 0.960000 0.000000 0.960000 ( 0.960423)
|
|
174
178
|
# upto: 0.950000 0.000000 0.950000 ( 0.954864)
|
|
175
179
|
#
|
|
176
|
-
#
|
|
180
|
+
# pkg:gem/benchmark#lib/benchmark.rb:216
|
|
177
181
|
def bm(label_width = T.unsafe(nil), *labels, &blk); end
|
|
178
182
|
|
|
179
183
|
# Sometimes benchmark results are skewed because code executed
|
|
@@ -213,7 +217,7 @@ module Benchmark
|
|
|
213
217
|
# #bmbm yields a Benchmark::Job object and returns an array of
|
|
214
218
|
# Benchmark::Tms objects.
|
|
215
219
|
#
|
|
216
|
-
#
|
|
220
|
+
# pkg:gem/benchmark#lib/benchmark.rb:258
|
|
217
221
|
def bmbm(width = T.unsafe(nil)); end
|
|
218
222
|
|
|
219
223
|
# Returns the time used to execute the given block as a
|
|
@@ -232,12 +236,25 @@ module Benchmark
|
|
|
232
236
|
#
|
|
233
237
|
# 0.220000 0.000000 0.220000 ( 0.227313)
|
|
234
238
|
#
|
|
235
|
-
#
|
|
239
|
+
# pkg:gem/benchmark#lib/benchmark.rb:303
|
|
236
240
|
def measure(label = T.unsafe(nil)); end
|
|
237
241
|
|
|
238
242
|
# Returns the elapsed real time used to execute the given block.
|
|
243
|
+
# The unit of time is milliseconds.
|
|
244
|
+
#
|
|
245
|
+
# Benchmark.ms { "a" * 1_000_000_000 }
|
|
246
|
+
# #=> 509.8029999935534
|
|
239
247
|
#
|
|
240
|
-
#
|
|
248
|
+
# pkg:gem/benchmark#lib/benchmark.rb:335
|
|
249
|
+
def ms; end
|
|
250
|
+
|
|
251
|
+
# Returns the elapsed real time used to execute the given block.
|
|
252
|
+
# The unit of time is seconds.
|
|
253
|
+
#
|
|
254
|
+
# Benchmark.realtime { "a" * 1_000_000_000 }
|
|
255
|
+
# #=> 0.5098029999935534
|
|
256
|
+
#
|
|
257
|
+
# pkg:gem/benchmark#lib/benchmark.rb:322
|
|
241
258
|
def realtime; end
|
|
242
259
|
|
|
243
260
|
class << self
|
|
@@ -282,7 +299,7 @@ module Benchmark
|
|
|
282
299
|
# >total: 2.930000 0.000000 2.930000 ( 2.932889)
|
|
283
300
|
# >avg: 0.976667 0.000000 0.976667 ( 0.977630)
|
|
284
301
|
#
|
|
285
|
-
#
|
|
302
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
286
303
|
def benchmark(caption = T.unsafe(nil), label_width = T.unsafe(nil), format = T.unsafe(nil), *labels); end
|
|
287
304
|
|
|
288
305
|
# A simple interface to the #benchmark method, #bm generates sequential
|
|
@@ -305,7 +322,7 @@ module Benchmark
|
|
|
305
322
|
# times: 0.960000 0.000000 0.960000 ( 0.960423)
|
|
306
323
|
# upto: 0.950000 0.000000 0.950000 ( 0.954864)
|
|
307
324
|
#
|
|
308
|
-
#
|
|
325
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
309
326
|
def bm(label_width = T.unsafe(nil), *labels, &blk); end
|
|
310
327
|
|
|
311
328
|
# Sometimes benchmark results are skewed because code executed
|
|
@@ -345,7 +362,7 @@ module Benchmark
|
|
|
345
362
|
# #bmbm yields a Benchmark::Job object and returns an array of
|
|
346
363
|
# Benchmark::Tms objects.
|
|
347
364
|
#
|
|
348
|
-
#
|
|
365
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
349
366
|
def bmbm(width = T.unsafe(nil)); end
|
|
350
367
|
|
|
351
368
|
# Returns the time used to execute the given block as a
|
|
@@ -364,18 +381,33 @@ module Benchmark
|
|
|
364
381
|
#
|
|
365
382
|
# 0.220000 0.000000 0.220000 ( 0.227313)
|
|
366
383
|
#
|
|
367
|
-
#
|
|
384
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
368
385
|
def measure(label = T.unsafe(nil)); end
|
|
369
386
|
|
|
370
387
|
# Returns the elapsed real time used to execute the given block.
|
|
388
|
+
# The unit of time is milliseconds.
|
|
371
389
|
#
|
|
372
|
-
#
|
|
390
|
+
# Benchmark.ms { "a" * 1_000_000_000 }
|
|
391
|
+
# #=> 509.8029999935534
|
|
392
|
+
#
|
|
393
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
394
|
+
def ms; end
|
|
395
|
+
|
|
396
|
+
# Returns the elapsed real time used to execute the given block.
|
|
397
|
+
# The unit of time is seconds.
|
|
398
|
+
#
|
|
399
|
+
# Benchmark.realtime { "a" * 1_000_000_000 }
|
|
400
|
+
# #=> 0.5098029999935534
|
|
401
|
+
#
|
|
402
|
+
# pkg:gem/benchmark#lib/benchmark.rb:341
|
|
373
403
|
def realtime; end
|
|
374
404
|
end
|
|
375
405
|
end
|
|
376
406
|
|
|
377
407
|
# A Job is a sequence of labelled blocks to be processed by the
|
|
378
408
|
# Benchmark.bmbm method. It is of little direct interest to the user.
|
|
409
|
+
#
|
|
410
|
+
# pkg:gem/benchmark#lib/benchmark.rb:347
|
|
379
411
|
class Benchmark::Job
|
|
380
412
|
# Returns an initialized Job instance.
|
|
381
413
|
# Usually, one doesn't call this method directly, as new
|
|
@@ -383,38 +415,32 @@ class Benchmark::Job
|
|
|
383
415
|
# +width+ is a initial value for the label offset used in formatting;
|
|
384
416
|
# the #bmbm method passes its +width+ argument to this constructor.
|
|
385
417
|
#
|
|
386
|
-
#
|
|
387
|
-
#
|
|
388
|
-
# source://RUBY_ROOT/benchmark.rb:329
|
|
418
|
+
# pkg:gem/benchmark#lib/benchmark.rb:355
|
|
389
419
|
def initialize(width); end
|
|
390
420
|
|
|
391
421
|
# Registers the given label and block pair in the job list.
|
|
392
422
|
#
|
|
393
|
-
#
|
|
394
|
-
#
|
|
395
|
-
# source://RUBY_ROOT/benchmark.rb:337
|
|
423
|
+
# pkg:gem/benchmark#lib/benchmark.rb:363
|
|
396
424
|
def item(label = T.unsafe(nil), &blk); end
|
|
397
425
|
|
|
398
426
|
# An array of 2-element arrays, consisting of label and block pairs.
|
|
399
427
|
#
|
|
400
|
-
#
|
|
428
|
+
# pkg:gem/benchmark#lib/benchmark.rb:375
|
|
401
429
|
def list; end
|
|
402
430
|
|
|
403
|
-
#
|
|
404
|
-
#
|
|
405
|
-
# @raise [ArgumentError]
|
|
406
|
-
#
|
|
407
|
-
# source://RUBY_ROOT/benchmark.rb:337
|
|
431
|
+
# pkg:gem/benchmark#lib/benchmark.rb:372
|
|
408
432
|
def report(label = T.unsafe(nil), &blk); end
|
|
409
433
|
|
|
410
434
|
# Length of the widest label in the #list.
|
|
411
435
|
#
|
|
412
|
-
#
|
|
436
|
+
# pkg:gem/benchmark#lib/benchmark.rb:378
|
|
413
437
|
def width; end
|
|
414
438
|
end
|
|
415
439
|
|
|
416
440
|
# This class is used by the Benchmark.benchmark and Benchmark.bm methods.
|
|
417
441
|
# It is of little direct interest to the user.
|
|
442
|
+
#
|
|
443
|
+
# pkg:gem/benchmark#lib/benchmark.rb:385
|
|
418
444
|
class Benchmark::Report
|
|
419
445
|
# Returns an initialized Report instance.
|
|
420
446
|
# Usually, one doesn't call this method directly, as new
|
|
@@ -422,48 +448,52 @@ class Benchmark::Report
|
|
|
422
448
|
# +width+ and +format+ are the label offset and
|
|
423
449
|
# format string used by Tms#format.
|
|
424
450
|
#
|
|
425
|
-
#
|
|
426
|
-
#
|
|
427
|
-
# source://RUBY_ROOT/benchmark.rb:367
|
|
451
|
+
# pkg:gem/benchmark#lib/benchmark.rb:393
|
|
428
452
|
def initialize(width = T.unsafe(nil), format = T.unsafe(nil)); end
|
|
429
453
|
|
|
454
|
+
# An array of Benchmark::Tms objects representing each item.
|
|
455
|
+
#
|
|
456
|
+
# pkg:gem/benchmark#lib/benchmark.rb:412
|
|
457
|
+
def format; end
|
|
458
|
+
|
|
430
459
|
# Prints the +label+ and measured time for the block,
|
|
431
460
|
# formatted by +format+. See Tms#format for the
|
|
432
461
|
# formatting rules.
|
|
433
462
|
#
|
|
434
|
-
#
|
|
463
|
+
# pkg:gem/benchmark#lib/benchmark.rb:402
|
|
435
464
|
def item(label = T.unsafe(nil), *format, &blk); end
|
|
436
465
|
|
|
437
466
|
# An array of Benchmark::Tms objects representing each item.
|
|
438
467
|
#
|
|
439
|
-
#
|
|
468
|
+
# pkg:gem/benchmark#lib/benchmark.rb:412
|
|
440
469
|
def list; end
|
|
441
470
|
|
|
442
|
-
#
|
|
443
|
-
# formatted by +format+. See Tms#format for the
|
|
444
|
-
# formatting rules.
|
|
445
|
-
#
|
|
446
|
-
# source://RUBY_ROOT/benchmark.rb:376
|
|
471
|
+
# pkg:gem/benchmark#lib/benchmark.rb:409
|
|
447
472
|
def report(label = T.unsafe(nil), *format, &blk); end
|
|
473
|
+
|
|
474
|
+
# An array of Benchmark::Tms objects representing each item.
|
|
475
|
+
#
|
|
476
|
+
# pkg:gem/benchmark#lib/benchmark.rb:412
|
|
477
|
+
def width; end
|
|
448
478
|
end
|
|
449
479
|
|
|
450
480
|
# A data object, representing the times associated with a benchmark
|
|
451
481
|
# measurement.
|
|
482
|
+
#
|
|
483
|
+
# pkg:gem/benchmark#lib/benchmark.rb:421
|
|
452
484
|
class Benchmark::Tms
|
|
453
485
|
# Returns an initialized Tms object which has
|
|
454
486
|
# +utime+ as the user CPU time, +stime+ as the system CPU time,
|
|
455
487
|
# +cutime+ as the children's user CPU time, +cstime+ as the children's
|
|
456
488
|
# system CPU time, +real+ as the elapsed real time and +label+ as the label.
|
|
457
489
|
#
|
|
458
|
-
#
|
|
459
|
-
#
|
|
460
|
-
# source://RUBY_ROOT/benchmark.rb:430
|
|
490
|
+
# pkg:gem/benchmark#lib/benchmark.rb:456
|
|
461
491
|
def initialize(utime = T.unsafe(nil), stime = T.unsafe(nil), cutime = T.unsafe(nil), cstime = T.unsafe(nil), real = T.unsafe(nil), label = T.unsafe(nil)); end
|
|
462
492
|
|
|
463
493
|
# Returns a new Tms object obtained by memberwise multiplication
|
|
464
494
|
# of the individual times for this Tms object by +x+.
|
|
465
495
|
#
|
|
466
|
-
#
|
|
496
|
+
# pkg:gem/benchmark#lib/benchmark.rb:504
|
|
467
497
|
def *(x); end
|
|
468
498
|
|
|
469
499
|
# Returns a new Tms object obtained by memberwise summation
|
|
@@ -471,27 +501,27 @@ class Benchmark::Tms
|
|
|
471
501
|
# Tms object.
|
|
472
502
|
# This method and #/() are useful for taking statistics.
|
|
473
503
|
#
|
|
474
|
-
#
|
|
504
|
+
# pkg:gem/benchmark#lib/benchmark.rb:491
|
|
475
505
|
def +(other); end
|
|
476
506
|
|
|
477
507
|
# Returns a new Tms object obtained by memberwise subtraction
|
|
478
508
|
# of the individual times for the +other+ Tms object from those of this
|
|
479
509
|
# Tms object.
|
|
480
510
|
#
|
|
481
|
-
#
|
|
511
|
+
# pkg:gem/benchmark#lib/benchmark.rb:498
|
|
482
512
|
def -(other); end
|
|
483
513
|
|
|
484
514
|
# Returns a new Tms object obtained by memberwise division
|
|
485
515
|
# of the individual times for this Tms object by +x+.
|
|
486
516
|
# This method and #+() are useful for taking statistics.
|
|
487
517
|
#
|
|
488
|
-
#
|
|
518
|
+
# pkg:gem/benchmark#lib/benchmark.rb:511
|
|
489
519
|
def /(x); end
|
|
490
520
|
|
|
491
521
|
# Returns a new Tms object whose times are the sum of the times for this
|
|
492
522
|
# Tms object, plus the time required to execute the code block (+blk+).
|
|
493
523
|
#
|
|
494
|
-
#
|
|
524
|
+
# pkg:gem/benchmark#lib/benchmark.rb:465
|
|
495
525
|
def add(&blk); end
|
|
496
526
|
|
|
497
527
|
# An in-place version of #add.
|
|
@@ -499,17 +529,17 @@ class Benchmark::Tms
|
|
|
499
529
|
# for this Tms object, plus the time required to execute
|
|
500
530
|
# the code block (+blk+).
|
|
501
531
|
#
|
|
502
|
-
#
|
|
532
|
+
# pkg:gem/benchmark#lib/benchmark.rb:475
|
|
503
533
|
def add!(&blk); end
|
|
504
534
|
|
|
505
535
|
# System CPU time of children
|
|
506
536
|
#
|
|
507
|
-
#
|
|
537
|
+
# pkg:gem/benchmark#lib/benchmark.rb:439
|
|
508
538
|
def cstime; end
|
|
509
539
|
|
|
510
540
|
# User CPU time of children
|
|
511
541
|
#
|
|
512
|
-
#
|
|
542
|
+
# pkg:gem/benchmark#lib/benchmark.rb:436
|
|
513
543
|
def cutime; end
|
|
514
544
|
|
|
515
545
|
# Returns the contents of this Tms object as
|
|
@@ -518,7 +548,7 @@ class Benchmark::Tms
|
|
|
518
548
|
# accepts the following extensions:
|
|
519
549
|
#
|
|
520
550
|
# <tt>%u</tt>:: Replaced by the user CPU time, as reported by Tms#utime.
|
|
521
|
-
# <tt>%y</tt>:: Replaced by the system CPU time, as reported by #stime (Mnemonic: y of "s*y*stem")
|
|
551
|
+
# <tt>%y</tt>:: Replaced by the system CPU time, as reported by Tms#stime (Mnemonic: y of "s*y*stem")
|
|
522
552
|
# <tt>%U</tt>:: Replaced by the children's user CPU time, as reported by Tms#cutime
|
|
523
553
|
# <tt>%Y</tt>:: Replaced by the children's system CPU time, as reported by Tms#cstime
|
|
524
554
|
# <tt>%t</tt>:: Replaced by the total CPU time, as reported by Tms#total
|
|
@@ -526,24 +556,24 @@ class Benchmark::Tms
|
|
|
526
556
|
# <tt>%n</tt>:: Replaced by the label string, as reported by Tms#label (Mnemonic: n of "*n*ame")
|
|
527
557
|
#
|
|
528
558
|
# If +format+ is not given, FORMAT is used as default value, detailing the
|
|
529
|
-
# user, system and real elapsed time.
|
|
559
|
+
# user, system, total and real elapsed time.
|
|
530
560
|
#
|
|
531
|
-
#
|
|
561
|
+
# pkg:gem/benchmark#lib/benchmark.rb:530
|
|
532
562
|
def format(format = T.unsafe(nil), *args); end
|
|
533
563
|
|
|
534
564
|
# Label
|
|
535
565
|
#
|
|
536
|
-
#
|
|
566
|
+
# pkg:gem/benchmark#lib/benchmark.rb:448
|
|
537
567
|
def label; end
|
|
538
568
|
|
|
539
569
|
# Elapsed real time
|
|
540
570
|
#
|
|
541
|
-
#
|
|
571
|
+
# pkg:gem/benchmark#lib/benchmark.rb:442
|
|
542
572
|
def real; end
|
|
543
573
|
|
|
544
574
|
# System CPU time
|
|
545
575
|
#
|
|
546
|
-
#
|
|
576
|
+
# pkg:gem/benchmark#lib/benchmark.rb:433
|
|
547
577
|
def stime; end
|
|
548
578
|
|
|
549
579
|
# Returns a new 6-element array, consisting of the
|
|
@@ -551,27 +581,27 @@ class Benchmark::Tms
|
|
|
551
581
|
# user CPU time, children's system CPU time and elapsed
|
|
552
582
|
# real time.
|
|
553
583
|
#
|
|
554
|
-
#
|
|
584
|
+
# pkg:gem/benchmark#lib/benchmark.rb:555
|
|
555
585
|
def to_a; end
|
|
556
586
|
|
|
557
587
|
# Returns a hash containing the same data as `to_a`.
|
|
558
588
|
#
|
|
559
|
-
#
|
|
589
|
+
# pkg:gem/benchmark#lib/benchmark.rb:562
|
|
560
590
|
def to_h; end
|
|
561
591
|
|
|
562
592
|
# Same as #format.
|
|
563
593
|
#
|
|
564
|
-
#
|
|
594
|
+
# pkg:gem/benchmark#lib/benchmark.rb:545
|
|
565
595
|
def to_s; end
|
|
566
596
|
|
|
567
597
|
# Total time, that is +utime+ + +stime+ + +cutime+ + +cstime+
|
|
568
598
|
#
|
|
569
|
-
#
|
|
599
|
+
# pkg:gem/benchmark#lib/benchmark.rb:445
|
|
570
600
|
def total; end
|
|
571
601
|
|
|
572
602
|
# User CPU time
|
|
573
603
|
#
|
|
574
|
-
#
|
|
604
|
+
# pkg:gem/benchmark#lib/benchmark.rb:430
|
|
575
605
|
def utime; end
|
|
576
606
|
|
|
577
607
|
protected
|
|
@@ -583,6 +613,9 @@ class Benchmark::Tms
|
|
|
583
613
|
# +op+ can be a mathematical operation such as <tt>+</tt>, <tt>-</tt>,
|
|
584
614
|
# <tt>*</tt>, <tt>/</tt>
|
|
585
615
|
#
|
|
586
|
-
#
|
|
616
|
+
# pkg:gem/benchmark#lib/benchmark.rb:583
|
|
587
617
|
def memberwise(op, x); end
|
|
588
618
|
end
|
|
619
|
+
|
|
620
|
+
# pkg:gem/benchmark#lib/benchmark.rb:125
|
|
621
|
+
Benchmark::VERSION = T.let(T.unsafe(nil), String)
|