benchmark 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145433cc28066cac5af1cb90961edfde1bd7b54e2ac05357874fb2f4be169a19
-  data.tar.gz: 3732c4e2aaef0eaf7ef4d9513e2bb5116ef18ee7e74546345ccb88f1b3bbddc2
+  metadata.gz: 71da3f4deaf010cbee21c6d4b962c8ae7741a9e1efe64de0f183bf34b4d27d8d
+  data.tar.gz: c4bb5fc6eca86edcad141451fab6e6f6f1cadd1d3fa5dfdfe73b174ff1b48e67
 SHA512:
-  metadata.gz: a11e3910a7c5a636d7993c80ba736682c41a407c3b5d18fe936096c383ffb7c8781a8fae4013760271c05a819c8f126cf17835e91d327c3cb7066e735aed3272
-  data.tar.gz: 3d003fd533f1b4291ac21cdb6b02b93ebbb19e6ca5f7a90dd677416321c49fa2713cc75ccd9a92a89ccdc62d0e0a3cf48f6c2c671ae8935854194fbecc9eafee
+  metadata.gz: da08f1963ba18421b6dda1f03f1c1ab196913b680de4289387f75b26845f8789c5320cd34dc5765d4ff488730eba5c1fb52673de6e657150dc3f0f73821335f5
+  data.tar.gz: 41eb1f1fa53b7da51feacda122f513e2a36a661a82c12f3e239ad384d1f96e090ae9cf412fdb1486b5b391add4c99d540261d980e792381f2954ec8b3f703cab

data/.github/workflows/push_gem.yml

@@ -23,24 +23,24 @@ jobs:
 
     steps:
       - name: Harden Runner
-        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0
+        uses: ruby/setup-ruby@44511735964dcb71245e7e55f72539531f7bc0eb # v1.257.0
         with:
           bundler-cache: true
           ruby-version: ruby
 
       - name: Publish to RubyGems
-        uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31 # v1
+        uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32 # v1.1.1
 
       - name: Create GitHub release
         run: |
           tag_name="$(git describe --tags --abbrev=0)"
           gh release create "${tag_name}" --verify-tag --generate-notes
         env:
-          GITHUB_TOKEN: ${{ secrets.MATZBOT_GITHUB_WORKFLOW_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/test.yml

@@ -21,7 +21,7 @@ jobs:
           - { os: windows-latest, ruby: truffleruby }
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/README.md

@@ -35,7 +35,7 @@ On my machine (OSX 10.8.3 on i5 1.7 GHz) this generates:
 0.350000   0.400000   0.750000 (  0.835234)
 ```
 
-This report shows the user CPU time, system CPU time, the sum of the user and system CPU times, and the elapsed real time. The unit of time is seconds.
+This report shows the user CPU time, system CPU time, the total time (sum of user CPU time, system CPU time, children's user CPU time, and children's system CPU time), and the elapsed real time. The unit of time is seconds.
 
 Do some experiments sequentially using the #bm method:
 

data/lib/benchmark.rb

@@ -30,8 +30,9 @@
 #
 #       0.350000   0.400000   0.750000 (  0.835234)
 #
-#   This report shows the user CPU time, system CPU time, the sum of
-#   the user and system CPU times, and the elapsed real time. The unit
+#   This report shows the user CPU time, system CPU time, the total time
+#   (sum of user CPU time, system CPU time, children's user CPU time,
+#   and children's system CPU time), and the elapsed real time. The unit
 #   of time is seconds.
 #
 # * Do some experiments sequentially using the #bm method:
@@ -121,7 +122,7 @@
 
 module Benchmark
 
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 
   BENCHMARK_VERSION = "2002-04-25" # :nodoc:
 
@@ -324,7 +325,20 @@ module Benchmark
     Process.clock_gettime(Process::CLOCK_MONOTONIC) - r0
   end
 
-  module_function :benchmark, :measure, :realtime, :bm, :bmbm
+  #
+  # Returns the elapsed real time used to execute the given block.
+  # The unit of time is milliseconds.
+  #
+  #       Benchmark.ms { "a" * 1_000_000_000 }
+  #       #=> 509.8029999935534
+  #
+  def ms # :yield:
+    r0 = Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond)
+    yield
+    Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_millisecond) - r0
+  end
+
+  module_function :benchmark, :measure, :realtime, :ms, :bm, :bmbm
 
   #
   # A Job is a sequence of labelled blocks to be processed by the
@@ -503,7 +517,7 @@ module Benchmark
     # accepts the following extensions:
     #
     # <tt>%u</tt>::     Replaced by the user CPU time, as reported by Tms#utime.
-    # <tt>%y</tt>::     Replaced by the system CPU time, as reported by #stime (Mnemonic: y of "s*y*stem")
+    # <tt>%y</tt>::     Replaced by the system CPU time, as reported by Tms#stime (Mnemonic: y of "s*y*stem")
     # <tt>%U</tt>::     Replaced by the children's user CPU time, as reported by Tms#cutime
     # <tt>%Y</tt>::     Replaced by the children's system CPU time, as reported by Tms#cstime
     # <tt>%t</tt>::     Replaced by the total CPU time, as reported by Tms#total
@@ -511,7 +525,7 @@ module Benchmark
     # <tt>%n</tt>::     Replaced by the label string, as reported by Tms#label (Mnemonic: n of "*n*ame")
     #
     # If +format+ is not given, FORMAT is used as default value, detailing the
-    # user, system and real elapsed time.
+    # user, system, total and real elapsed time.
     #
     def format(format = nil, *args)
       str = (format || FORMAT).dup

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: benchmark
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yukihiro Matsumoto
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: a performance benchmarking library
 email:
@@ -37,7 +36,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ruby/benchmark
   source_code_uri: https://github.com/ruby/benchmark
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,8 +50,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: a performance benchmarking library
 test_files: []