benchmark 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e76ab3c1efb3757eea5a1d3758254c823f7502c2c21b993d677fe3698a2dfb2
-  data.tar.gz: 69665530e80e5c47d76c7889f6bd5a97d1bac3c5fbe35a6f6ff37bdfd6d88a0a
+  metadata.gz: 5c8a929d80c7226cb317950efed766404d6dff1f921c0c9235ac5c812bed298b
+  data.tar.gz: 2f7a36ecb752ab4505fd7cbf731c8ae3b160972b2b500821e75243e2f7f8b7ae
 SHA512:
-  metadata.gz: ca3f98d803b6337f5f73a30de2d70fc192abf8f70ca73be0187f21ac1c5b36dcc0d3248a9507ceb62b715cfd338d3bba2149d94ec0b28614809bd07dc2097ac2
-  data.tar.gz: fe9cfad0396eb71b31ffcd6a7023485e23ebf288e56f009a690e244fc6f66833a288c1e61d9a318b7e5b4270757b011dc57c356daad8be42acf5f6617d556961
+  metadata.gz: 58043fc0c11da02f8abc4fcd0535eee0724d7950e0c593c8079077869c473e1c36a9dfd69b559e8761d1c79fc461f2cb2fcba68d8b3f16e4bdd40a2d1a90cba8
+  data.tar.gz: 9e620a007cb7c9d7beaf15779cf160be1b4726fe49791a229048dd6d1730dba490e7ac1f9f614b9eb466b84eb6140b84634fcaa08c8b4d0c0e5e2176f68f972e

data/.github/workflows/push_gem.yml

@@ -0,0 +1,46 @@
+name: Publish gem to rubygems.org
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'ruby/benchmark'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: rubygems.org
+      url: https://rubygems.org/gems/benchmark
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1.190.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - name: Publish to RubyGems
+        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 }}

data/.github/workflows/test.yml

@@ -16,6 +16,7 @@ jobs:
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
         os: [ ubuntu-latest, macos-latest, windows-latest ]
         exclude:
+          - { os: macos-latest, ruby: 2.5 }
           - { os: windows-latest, ruby: truffleruby-head }
           - { os: windows-latest, ruby: truffleruby }
     runs-on: ${{ matrix.os }}

data/{LICENSE.txt → BSDL}

@@ -4,10 +4,10 @@ Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
+   notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
-notice, this list of conditions and the following disclaimer in the
-documentation and/or other materials provided with the distribution.
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

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/benchmark.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/benchmark"
   spec.licenses       = ["Ruby", "BSD-2-Clause"]
 
+  spec.required_ruby_version = ">= 2.1.0"
+
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
 

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.3.0"
+  VERSION = "0.4.1"
 
   BENCHMARK_VERSION = "2002-04-25" # :nodoc:
 
@@ -173,9 +174,15 @@ module Benchmark
     label_width ||= 0
     label_width += 1
     format ||= FORMAT
-    print ' '*label_width + caption unless caption.empty?
     report = Report.new(label_width, format)
     results = yield(report)
+
+    print " " * report.width + caption unless caption.empty?
+    report.list.each { |i|
+      print i.label.to_s.ljust(report.width)
+      print i.format(report.format, *format)
+    }
+
     Array === results and results.grep(Tms).each {|t|
       print((labels.shift || t.label || "").ljust(label_width), t.format(format))
     }
@@ -307,6 +314,10 @@ module Benchmark
 
   #
   # Returns the elapsed real time used to execute the given block.
+  # The unit of time is seconds.
+  #
+  #       Benchmark.realtime { "a" * 1_000_000_000 }
+  #       #=> 0.5098029999935534
   #
   def realtime # :yield:
     r0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
@@ -376,16 +387,16 @@ module Benchmark
     # formatting rules.
     #
     def item(label = "", *format, &blk) # :yield:
-      print label.to_s.ljust(@width)
+      w = label.to_s.length
+      @width = w if @width < w
       @list << res = Benchmark.measure(label, &blk)
-      print res.format(@format, *format)
       res
     end
 
     alias report item
 
     # An array of Benchmark::Tms objects representing each item.
-    attr_reader :list
+    attr_reader :width, :format, :list
   end
 
 
@@ -493,7 +504,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
@@ -501,7 +512,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,14 @@
 --- !ruby/object:Gem::Specification
 name: benchmark
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yukihiro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies: []
 description: a performance benchmarking library
 email:
@@ -18,10 +18,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/push_gem.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- BSDL
+- COPYING
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - benchmark.gemspec
@@ -43,14 +45,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: a performance benchmarking library